Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<ProfileInsertRQ> | The ProfileInsert transaction set inserts a new profile into the profile database. | 1 | ||
<ProfileData> | Common Profile data structure for most profile schemas | 1 | ||
<AccessRights> | *** FUTURE USE *** to be used for Super profile database only | 0..1 | ||
<SharedID> | Office(s) with access rights to this profile | 1..N | ||
@Write | Allowed value: Y Y will allow this ID to update the profile. Default or omission does NOT allow to update the profile. | [Y] | 0..1 | |
@Delete | Allowed value: Y Y will allow this ID to delete the profile. Default or omission does NOT allow to delete the profile. | [Y] | 0..1 | |
<PseudoCityCode/> | Pseudo city code of agency who has ownership of this company or traveler profile. | 1 | LNJ2 | |
<IATA/> | Agent IATA number. | 1 | 12345678 | |
</SharedID> | ||||
</AccessRights> | ||||
<ProfileIdentification> | Identifies type (Company or Traveler), location and ownership of profile. | 1..N | ||
@Type | Identifies the profile type, e.g. T = TravelerProfile, C = Company Profile, | [T] [C] | 1 | |
@Source | Identifies the source of the profile database. Not limited to GDS, applicable to other DBs as well | 0..1 | 1G | |
<PseudoCityCode/> | Pseudo city code of agency who has ownership of this company or traveler profile. | 1 | LNJ2 | |
<ProfileName/> | Name of traveler or company profile as stored in profile database. | 1 | MILLER/JOE (Traveler Prof) IBM CORP (Company Prof) | |
<AssociationData> | Identifies the profile to associate with | 0..N | ||
<ProfileIndex> | Identifies the (target)profile with which an association is established. This can be a company profile or another traveler profile | 1 | ||
@Type | Identifies the profile type, e.g. T = TravelerProfile, C = Company Profile, | [T] [C] | 0..1 | |
</ProfileIndex> | ||||
<ProfileVendor/> | 1 | |||
<SourceProfileIndex/> | 1 | |||
<Relationship/> | Identifies the relationship type (free flow text), e.g. Employee, Consultant, Spouse, Child | 0..1 | ||
<CostCenter/> | CostCenter for this Traveler in this association. | 0..1 | 4520 | |
<Department/> | Department description for this Traveler in this association. | 0..1 | Marketing | |
<EmployeeID/> | EmployeeID of traveler for this association. Example 476254 | 0..1 | ||
<Position/> | Position within the organization. Examples: Director of ... CEO Product Manager | 0..1 | ||
</AssociationData> | ||||
<SelfServiceDevices> | Self servicing devices - allowing traveler to self service their reservations | 0..1 | ||
<SelfServiceDevice> | Self service device data | 0..N | ||
<DeviceType/> | Device Type Allowed values are: iPhone GooglePhone Blackberry OtherHandheld Other | 1 | iPhone | |
<DeviceID/> | Mac ID or telephone number associated with the device | 1 | ||
<DevicePIN/> | PIN or Security ID if required by device type or configuration | 0..1 | ||
</SelfServiceDevice> | ||||
</SelfServiceDevices> | ||||
</ProfileIdentification> | ||||
<ProfileInformation> | Contains notes, information, action items related to profile. Data is for informational purposes only and stored in profile, not moved into PNRs to directly create PNR elements, but can be used for a) flash alert/info screens b) action reminders via UI or via backend queries c) creation of APIS SSRs and others | 0..1 | ||
<PriorityLines> | This section maps the Priority Lines found in GDS. They can be displayed separately and/or moved into a PNR. | 0..1 | ||
<Text> | Free flow text. | 1..N | (1) VIP Status (2) Always call him by his initials "TJ" | |
</Text> | ||||
</PriorityLines> | ||||
<Notes> | Freeflow text remarks pertaining to this profile. Ideal to capture Sabre 'N' and 'R' lines and Amadeus 'N' lines as they are only informative and not to be moved into a PNR. | 0..1 | ||
<Text> | Text only stored in profile. Never moved to PNR. | 1..N | Free flow text. | |
@ProfSource | ONLY used in ProfileViewRS Indicates if this value is returned from a (T)raveler or (C)ompany profile. A number separated by a point and appended to the value such as "T.3" refers to the actual sequential position of the ProfileIdentification node, if multiple profiles are merged. A number separated by a colon and appended to the value such as "T.3:2" or "T:3" refers to the actual sequential position of the AssociationData node within the ProfileIdentification node, if references to other associated profiles are required. T = Traveler Prof Data C = Company Prof Data | 0..1 | T Note: If multiple profiles are merged, the value here will be ---with company profile--- "C" - company "T" - 1st traveler "T.3" - 2nd traveler "T.4" - 3rd traveler ---without company profile--- "T" - 1st traveler "T.2" - 2nd traveler "T.3" - 3rd traveler | |
@LineRef | ONLY used in ProfileViewRS and ProfileReplaceRQ Identifies the element number (4-digits) in the source profile - mostly in case of GDS source. This number is to be used to update and/or delete the corresponding element in the source database. | 0..1 | 0001 | |
</Text> | ||||
</Notes> | ||||
<FollowUpItems> | Freeflow text to capture follow up action items. Data here can be used for special 'Follow-Up List' queries, etc. (as it is done e.g. in Amadeus) | 0..1 | ||
<ActionItem> | Any item stored contains a freeflow action text plus an optional date which can be used to extract actions due on a specific date | 1..N | ||
<Date/> | Date in ISO 8601 format (YYYY-MM-DD). | 0..1 | 2009-11-30 | |
<Text/> | 1..N | |||
</ActionItem> | ||||
</FollowUpItems> | ||||
<TravelerInfo> | Information about traveler and traveler documentation. (used for traveler profiles, and in ProfileViewRS also used in merged profile response) | 0..1 | ||
<PersonalData> | Holds personal structured information about traveler and -if applicable- his relationship to the associated corporation. Data stored here does not create a PNR element but can be used to apply within the UI for various purposes, such as creating Account elements as well as DOCS|O|S APIS SSR elements, etc. | 0..1 | ||
<HomeAirport/> | Home airport. | 0..1 | TPA | |
<CountryBirth/> | Traveler's country of birth. | 0..1 | US | |
<CountryCitizen/> | Traveler's country/countries of citizenship. | 0..N | US | |
<CountryResidence/> | 2-letter CountryCode where the company is located or where the traveler resides. | 0..1 | GB | |
<Language/> | Language(s) preferred by traveler using xsd:language type codes (localization codes). Sample: fr-ca or fr | 0..N | ||
<DateOfBirth/> | Traveler's date of birth in ISO 8601 format (yyyy-mm-dd). | 0..1 | 1978-12-25 | |
<Gender/> | Traveler gender. Values are: F = Female M = Male FI = Female Infant MI = Male Infant U = Unknown at time of booking | [F] [M] [MI] [FI] [U] | 0..1 | M |
<Agreement> | Different types of agreements the traveler can have made. For example an agreement that customer allows to receive information material from a company. | 0..N | ||
<Type/> | Possible values: IM..Receive Information Material | [IM] | 1 | |
<Status/> | Possible values: A..Accept D..Decline | [A] [D] | 1 | |
</Agreement> | ||||
<Salutation/> | Salutation for a traveler, if systems differentiate between title and salutation. Examples: MR, MRS, MS | 0..1 | ||
<PlaceBirth/> | Traveler's place of birth. | 0..1 | Miami | |
</PersonalData> | ||||
<TravelDocs> | Holds data matching the data of traveler's government issued documents. | 0..1 | ||
<Document> | Data stored here provides structured information about any ID and travel document the traveler uses. This information in conjunction with personal data is used to create any DOCA|DOCO|DOCS APIS SSR elements, for advance security clearance, etc. | 1..N | ||
@LineRef | ONLY used in ProfileViewRS and ProfileReplaceRQ Identifies the element number (4-digits) in the source profile - mostly in case of GDS source. This number is to be used to update and/or delete the corresponding element in the source database. | 0..1 | 0001 | |
<DocType/> | DocType Values are: PP = Passport VI = Visa Waiver KT - Known Traveler RN - Redress Number ID = Other Identity Card DL = Driver License | [PP] [VI] [KT] [RN] [ID] [DL] | 1 | PP |
<HolderName> | Name as it appears on the document (if different from Traveler Name) - if ommitted the name of this document is assumed to match the name stored as a traveler name | 0..1 | ||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<Initial/> | Traveler middle initial. | 0..1 | G | |
<MiddleName/> | Traveler given middle name. | 0..1 | JANE | |
<Title/> | Traveler title. | 0..1 | MISS | |
</HolderName> | ||||
<HolderID/> | Identifies the Traveler as the primary passport holder in case of a Multi-Person-Passport. Values: Omit or "H" | 0..1 | ||
<CountryCode/> | Country code where document was issued. | 0..1 | US | |
<DocNumber/> | The alphanumerical document number. | 0..1 | A074-777-451 | |
<DocIssueDate/> | Specifies the date when the document was issued. Date is in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2007-12-17 | |
<DocExpiryDate/> | Specifies the date when the document will expire. Date is in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2009-12-15 | |
<DocHolderCitizenship/> | CountryCode for Citizenship in document | 0..1 | ||
<DocIssueLocation/> | Name of the city where document (for instance passport) was issued. | 0..1 | LONDON GBR | |
<DocDescription/> | Document type description. | 0..1 | Permanent Resident Card | |
</Document> | ||||
</TravelDocs> | ||||
</TravelerInfo> | ||||
<CompanyInfo> | Information about company. (used for company profiles, and in ProfileViewRS also used in merged profile response) This section also holds a customizable TripPurpose Code Table. | 0..1 | ||
<CompanyName/> | Full company name to be used if no name is given in company addresses | 0..1 | Company Inc. | |
<CountryResidence/> | 2-letter CountryCode where the company is located or where the traveler resides. | 0..1 | GB | |
<AccountNumber/> | Account number matching the back office system's account number used for this company (in Sabre this is e.g. the DK-Number) | 0..1 | 1234520 | |
<IATACompanyNumber/> | An IATA assigned company number patterned as follows: CCC = Company Code DDD = Depatment Code CC = 2-letter Country Code | 0..1 | IBM245US | |
<CustomerRefNumber/> | Unique customer reference number if neither an "Accountnumber" nor "IATACompanyNumber" | 0..1 | VDFGFD2312 | |
<TripPurposeTable> | Table of all TripPurpose codes defined for this Company and used in all Traveler Profiles associated to this company. This table may be used by the GUI to populate dropdown lists with this dynamic array. | 0..1 | ||
<TripPurpose> | Individual code set | 1..N | ||
<Code/> | Code to identify the purpose of the trip. | 1 | BIZ = business travel TRNG = training EDU = seminar/education PERS = personal travel | |
<Text> | Freeflow text to describe the TripPurpose code. | 1 | Trip for Training | |
</Text> | ||||
</TripPurpose> | ||||
</TripPurposeTable> | ||||
<LoyaltyPrograms> | 0..1 | |||
<Program> | Individual Program data | 1..N | ||
<LoyaltyMemberID/> | Membership number | 1 | ||
<Name/> | Individual Program name | 1 | ||
<AirlineCode/> | Airline code of the airline offering this Loyaty Program | 1 | ||
</Program> | ||||
</LoyaltyPrograms> | ||||
</CompanyInfo> | ||||
</ProfileInformation> | ||||
<PNRElements> | Structured PNR elements. | 0..1 | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
<Traveler> | Traveler element. Data from traveler profile only. MANDATORY for traveler profile data. | 0..1 | ||
<TravelerName> | Individual name | 1 | ||
@PTC | Passenger type code. Values are: ADT = Adult, INS = Infant w/seat, INF = Infant on lap, CHD = Child, YTH = Youth, MIL = Military, GOV = Government, SRC = Senior Citizen, STD = Student | [ADT] [INS] [INF] [CHD] [YTH] [MIL] [GOV] [SRC] [STD] | 0..1 | ADT |
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<Initial/> | Traveler middle initial. | 0..1 | G | |
<MiddleName/> | Traveler given middle name. | 0..1 | JANE | |
<Title/> | Traveler title. | 0..1 | MISS | |
<NameRemark/> | Free text name remark, e.g. ID number. | 0..1 | A123456 | |
</TravelerName> | ||||
</Traveler> | ||||
<ContactGroup> | Contact group. | 1 | ||
<TelephoneGroup> | Telephone group. | 1 | ||
<Telephone> | Telephone Number | 1..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Type | Phone type. Values are: B = BUSINESS C = CELLULAR F = FAX H = HOME E = EMERGENCY T = TRAVEL ARRANGER O = OTHER | [B] [C] [F] [H] [E] [T] [O] | 0..1 | H |
<PhonePreFix/> | This could be a city code, country code or a combination of it. | 0..1 | MIA MIAUS FRA DE | |
<TelephoneNumber> | Telephone number. | 1 | 305-269-6975 | |
@Extension | Phone extension | 0..1 | 624 | |
</TelephoneNumber> | ||||
<Remark/> | Freeflow text remark, such as contact name, best time to call, etc. Examples: After hours only NOTE: If the TravelArranger node is also populated, map the "Remark" content PLUS the "Travelarranger" content as a single string with separator to the PNRCreate/....../Telephone/Remark node. | 0..1 | ||
<TravelArranger> | Use to associate a Travel Arranger to this traveler. Name and ID is stored here (to be used for queries based on this data) | 0..1 | ||
<Name/> | Full name of Travel Arranger (may also be used for queries). | 0..1 | Melanie Reidy | |
<IDNumber/> | Unique Travel arranger ID to be used for queries | 1 | KJR878 | |
</TravelArranger> | ||||
</Telephone> | ||||
</TelephoneGroup> | ||||
<EmailGroup> | Email address group | 0..1 | ||
<EmailAddress> | E-mail address | 1..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Type | Email type. Values are: B = BUSINESS H = HOME E = EMERGENCY T = TRAVEL ARRANGER O = OTHER | [B] [H] [E] [T] [O] | 0..1 | H |
<Email/> | Individual e-mail address. | 1 | support@sample.com | |
<Remark/> | Freeflow text remark, such as contact name, emergency contactl, etc. Examples: Emergency email NOTE: If the TravelArranger node is also populated, map the "Remark" content PLUS the "Travelarranger" content as a single string with separator to the PNRCreate/.../EmailAddress/Remark node. | 0..1 | ||
<Language/> | Language(s) preferred by traveler using .net language codes (localization codes). Sample: fr-ca | 0..1 | ||
<TravelArranger> | Use to associate a Travel Arranger to this traveler. Name and ID is stored here (to be used for queries based on this data) | 0..1 | ||
<Name/> | Full name of Travel Arranger (may also be used for queries). | 0..1 | Melanie Reidy | |
<IDNumber/> | Unique Travel arranger ID to be used for queries | 0..1 | KJR878 | |
</TravelArranger> | ||||
</EmailAddress> | ||||
</EmailGroup> | ||||
</ContactGroup> | ||||
<FrequentTravelerGroup> | Frequent traveler group. Data from traveler profile only. | 0..1 | ||
<FreqFlyerNumber> | Frequent Flyer Card and Status information. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<AirlineCode/> | Issuing Airline Code. | 1 | LH | |
<IDNumber/> | Frequent flyer number. | 1 | 0956301007 | |
<ProgramName/> | Program name. | 0..1 | Miles and More (air) | |
<PartnerAirline/> | Airline code. If entered, any miles flown on one of these partner airlines are credited to the associated frequent flyer program. This allows via UI to select the accruel of miles for a partner airline flight. Sceanrio: The program "Miles and More" is offered by LH (Lufthansa). Miles earned on flights marketed by any of LH's Star Alliance and other selected partners can be credited to LH's "Miles and More" program. | 0..N | AC | |
<Alliance/> | Name of alliance of which the program offering airline is a member. Possible Values are 'Star Alliance' 'oneworld' 'SkyTeam' Examples: Star Alliance | [Star Alliance] [oneworld] [SkyTeam] | 0..1 | |
</FreqFlyerNumber> | ||||
<FreqGuestNumber> | Frequent Guest Card and Status information | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Type | Identified association to one of the following groups: CR = CAR HL = HOTEL | [CR] [HL] | 0..1 | |
<CompanyCode/> | Car Company or Hotel Chain 2-letter code. | 1 | ZE | |
<IDNumber/> | Frequent Renter or Guest ID number. | 1 | 0956301007 | |
<ProgramName/> | Program name. | 0..1 | Hilton HHonors (hotel) Emerald Club (car) | |
<Association> | Associated airline frequent flyer program. This is the frequent flyer program a traveler assigns in order to earn additional miles/points from hotel and/or car companies | 0..1 | ||
<AirlineCode/> | Issuing Airline Code. | 1 | LH | |
<IDNumber/> | Frequent flyer ID number. | 1 | 0956301007 | |
</Association> | ||||
</FreqGuestNumber> | ||||
<OtherMemberShips> | Discount Cards such as AAA, AARP, etc. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Type | Identifies association to one of the following groups: AL = Airline AC = Alliance AZ = All (A to Z) BU = Bus/Ground Transport CR = Car CS = Cruise GD = GDS HL = Hotel HC = Hotel Chain IN = Insurance RL = Rail SS = Specialty Service TR = Tour | [AL] [AC] [AZ] [BU] [CR] [CS] [GD] [HL] [HC] [IN] [RL] [SS] [TR] | 0..1 | |
<AssociationCode/> | Code for organization or association. | 0..1 | AARP, AAA | |
<IDNumber/> | Membership ID number. | 1 | 0956301007 | |
<ProgramName/> | Program name. | 0..1 | AARP Membership AAA Membership | |
</OtherMemberShips> | ||||
</FrequentTravelerGroup> | ||||
<SpecialServiceRequests> | Special service request group, accommodates structured SSR elements | 0..1 | ||
<Regular> | Special service request, such as for wheelchair, special meal, special luggage, seats, etc. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<SSRCode/> | Special service request code. IATA standard. | 1 | VGML | |
<AirlineCode/> | Airline code to dispatch request to. If code "YY" is used this request will be dispatched to all participating carriers in the itinerary. | 0..1 | AA (specific) YY (dispatch to all) | |
<Text/> | 0..1 | |||
</Regular> | ||||
<APIS> | Contains fully structured SSR elements if provided by source profile; applies to traveler profiles only; uses advanced "DOC[S,O,A]" SSR codes. Note: If APIS data is not provided by source profile, information to construct an APIS SSR may be available in the following nodes: .../ProfileInformation/TravelerInfo/PersonalData .../ProfileInformation/TravelerInfo/TravelDocs | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<PictureID> | Passport and secondary document data, not including Visa. APIS SSR Code: DOCS | 0..1 | ||
<SSRCode/> | Only valid code for this re- quest type is DOCS(Passport or other ID) | 1 | DOCS | |
<AirlineCode/> | Mandatory for Amadeus. Airline code to dispatch request to. If code "YY" is used this request will be dispatched to all participating carriers in the itinerary. | 0..1 | AA (specific) YY (dispatch to all) | |
<APISDocType/> | A - Alien resident card C - Permanent resident card F - Facilitation document I - Identity card (International routings usually require a valid passport for travel. However, there are countries where passengers can travel across borders with a national identity card such as travel between various European countries. ) M - Military N - Naturalization certificate P - Passport T - Refugee travel document and re-entry permit, US Travel document V - Border crossing card | [A] [C] [F] [I] [M] [N] [P] [T] [V] | 0..1 | |
<CountryOfIssue/> | The three-letter AIRIMP country code where this document was issued. | 0..1 | USA Mandatory for all airlines complying to AIRIMP standards, optional for others. Note: 2-letter codes are allowed but above is IATA recommended | |
<DocNumber/> | The alphanumerical document number. | 1 | A074-777-451 | |
<CountryOfNationality/> | Nationality in three-letter AIRIMP country code format. | 0..1 | USA Mandatory for all airlines complying to AIRIMP standards, optional for others. Note: 2-letter codes are allowed but above is IATA recommended | |
<DateOfBirth/> | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 Note: when sent to airlines in APIS it needs to be formatted to: DDMMMYY. Example: 25DEC2001 | |
<Gender/> | Traveler gender. Values are: F = Female M = Male FI = Female Infant MI = Male Infant U = Unknown at time of booking | [F] [M] [MI] [FI] [U] | 1 | M |
<DocExpiryDate/> | Specifies the date when the document will expire. Date is in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2009-12-15 Note: when sent to airlines in APIS it needs to be formatted to: DDMMMYY. Example: 15DEC2009 | |
<Surname/> | Traveler family (last) name - as it appears on the document. | 0..1 | SMITH | |
<GivenName/> | Traveler given (first) name - as it appears on the document. | 0..1 | JANE | |
<MiddleName/> | Traveler middle name or middle initial - as it appears on the document. | 0..1 | JANE | |
<PassportHolder/> | Mandatory for a Multi-Passenger Passport. If traveler is the primary passport holder the value must be set to "H". Allowed value: H = primary pspt holder | 0..1 | ||
</PictureID> | ||||
<Visa> | Passenger’s Visa, Place of Visa Issue and Passenger’s Place of Birth. APIS SSR Code: DOCO | 0..1 | ||
<SSRCode/> | Only valid code for this re- quest type is DOCO(Visa) | 1 | DOCO | |
<AirlineCode/> | Mandatory for Amadeus. Airline code to dispatch request to. If code "YY" is used this request will be dispatched to all participating carriers in the itinerary. | 0..1 | AA (specific) YY (dispatch to all) | |
<PlaceOfBirth/> | Freeflow text - enter e.g. complete country name or the country code. a city and state, or a city and country name. Examples: US Houstan Texas | 0..1 | ||
<APISDocType/> | Identifies the type of the SSR DOCO entered. Three types exist: Visa (default), Known Traveler Number and Redress Number. V - Visa K - Known Traveler R - Redress Number | [V] [K] [R] | 1 | V |
<DocNumber/> | The alphanumerical document number. | 1 | A074-777-451 | |
<PlaceOfIssue/> | Freeflow text - enter e.g. complete country name or the country code. a city and state, or a city and country name. Examples: US Houstan Texas | 1 | ||
<DocIssueDate/> | Specifies the date when the document was issued. Date is in ISO 8601 format (yyyy-mm-dd). | 1 | 2007-12-17 Note: when sent to airlines in APIS it needs to be formatted to: DDMMMYY. Example: 17DEC2007 | |
<VisitingCountryCode/> | Three-letter AIRIMP country code of the country the Visa applies to. | 1 | HKG Note: 2-letter codes are allowed but above is IATA recommended | |
<InfantLapIndicator/> | A mandatory indicator if traveler is accompanied by an infant on the lap (no seperate seat) Possible value: I = Infant on lap Note: Infant w/own seat requires separate SSR | [I] | 0..1 | |
</Visa> | ||||
<AddressAdvice> | Passenger’s Resident address APIS SSR Code: DOCA | 0..1 | ||
<SSRCode/> | Only valid code for this re- quest type is DOCA (Addresses) | 1 | DOCA | |
<AirlineCode/> | Mandatory for Amadeus, not applicable for Sabre. Airline code to dispatch request to. If code "YY" is used this request will be dispatched to all participating carriers in the itinerary. | 0..1 | AA (specific) YY (dispatch to all) | |
<AddressType/> | Valid address types as per industry standard are: R - Residence Address D - Destination Address Note: Only the type "R" can be stored in a profile. Any APIS/AddressAdvice of type "D" for a Destination address needs to be provided by the booking tool based on manual user entry | [R] [D] | 1 | |
<CountryCode/> | Country code. | 0..1 | US | |
<AddressLine/> | Street or PO Box address. | 1 | 1234 Main Street | |
<City/> | City name. | 1 | NY | |
<PostalCode/> | Postal code or zip code. | 1 | 12345 | |
<StateProvinceCode/> | State or province code. | 1 | NY | |
<InfantLapIndicator/> | A mandatory indicator if traveler is accompanied by an infant on the lap (no seperate seat) Possible value: I = Infant on lap Note: Infant w/own seat requires separate SSR | [I] | 0..1 | |
</AddressAdvice> | ||||
</APIS> | ||||
</SpecialServiceRequests> | ||||
<OtherServiceInfoGroup> | Other service information group | 0..1 | ||
<OSIElement> | Individual OSI element | 1..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<AirlineCode/> | Specific Airline code. If 'YY' is entered the OSI element is to be dispatched to all airlines participating in the itinerary. | 1 | AA | |
<Text/> | OSI free-flow text | 1 | ||
</OSIElement> | ||||
</OtherServiceInfoGroup> | ||||
<FormOfPaymentGroup> | All Form of Payments for this single or merged profile | 0..1 | ||
<FormOfPayment> | Form of payment group | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Priority | ** for experimental use ** Indicator if this FOP element ranks higher than an existing Company FOP with a @Action of "A". If set to "Y" this FOP is used even if a comany FOP with an @Action value = A exists, unless company FOP itself is set to "Y" (highest rank). Possible values: Y. N Examples: (1) @ProfSource of C plus @Action of A plus Priority of Y = HIGHEST rank, trumps all other FOPs (2) @ProfSource of T plus @Action of A plus Priority of Y = HIGHEST rank, trumps all other FOPs with exception of (1) (3) @ProfSource of C plus @Action of A plus Priority of N = HIGHEST rank, trumps all other FOPs w/@ProfSource of T NOTE: MAY NEED SOME MORE BUSINESS CASES | 0..1 | ||
@Purpose | Indicator for which transactions this FOP can be used. Available values: TRANS = use for air/rail transportation only GUAR = use for Car/Hotel guarantee only PERS = use for personal travel only ALL = (default) use for all transactions. | [TRANS] [GUAR] [PERS] [ALL] | 0..1 | TRANS |
<CreditCard> | Credit card group | 1 | ||
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX | |
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | 1 | 02 Can be returned encrypted by GDS/CRS. Example: XX | |
<Year/> | Last two digits of the credit card expiration year. | 1 | 06 Can be returned encrypted by GDS/CRS. Example: XX | |
</CCExpiration> | ||||
<SecurityID/> | Credit card security number for online transactions (referred to also as CVV2, CVC2, CSC or CID). This is a 3-digit (Visa, Master, Discover) or 4-digit (Amex) number. IS THIS NUMBER ALLOWED TO BE STORED AT ALL? OR CAN IT BE STORED ENCRYPTED? | 0..1 | ||
<ReportingData> | Data Elements required by certain card issuers for report purposes | 0..1 | ||
<AccountNumber> | Corporation's account number | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | [A] [N] [D] | 0..1 | |
@Mandatory | O - optional (default) M - mandatory | [O] [M] | 0..1 | |
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</AccountNumber> | ||||
<CostCenter> | Cost center number/code | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | [A] [N] [D] | 0..1 | |
@Mandatory | O - optional (default) M - mandatory | [O] [M] | 0..1 | |
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</CostCenter> | ||||
<Department> | Department description for this Traveler in this association. | 0..1 | Marketing | |
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | [A] [N] [D] | 0..1 | |
@Mandatory | O - optional (default) M - mandatory | [O] [M] | 0..1 | |
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</Department> | ||||
<EmployeeID> | EmployeeID of traveler for this association. Example 476254 | 0..1 | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | [A] [N] [D] | 0..1 | |
@Mandatory | O - optional (default) M - mandatory | [O] [M] | 0..1 | |
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</EmployeeID> | ||||
<GenericElement> | These are elements provided by CC vendor and could include elements such as - ProjectNumber - AccountingUnit - ActionNumber - DepartingDate - FinalDestination Above sample reflects data elements from UATP/Airplus requirements | 0..N | ||
@Min | minimum length | 0..1 | ||
@Max | maximum length | 0..1 | ||
@Format | A - alphanumeric (default) N - numeric D - ISO date format | [A] [N] [D] | 0..1 | |
@Mandatory | O - optional (default) M - mandatory | [O] [M] | 0..1 | |
@DataElementID | Vendor code assigned to this reporting element | 1 | BK | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Corperate ID | |
</GenericElement> | ||||
</ReportingData> | ||||
<CardholderFullName/> | Credit cardholder full name as it appears on the card | 0..1 | ||
<CCAddressGroup> | Use this to map a CC address which deviates from the billing address in profile. This is typically the case when (a) the traveler has a different billing address than CC address or (b) when a card is used of a person which is not part of itinerary | 0..1 | ||
<AddressLine/> | Street or PO Box address. | 1..2 | 1234 Main Street | |
<City/> | City name. | 1 | NY | |
<PostalCode/> | Postal code or zip code. | 1 | 12345 | |
<StateProvinceCode/> | State or province code. | 0..1 | NY | |
<CountryCode/> | ISO Country code. This element is introduced as mandatory although GDS implementation will not require its presence until 30MAR2008. | 1 | US | |
</CCAddressGroup> | ||||
</CreditCard> | ||||
<Other/> | Other payment information. | 1 | Check 113 | |
<Remark/> | Freeflow text remark | 0..1 | Bartercard for AA validated flights | |
</FormOfPayment> | ||||
</FormOfPaymentGroup> | ||||
<AddressGroup> | All Addresses for this single or merged profile | 0..1 | ||
<Address> | Individual Address | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@Use | Indicates use of address information. Values are: B = Billing D = Delivery H = Mailing home address (Amadeus) O = Mailing miscellaneous address (Amadeus) M = Mailing address (Amadeus) As you can see B and D are supported by all GDS. See for GDS specific address types above. | [B] [D] [A] [H] [O] [M] | 0..1 | D NOTE: THIS NEEDS TO BE REWORKED AS IT IS FACTUALLY NOT TRUE. /H, /D and /M in Amadeus ONLY APPLY TO AM (Mailing) ELEMENTS |
<OptionalName/> | (Optional) Name if deviated from Traveler's name or Company's name - see nodes: ../ProfileInformation/CompanyInfo ../ProfileInformation/TravelerInfo | 0..1 | ||
<AddressLine/> | Street or PO Box address. | 1..2 | 1234 Main Street | |
<City/> | City name. | 1 | NY | |
<PostalCode/> | Postal code or zip code. | 1 | 12345 | |
<StateProvinceCode/> | State or province code. | 0..1 | NY | |
<CountryName/> | Country name. | 0..1 | Great Britain | |
<CountryCode/> | ISO Country code. This element is introduced as mandatory although GDS implementation will not require its presence until 30MAR2008. | 1 | US | |
</Address> | ||||
</AddressGroup> | ||||
<GeneralRemarkGroup> | General and custom coded PNR Remark elements | 0..1 | ||
<GeneralRemark> | These are informational PNR remarks which will not print to any invoice/itinereray. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@CustomCategory | Unique 1-letter category (offered by most GDS) and assigned by agency; mostly used to group remarks by AIR, CAR, FARES or HOTEL related remarks. Possible values are all letters of the alphabet with the following exceptions: T, ?? | 0..1 | C NOTE: ALL GDS MUST BE CHECKED IF A 1-LETTER CODE APPLIES TO ALL. | |
<Text/> | Any remark free-flow text | 1 | ||
</GeneralRemark> | ||||
<HiddenRemark> | Hidden/confidential remarks can only be displayed by PCCs listed if they have an EOS agreement. A right to modify can be given to a PCC. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<Text/> | Any remark free-flow text | 1 | ||
<PseudoCityCode> | PCCs listed here do have a right to read or update this type of remark lines according to access code defined in attribute | 0..3 | ||
@Write | Allowed values: Y, N Y = will allow this PCC to update this remark. N = allow that this PCC can only retrieve/read this remark (default) Default or omission does NOT allow to update this remark. | [Y] [N] | 0..1 | |
</PseudoCityCode> | ||||
</HiddenRemark> | ||||
<CorporateRemark> | Corporate remarks allow corporations to share remarks with pre-defined offices (thus no need to enter PCC which are allowed to view) Only PCCs with appropriate EOS with the PNR creating office can view this type of remark. | 0..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<Text/> | Any remark free-flow text | 1 | ||
</CorporateRemark> | ||||
</GeneralRemarkGroup> | ||||
<DocumentRemarks> | Document remarks group | 0..1 | ||
<PrintRemark> | Remark to be printed on Invoice, Itinerary, ETicket, PaxReceipt | 1..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
@PrintCode | defines where this remark is to be printed. Possible values are: IT = Itinerary Only IN = Inv/PaxReceipt II = Inv/Itin/PaxReceipt ET = Etkt PaxReceipt only | [IT] [IN] [II] [ET] | 1 | |
<Text/> | Any free-flow text to be printed on defined document | 1 | ||
</PrintRemark> | ||||
</DocumentRemarks> | ||||
<UserDefinedIDGroup> | User defined UDID for back office communication | 0..1 | ||
<UDID> | User defined remark | 1..N | ||
@Action | Indicates how this data is moved into or added to a PNR. Values are: A = Always move line O = Optional move line N = Never move line | [A] [N] [O] | 0..1 | A |
<UDIDNumber/> | User defined number. | 1 | 09 | |
<Text/> | UDID text | 1 | ||
</UDID> | ||||
</UserDefinedIDGroup> | ||||
</PNRElements> | ||||
<ContractInformation> | Private contracts, FlightPass, Corporate IDs | 0..1 | ||
@DataBaseLink | Reference to a separate database where the contract data is stored (if independent of profile database). This link allows to create the "ContractInformation" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<AirContract> | Air related contracts | 0..N | ||
@FareSystem | Identifies the fare system that holds the private fares. Possibles values are: 1A = Amadeus 1B = Abacus 1V = Apollo 1G = Galileo 1S = Sabre (also 1W) 1P = Worldspan | [1A] [1B] [1V] [1G] [1S] [1P] | 0..1 | 1V |
<AirlineCode/> | Airline code. | 1 | AA | |
<Office/> | Pseudo city under which private fares are stored. | 0..1 | 1C1K | |
<IATA/> | Agency's IATA Code owning this contract | 0..1 | ||
<AccountNumber/> | Specifies the corporate account number to use to query for private/negotiated fares. | 0..1 | 000243 | |
<ContractID/> | Contract ID Reference | 0..1 | ||
<LoyaltyPrograms> | Loyalty Program data | 0..1 | ||
<LoyaltyMemberID/> | Membership number | 1 | ||
<ProgramName/> | Loyalty Program name | 1 | ||
</LoyaltyPrograms> | ||||
<PTC/> | IATA Passenger Type Code(s) covered under this contract. | 0..N | ADT | |
<BookingClass/> | Required Booking classes or Price classes to book this contracted fare. | 0..N | Tango (if price class) H (if booking class) | |
<TicketDesignator/> | TicketDesignator to be used as per contract. | 0..1 | ZO15 | |
<Discount> | Pricing discount value. | 0..1 | 2000 | |
<DiscountValue> | Enter either an amount or percentage. If percentage enter the number of decimals in the attribute 'NbrOfDecimals' If amount, the CurrencyCode with it's associated 'NumberOfDecimals' becomes mandatory. | 1 | ||
@Type | Type of discount. Values are: P = Percent A = Amount | [P] [A] | 1 | A |
@NbrOfDecimals | ONLY IF PERCENTAGE (content will be ignored if value attribute Type=A) | 0..1 | ||
</DiscountValue> | ||||
<CurrencyCode> | If discount value is an amount, the CurrencyCode is mandatory. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</Discount> | ||||
<Cabin/> | Specifies the applicable cabin. Valid values are : P = Premium First class F = First class J = Premium Business class C = Business class W = Premium Economy class Y = Coach class | [P] [F] [J] [C] [W] [Y] | 0..1 | F |
<MarketApplication> | Define the applicable market by using the elements "OriginMarket" and "DestinationMarket". The elements allow to exactly identify the applicable market: 1st Level - Region or Zone 2nd Level - Countries 3rd Level - Country/State 4th Level - City/Airports Examples: 1) EUROPE/US-PACIFIC 2) US/DE 3) USFL/USCA 4) MIA/FRA 5) blank/EUROPE (blank=home airport) or a mix of the above: 5) US/EUROPE 6) MIA/CARIBBEAN 7) USFL/FRA Possible values: 4th Level - a three-letter airport or city code 3rd Level - Country:State using pattern CC:SS e.g. US:NY 2nd Level - a two-letter country code 1st Level - a region/zone name from this list: NORTH-AMERICA (50) USA (48) CA HI PR VI AK MX GSM CARIBBEAN CENTRAL-AMERICA SOUTH-AMERICA SOUTH-AMERICA -ATLANTIC SOUTH-AMERICA -NORTHRIM EUROPE IBERIAN-PENINSULA SCANDINAVIA MIDDLE-EAST AFRICA WEST-AFRICA SOUTHERN-AFRICA EAST-AFRICA JAPAN-KOREA SOUTHEAST-ASIA SOUTH-ASIAN-SUB SOUTHWEST-PACIFIC US-PACIFIC -TERRITORIES RUSSIA-EAST MICRONESIA | 0..1 | ||
<OriginMarket/> | Destination market to which this preference or fare applies. If left blank this should be populated with the "HomeAirport" of the traveler. Examples: 1) JFK (from HomeAirport) 2) US (specific country) 3) NYC (specific city) 4) EUROPE (specific region) 5) US:NY (state in a country) | 1 | ||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
<MarketExclusions> | Define here the (lower level) market(s) to be excluded from the higher level market definition | 0..N | ||
<OriginMarket/> | Destination market to which this preference or fare applies. If left blank this should be populated with the "HomeAirport" of the traveler. Examples: 1) MIA (from HomeAirport) 2) US (specific country) 3) NYC (specific city) 4) EUROPE (specific region) 5) US:NY (state in a country) | 1 | ||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
</MarketExclusions> | ||||
</MarketApplication> | ||||
</AirContract> | ||||
<FlightPass> | Contracted Flight Passes The applicable market can be defined in the child element "MarketFare" using the attributes 'OriginMarket' and 'DestinationMarket' | 0..N | ||
@FareSystem | Identifies the fare system that holds the private fares. Possibles values are: 1A = Amadeus 1B = Abacus 1V = Apollo 1G = Galileo 1S = Sabre (also 1W) 1P = Worldspan | [1A] [1B] [1V] [1G] [1S] [1P] | 0..1 | 1V |
<AirlineCode/> | Airline code. | 1 | AA | |
<Office/> | Pseudo city under which private fares are stored. | 0..1 | 1C1K | |
<IATA/> | Agency's IATA Code holding this prepaid pass | 0..1 | ||
<AccountNumber/> | Specifies the corporate account number to use to query for private/negotiated fares. | 0..1 | 000243 | |
<PassCredentials> | Ownership and access information | 0..1 | ||
<EmailAddress/> | E-mail address | 0..1 | ||
<MemberNumber> | mandatory for AC flight passes | 0..1 | ||
<AirlineCode/> | Airline code. | 1 | AA | |
<IDNumber/> | Frequent flyer or guest ID number. | 1 | 0956301007 | |
</MemberNumber> | ||||
</PassCredentials> | ||||
<FlightPassID/> | Contract ID Reference | 0..1 | ||
<FlightPassName/> | Name of the purchased flight pass. | 0..1 | Western Commuter Pass | |
<MarketApplication> | Define the applicable market by using the elements "OriginMarket" and "DestinationMarket". The elements allow to exactly identify the applicable market: 1st Level - Region or Zone 2nd Level - Countries 3rd Level - Country/State 4th Level - City/Airports Examples: 1) EUROPE/US-PACIFIC 2) US/DE 3) USFL/USCA 4) MIA/FRA 5) blank/EUROPE (blank=home airport) or a mix of the above: 5) US/EUROPE 6) MIA/CARIBBEAN 7) USFL/FRA Possible values: 4th Level - a three-letter airport or city code 3rd Level - Country:State using pattern CC:SS e.g. US:NY 2nd Level - a two-letter country code 1st Level - a region/zone name from this list: NORTH-AMERICA (50) USA (48) CA HI PR VI AK MX GSM CARIBBEAN CENTRAL-AMERICA SOUTH-AMERICA SOUTH-AMERICA -ATLANTIC SOUTH-AMERICA -NORTHRIM EUROPE IBERIAN-PENINSULA SCANDINAVIA MIDDLE-EAST AFRICA WEST-AFRICA SOUTHERN-AFRICA EAST-AFRICA JAPAN-KOREA SOUTHEAST-ASIA SOUTH-ASIAN-SUB SOUTHWEST-PACIFIC US-PACIFIC -TERRITORIES RUSSIA-EAST MICRONESIA | 0..1 | ||
<OriginMarket/> | Destination market to which this preference or fare applies. If left blank this should be populated with the "HomeAirport" of the traveler. Examples: 1) JFK (from HomeAirport) 2) US (specific country) 3) NYC (specific city) 4) EUROPE (specific region) 5) US:NY (state in a country) | 1 | ||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
<MarketExclusions> | Define here the (lower level) market(s) to be excluded from the higher level market definition | 0..N | ||
<OriginMarket/> | Destination market to which this preference or fare applies. If left blank this should be populated with the "HomeAirport" of the traveler. Examples: 1) MIA (from HomeAirport) 2) US (specific country) 3) NYC (specific city) 4) EUROPE (specific region) 5) US:NY (state in a country) | 1 | ||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
</MarketExclusions> | ||||
</MarketApplication> | ||||
<MarketFare> | Contracted base fare for identified market | 0..1 | ||
<BaseFare/> | Applicable base fare for associated market | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</MarketFare> | ||||
<PTC/> | IATA Passenger Type Code(s) covered under this contract. | 0..N | ADT | |
<BookingClass/> | Required Booking classes or Price classes to book this contracted fare. | 0..N | Tango (if price class) H (if booking class) | |
<Cabin/> | Specifies the applicable cabin. Valid values are : P = Premium First class F = First class J = Premium Business class C = Business class W = Premium Economy class Y = Coach class | [P] [F] [J] [C] [W] [Y] | 0..1 | F |
</FlightPass> | ||||
<Car> | Car related contracts | 0..N | ||
<CorpID/> | CD number assigned to the corporate account | 1 | ||
<CompanyCode/> | Car Company or Hotel Chain 2-letter code. | 1 | ZE | |
</Car> | ||||
<Hotel> | Hotel related contracts | 0..N | ||
<CorpID/> | CD number assigned to the corporate account | 1 | ||
<CompanyCode/> | Car Company or Hotel Chain 2-letter code. | 1 | ZE | |
</Hotel> | ||||
</ContractInformation> | ||||
<Preferences> | Air, Car and Hotel preferences | 0..1 | ||
@DataBaseLink | Reference to a separate database where the preferences are stored (if independent of profile database). This link allows to create the "Preferences" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<AirPref> | Air preferences | 0..1 | ||
<BasicPreference> | Basic(default) preferences. These preference only applies if no market specific preference exist. Only different "TripPurpose" attributes can trigger another instance of this BasicPreference node. | 0..N | IC | |
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<Airlines> | Airline code(s). Any market preference supersedes this basic preference. | 0..1 | ||
<AirlineCode> | 2-digit airline code(s). Any applicable market preference supersedes this basic preference. | 1..N | AA | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</AirlineCode> | ||||
</Airlines> | ||||
<SeatPreference> | Traveler's basic (general) seat preference - if not overwritten by specific market preference | 0..1 | ||
<SeatArea/> | Seat area identifier. Values are: A = Aisle W = Window | [A] [W] | 0..1 | W |
<RowArea/> | B = Bulkhead F = Front of Aircraft R = Rear of Aircraft | [B] [F] [T] | 0..1 | |
<Characteristic> | Seat characteristic for generic seat request. Values are: S = Smoking N = Non Smoking E = Exit C = Cot R = Rear-Facing P = Upper Deck | 0..N | E | |
</Characteristic> | ||||
<SeatRemark/> | Additional remarks to seats e.g. upper deck only | 0..1 | ||
</SeatPreference> | ||||
</BasicPreference> | ||||
<MarketPreference> | Allows for different levels of preferences for specified markets. 1st Level - Region or Zone 2nd Level - Countries 3rd Level - Country/State 4th Level - City/Airports Examples: 1) EUROPE/US-PACIFIC 2) US/DE 3) USFL/USCA 4) MIA/FRA 5) blank/EUROPE (blank=home airport) or a mix of the above: 5) US/EUROPE 6) MIA/CARIBBEAN 7) USFL/FRA Possible values: 4th Level - a three-letter airport or city code 3rd Level - Country:State using pattern CC:SS e.g. US:NY 2nd Level - a two-letter country code 1st Level - a region/zone name from this list: NORTH-AMERICA (50) USA (48) CA HI PR VI AK MX GSM CARIBBEAN CENTRAL-AMERICA SOUTH-AMERICA SOUTH-AMERICA -ATLANTIC SOUTH-AMERICA -NORTHRIM EUROPE IBERIAN-PENINSULA SCANDINAVIA MIDDLE-EAST AFRICA WEST-AFRICA SOUTHERN-AFRICA EAST-AFRICA JAPAN-KOREA SOUTHEAST-ASIA SOUTH-ASIAN-SUB SOUTHWEST-PACIFIC US-PACIFIC -TERRITORIES RUSSIA-EAST MICRONESIA | 0..N | ||
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<Airlines> | Airline code(s). Any market preference supersedes this basic preference. | 0..1 | ||
<AirlineCode> | 2-digit airline code(s). Any applicable market preference supersedes this basic preference. | 1..N | AA | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</AirlineCode> | ||||
</Airlines> | ||||
<SeatPreference> | If present defines a seat preference for this particular market | 0..1 | ||
<SeatArea/> | Seat area identifier. Values are: A = Aisle W = Window | [A] [W] | 0..1 | W |
<RowArea/> | B = Bulkhead F = Front of Aircraft R = Rear of Aircraft | [B] [F] [T] | 0..1 | |
<Characteristic> | Seat characteristic for generic seat request. Values are: S = Smoking N = Non Smoking E = Exit C = Cot R = Rear-Facing P = Upper Deck | 0..N | E | |
</Characteristic> | ||||
<SeatRemark/> | Additional remarks to seats e.g. upper deck only | 0..1 | ||
</SeatPreference> | ||||
<OriginMarket/> | Destination market to which this preference or fare applies. If left blank this should be populated with the "HomeAirport" of the traveler. Examples: 1) MIA (from HomeAirport) 2) US (specific country) 3) NYC (specific city) 4) EUROPE (specific region) 5) US:NY (state in a country) | 1 | ||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
</MarketPreference> | ||||
</AirPref> | ||||
<CarPref> | Car preferences | 0..1 | ||
<BasicPreference> | Basic(default) preferences. These preference only applies if no market specific preference exist. Only different "TripPurpose" attributes can trigger another instance of this BasicPreference node. | 0..N | ||
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<CarCompanies> | Car company code(s). Any market preference supersedes this basic preference. | 0..1 | ||
<CompanyCode> | Car Company 2-letter code. | 1..N | ZE | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</CompanyCode> | ||||
</CarCompanies> | ||||
<VehicleType> | Preferred vehicle type. Values need to be per car industry standard ACRISS code. | 0..1 | ICAR NOTE: See ACRISS website for MATRIX of codes and references to all GDS | |
</VehicleType> | ||||
<SpecialInformation> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
</SpecialInformation> | ||||
</BasicPreference> | ||||
<MarketPreference> | Allows for different levels of preferences for specified markets. 1st Level - Region or Zone 2nd Level - Countries 3rd Level - Country/State 4th Level - City/Airports Examples: 1) EUROPE/US-PACIFIC 2) US/DE 3) USFL/USCA 4) MIA/FRA 5) blank/EUROPE (blank=home airport) or a mix of the above: 5) US/EUROPE 6) MIA/CARIBBEAN 7) USFL/FRA Possible values: 4th Level - a three-letter airport or city code 3rd Level - Country:State using pattern CC:SS e.g. US:NY 2nd Level - a two-letter country code 1st Level - a region/zone name from this list: NORTH-AMERICA (50) USA (48) CA HI PR VI AK MX GSM CARIBBEAN CENTRAL-AMERICA SOUTH-AMERICA SOUTH-AMERICA -ATLANTIC SOUTH-AMERICA -NORTHRIM EUROPE IBERIAN-PENINSULA SCANDINAVIA MIDDLE-EAST AFRICA WEST-AFRICA SOUTHERN-AFRICA EAST-AFRICA JAPAN-KOREA SOUTHEAST-ASIA SOUTH-ASIAN-SUB SOUTHWEST-PACIFIC US-PACIFIC -TERRITORIES RUSSIA-EAST MICRONESIA | 0..N | ||
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<CarCompanies> | Market specific 2-letter car company code preferences. Ranking is needed for multiple preferences. | 0..1 | ||
<CompanyCode> | Car Company 2-letter code. | 1..N | ZE | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</CompanyCode> | ||||
<LocationID/> | This is a unique Location ID used in this arrival city (only allowed when value of Destination Market is a 3-letter airport- or citycode). | 0..1 | ||
</CarCompanies> | ||||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
<VehicleType> | Preferred vehicle type. Values need to be per car industry standard ACRISS code. | 0..1 | ICAR NOTE: See ACRISS website for MATRIX of codes and references to all GDS | |
</VehicleType> | ||||
<SpecialInformation> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
</SpecialInformation> | ||||
</MarketPreference> | ||||
</CarPref> | ||||
<HotelPref> | Hotel preferences | 0..1 | ||
<BasicPreference> | Basic(default) preferences. These preference only applies if no market specific preference exist. Only different "TripPurpose" attributes can trigger another instance of this BasicPreference node. | 0..N | ||
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<HotelChain> | Hotel chain code(s). | 0..1 | ||
<CompanyCode> | Hotel Chain 2-letter code. | 1..N | HH | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</CompanyCode> | ||||
</HotelChain> | ||||
<HotelCategory/> | Hotel category preference Valid values are: F = First class L = Luxuy class S = Standard class T = Tourist class | [F] [L] [S] [T] | 0..1 | F |
<RoomTypeCode/> | Room type code. The code consists of three parameters: room category, number of beds and bed type. 1st Character value to be assigned from this list of possible values: A-SUPERIOR ROOM B-MODERATE ROOM C-STANDARD ROOM D-MINIMUM ROOM P-EXECUTIVE FLOOR S-MODERATE SUITE T-STANDARD SUITE 2nd Character value (number of beds) to be assigned from this list of possible values: 1 - 9 3rd Character value to be assigned from this list of possible values: D-DOUBLE K-KING P-PULLOUT Q-QUEEN S-SINGLE T-TWIN W-WATER BED EXCEPTIONS: The above format is not supported by the following providers: -Sabre A proprietary format has to be used for them. | 0..1 | A1K | |
<SpecialInformation> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
</SpecialInformation> | ||||
</BasicPreference> | ||||
<MarketPreference> | Allows for different levels of preferences for specified markets. 1st Level - Region or Zone 2nd Level - Countries 3rd Level - Country/State 4th Level - City/Airports Examples: 1) EUROPE/US-PACIFIC 2) US/DE 3) USFL/USCA 4) MIA/FRA 5) blank/EUROPE (blank=home airport) or a mix of the above: 5) US/EUROPE 6) MIA/CARIBBEAN 7) USFL/FRA Possible values: 4th Level - a three-letter airport or city code 3rd Level - Country:State using pattern CC:SS e.g. US:NY 2nd Level - a two-letter country code 1st Level - a region/zone name from this list: NORTH-AMERICA (50) USA (48) CA HI PR VI AK MX GSM CARIBBEAN CENTRAL-AMERICA SOUTH-AMERICA SOUTH-AMERICA -ATLANTIC SOUTH-AMERICA -NORTHRIM EUROPE IBERIAN-PENINSULA SCANDINAVIA MIDDLE-EAST AFRICA WEST-AFRICA SOUTHERN-AFRICA EAST-AFRICA JAPAN-KOREA SOUTHEAST-ASIA SOUTH-ASIAN-SUB SOUTHWEST-PACIFIC US-PACIFIC -TERRITORIES RUSSIA-EAST MICRONESIA | 0..N | ||
@TripPurpose | The trip purpose to which this preference applies. If absent or blank the preference applies to all trips. If used, trip purpose codes are defined in the ProfileInformation/CompanyInfo node. | 0..1 | BIZ | |
<HotelChain> | Market specific 2-letter hotel chain code preferences. Ranking is needed for multiple preferences. | 0..1 | ||
<CompanyCode> | Hotel Chain 2-letter code. | 1..N | HH | |
@Rank | ranks the priority if multiple choices are available. | 0..1 | 1 | |
</CompanyCode> | ||||
<PropertyCode/> | This is a unique property code used in this arrival city (only allowed when value of DestinationMarket is a 3-letter airport- or citycode). | 1 | ||
<AddressSearch/> | if present will be used to identify property by address, e.g. "210 Washington Ave" returns the specific hotelat that location in the identified city in the 'DestinationMarket' element. Note: as the objective is to get a single unique property return, enter the FULL street address as published by the hotel property. | 1 | 42 Doral Blvd | |
<PhoneSearch/> | if present will be used to identify property by phone, e.g. if "4412443240" is present, search will return the property in the identified city code Note: as the objective is to get a single unique property returned, enter the FULL phone number as published by the hotel property. | 1 | ||
</HotelChain> | ||||
<DestinationMarket/> | Destination market to which this preference or fare applies. Examples: 1) US (specific country) 2) NYC (specific city) 3) EUROPE (specific region) 4) US:NY (state in a country) | 1 | ||
<HotelCategory/> | Hotel category preference Valid values are: F = First class L = Luxuy class S = Standard class T = Tourist class | [F] [L] [S] [T] | 0..1 | F |
<RoomTypeCode/> | Room type code. The code consists of three parameters: room category, number of beds and bed type. 1st Character value to be assigned from this list of possible values: A-SUPERIOR ROOM B-MODERATE ROOM C-STANDARD ROOM D-MINIMUM ROOM P-EXECUTIVE FLOOR S-MODERATE SUITE T-STANDARD SUITE 2nd Character value (number of beds) to be assigned from this list of possible values: 1 - 9 3rd Character value to be assigned from this list of possible values: D-DOUBLE K-KING P-PULLOUT Q-QUEEN S-SINGLE T-TWIN W-WATER BED EXCEPTIONS: The above format is not supported by the following providers: -Sabre A proprietary format has to be used for them. | 0..1 | A1K | |
<SpecialInformation> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
</SpecialInformation> | ||||
</MarketPreference> | ||||
</HotelPref> | ||||
</Preferences> | ||||
<TripTemplates> | Itineraries including detailed air, car and hotel preferences A trip template can be generated either via manual Profile maintenance UI or automatically by allowing the user to save an active itinerary from the PNRViewRS. | 0..1 | ||
@DataBaseLink | Reference to a separate database where the trip data is stored (if independent of profile database). This link allows to create the "TripTemplates" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<Itinerary> | Trip information for preferred or past trips | 1..N | ||
@Name | Name of this itinerary (normally given by user when 'saving/storing' this trip itinerary as a template). This name is designed to create a dynamic array in the GUI. | 1 | Monthly board meeting ORD | |
<CityPair> | CityPair element(s) (OriginDestination ID) used in described Itinerary. A regular one-way trip would have one element and a regular round trip would have 2 citypair elements, more elements for multi-city pair itineraries as per ODs. | 0..N | ||
<NumberOfNights/> | Length of trip expressed in number of nights between Departure Date of next CityPair node minus ArrivalDate of preceding CityPair node - see sample. This value is used to pre-populate air return dates, hotel nights and car rental dates. Sample Itinerary (to be saved as a template from active PNRViewRS): 1st CityPair (OD1) is "MIA/ORD" w/2 flights CO 1500 12MAY MIA NYC CO 2243 12MAY NYC ORD 2nd CityPair (OD2) is "ORD/SFO" w/1 flight AA 7654 15MAY ORD SFO 3rd CityPair (OD3) is "SFO/MIA" UA 1234 23MAY SFO MIA Calculation using sample: DepDate of CityPair #2 minus ArrDate of CityPair #1 = 3 Nights in ORD DepDate of CityPair #3 minus ArrDate of CityPair #2 = 8 Nights in SFO | 0..1 | ||
<OriginCode/> | Originating airport code for this CityPair (OD = OriginDestination) | 1 | ||
<DestinationCode/> | Destination airport code for this CityPair (OD = OriginDestination) | 1 | ||
<Flight> | All flights used to construct this CityPair | 1..N | ||
<AirlineCode/> | Airline code. | 1 | AA | |
<FlightNumber> | Flight number - an integer value within the range of [0,9999]. | 1 | 1234 | |
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<ClassOfService/> | Class of service. | 1 | B | |
<DepartureCode/> | Departure airport code for this flight. | 1 | MIA | |
<ArrivalCode/> | Arrival airport code for this flight. | 1 | NYC | |
<ArrivalTime/> | Time in ISO 8601 format (hh:mm). | 1 | 14:30 | |
</Flight> | ||||
<Car> | Car details for this "DestinationCode" | 0..1 | ||
<CarCompany> | Itinerary specific 2-letter car company code | 0..1 | ||
<CompanyCode/> | Car Company 2-letter code. | 1 | ZE | |
<LocationID/> | Use the unique Car Location ID to be used in a long sell. | 0..1 | ||
</CarCompany> | ||||
<VehicleType> | Preferred vehicle type. Values need to be per car industry standard ACRISS code. | 0..1 | ICAR NOTE: See ACRISS website for MATRIX of codes and references to all GDS | |
</VehicleType> | ||||
<SpecialInformation/> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
<CarPickUp/> | Pick up LocationID if different than 'DestinationCode' (=airport pick-up). | 0..1 | ||
<CarDropOff/> | DropOff LocationID if different than 'OriginCode' (=airport pick-up) of NEXT CityPair. | 0..1 | ||
</Car> | ||||
<Hotel> | Hotel details for this "DestinationCode" | 0..1 | ||
<HotelChain> | Itinerary specific hotel property data | 1 | ||
<CompanyCode/> | Hotel Chain 2-letter code. | 1 | HH | |
<PropertyCode/> | This is a unique property code used for this CityPair's DestinationCode. | 1 | ||
<AddressSearch/> | if present will be used to identify property by address, e.g. if "210 Washington Ave" is present, search will return the property for theDestinationCode of this CityPair. | 1 | 42 Doral Blvd | |
<PhoneSearch/> | if present will be used to identify property by phone, e.g. if "4412443240" is present, search will return the property for DestinationCode of this CityPair. | 1 | ||
</HotelChain> | ||||
<RoomTypeCode/> | Store the Room type code as it is associated to the booked itinerary (if trip template is created from existing PNRViewRS) If created manually use the 3-letter code. The code consists of three parameters: room category, number of beds and bed type. 1st Character value to be assigned from this list of possible values: A-SUPERIOR ROOM B-MODERATE ROOM C-STANDARD ROOM D-MINIMUM ROOM P-EXECUTIVE FLOOR S-MODERATE SUITE T-STANDARD SUITE 2nd Character value (number of beds) to be assigned from this list of possible values: 1 - 9 3rd Character value to be assigned from this list of possible values: D-DOUBLE K-KING P-PULLOUT Q-QUEEN S-SINGLE T-TWIN W-WATER BED | 0..1 | A1K | |
<SpecialInformation> | Information to be transmitted via SI-element to Provider at booking time | 0..1 | ||
</SpecialInformation> | ||||
</Hotel> | ||||
</CityPair> | ||||
</Itinerary> | ||||
</TripTemplates> | ||||
<FareSavingTable> | FareSaving remark group. This table will allow to provide all Fare Saving Reason Codes applicable for theis Company profile. Ideally used to provide a dropdown list with these values | 0..1 | ||
@DataBaseLink | Reference to a separate database where the fare saving remarks are stored (if independent of profile database). This link allows to create the "FareSavingTable" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<FareSavingRemark> | Individual Fare Saving Remark | 1..N | ||
<FareSavingCode/> | FareSaving code assigned by agency to this remark | 1 | FD | |
<Text/> | Any remark free-flow text | 1 | Lowest Possible Fare | |
</FareSavingRemark> | ||||
</FareSavingTable> | ||||
<QCRemarks> | Quality Control remark group. This table allows the provision of Quality Control checks unique to the account (corporation). The table is returned via the corporate profile and may be hosted in the profile database itself or may be appended from a supplemental database/table. The execution of the required QC edits is ideally performed between the UI and a rule engine (without dispatching to any source). | 0..1 | ||
@DataBaseLink | Reference to a separate database where the QC Edit Remarks are stored (if independent of profile database). This link allows to create the "QCRemarks" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<QCRemark> | Below are samples of some QC edits: F1 = Check for FOP element F2 = Check for stored fare P1 = Check for Phone number S1 = Check for service fee C1 = Check for CAR element H1 = Check for HOTEL element XX = any code assigned by customer | 1..N | XX | |
<QCCode/> | A 2 letter alphanumeric code identifying the quality control check required for this PNR. | 1 | F1 - corresponds with example in Text node below | |
<Text/> | Any descriptive free-flow text | 1 | Check for FOP element | |
</QCRemark> | ||||
</QCRemarks> | ||||
<DocumentTracking> | To be used to track unused documents (tickets, MCOs, EMDs). Data may be provided by a/ source profile db itself b/ independent tracking db c/ query to participating airlines | 0..1 | ||
@DataBaseLink | Reference to a separate database where the unused tickets/documents are stored (if independent of profile database). This link allows to create the "TicketTracking" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<Document> | 1..N | |||
<ValidatingAirline/> | Airline code. | 1 | AA | |
<DocumentNumber> | The 13-digit Document Number including 3-digit airline code (excluding check digit) | 1 | ||
@DocType | Possible values are: TKT MCO EMD PTA MPD | [TKT] [MCO] [EMD] [PTA] [MPD] | 0..1 | |
@IssueType | Specifies type of document. Possible values are E (electronically issued), P (paper issue). | [E] [P] | 0..1 | E |
@ConjDocumentNumber | LAST 13-digit document number of an conjunctive document set. | 0..1 | 1761233215673 | |
@TktTypeCode | DF = Domestic full DP = Domestic partial IF = International full IP = International partial MCO = Voucher / MCO | [DF] [DP] [IF] [IP] [MCO] | 0..1 | |
</DocumentNumber> | ||||
<DocumentInfo> | Ticket information group | 1 | ||
<CRSID/> | Identifies the issuing source system (CRS identification). | 1 | 1G | |
<IssuingOfficeID/> | Issuing Office PCC (PseudoCityCode). | 0..1 | KLTLOB | |
<IssuingIATA/> | IATA number of issuing office. | 0..1 | 78561234 | |
<IssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<IssueTime/> | Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<IssuePlace/> | Identifies location where document was issued. Normally a 3-letter airport/city code. | 0..1 | ||
<IssueCountry/> | Identifies country where document was issued by a two letter country code. | 0..1 | CA | |
</DocumentInfo> | ||||
<ExpiryDate> | 1 | |||
<Date/> | Date in ISO 8601 format (YYYY-MM-DD). | 1 | 2009-11-30 | |
</ExpiryDate> | ||||
<DocumentValue> | 1 | |||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<OriginalValue/> | This is the Original UNUSED Value of the document. If not partially used this is the Original total document amount; If partially used, this is the residual(unused) value of the document. | 1 | ||
<Deductions> | Withdrawals against the remaining Value of the document | 0..1 | ||
@Total | Sum of all debit nodes | 0..1 | ||
<Debit> | When this document's remaining value is applied to pay for a new transaction, a "Debit" must be entered either manually or by automated process. | 1..N | ||
<Type/> | Valid Values: P = Penalty W = Withdrawal | [P] [W] | 1 | |
<Amount/> | Amount deducted from Remaining Value attribute | 1 | ||
<Date/> | Date of transaction. Date in ISO 8601 format (YYYY-MM-DD). | 1 | 2009-11-30 | |
</Debit> | ||||
</Deductions> | ||||
<RemainingValue/> | Current value available for a withdrawal | 0..1 | ||
</DocumentValue> | ||||
<RecordLocator/> | PNR record locator for the ticket. | 0..1 | ||
</Document> | ||||
</DocumentTracking> | ||||
<ServiceFees> | Service Fees group. This table allows the provision of Service Fees unique to the account (corporation). The table is returned via the corporate profile and may be hosted in the profile database itself or may be appended from a supplemental database/table. This service fee table is ideally used by the UI to populate Dropdown menus and/or to automatically create service fee entries (TASF) via PNRCreateRQ. | 0..1 | ||
@DataBaseLink | Reference to a separate database where the service fees are stored (if independent of profile database). This link allows to create the "ServiceFees" node using a supplemental table/database before appended to ProfileViewRS | 0..1 | ||
<ServiceFee> | Service Fee Table unique to this corporate account (company profile). | 1..N | ||
<ServiceFeeCode/> | Any alphanumeric code if used by the account. | 0..1 | TKT - Ticketing Service Fee EXCH - Exchange Fee | |
<Text/> | Any descriptive free-flow text | 1 | Check for FOP element | |
<FeeAmount> | Service fee break down | 1 | ||
@Total | Total fee amount as specified either per traveler, transaction, reservation. Total price = base amount + taxes amount. | 0..1 | 6500 + 650 = 7150 | |
<BaseAmount> | base amount of the service fee | 1 | ||
@Amount | Base fee amount. | 1 | 6500 | |
</BaseAmount> | ||||
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 300 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 300 | |
<Designator/> | Tax designator. | 0..1 | CA | |
<Description/> | Tax description. | 0..1 | Canadian VAT Tax | |
</Tax> | ||||
</Taxes> | ||||
</FeeAmount> | ||||
<FeeType/> | determines how the identified service fee is to be applied. Possible values are: PAX = per passenger (default) TRX = per transaction RES = per reservation SEG = per segment HTL = per hotel reservation CAR = per car reservation | [PAX] [TRX] [RES] [SEG] [HTL] [CAR] | 1 | |
</ServiceFee> | ||||
<CurrencyCode> | The currency code applicable to the Service Fees. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</ServiceFees> | ||||
<CustomData> | User-Defined custom data structure. NOTE: provides data storage and retrieval only. | 0..1 | ||
</CustomData> | ||||
</ProfileData> | ||||
</ProfileInsertRQ> |
| Column | Description |
|---|---|
| Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server