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 |
|---|---|---|---|---|
<TicketIssueRS> | Ticket Issue Response Root Element | 1 | ||
@Version | Version number. | 0..1 | 1.0 | |
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<TicketImage> | Ticket Coupon | 0..N | ||
@ValidatingCarrier | The 2-character airline code of the carrier validating this Ticket/Document. | 1 | EK, AA | |
@TicketNumber | 1 | |||
@DocType | Possible values are: "TKTT" or "CANX" | [TKTT] [CANX] | 1 | |
@Status | Possible values are: - TICKETED - VOIDED - EXCHANGED - REFUNDED | [TICKETED] [VOIDED] [EXCHANGED] [REFUNDED] | 1 | |
@Conjunctive | Possible values are: "Y" or "N" | [Y] [N] | 0..1 | |
@Next | If this ticket is part of a conjunctive set, use this field to show the ticket number of the "next" coupon in the set. | 0..1 | ||
@Prior | If this ticket is part of a conjunctive set, use this field to show the ticket number of the "previous" coupon in the set. | 0..1 | ||
@Origin | Trip's overall Origin - may not match this ticket's first segment's Departure airport if this is not the first coupon in a Conjunctive set. | 1 | ||
@Destination | Trip's overall Destination - may not match this ticket's last segment's Arrival airport if this is not the last coupon in a Conjunctive set. | 1 | ||
<TktType> | Ticket type code: E-TKT, ATB, ATB2, OPTAT, PAPER. | 1 | ||
@Code | Ticket type code: E-TKT, ATB, ATB2, OPTAT, PAPER. | 1 | ||
@FareIndicator | Identifies state of the ticket. Possible values are: F - First Ticket R - Reissue (Exchange) I - IT Ticket Y - IT Ticket Reissue (Exchange) U - Bulk Ticket W - Bulk Ticket Reissue (Exchange) | [F] [R] [I] [Y] [U] [W] | 0..1 | |
</TktType> | ||||
<TicketIdentification> | Ticket information group | 1 | ||
<RecordLocator/> | Record Identifer | 0..1 | ||
<Ownership> | 0..1 | |||
<CRSID/> | CRS identification. | 0..1 | 1G | |
<Agency/> | Agency that issued the ticket. | 0..1 | ||
<PseudoCityCode/> | Agency PCC. | 1 | AX49 | |
</Ownership> | ||||
<AgencyData> | 1 | |||
<SignOn/> | Agent sign on. | 0..1 | ||
<DutyCode/> | Agent duty code | 0..1 | ||
<IATA/> | Agency IATA number | 0..1 | ||
<AgencyID> | Additional identification such as federal tax IDs or registry entries. Depends on local (country) requirements. See ID and Description. | 0..3 | ||
<Description/> | Free from text description of the agency identification. | 1 | Federal GST Tax ID or TICO ID etc. | |
<ID/> | Unique alphanumeric identifier. | 1 | ||
</AgencyID> | ||||
</AgencyData> | ||||
<TicketOfficeID/> | Ticket office Identification. | 0..1 | KLTLOB | |
<TicketingAgent/> | Booking Agent Identification, Agent ID. | 0..1 | RI17 | |
<TktIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<TktIssueTime/> | Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<TktIssuePlace/> | Identifies location where ticket was issued. Normally a 3-letter airport/city code. This value can/should be used in TicketExchangeRQ for element TicketExchangeRQ/OriginalTicket/OriginalIssuePlace | 0..1 | ||
<TktIssueCountry/> | Identifies country where ticket was issued by a two letter country code. | 0..1 | CA | |
<OtherVendorInformation> | Other vendor information group | 0..1 | ||
<Vendor> | Each Vendor element represents a PNR (booking record) in an external CRS whose content is part of the PNR represented by this PNRViewRS. If for example the PNRViewRS as a whole represents a GDS PNR, Vendor elements could represent PNRs in airline CRS where the individual flight segments where booked. | 1..N | ||
<SegmentNumber/> | Segment number related to this vendor record locator. | 1..N | 3 | |
<VendorCode/> | Vendor code. | 1 | AA | |
<VendorTicketNumber/> | Vendor ticket number. | 1 | 5432198765432 | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd. | 0..1 | 2008-12-12 | |
<Time/> | Time in ISO 8601 hh:mm format. | 0..1 | 14:00 | |
<TicketIdentification/> | Please see PNRIdentification documentation for further details. This recursive occurance of PNRIdentification is for multi-source usage of PNRViewRS only. | 0..1 | ||
</Vendor> | ||||
</OtherVendorInformation> | ||||
</TicketIdentification> | ||||
<VoidByDate/> | Date and time by which this ticket can be voided according to point of sale and ARC or BSP rules as applicable. Once passed, ticket can no longer be voided. | 0..1 | 2013-01-13T13:20:00 | |
<FCICode/> | 0: System auto priced Cash or check 1: Agent priced Cash or Check 2: System auto priced Credit card with manual approval code 3: Agent priced Credit card with manual approval code 4: No fare option Cash or check Same as agent priced 5: No fare option Credit card Same as agent priced 6: System auto priced Credit card with approval through the system (ECCP) 7: Agent priced Credit card with approval throughthe system (ECCP) 8: Agent priced Cash, check or credit card with manual approval 9: Auto Pricing | [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] | 0..1 | |
<Traveler> | Traveler details group | 1 | ||
@Type | Passenger type. Values are: ADT = Adult, INS = Infant occupying seat, CHD = Child, YTH = Youth, MIL = Military, GOV = Government, SRC = Senior Citizen, STD = Student ( | 1 | ADT) | |
<ElementNumber> | 1 | |||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
<TravelerName> | 1 | |||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<NativeGivenName/> | This field contains the given (first) name as it is returned from the GDS (free form text which contains given name, initial and title). In addition the given name as it comes from the GDS is parsed according to the GDS convention and the content is returned in sibling elments GivenName, Initial and Title. NOTE: client applications which implement their own parsing algorithm should use the content of this field! EXAMPLE: JOHN A MR | 1 | ||
<Initial/> | Traveler middle initial (only one letter). | 0..1 | G | |
<Title/> | Traveler title. | 0..1 | MISS, MRS, THEREVCON | |
<DateOfBirth/> | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<Age/> | Traveler age. | 0..1 | 01 | |
<NameRemark/> | Free text name remark. | 0..1 | A123456 | |
</TravelerName> | ||||
<Infant> | 0..1 | |||
<ElementNumber> | 1 | |||
@TattooNumber | Tattoo number. | 0..1 | 2 | |
@TattooQualifier | Tattoo qualifier. | 0..1 | ST | |
</ElementNumber> | ||||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
<AgeInMonths/> | 1 | |||
<DateOfBirth/> | Traveler birth date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
</Infant> | ||||
</Traveler> | ||||
<FrequentTravelerGroup> | One or more frequent traveler numbers. | 0..N | ||
<FFCompanyCode/> | IATA airline code of the frequent flyer program. | 1 | AA | |
<FFNumber/> | Frequent flyer ID. Alphanumeric. | 1 | ||
<FFFlyingCompany/> | 0..1 | |||
</FrequentTravelerGroup> | ||||
<Itinerary> | 1 | |||
@Source | 0..1 | |||
@SourceRef | 0..1 | |||
<TicketCoupon> | 1 | |||
@CouponNumber | Flight coupon number | 1 | ||
@SegmentStatus | Air segment status on ticket. Possible values are: OK -space confirmed RQ - space requested but not confirmed, or space waitlisted SA - subject to space being available, whenever fare or rule prohibits making advanced reservations NS - infant not occupying a seat (additionally "INF NO SEAT", "INFANT" or "NO SEAT" may be entered across the other reservations boxes/datal elements) | 0..1 | ||
@CouponStatus | The IATA coupon status code. Possible values: A .. AIRPORT CONTROL C .. CHECKED IN E .. EXCHANGED / REISSUED F .. FLOWN/USED G .. CONVERTED TO FIM I .. IRREGULAR OPERATIONS L .. LIFTED/BOARDED N .. COUPON NOTIFICATION O .. OPEN FOR USE P .. PRINTED R .. REFUNDED S .. SUSPENDED T .. PAPER TICKET U .. UNAVAILABLE V .. VOID X .. PRINT EXCHANGE Z .. CLOSED UNK .. UNKNOWN (this means coupon status could not be determined from airline for various reasons. This should be rechecked manually with airline.) | [A] [C] [E] [F] [G] [I] [L] [N] [O] [P] [R] [S] [T] [U] [V] [X] [Z] [UNK] | 0..1 | |
@NotValidBefore | If the fare does not permit travel to be commenced or completed before a certain date. | 0..1 | ||
@NotValidAfter | Date by which travel must be commenced/completed. | 0..1 | ||
@FareBasisCode | Fare basis code. | 0..1 | Y26 | |
@TicketDesignator | Ticket designator for the fare | 0..1 | ||
@BaggageAllowance | Baggage allowance. PC = per piece 1PC = 1 piece 2PC = 2 pieces nn = per weight (nn is the weight limit). | 0..1 | 2PC | |
@StopOverIndicator | Indicates if stopover is permitted w/ the fare. Uses industry values to refelct the status. Values are X, O When X is the value - the departure city of the segment was considered a transfer point at time of fare calculation. If the passenger to stop in that city, the fare must be recalculated; the fara may or may not permit stopovers. Code O is used to denote that stopover is permitted. | [X] [O] | 0..1 | |
<ARNK/> | Arrival unknown segment. If a TicketCoupon refers to an arrival unknown segment, an empty ARNK child element will be returned. | 1 | ||
<Flight> | 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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@MarriedSegment | Indicator to mark a group of married segments. The first Flight in a group of married segments is marked with value "B" (begin), the last Flight with value "E" (end). These two and all Flight elements in between in document order form a group of married segments. | [B] [E] | 0..1 | B |
@VendorLocator | Record locator in the carrier system. Is different from SourceRef since SourceRef could reflect a GDS PNR record locator in multy source environment, whereas this element is the record locator as created in airlines system. | 0..1 | ||
@CnxxIndicator | If attribute CnxxIndicator is returned and value is "Y", the arrival point of this flight segment is a connecting point to the next flight segment, not a stop over point. If the value is "N", the arrival point of this segment is a stop over (or final destination) point. If attribute is not returned this information is not available. Values: Y = Yes N = No | [N] [Y] | 0..1 | Y |
<Departure> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd | 1 | 2008-12-12 | |
<Time/> | Time in ISO 8601 hh:mm format. | 0..1 | 14:00 | |
<Terminal/> | Airport terminal. | 0..1 | 2B | |
</Departure> | ||||
<Arrival> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd. | 0..1 | 2008-12-12 | |
<ChangeOfDay/> | Number of days between departure and arrival. If not present - no change of day - same day as departure. | 0..1 | 1 | |
<Time/> | Time in ISO 8601 hh:mm format. | 0..1 | 14:00 | |
<Terminal/> | Airport terminal. | 0..1 | 2B | |
</Arrival> | ||||
<Carrier> | 1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
</Carrier> | ||||
<OperatingCarrier> | 0..1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<Comment/> | Free form text additional flight information. | 1 | ||
</OperatingCarrier> | ||||
<CheckIn> | Check In information. Usually associated with code share flights where operating carrier is different from marketing carrier. The this group displays information where passengers should check-in. | 0..1 | ||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
</CheckIn> | ||||
<Equipment> | 0..1 | |||
<Code/> | Aircraft equipment code. | 1 | 772 | |
<Name/> | Equipment (aircraft) name - vendor, model. | 1 | ||
</Equipment> | ||||
<NumberOfStops/> | Number of stops for this flight. | 0..1 | 1 | |
<Meals/> | Indicates what types of meals are served. Meal codes are IATA standard. Values are: B = Breakfast K = Continental breakfast V = Refreshment for purchase L = Lunch D = Dinner S = Snack or brunch O = Cold meal H = Hot meal M = Meal (non-specific) R = Refreshment complimentary C = Alcoholic beverages complimentary F = Food for purchase P = Alcoholic beverages for purchase Y = Duty free sales available G = Food and/or Beverage for purchase N = No meal service | [B] [K] [V] [L] [D] [S] [O] [H] [M] [R] [C] [F] [P] [Y] [G] [N] | 0..N | B |
<ClassOfService/> | Class of service. | 1 | B | |
<Cabin/> | Cabin code. 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 | Y |
<Information> | Free form additional information for the flight - if any available. | 0..1 | ||
<Text/> | Information text or error text. | 1 | Free flow text. Example: Invalid flight number | |
</Information> | ||||
<SeatLocation/> | Seat assignment location. | 0..1 | 03A | |
</Flight> | ||||
<Open> | 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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<OpenDeparture> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd | 0..1 | 2008-12-12 | |
</OpenDeparture> | ||||
<OpenArrival> | 1 | |||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
<AirportName/> | Name of the airport identified in AirportCode element. | 1 | MIAMI INTERNATIONAL | |
<Date/> | Date of departure. ISO format: yyyy-mm-dd. | 0..1 | 2008-12-12 | |
</OpenArrival> | ||||
<Carrier> | 1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
</Carrier> | ||||
<OperatingCarrier> | 0..1 | |||
<AirlineCode/> | IATA Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 0..1 | American Airlines | |
<FlightNumber> | 0..1 | |||
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
<Comment/> | Free form text additional flight information. | 1 | ||
</OperatingCarrier> | ||||
<ClassOfService/> | Class of service. | 1 | B | |
</Open> | ||||
</TicketCoupon> | ||||
</Itinerary> | ||||
<FareGroup> | Represents ticketed fare. Includes Base fare, taxes, fare calculation line etc. | 1 | ||
<CurrencyCode> | Currency in which ticket was issued. Governs all amounts in below sections unless specified otherwise. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 0..1 | 2 | |
</CurrencyCode> | ||||
<TravelerGroup> | Container for passenger price data. Includes base fare, taxes. | 1 | ||
@TypeRequested | Passenger type being requested for pricing. If the passenger type sent by the GDS is not in the below predefined list, then it is shown as is. Predefined values are: ADT= Adult INF = Infant CHD = Child YTH = Youth MIL = Military GOV = Government SRC = Senior citizen STD = Student XXX = Undefined | 0..1 | CHD | |
@TypePriced | Passenger type being priced. This type can be different from the type requested if there is no available fare for the requested type. For example the requested type is GOV and the priced type is ADT because there is no available fare for type GOV and there is an available fare for type ADT. If the passenger type sent by the GDS is not the below predefined list, then it is shown as is. Predefined values are: ADT= Adult CHD = Child INF = Infant YTH = Youth MIL = Military GOV = Government SRC = Senior citizen STD = Student | 0..1 | ADT | |
<Price> | 1 | |||
@Total | Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 0..1 | 230000 | |
@ExchangeIndicator | Indicator to represent if additional collection is done. Enumeration Values are: "NO ADC", "A". If Value ="NO ADC" then "NO ADC" is shown instead of the total amount on the ticket coupon. If Value ="A" then "A" is appended to the total amount shown on the ticket coupon representing an Add collect. | [NO ADC] [A] | 0..1 | |
@TourFare | According to IATA rules for "Special Fares", Total and BaseFare amounts are usually not returned for tour fares, unless the applicable fare rules require the fare to be shown. If a tour fare applies, the type of the tour fare will be shown here. Value are: IT .. Inclusive Tour BT .. Bulk Inclusive Tour | [IT] [BT] | 0..1 | BT |
<BaseFare> | 0..1 | |||
@Amount | Total base fare amount that includes surcharges (if any). For tickets resulting from an exchange and having different base and equivalent currency, the equivalent currency will not be returned on BSP markets as per IATA resolution 720a. In these cases, the Amount attribute will be missing and only the basefare amount in the currency in which the fare was filed will be returned in the FiledIn node. | 0..1 | 200000 | |
<FiledIn> | This group represents fares filed in a currency different from the currency of a point of sale. The content elements represent the original currency and amount as filed. | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Amount/> | Base Fare Amount as originally filed. | 1 | ||
</FiledIn> | ||||
<Surcharges> | Sourcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 1..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<NetRemit> | Net Remit group | 0..1 | ||
@NRIndicator | Identifies Fare as a Net Remit transaction. Identifier is carried through for BSP reporting; Values are "Y", "N" | [Y] [N] | 1 | "Y" |
<APBC/> | This IATA term stands for 'Amount Paid By Customer' and is needed for Net Remit methods 2A, 2E (Currency and decimals taken from FareGroup) | 0..1 | 57500 | |
<AEBA/> | This IATA term stands for 'Amount Entered By Agent' and is needed for Net Remit methods 2A, 2E (Currency and decimals taken from FareGroup) | 0..1 | 40000 | |
</NetRemit> | ||||
<Taxes> | 0..1 | |||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
@Paid | Indicator to represent that given tax is already paid. Will be used only in the new Ticket issued as part of exchange process is the BSP markets. Values: "PD", "RF" (.. if refunded). | [PD] [RF] | 0..1 | |
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<CommissionGroup> | 0..1 | |||
@Amount | Total commission amount for the base fare as identified in BaseFare/@Amount. Represents calculated sum of the Commission elements below. | 0..1 | 200000 | |
<Commission> | Commission flat amount or per-cent stored wirth this fare. See Type attribute of this element. | 1..N | ||
@Type | Commission type. Values are: P = Percent, A = Amount | [P] [A] | 1 | A |
@RuleCode | System defined commission processing code. Can be retrieved in RevenueStructureRS | 0..1 | XYZ. | |
</Commission> | ||||
</CommissionGroup> | ||||
<FareRules> | Fare rules information group. | 1 | ||
<FareInfo> | A FareInfo element contains data related to a fare component used during pricing. Since a fare may consist of more than one fare component, a FareGroup may have more than one FareInfo element. This data can be used for FareRulesRQ as a follow up request. | 1..N | ||
<DepartureDate/> | Segment departure date in ISO 8601 format (yyyy-mm-dd). | 1 | 2002-12-25 | |
<DepartureCode/> | Departure airport or city code. | 1 | MIA | |
<ArrivalCode/> | Arrival airport or city code. | 1 | NYC | |
<RelatedSegment> | A FareInfo element refers to one or more TicketCoupon/Flight elements. It has one RelatedSegment element for each Flight element it refers to. | 1..N | ||
<SegmentIDRef/> | The value of the SegmentIDRef element is the ElementNumber of the corresponding AirGroup/Flight element. | 1 | ||
<Cabin/> | Cabin code. 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 | Y |
<ClassOfService/> | Class of service. | 0..1 | B | |
<BaggageAllowance> | Free Baggage allowance. nnPC = per piece 1PC = 1 piece 2PC = 2 pieces nnX = per weight (nn is the weight limit, units X can be K (kg) or L (lb) ). | 0..1 | 2PC 20K 40L Sabre only: In case only number of pieces are restriced, will show nnPC. @MaxPieces will be returned additionally. In case only total weight is restriced, will show nnX. @MaxWeightTotal and @WieghtUnit will be returned additionally. In case piece and weight restrictions apply, will show nnPC. @MaxPieces will be returned additionally. Weight restriction details will only be returned in @MaxWeightPerPiece, @MaxWeightTotal (which ever applies) and @WieghtUnit. | |
@MaxPieces | If number of pieces are restricted, maximum allowed number of pieces is returned. | 0..1 | 2 | |
@MaxWeightPerPiece | If a weight restriction applies in a per piece basis, the maximum allowed weight per pieces is returned. | 0..1 | 32 | |
@MaxWeightTotal | If a restriction to the total weight of all pieces applies, the maxmum allowed total weight is returned here. | 0..1 | 64 | |
@WeightUnit | Unit of weight. Values: K - Kilogramm L - Pounds (lb) | [K] [L] | 0..1 | K |
</BaggageAllowance> | ||||
<NVB/> | Identifies "not valid befoe" date for a fare. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<NVA/> | Identifies "not valid after" date for a fare.Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<StopOverIndicator/> | Indicates if stopover is permitted w/ the fare. Uses industry values to reflect the status. Values are X, O When X is the value - the departure city of the segment was considered a transfer point at time of fare calculation. If the passenger wants to stop in that city, the fare must be recalculated; the fare may or may not permit stopovers. | [X] [O] | 0..1 | |
<BaggagePolicy> | Baggage Policy according to US DOT Baggage Mandate | 0..N | ||
@Amount | Amount charged per bag | 0..1 | ||
@BaggageItem | Specifies whether this policy applies: 1..9 : to the 1st, 2nd, Nth bag BF : to free baggage allowance C : to carry-on baggage (C) CF : to free carry-on-baggage allowance E : to Embargoes | 0..1 | ||
<TravelerIDRef/> | This value can be the a) TravelerElementNumber of the booked PNR, | 0..N | 1 (b) or the traveler's ID reference assigned by and passed in with the request. It is necessary to be able to refer to specific travelers even of the same type on the same segment, because the baggage policy can depend on the frequent flyer status of a traveler. Example: T1 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<Url> | URL where additional information regarding the baggage policiy can be found. | 0..N | ||
@Text | Description text. | 0..1 | ||
</Url> | ||||
</BaggagePolicy> | ||||
</RelatedSegment> | ||||
<FareBasisCode/> | Fare basis code. | 1 | Y26 | |
<TicketDesignator/> | Ticket designator code. | 0..1 | ATM1 | |
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<AirlineCode/> | Airline code. | 1 | AA | |
<Penalty> | Penalty group | 0..1 | ||
@TicketRefundable | Indicates if ticket is refundable or not. A ticket is regarded as refundable if it is at least refundable at a certain point in time with or without a charge. That is, a ticket which is refundable at a charge prior to departure and not refundable after departure would be regarded as refundable. More detailed information may be returned in the FeeApplies and Cancel elements when available. Values are: Y = Ticket is refundable N = Ticket is not refundable. | [Y] [N] | 0..1 | Y |
@DepositRequired | Indicates if deposit is required or not. Values are: Y = Deposit is required N = Deposit is not required. | [Y] [N] | 0..1 | Y |
@DepositRefundable | Indicates if deposit is refundable or not. Values are: Y = Deposit is refundable N = Deposit is not refundable. | [Y] [N] | 0..1 | Y |
@TicketChangeable | Indicates if ticket is changeable or not. A ticket is regarded as changeable if it is at least changeable at a certain point in time with or without a charge. That is, a ticket which is changeable at a charge prior to departure and not changeable after departure would be regarded as changeable. More detailed information may be returned in the FeeApplies and Change elements when available. Values are: Y = Ticket is changeable N = Ticket is not changeable | [Y] [N] | 0..1 | Y |
<TicketText/> | Text related to the ticket penalty. Possible values: AD = ticket is not refundable after departure BD = ticket is not refundable before departure | [AD] [BD] | 0..1 | AD |
<FeeApplies> | Fee applies group | 0..1 | ||
@FailureToConfirm | Y = Pax must confirm space N = No confirmation required | [Y] [N] | 0..1 | Y |
@Cancellation | Y = Cancellation Fee Applies N = No Cancel Fee | [Y] [N] | 0..1 | Y |
@Carrier | Y = Carrier Fee applies N = No carrier fees | [Y] [N] | 0..1 | Y |
@ReplaceTicket | Y = Replacement fee applies N = No replacement fee | [Y] [N] | 0..1 | Y |
@ChangeItinerary | Y= Change Itinerary fee applies N = No change fee | [Y] [N] | 0..1 | Y |
</FeeApplies> | ||||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Change> | Change penalty group | 0..N | ||
@Type | Determines whether penalty applies to reissues or revalidation RI = Reissue RV= Revalidation If attribute is not present, no information to which type of change the penalty applies is available. | 0..1 | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for changes. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..N | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for cancellation. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
<Failure> | Failure to confirm penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Failure> | ||||
<Replace> | Replacement penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Replace> | ||||
</Penalty> | ||||
<Restrictions> | Restrictions group showing if or not respective restrictions apply. | 0..1 | ||
@AdvancePurchase | Indicates whether AdvancePurchase restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@AdvanceReservation | Indicates whether AdvanceTicketing restrictions apply for AdvanceReservation. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@AdvanceDeparture | Indicates whether AdvanceTicketing restrictions apply for AdvanceDeparture. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@MinimumStay | Indicates whether MinimumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@MaximumStay | Indicates whether MaximumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
</Restrictions> | ||||
<AdvancePurchase> | Advance purchase restrictions. The type is defined by the Advance Unit attribute. If for example this number is 3 and the unit is D, the advance purchase restriction is 3 days. | 0..2 | 3 | |
@Unit | Advance purchase restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvancePurchase> | ||||
<AdvanceTicketing> | Advance ticketing group | 0..1 | ||
<AdvanceReservation> | Advance ticketing reservation restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 24 and the unit is H and the permitted is latest (value L), that means that ticketing must be at the latest 24 hours after purchase. If permitted was on time (value O), the ticketing must be 24 hours after purchase. | 0..2 | 24 | |
@Unit | Advance ticketing reservation restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase ticketing restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceReservation> | ||||
<AdvanceDeparture> | Advance ticketing departure restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 14 and the unit is D and the permitted is latest (value L), that means that ticketing must be at the latest 14 days before the departure. If permitted was on time (value O), the ticketing must be 14 days before departure. | 0..2 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance ticketing departure restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceDeparture> | ||||
</AdvanceTicketing> | ||||
<MinimumStay> | Minimum stay rules group | 0..1 | ||
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MinimumStay> | ||||
<MaximumStay> | Maximum stay rules group | 0..1 | ||
@Application | Maximum Stay applicability. Possible values are: CP = Travel must be Completed before CC = Travel must Commence before | [CP] [CC] | 0..1 | CP |
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MaximumStay> | ||||
</FareInfo> | ||||
<TourCode/> | Tour code identifier. | 0..1 | ITGF12 (Galileo / Apollo) | |
<Endorsement> | Endorsements on ticket. | 0..N | NONREF | |
<Text/> | Information text or error text. | 1 | Free flow text. Example: Invalid flight number | |
</Endorsement> | ||||
<FareCalculation/> | Fare calculation line. | 0..1 | MIA AA NYC Q4.65 82.79SA7HPTN 87.44 END ZPMIA XFMIA4.5 | |
</FareRules> | ||||
<FeeGroup> | Fees claimed for all services charged with this Ticket. | 0..1 | ||
@Amount | Total fee amount for the Fare | 1 | 200000 | |
<Fee> | 1..N | |||
@ServiceCode | Additional unique ATPCO code. Please refer to FLX Codeset document for acceptable values. | 0..1 | OC | |
@SubCode | ATPCO RFISC (ReasonForIssuance Subcode). Example of RFISC: 0CC | 0..1 | ||
@Refundable | Indicates if fee is refundable. Values are: Y = Fee refundable N = Fee not refundable. If attribute is not there then default is Y. | 0..1 | ||
<Amount/> | Fee amount. | 1 | 2000 | |
<Description/> | Title description (Commercial Name) of Fee. | 0..1 | "Credit Card Fee" | |
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
</Fee> | ||||
</FeeGroup> | ||||
</TravelerGroup> | ||||
</FareGroup> | ||||
<BillingAndDeliveryData> | 0..1 | |||
<FormOfPayment> | 1..N | |||
<CreditCard> | 0..N | |||
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 0..1 | 200000 | |
<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> | ||||
<ExtendedPayment> | Credit card extended payment. Values are: Y = Add extended payment N = Do not add extended payment | 0..1 | N | |
@NumberOfMonths | If and only if the value of the ExtendedPayment is set to Y. Identifies the period of extended payment in months. Usually credit card systems (or the travel agency) allows a payment to be extended over a certain number of months. The actual timeframe will vary depending on the credit card system. | 0..1 | 5 | |
@Code | Code necessary for a special form of payment (if ExtendedPayment=Y). For Amadeus: A credit card is used for an initial amount and uniform subsequent monthly installment amounts. The total of the installment amounts is expected in the PartialAmount attribute of the Other element, which has content INSTALLMENT in this case. The currency given in the same FormOfPayment element is used. | 0..1 | CM5 | |
</ExtendedPayment> | ||||
<CardholderFirstName/> | Credit card holder's first name. | 0..1 | JOHN | |
<CardholderLastName/> | Credit card holder's last name. This is only required for Sabre. | 0..1 | SMITH | |
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
</CreditCard> | ||||
<Other> | Other payment information. | 0..N | "CHECK", "CASH" | |
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 0..1 | 200000 | |
</Other> | ||||
</FormOfPayment> | ||||
<AddressGroup> | 0..N | |||
<OptionalName/> | Addressee's name. | 0..1 | PASS Consulting | |
<Address/> | Street or PO Box address. | 0..N | 5301 BLUE LAGOON | |
<City/> | City. | 0..1 | MIAMI | |
<PostalCode/> | Postal or ZIP code. | 0..1 | 33139 | |
<StateCode/> | State or province code. Mainly US. | 0..1 | FL | |
<Country/> | ISO 2-letter country code. | 0..1 | US | |
<AddressText/> | Free flow address text information. | 1..N | 5301 BLUE LAGOON DR, MIAMI, FL, US | |
</AddressGroup> | ||||
</BillingAndDeliveryData> | ||||
<CountryList> | 0..1 | |||
<Country/> | ISO 2-letter country code. | 1..N | US | |
</CountryList> | ||||
<Distributor/> | Name of entity that distributed this fare. Can be ATPCO, SITA, IATA, consolidator or airline. | [ATPCO] [SITA] [IATA] [CONSOLIDATOR] [AIRLINE] | 0..1 | |
<Feature> | Special feature (Upsell, prepaid meal etc.) | 0..N | ||
<Code/> | Feature code | 1 | ||
<CustomPrice> | Pricing Element | 0..N | ||
<Type/> | Fare, Markup, Surcharge, Add-On, Tax, Commision, Equivalent fare, total base fare | 1 | ||
<PaxType/> | Passenger Type Code ADT, CHD or INF. Applies to any type if omitted. | 0..1 | ||
<Amount/> | 1 | |||
<Remark/> | 1 | |||
</CustomPrice> | ||||
<SSR/> | Contains required SSR message to be sent at ticketing time. | 0..N | ||
<OSI/> | Contains required OSI message to be sent at ticketing time. If being sent to GDS, some GDS have length per line limitations | 0..N | ||
</Feature> | ||||
<ESAC/> | 0..1 | |||
<RefundAuthNumber/> | Refund Authorization Number. Alphanumeric. | 0..1 | XYZ999 | |
<WaiverCode/> | Refund Waiver Code. Mandatory in some BSP countries such as Japan. | 0..1 | XYZ123 | |
<OriginalTicket> | Data of the original (first) ticket. Will only be presents if ticket was exchanged (meaning displayed ticket as defined in this schema is result of an exchange). | 1 | ||
<Ticket> | Data of the ticket has been exchanged. In case of a conjunctive ticket, all ticket numbers must be supplied with all coupon numbers that has been exchanged before. | 1..4 | ||
@Number | The 13 digt ticket number of the ticket to be refunded. | 1 | 0012345467891 | |
<CouponNumber/> | The number of the coupon that has been exchanged. | 1..4 | 1 | |
</Ticket> | ||||
<TktIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<IATA/> | The IATA number of the agency originally issuing the ticket. | 0..1 | ||
<OriginalIssuePlace/> | Three letter IATA code of the town where the ticket originally has been issued. | 0..1 | MIA | |
<FormOfPayment> | 0..1 | |||
<CreditCard> | 0..N | |||
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 0..1 | 200000 | |
<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> | ||||
<ExtendedPayment> | Credit card extended payment. Values are: Y = Add extended payment N = Do not add extended payment | 0..1 | N | |
@NumberOfMonths | If and only if the value of the ExtendedPayment is set to Y. Identifies the period of extended payment in months. Usually credit card systems (or the travel agency) allows a payment to be extended over a certain number of months. The actual timeframe will vary depending on the credit card system. | 0..1 | 5 | |
@Code | Code necessary for a special form of payment (if ExtendedPayment=Y). For Amadeus: A credit card is used for an initial amount and uniform subsequent monthly installment amounts. The total of the installment amounts is expected in the PartialAmount attribute of the Other element, which has content INSTALLMENT in this case. The currency given in the same FormOfPayment element is used. | 0..1 | CM5 | |
</ExtendedPayment> | ||||
<CardholderFirstName/> | Credit card holder's first name. | 0..1 | JOHN | |
<CardholderLastName/> | Credit card holder's last name. This is only required for Sabre. | 0..1 | SMITH | |
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
</CreditCard> | ||||
<Other> | Other payment information. | 0..N | "CHECK", "CASH" | |
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual amount charged to credit card. | 0..1 | 200000 | |
</Other> | ||||
</FormOfPayment> | ||||
</OriginalTicket> | ||||
<InExchangeFor> | Represents tickets from the last exchange. | 1 | ||
<TicketNumber/> | The 13 digt ticket number of the ticket. | 1..4 | 0012345467891 | |
</InExchangeFor> | ||||
<Telephone> | Telephone group | 0..N | ||
@Type | Phone type. Values are: A = AGENCY B = BUSINESS C = CELLULAR F = FAX H = HOME M = MOBILE O = OTHER | [A] [B] [C] [F] [H] [M] [O] | 0..1 | H |
<TelephoneNumber/> | Telephone number. | 1 | 305-269-6975 | |
</Telephone> | ||||
<CustomerIdentification> | Customer identification group | 0..1 | ||
<Text/> | Information text or error text. | 1 | Free flow text. Example: Invalid flight number | |
</CustomerIdentification> | ||||
<Invoice> | Invoice information group | 0..1 | ||
<InvoiceNumber/> | Invoice Number | 1 | XYZ999 | |
</Invoice> | ||||
<RefundData> | Data specific to the monetary refund | 0..1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<FeesAndPenalties> | Total fees and penalties | 0..1 | ||
@Amount | Total fees and penalties amount. | 1 | 30000 | |
<Tax> | Tax break down information group. Non-refundable taxes (treated as a penalty). Tax break-down needed for some settlement authorities such as BSP | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
<CancellationCommission> | The amount of commission taken on the cancellation penalty. | 0..1 | 100 | |
@Type | The type of commission: Percentage (P) or Amount (A). | [A] [P] | 1 | A |
</CancellationCommission> | ||||
<CancellationPenalty> | The amount that is to be paid as cancellation penalty. | 0..1 | 100 | |
</CancellationPenalty> | ||||
<FormOfPayment> | The form of payment used to settle the charges of this EMD. This only applies to CancellationPenalty | 0..1 | ||
<CreditCard> | Credit card group | 1 | ||
<CCCode/> | Credit card code. | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 | |
<CCExpiration> | Credit card expiration group | 1 | ||
<Month/> | Credit card expiration month. | [1] to [12] | 1 | 02 |
<Year/> | Last two digits of the credit card expiration year. | [00] to [99] | 1 | 06 |
</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. | 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 | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 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 | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 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 | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 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 | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 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 | 0..1 | ||
@Mandatory | O - optional (default) M - mandatory | 0..1 | ||
@DataElementID | Vendor code assigned to this reporting element | 1 | PN | |
@DataElementName | Vendor element name assigned to this reporting element | 1 | Project Number | |
@SystemProcess | Allowed value: Y If set this identifies that this data content for this element is system generated (not provide by user input or profiles) | 0..1 | ||
</GenericElement> | ||||
</ReportingData> | ||||
<Authorization> | Credit card authorization. Values are: Y = Obtain credit card authorization and approval code S = Obtain credit card authorization and approval code and store approval code in the PNR N = Do not obtain credit card authorization | 0..1 | N | |
@Amount | Amount approved for this credit card. | 0..1 | 1200 | |
@AirlineCode | Airline Code. | 0..1 | AA | |
</Authorization> | ||||
<CardholderFirstName/> | FirstName on card. | 0..1 | ||
<CardholderLastName/> | Name on card. | 1 | ||
<CardholderFullName/> | Credit cardholder full name as it appears on the card | 1 | ||
<ApprovalCode/> | Credit card approval code. | 0..1 | 996456 | |
<CCAddressGroup> | 0..1 | |||
<Address/> | Street or PO Box address. | 1..2 | 1234 Main Street | |
<City/> | City. | 1 | NY | |
<PostalCode/> | Postal or ZIP code. | 1 | 33139 | |
<StateCode/> | State or province code. Mainly US. | 0..1 | NY | |
<CountryCode/> | Country where sale takes place or Ticket issuing country. | 1 | US | |
<StreetNumber/> | Street number (if not included in Address lines.) | 0..1 | 100 | |
</CCAddressGroup> | ||||
</CreditCard> | ||||
<Other/> | Other payment type. Possible values: CASH, CHECK. | [CASH] [CHECK] [] | 1 | |
</FormOfPayment> | ||||
<CommFee/> | non-refundable commission fee amount charged (if any). | 0..1 | 1000 | |
</FeesAndPenalties> | ||||
<TotalRefund> | The total refund amount | 0..1 | ||
@Amount | Amount EXCLUDING any fees and penalties. | 1 | ||
@Refund | Amount INCLUDING any fees and penalties. This is the exact amount returned as a refund. | 0..1 | ||
<BaseFare> | 1 | |||
@Amount | Refunded base fare amount that includes surcharges (if any). | 1 | 200000 | |
</BaseFare> | ||||
<Taxes> | Tax break down information group | 1 | ||
@Amount | Total refunded taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group for refunded taxes | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
</Tax> | ||||
</Taxes> | ||||
</TotalRefund> | ||||
<TotalCredit> | The total credit amount (but excluding any fees and penalties) | 0..1 | ||
@Amount | [Credit] Amount EXCLUDING any fees and penalties. | 1 | ||
@Refund | Amount INCLUDING any fees and penalties. This is the exact amount issued as a credit (MCO/EMD, etc) | 1 | ||
</TotalCredit> | ||||
<RefundDate/> | Date the refund was processed. The format is (YYYY-MM-DD) and represents the date at POS. | 1 | ||
</RefundData> | ||||
<CustomData> | Custom Data element. | 0..N | ||
@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. | |
</CustomData> | ||||
</TicketImage> | ||||
</TicketIssueRS> |
| 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