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 |
|---|---|---|---|---|
<FareSearchRS> | Fare search response root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@QueryID | Optional, alphanumeric. Used only for internal tracking purposes. | 0..1 | ||
<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> | ||||
<FareGroup> | Fare group containing all information regarding the air fares. It includes the type of fare, the passenger type and number in party as well as tax information and restrictions, if any. | 0..N | ||
@FareType | Type of fare being returned. Values are: PUBL = published fare NEGO = negotiated/private fare BOTH = mix of fare types UNDF = undefined, the type of fare is unknown | [PUBL] [NEGO] [BOTH] [UNDF] | 1 | NEGO |
@TravelerCount | Total number of passengers of all types for the entire itinerary. | [0] to [18] | 1 | 4 |
@TotalPrice | Total price for the entire itinerary for all passengers of all types. It is the sum of all TypeTotalPrice. | 1 | 320000 | |
@TotalJourneyPrice | Total price for the entire itinerary for all passengers of all types. It is the sum of all TypeTotalPrice plus any selected services (e.g. optional payment charges if a specific FormOfPayment was selected in request). | 0..1 | 380000 | |
@TotalLowestPrice | Total price of entire itinerary for all passengers of all types. It is the sum of all 'TypeTotalLowest' elements. | 0..1 | 300000 | |
@TotalHighestPrice | Total highest price for all passengers of all types(TravelerGroups). It is the sum of all 'TravelerGroup/TypeTotalHighest' elements. | 0..1 | 300000 | |
@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. | |
@CustomRouting | Indicates whether FareGroup stems from a CustomRouting defined in FareSearchRQ. Values are: Y = Yes N = No Default: N | [Y] [N] | 0..1 | |
<Remark/> | Remark contains miscellaneous warnings as free text. | 0..N | SPLIT PNR | |
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<TravelerGroup> | Traveler group. Includes pricing information for all passengers of the same type. | 1..N | ||
@TypeRequested | Passenger type which was requested for pricing. If the passenger type does not correspond to one of the normalized XX/1 values below it is returned as is. Normalized values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth | 1 | CHD | |
@TypePriced | Passenger type which was actually priced. This type can differ from the type requested if there was no fare available for the requested type. | 1 | type requested was GOV and type priced is ADT because there was no fare available for type GOV but there was one for type ADT. If the passenger type does not correspond to one of the normalized XX/1 values below it is returned as is. Normalized values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth Example: ADT | |
@TypeCount | Number of travelers of the same passenger type. | [0] to [9] | 1 | 2 |
@TypeTotalPrice | Total price for all passengers of the same type. It is the result of Price multiplied by TypeCount. | 0..1 | 200000 | |
@TypeTotalLowest | Total of bottom range price for all passengers of the same type. It is the result of ''PriceRange/LowestPrice' multiplied by TypeCount. | 0..1 | 150000 | |
@TypeTotalHighest | Total of top range price for all passengers of the same type (TravelerGroup). It is the result of ''PriceRange/HighestPrice' multiplied by TypeCount. | 0..1 | 150000 | |
<TravelerIDRef/> | Reference to a TravelerIDs in the corresponding request (by its @AssociationID value) | 0..N | T1 | |
<PriceRange> | Some special versions of FareSearchRQ may return a PriceRange instead of a price for certain FareGroups. The various prices are then returned as OriginDestination/Flight/PriceGroup/PriceClass elements. | 1 | ||
@LowestPrice | Lowest Base Fare amount for one traveler of the specified passenger type reflected by Price element in Flight children of OriginDestination | 1 | 110000 | |
@HighestPrice | Highest price for one traveler of the specified passenger type reflecting the highest price found under ".../OriinDestination/Flight/Price/@Total" | 0..1 | 220000 | |
</PriceRange> | ||||
<Price> | Price group | 1 | ||
@Total | Total Fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
<BaseFare> | Base fare group | 0..1 | ||
@Amount | Total base fare amount that includes surcharges (if any). | 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> | Surcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 0..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
@Segment | Segment number to which the surcharge applies. | 0..1 | 1 | |
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<FareRules> | Fare rules applicable for this fare and passenger type. All regular XX/1 provider adapters will usually return exactly one FareRules element as the respective rules apply to the complete fare. Only if a PriceRange is returned instead of a Price, then the FareRules will be left out completely as the rules may differ for the prices within the range. The Pass SuperPNR component may return two FareRules elements per TravelerGroup and only for FareGroups created by merging two one-way fares. This is necessary as the rules may differ completely for the two one-way fares. Each FareRules element then applies to all the segments referenced by one of its FareInfo/RelatedSegments decendants. | 0..2 | ||
<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 | ||
@DetailedFareType | Detailed fare type for this fare component. May be left out when the known fare type of the fare component is not more specific than for the FareGroup as a whole. Values are: A35F = CAT35 ATPCO NEGOTIATED CA35 = CAT35 CORPORATE ATPCO NEGOTIATED CNFR = CORPORATE NEGOTIATED DDFR = DYNAMIC DISCOUNT A15F = CAT15 ATPCO PRIVATE CA15 = CAT15 CORPORATE ATPCO PRIVATE CDDF = CORPORATE DYNAMIC DISCOUNT PRFR = PUBLIC RESIDENT DISCOUNT FARE NRFR = NEGOTIATED RESIDENT DISCOUNT FARE PUBL = published fare NEGO = unspecific negotiated/private fare UNDF = undefined, the type of fare is unknown | [A35F] [CA35] [CNFR] [DDFR] [A15F] [CA15] [CDDF] [PRFR] [NRFR] [PUBL] [NEGO] [UNDF] | 0..1 | A35F |
<DepartureDate/> | Fare info departure date. Indicates the departure date which has to be used to request the fare rules and/or a fare quote display containing this particular fare. ATTENTION: This date is not necessarily the departure date of all flights in the corresponding OriginDestination. If search by arrival (supported by MP and FareQuoteSuperBB) the departure date of the actual flight segments can differ. | 1 | 2002-12-25 | |
<DepartureCode/> | Fare info departure code. Indicates the departure city/airport of the segment related to that FareInfo group. | 1 | MIA | |
<ArrivalCode/> | Fare info arrival code. Indicates the arrival city/airport of the segment related to that FareInfo group. | 1 | DFW | |
<RelatedSegment> | A FareInfo element refers to one or more OriginDestination/Flight/Segment elements of the same FareGroup. It has one RelatedSegment element for each Segment element it refers to. | 1..N | ||
<SegmentIDRef/> | The value of the SegmentIDRef element is the relative position of the corresponding FareGroup/OriginDestination/Flight/Segment element among a complete set of Segment elements. An Example - FareGroup OriginDestination[1] Flight[1] Segment A (pos 1) Segment B (pos 2) Flight[2] Segment C (pos 1) Segment D (pos 2) OriginDestination[2] Flight[1] Segment E (pos 3) Segment F (pos 4) Flight[2] Segment G (pos 3) Segment H (pos 4) A complete set of Segments consists of one OriginDestination[1]/Flight and one OriginDestination[2]/Flight element (as Flight elements within one OriginDestination are mutually exclusive alternative options). Therefore a SegmentIDRef value of 3 would refer to the first Segment of Flight Elements in OriginDestination[2] (E and G). | 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 | |
<FareComponent> | Price break-down per fare component. Not supported by all GDS/PricingEngines (1A=N; 1W=Y; 1V=Y; 1P=N; ITA=Y, SITA=N). | 0..1 | ||
@Total | Total amount for this fare component. Total = base fare amount + taxes amount. | 1 | 15000 | |
<CurrencyCode> | Currency for this FareComponent may not be the same as POS Currency Code. | 0..1 | HKD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BaseFare> | Base fare for this fare component | 0..1 | ||
@Amount | Total component fare amount that includes surcharges (if any). | 1 | 7500 | |
<Surcharges> | Surcharges break down information. | 0..1 | ||
@Amount | Total surcharges amount. | 0..1 | 2000 | |
<Surcharge> | Individual Surcharge information. | 1..N | ||
@Segment | Segment element number associated to this item. | 0..1 | 1 | |
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</FareComponent> | ||||
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<TicketDesignator/> | Ticket designator code. | 0..1 | ATM1 | |
<QCPCityPair/> | City code directly associated with the FareBasisCode. | 0..1 | MIANCEDL | |
<AirlineCode/> | Airline code. | 1 | AA | |
<CorporateFares> | Corporate fares group | 0..1 | ||
@Priced | Indicates whether this corporate fare information was actually used to price. Possible values are 'Y' for Yes and 'U' for Unknown (Sabre at this point doesn't return reliably whether the fare is a corporate fare or not). | [Y] [U] | 1 | U |
<AccountNumber/> | Corporate fare account number. | 1 | 000243 | |
<ContractCode/> | Corporate fare contract code. | 1 | 00001 | |
</CorporateFares> | ||||
<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> | If present, this element specifies the currency for all penalty amounts (see Change, Cancel,...). If missing, the FareGroup/CurrencyCode element applies. | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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> | ||||
<PriceClassComments> | Description and remarks associated to a PriceClass. | 0..1 | ||
@ProgramCode | Code of the PriceClass Program. | 0..1 | IC | |
@ProgramName | Code of the PriceClass Program. | 0..1 | Intercontinental | |
@PriceClassCode | Code of the price class. | 0..1 | 3 | |
@PriceClassName | Marketing name of the price class. | 0..1 | TANGO | |
<Icons> | Providing service icons included in this PriceClass. | 0..1 | ||
<Icon> | Individual icon ID. Possible values: - BAGGAGE = 1st bag free of charge - CARBON = Carbon offset - CARRYON - EMPTYMIDDLESEAT - LOUNGE = Lounge Access - MAGAZINES - MEALS - MILEAGE - PRIORITY = Priority Boarding - REDUCEDCHANGEFEE - SEATRES - SECURITY - SNACKS - TIMELIMIT = Extended Ticketing Time Limit - TKTVALUETRANSFER = Ticket Value Transfer (=change of person travelling) - WIFI = Free WiFi | 1..N | WIFI | |
@Description | Individual Icon description. | 0..1 | Free WiFi on plane | |
</Icon> | ||||
</Icons> | ||||
<Text/> | Describing the highlights of the PriceClass. | 0..N | ||
<Upsell> | 0..N | |||
@ProgramCode | Code of the PriceClass Program. | 0..1 | IC | |
@ProgramName | Code of the PriceClass Program. | 0..1 | Intercontinental | |
@PriceClassCode | Code of the price class. | 0..1 | 3 | |
@PriceClassName | Marketing name of the price class. | 0..1 | TANGO | |
</Upsell> | ||||
</PriceClassComments> | ||||
</FareInfo> | ||||
<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> | If present, this element specifies the currency for all penalty amounts (see Change, Cancel,...). If missing, the FareGroup/CurrencyCode element applies. | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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> | ||||
<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..1 | 3 | |
@Unit | Advance purchase restriction value unit. Values are: H = Hours D = Days M = Months. | [H] [D] [M] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. 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..1 | 24 | |
@Unit | Advance purchase ticketing restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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..1 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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 requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MinimumStay> | ||||
<MaximumStay> | Maximum stay requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MaximumStay> | ||||
<TicketByDate> | Ticket by date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
@Time | Time in ISO 8601 format. | 0..1 | 12:35 or 19:45 | |
</TicketByDate> | ||||
<Remark/> | Fare rules miscellaneous remarks. | 0..N | See pax type | |
<Endorsement> | 0..N | |||
<Text/> | Endorsement text. | 1 | ||
@Type | Identifies the creation mode of this line. Values are: A - automatically by pricing system | [A] | 1 | |
</Endorsement> | ||||
<FareCalculation/> | FareCalculation Line | 0..1 | ||
<TourCode/> | Tour code if applicable and associated with the priced fare. Alpha-numeric. | 0..1 | ITGF12 | |
</FareRules> | ||||
</TravelerGroup> | ||||
<OriginDestination> | Origin and destination group | 1..N | ||
@DepartureCode | Departure airport or city code. | 1 | JFK | |
@ArrivalCode | Arrival airport or city code. | 1 | MIA | |
@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. | |
@OriginDestinationNumber | Number of the corresponding OriginDestiontion from FareSearchRQ. | 0..1 | ||
<PriceClassComments> | Description and remarks associated to a PriceClass returned in the Flight/PriceGroup element, e.g. TANGO | 0..N | ||
@ProgramCode | Code of the PriceClass Program. | 0..1 | IC | |
@ProgramName | Code of the PriceClass Program. | 0..1 | Intercontinental | |
@PriceClassName | Marketing name of the price class. | 0..1 | TANGO | |
@PriceClassCode | Code of the price class. | 0..1 | 3 | |
@ColumnOrder | If present this value determines the sequence of the PriceClass columns | 0..1 | ||
<Icons> | Providing service icons included in this PriceClass, e.g. WIFI = Free WiFi on plane LOUNGE = Access to VIP Lounge PRIORITY = Priotity Boarding BAGGAGE = 1st bag free of charge | 0..1 | ||
<Icon> | Individual icon ID. | 1..N | WIFI | |
@Description | Individual Icon description. | 0..1 | Free WiFi on plane | |
</Icon> | ||||
</Icons> | ||||
<Text/> | Describing the highlights of the PriceClass. | 0..N | ||
<Combinability> | Lists all price classes with which this price class is combinable | 0..1 | ||
<FareBrand/> | List of the fare brand/price class labels | 1..N | ||
</Combinability> | ||||
</PriceClassComments> | ||||
<Flight> | Each Flight element contains an alternative set of Segments to travel from origin to destination. For each OriginDestination, one of the alternative Flight elements must be chosen. Each Flight element of one OriginDestination can be freely combined with any of the Flight elements of another OriginDestination. All Flight elements of one OriginDestination will have the same number of Segments. Only some provider systems will return more than one Flight per OriginDestination. | 1..N | ||
@RecommendationID | Identifies flight cross OriginDestination groups as a recommendation. Currently only supported by Amadeus MasterPricer variants. | 0..1 | ||
@LinkType | Flight link type. Possible values are: 1A = Amadeus (full) Access (AS + AU) 1ADA = Amadeus (full) Access and Direct Access ATLA = Amadeus Ticketless Access (includes AEAC + ALT) AEAC = Amadeus Extended Air Choice ALT = Amadeus Light Ticketing AS = Amadeus Access Sell ASDA = Amadeus Access Sell and Direct Access AU = Amadeus Access Update AUDA = Amadeus Access Update and Direct Access DA = Amadeus Direct Access DAM = Direct Access Mode FS = Apollo/Galileo Free sale agreement GA = Apollo/Galileo Guaranteed against Alpha AVS status GU = Apollo/Galileo Guaranteed against numeric status NO = Apollo/Galileo No sell agreement exists between host and the vendor NS = Apollo/Galileo Non-statusing member - flights are generally on request SA = Apollo/Galileo Same as GA, except vendor record locator is returned sooner SAB = Sabre answerback SDA = Sabre direct Access SDC = Sabre direct Connect SMA = Sabre multi Access SS = Apollo/Galileo Secured Sell ST = Apollo/Galileo Standard AVS status sell - no guarantees, no last seat SU = Apollo/Galileo Same as GU, except vendor record locator is returned sooner WDA = Worldspan AccessPlus WDD = Worldspan Direct Sell WDR = Worldspan Direct Response WDS = Worldspan Airline Source | [1A] [1ADA] [ATLA] [AEAC] [ALT] [AS] [ASDA] [AU] [AUDA] [DA] [DAM] [FS] [GA] [GU] [NO] [NS] [SA] [SAB] [SDA] [SDC] [SMA] [SS] [ST] [SU] [WDA] [WDD] [WDR] [WDS] | 0..1 | SDA |
<JourneyTime/> | Total journey time of the flight. | 0..1 | 13:45 | |
<PriceGroup> | List of prices offered for this OD and flight component, e.g. 3 PriceClasses are offered: Tango - $200.00 Tango Plus - 300.00 Executive - 450.00 Will only be returned in conjunction with a Traveler/PriceRange. | 0..1 | ||
<PriceClass> | Identifies the price group associated to this price, e.g. TANGO | 1..N | ||
@FareType | Type of fare being returned. Values are: PUBL = published fare NEGO = negotiated/private fare BOTH = mix of fare types UNDF = undefined, the type of fare is unknown | [PUBL] [NEGO] [BOTH] [UNDF] | 0..1 | NEGO |
@Name | Marketing name of the price class. | 0..1 | TANGO | |
@Code | Code of the price class. | 0..1 | 3 | |
<Price> | Price group | 1..N | ||
@Total | Total Fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 230000 | |
@TypeRequested | Passenger type which was requested for pricing. If the passenger type does not correspond to one of the normalized XX/1 values below it is returned as is. Normalized values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth | 0..1 | CHD | |
@TypePriced | Passenger type which was actually priced. This type can differ from the type requested if there was no fare available for the requested type. | 0..1 | type requested was GOV and type priced is ADT because there was no fare available for type GOV but there was one for type ADT. If the passenger type does not correspond to one of the normalized XX/1 values below it is returned as is. Normalized values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth Example: ADT | |
<BaseFare> | Base fare group | 1 | ||
<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> | Surcharges group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 0..N | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
<Designator/> | Surcharge designator. | 1 | ||
<Description/> | Surcharge descriptions as free form text. | 0..1 | ||
@Segment | Segment number to which the surcharge applies. | 0..1 | 1 | |
</Surcharge> | ||||
</Surcharges> | ||||
</BaseFare> | ||||
<Taxes> | Taxes group | 1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<PriceSegment> | 0..N | |||
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 1 | F1 | |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..N | T1 | |
<FareBasisCode/> | Fare basis code. | 1 | Y26 | |
<ClassOfService/> | Class of service. | 1 | B | |
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<NVA/> | Identifies "not valid after" date for a fare.Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<NVB/> | Identifies "not valid befoe" date for a fare. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<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> | ||||
<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..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 |
<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..1 | 24 | |
@Unit | Advance purchase ticketing restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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..1 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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> | ||||
<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..1 | 3 | |
@Unit | Advance purchase restriction value unit. Values are: H = Hours D = Days M = Months. | [H] [D] [M] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. Values are: L = Latest E = Earliest O = On time. | [L] [E] [O] | 1 | L |
</AdvancePurchase> | ||||
<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> | If present, this element specifies the currency for all penalty amounts (see Change, Cancel,...). If missing, the FareGroup/CurrencyCode element applies. | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | 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> | ||||
<MinimumStay> | Minimum stay requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MinimumStay> | ||||
<MaximumStay> | Maximum stay requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MaximumStay> | ||||
</PriceSegment> | ||||
<FareRules> | 0..N | |||
<FareCalculation/> | FareCalculation Line | 0..1 | ||
<TripMileage/> | Mileage for fared itinerary (=sum of ComponentMileage) | 0..1 | 6565 | |
<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..1 | 24 | |
@Unit | Advance purchase ticketing restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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..1 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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> | ||||
<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..1 | 3 | |
@Unit | Advance purchase restriction value unit. Values are: H = Hours D = Days M = Months. | [H] [D] [M] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. Values are: L = Latest E = Earliest O = On time. | [L] [E] [O] | 1 | L |
</AdvancePurchase> | ||||
<InstantPurchase/> | Instant Purchase indicator. CC = Purchase is immediately charged to CC AP = Purchase is using AirPass credit(s) PP = Purchase is charged via PayPal N = Not an instant purchase TT = Purchase is immediate after Ticketing time AU = EMD will be automatically issued without sending EMDIssueRQ | [CC] [AP] [PP] [N] [TT] [AU] | 0..1 | TT |
<MinimumStay> | Minimum stay requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MinimumStay> | ||||
<MaximumStay> | Maximum stay requirement 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. | 1 | 7 | |
@Unit | Minimum or maximum stay value unit. Possible values are: H = Hours D = Days M = Months. | [H] [D] [M] | 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. | 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] [8] [9] | 1 | 1 |
</DayOfWeek> | ||||
</MaximumStay> | ||||
<CorporateFares> | Corporate fares group | 0..1 | ||
@Priced | Indicates whether this corporate fare information was actually used to price. Possible values are 'Y' for Yes and 'U' for Unknown (Sabre at this point doesn't return reliably whether the fare is a corporate fare or not). | [Y] [U] | 1 | U |
<AccountNumber/> | Corporate fare account number. | 1 | 000243 | |
<ContractCode/> | Corporate fare contract code. | 1 | 00001 | |
</CorporateFares> | ||||
<TicketByDate> | Ticket by date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
@Time | Time in ISO 8601 format. | 0..1 | 12:35 or 19:45 | |
</TicketByDate> | ||||
<Endorsement> | 0..N | |||
<Text/> | Endorsement text. | 1 | ||
@Type | Identifies the creation mode of this line. Values are: A - automatically by pricing system | [A] | 1 | |
</Endorsement> | ||||
<TourCode/> | Tour code if applicable and associated with the priced fare. Alpha-numeric. | 0..1 | ITGF12 | |
</FareRules> | ||||
<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 |
</PriceClass> | ||||
</PriceGroup> | ||||
<Segment> | Segment information group | 1..N | ||
@ChangeOfAirport | Change of airport indicator. Values are: Y = there is a change of airport in the connection N = there is no change of airport in the connection. | [Y] [N] | 1 | Y |
@MarriedSegment | Indicates the beginning and end of segments grouped by marriage logic. Possible values: B = Beginning segment E = ending segment. | 0..1 | ||
@SellIndicator | Internal sell indicator used to identify segment grouping listed in a fare search response recommendation. If present in the response must be used as-is in PNRCreateRQ request for air sell. See PNRCreateRQ/CompletePNRElements/Itinerary/Flight. | 0..1 | ||
@CnxxIndicator | Connection indicator. | [Y] [N] | 0..1 | Y = Yes, N = No |
@SecureFlight | Indicates if Secure Flight data is required for this flight. Values: Y = Secure flight data must be provided N = (Default) flight does not require Secure Flight data | [Y] [N] | 0..1 | |
<Departure> | Segment departure group | 1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
<AirportName/> | Segment departure or arrival airport name. | 1 | John Fitzerald Kennedy | |
<Date/> | Segment departure or arrival date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<Time/> | Segment departure or arrival time in ISO 8601 (hh:mm). | 1 | 14:30 | |
<Terminal/> | Segment departure or arrival airport terminal. | 0..1 | 2B | |
</Departure> | ||||
<Arrival> | Segment arrival group | 1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
<AirportName/> | Segment departure or arrival airport name. | 1 | John Fitzerald Kennedy | |
<Date/> | Segment departure or arrival date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<ChangeOfDay/> | Change of day information. | 0..1 | 01 | |
<Time/> | Segment departure or arrival time in ISO 8601 (hh:mm). | 1 | 14:30 | |
<Terminal/> | Segment departure or arrival airport terminal. | 0..1 | 2B | |
</Arrival> | ||||
<Carrier> | Carrier group | 1 | ||
<AirlineCode/> | Airline code. | 1 | AA | |
<AirlineName/> | Airline name. | 1 | American Airlines | |
<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> | ||||
</Carrier> | ||||
<OperatingCarrier> | The Operating Carrier element is returned when the CRS provides the information that the flight is operated by a different carrier than the marketing carrier (i.e. the carrier returned in the Carrier element). In some cases a CRS may only provide the information that the operating carrier differs from the marketing carriers, but without revealing the operating carrier. In this case the value "**" is retuned for both AirlineCode and AirlineName. In these cases it may be possible to determine the operating carrier by sending a FlightInformationRQ request. | 0..1 | ||
<AirlineCode/> | Airline code of the operating carrier. In case the airline code is not provided by the CRS, a value of "**" is returned. | 1 | AA | |
<AirlineName/> | Airline name of the operating carrier. In case the airline name is not provided by the CRS, a value of "**" is returned. | 1 | American Airlines | |
<FlightNumber> | Flight number - an integer value within the range of [0,9999]. | 0..1 | 1234 | |
@Suffix | Flight number alpha qualifier. Values are: A B C D | [A] [B] [C] [D] | 0..1 | A |
</FlightNumber> | ||||
</OperatingCarrier> | ||||
<Equipment> | Equipment group | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Name/> | Airplane type name. | 1 | Boeing 747 series | |
</Equipment> | ||||
<NumberOfStops/> | Number of stops. | [0] to [9] | 0..1 | 0 |
<StopInformation> | Stop information group A Change of Gauge flight requires the @ChangeOfGauge attribte to be set to Y; it also requires to map the new equipment used from this stop forward. | 0..N | ||
@ChangeOfGauge | Possible Value: Y Set if the flight is a Change of Gauge flight which will also require to map the NEW equipment (for the next leg of this flight) to the "Equipment" node | [Y] | 0..1 | |
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
<AirportName/> | Segment departure or arrival airport name. | 1 | John Fitzerald Kennedy | |
<ArrivalDate/> | Fare info arrival date. Indicates the arrival date of one or more flights related to this FareInfo group. The arrival date will be returned when the FareSearch is based on arrival date. For departure dates please refer to specific flight segments in this case. | 1 | 2002-12-25 | |
<ArrivalTime/> | Stop arrival time in ISO 8601 format (hh:mm). | 1 | 14:50 | |
<DepartureDate/> | Fare info departure date. Indicates the departure date of one or more segments related to this FareInfo group. The departure date will be returned when the FareSearch is based on departure date. | 1 | 2002-12-25 | |
<DepartureTime/> | Stop departure time in ISO 8601 format (hh:mm). | 1 | 14:50 | |
<Equipment> | ONLY used in case of a Change of Gauge flight the equipment for the continuation of the flight is mapped here. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Name/> | Airplane type name. | 1 | Boeing 747 series | |
</Equipment> | ||||
</StopInformation> | ||||
<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 |
<Frequency/> | This indicates which days of the week the flight operates on- i.e. 1234567, 123, 467 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | 0..1 | 13456 | |
<FlightDuration/> | Segment total flying time. | 0..1 | 01:30 | |
<OnTimeInfo/> | Indicates the on time performance. Valid values are: 9 = 90-100 percent 8 = 80-89 percent 7 = 70-79 percent 6 = 60-69 percent 5 = 50-59 percent 4 = 40-49 percent 3 = 30-39 percent 2 = 20-29 percent 1 = 10-19 percent 0 = Less than 10 percent N = New flight - no performance U = No flight data available X = International or city where reporting is not required. | [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] [O] [N] [U] [X] | 0..1 | 6 |
<ElectronicTicketing/> | Electronic ticketing indicator. Values are: Y = eticket can be issued N = no eticket possible. | [Y] [N] | 0..1 | Y |
<TrafficRestrictions/> | Traffic restriction information. Valid values are: A = no local traffic B = local traffic only C = local and domestic connecting traffic only D = qualified international online connecting or stopover traffic only E = qualified online connecting or stopover traffic only F = local and online connecting traffic only G = qualified online connecting traffic only H = segment not to be displayed I = technical landing J = conditional traffic K = connecting traffic only L = online connex traffic M = international online stopover traffic only N = international connecting traffic only O = international online connecting traffic only P = subj to govt approval Q = international online connecting or stopover traffic only R = permanent request S = stopover traffic only T = online stopover traffic only U = intl stopover traffic V = connecting or stopover traffic only W = international connecting or stopover traffic only X = online connecting or stopover traffic only Y = online connecting traffic only Z = tr do not apply equally to passenger/cargo/mail Blank = no restrictions | [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W] [X] [Y] [Z] [] | 0..N | X |
<LegMiles/> | Number of miles for segment. | 0..1 | 2143 | |
<Classes> | Flight Classes group | 0..1 | ||
<ClassOfService> | Booking class of service to be applied for this Segment when booked as part of this FareGroup. Multiple ClassOfService may only be returned in conjunction with a Flight/PriceGroup. | 1..N | B | |
@Status | Numeric status (available seats). Values are: A = Seats are available, L = Waitlist Open for a segment, C = Waitlist closed, R = Seats on request only to airline, S = waitlist closed, 0 - 9 = number of at least available seats, 'empty' = no information. | [A] [L] [C] [R] [S] [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] [] | 1 | 9 |
@PriceClassName | Name of the PriceClass to which this ClassOfService belongs. | 0..1 | TANGO | |
@PriceClassCode | can be used as a key to associate this element with respective "Price" elements (which is returned with same value in the attribute @Code) | 0..1 | ||
</ClassOfService> | ||||
</Classes> | ||||
</Segment> | ||||
</Flight> | ||||
</OriginDestination> | ||||
<OptionalServices> | Services that are not included in the ticket fare, or that will be charged for by the carrier. | 0..1 | ||
<Service> | Service Details If the service can only be booked for the complete booking, no SegmentIDRef and no TravelerIDRef are returned. If the service can be booked per traveler, the service will be displayed for each FareSearchRQ/TravelerIDs element referencing the FareSearchRQ/TravelerIDs/@AssociationID in the TravelerIDRef. If the service can be booked per segment, the service will be displayed separate for each segment, specifying the position of the segment in the SegmentIDRef as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef. If the service can only be booked per OriginDestination, the service will be displayed separate for each OriginDestination, specifying the positions of the segments in multiple SegmentIDRef elements as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef. | 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. | |
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 1 | |
@Airline | This is the airline code of the Marketing carrier, the carrier actually offering the service. | 1 | ||
@TypeValue | EMD Type Value as defined by ATPCO 1 = Standalone 2 = Associated to a flight 3 = Standalone associated to a ticket (but not flight) 4 = no EMD, carrier directed type 5 = E-Ticket | 0..1 | ||
@SaleStatus | Allowed Values: "Offered" "Pending" "Booked" "Issued" "Canceled" "Issued" represents those services which have been issued and have a valid EMDInfo node "Booked" represent items sold/booked but not yet issued Values are returned in the response | [Offered] [Booked] [Issued] [Pending] [Canceled] | 0..1 | |
@ServiceType | The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)': F = Flight (TypeValue=2) R = Rule Buster (Type Value = 5) T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other) M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other) | 0..1 | ||
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. A = Air Transportation B = Surface Transportation/Non Air services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = in-flight Services I = Individual Airline Use | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@ServiceCode | Additional unique ATPCO code. | 0..1 | OC | |
@FareBrand | Service is part of a bundle associated to this fare brand | 0..1 | ||
@Status | Values are: NN = "Requested" HK = "Confirmed" | [NN] [HK] | 0..1 | |
@DealID | This ID represents an airline promotion for a special target market and applies only for FQTV numbers identified for this promotion | 0..1 | ||
@Type | Indicator if this option is a discount or a surcharge; Values are: "Discount" 1) "Surcharge" "Included" 2) "Not applicable" 3) 1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution) 2) This item is free of charge due to FQTV status or chosen Price Class 3) This item is not available/applicable due to FQTV status or chosen Price Class. Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler. | [Discount] [Surcharge] [Included] [Not applicable] | 1 | |
@FQTVAirline | The 2-character airline code of the Frequent Flyer membership | 0..1 | AA | |
@FQTVStatus | The status (tier level) of the traveler's FQTV account. This is available as a query results against the airline's FQTV database. Samples: AA(American AAdvantage): -- Gold -- Platinum -- Executive Platinum LH (Miles and More): -- Frequent Traveller -- Senator -- HON Circle EK (Emirates Skywards): -- Silver -- Gold | 0..1 | ||
@FQTVNumber | This is the actual FrequentFlyer number associated to the FQTVStatus. This will allow the POS GUI to associate the actual traveler with the respective option/price | 0..1 | ||
@NotValidBefore | Option is not available/usable until the date entered | 0..1 | ||
@NotValidAfter | Option is not available/usable after the date entered | 0..1 | ||
@Slice | In case of a "Change Of Gauge" flight, this determines to which slice of the flight the option belongs. Default = 0 (or absence) | 0..1 | YY 465 SFO FRA with change of gauge in ORD Slice 0 = SFO to ORD Slice 1 = ORD to FRA | |
@CanDeselect | Any service tagged with a "Y" setting here can be deselected. This attribute is set by the merchandizing engine for services which are typically included in a Price Class or CoS but may not be desired by the traveler, e.g. Premium Drinks on the flight. Allowed value: "Y" | [Y] | 0..1 | |
@MaxQuantity | Will determine what the maximum number can be for the Quantity. | 0..1 | 5 | |
@Quantity | This attribute provides how many service/items of the same type have been ordered, 1 being the default. | 0..1 | 3 | |
@SingleChoiceGroupID | There are cases where a set of Service elements belong to a group of which only one Service may be chosen at a time. Where this is known to XX1, it will add a SingleChoiceGroupID attribute with identical value to each Service of that group. While each Service element of such a set will have the same SingleChoiceGroupID value, different sets of such Service elements will have different values. When a Service has no SingleChoiceGroupID attribute, it may be freely combined with any other Service (or respective restrictions are not known to XX1). | 0..1 | G1 | |
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 0..N | F1 | |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..1 | T1 | |
<ServiceLocation/> | Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi. This is the 3-letter IATA city- or airport code related to the service. For example, an airport lounge pass may only be valid for one location. | 0..1 | DFW | |
<ServiceDate/> | Service date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2010-12-25 | |
<Description/> | Title description (Commercial Name) of offered service. | 1 | "3rd Bag Fee" UI tip: You may build a one line description to display by stringing the following values together: "Description"+"ServiceLocation"+"ServiceDate"+"DescriptionVariable" which could be displayed as sampled here: 'Airline Lounge Pass DFW 10May' where 'Airline Lounge Pass' is the "Description", 'DFW' the "ServiceLocation" and '10May' the "ServiceDate" or Premium Seat 9D where 'Premium Seat' is the "Description" and '9D' the "DescriptionVariable" | |
<DescriptionVariable/> | This value is used to provide a variable value for an selected service. Sample: for a Premium Seat this will be a seat number; for a annual pass of onboard WiFi this will be the credentials, etc. Examples: "9D" "UID: GO8978 PW: 1234" | 0..1 | ||
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
<ServicePrice> | Price for this service; not to be used for 'included' options (no charge options) This node uses the Currency/Decimals of the FareGroup root level | 0..1 | ||
@Total | Total amount for the chosen quantity of this service. Total = base price + total amount of taxes. | 1 | 7500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Service | 1 | ||
@Amount | Net price of service | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<ItemPrice> | Recommended to provide at all times, however if quantity is greater than 1 ItemPrice is mandatory | 0..1 | ||
@Total | Total amount for this service based on FQTV status and chosen Price Class. Total = base price + total amount of taxes. | 1 | 7500 | |
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of option. | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
</ItemPrice> | ||||
</ServicePrice> | ||||
<TicketByDate> | Date (in ISO 8601 format: (yyyy-mm-dd) by which this service must be issued. | 0..1 | 2010-05-07 | |
@Time | Time in ISO 8601 format. | 0..1 | 12:35 or 19:45 | |
</TicketByDate> | ||||
<Penalties> | Option Penalty group | 0..1 | ||
@Refundable | Indicates if option is refundable. Values are: Y = Option refundable N = Option not refundable | [Y] [N] | 0..1 | Y |
@Reusable | Indicates if option is reusable. Values are: Y = Funds are reusable N = Funds are not reusable (default) | [Y] [N] | 0..1 | Y |
<Change> | Change penalty group | 0..1 | ||
@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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</Penalties> | ||||
<Commission> | Commission amount or percentage for this option | 0..1 | ||
@Type | Commission type. Values are: P = Percent, A = Amount | [P] [A] | 1 | A |
</Commission> | ||||
<Endorsement> | Endorsements for this service. | 0..N | NONREF | |
<Text/> | Endorsement text. | 1 | ||
</Endorsement> | ||||
<ValidatingCarrier/> | Validating carrier code. Standard IATA 2-letter alphanumeric code. Allows to override the Validating Carrier assigned to the entire FareGroup | 0..1 | AF | |
<ReferenceKey/> | Unique reference key. If present in pricing response messages, must be included. | 0..1 | ||
<Attributes> | ATPCO S5 record attributes | 0..1 | ||
<Group> | Sample codes: BG = Baggage FF = Frequent Flyer GT = Ground Transportation and Non Air Services IE = In-flight entertainment LG = Lounge MD = Medical ML = Meal/Beverage PT = Pets RO = Rule Override SA = Prereserved Seat Assignment SB = Standby ST = Store TS = Travel Services UN = Unaccompanied Travel (Escort) UP = Upgrades WF = WiFi | 1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Group> | ||||
<SubGroup> | Sample codes for group "BG": CT = Container PP = Pre-paid excess baggage Sample codes for group "GT": BU = Bus LI = Limo, etc Sample codes for group "IE": IT = Internet access TV = Television, etc | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</SubGroup> | ||||
<Desc1> | Description codes. Examples: 05 = up to 5 kg 1Y = One Year AI = Aisle B1 = First Bag etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc1> | ||||
<Desc2> | Description codes. Examples: HT = Hot KO = Kosher etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc2> | ||||
</Attributes> | ||||
<BookingInstructions> | Contains instructions how to book this service with respective source | 0..1 | ||
<SSRCode/> | Special service request code. IATA standard. | 0..N | VGML | |
<OSIText/> | 0..N | |||
<UpgradeMethod> | Allowed Values: A = AutoUpgrade S = SSR request | 0..1 | ||
@NewClass | Instructs which new class to book | 0..1 | ||
</UpgradeMethod> | ||||
<Text/> | Any freeflow to instruct DC | 0..N | ||
</BookingInstructions> | ||||
<InstantPurchase/> | Instant Purchase indicator. CC = Purchase is immediately charged to CC AP = Purchase is using AirPass credit(s) PP = Purchase is charged via PayPal N = Not an instant purchase TT = Purchase is immediate after Ticketing time AU = EMD will be automatically issued without sending EMDIssueRQ | [CC] [AP] [PP] [N] [TT] [AU] | 0..1 | TT |
</Service> | ||||
</OptionalServices> | ||||
<IncludedServices> | Services that are included in the ticket fare, or free of charge due to the frequent flyer status of a traveler. | 0..1 | ||
<Service> | Service Details If the service can only be booked for the complete booking, no SegmentIDRef and no TravelerIDRef are returned. If the service can be booked per traveler, the service will be displayed for each FareSearchRQ/TravelerIDs element referencing the FareSearchRQ/TravelerIDs/@AssociationID in the TravelerIDRef. If the service can be booked per segment, the service will be displayed separate for each segment, specifying the position of the segment in the SegmentIDRef as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef. If the service can only be booked per OriginDestination, the service will be displayed separate for each OriginDestination, specifying the positions of the segments in multiple SegmentIDRef elements as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef. | 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. | |
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 1 | |
@Airline | This is the airline code of the Marketing carrier, the carrier actually offering the service. | 1 | ||
@TypeValue | EMD Type Value as defined by ATPCO 1 = Standalone 2 = Associated to a flight 3 = Standalone associated to a ticket (but not flight) 4 = no EMD, carrier directed type 5 = E-Ticket | 0..1 | ||
@SaleStatus | Allowed Values: "Offered" "Pending" "Booked" "Issued" "Canceled" "Issued" represents those services which have been issued and have a valid EMDInfo node "Booked" represent items sold/booked but not yet issued Values are returned in the response | [Offered] [Booked] [Issued] [Pending] [Canceled] | 0..1 | |
@ServiceType | The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)': F = Flight (TypeValue=2) R = Rule Buster (Type Value = 5) T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other) M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other) | 0..1 | ||
@ReasonCode | IATA RFIC (ReasonFor IssuanceCode, a 1-character main code) Example of RFIC: A Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs. A = Air Transportation B = Surface Transportation/Non Air services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = in-flight Services I = Individual Airline Use | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@ServiceCode | Additional unique ATPCO code. | 0..1 | OC | |
@FareBrand | Service is part of a bundle associated to this fare brand | 0..1 | ||
@Status | Values are: NN = "Requested" HK = "Confirmed" | [NN] [HK] | 0..1 | |
@DealID | This ID represents an airline promotion for a special target market and applies only for FQTV numbers identified for this promotion | 0..1 | ||
@Type | Indicator if this option is a discount or a surcharge; Values are: "Discount" 1) "Surcharge" "Included" 2) "Not applicable" 3) 1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution) 2) This item is free of charge due to FQTV status or chosen Price Class 3) This item is not available/applicable due to FQTV status or chosen Price Class. Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler. | [Discount] [Surcharge] [Included] [Not applicable] | 1 | |
@FQTVAirline | The 2-character airline code of the Frequent Flyer membership | 0..1 | AA | |
@FQTVStatus | The status (tier level) of the traveler's FQTV account. This is available as a query results against the airline's FQTV database. Samples: AA(American AAdvantage): -- Gold -- Platinum -- Executive Platinum LH (Miles and More): -- Frequent Traveller -- Senator -- HON Circle EK (Emirates Skywards): -- Silver -- Gold | 0..1 | ||
@FQTVNumber | This is the actual FrequentFlyer number associated to the FQTVStatus. This will allow the POS GUI to associate the actual traveler with the respective option/price | 0..1 | ||
@NotValidBefore | Option is not available/usable until the date entered | 0..1 | ||
@NotValidAfter | Option is not available/usable after the date entered | 0..1 | ||
@Slice | In case of a "Change Of Gauge" flight, this determines to which slice of the flight the option belongs. Default = 0 (or absence) | 0..1 | YY 465 SFO FRA with change of gauge in ORD Slice 0 = SFO to ORD Slice 1 = ORD to FRA | |
@CanDeselect | Any service tagged with a "Y" setting here can be deselected. This attribute is set by the merchandizing engine for services which are typically included in a Price Class or CoS but may not be desired by the traveler, e.g. Premium Drinks on the flight. Allowed value: "Y" | [Y] | 0..1 | |
@MaxQuantity | Will determine what the maximum number can be for the Quantity. | 0..1 | 5 | |
@Quantity | This attribute provides how many service/items of the same type have been ordered, 1 being the default. | 0..1 | 3 | |
@SingleChoiceGroupID | There are cases where a set of Service elements belong to a group of which only one Service may be chosen at a time. Where this is known to XX1, it will add a SingleChoiceGroupID attribute with identical value to each Service of that group. While each Service element of such a set will have the same SingleChoiceGroupID value, different sets of such Service elements will have different values. When a Service has no SingleChoiceGroupID attribute, it may be freely combined with any other Service (or respective restrictions are not known to XX1). | 0..1 | G1 | |
<SegmentIDRef/> | ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. | 0..N | F1 | |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..1 | T1 | |
<ServiceLocation/> | Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi. This is the 3-letter IATA city- or airport code related to the service. For example, an airport lounge pass may only be valid for one location. | 0..1 | DFW | |
<ServiceDate/> | Service date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2010-12-25 | |
<Description/> | Title description (Commercial Name) of offered service. | 1 | "3rd Bag Fee" UI tip: You may build a one line description to display by stringing the following values together: "Description"+"ServiceLocation"+"ServiceDate"+"DescriptionVariable" which could be displayed as sampled here: 'Airline Lounge Pass DFW 10May' where 'Airline Lounge Pass' is the "Description", 'DFW' the "ServiceLocation" and '10May' the "ServiceDate" or Premium Seat 9D where 'Premium Seat' is the "Description" and '9D' the "DescriptionVariable" | |
<DescriptionVariable/> | This value is used to provide a variable value for an selected service. Sample: for a Premium Seat this will be a seat number; for a annual pass of onboard WiFi this will be the credentials, etc. Examples: "9D" "UID: GO8978 PW: 1234" | 0..1 | ||
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
<ServicePrice> | Price for this service; not to be used for 'included' options (no charge options) This node uses the Currency/Decimals of the FareGroup root level | 0..1 | ||
@Total | Total amount for the chosen quantity of this service. Total = base price + total amount of taxes. | 1 | 7500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Service | 1 | ||
@Amount | Net price of service | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<ItemPrice> | Recommended to provide at all times, however if quantity is greater than 1 ItemPrice is mandatory | 0..1 | ||
@Total | Total amount for this service based on FQTV status and chosen Price Class. Total = base price + total amount of taxes. | 1 | 7500 | |
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of option. | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
</ItemPrice> | ||||
</ServicePrice> | ||||
<TicketByDate> | Date (in ISO 8601 format: (yyyy-mm-dd) by which this service must be issued. | 0..1 | 2010-05-07 | |
@Time | Time in ISO 8601 format. | 0..1 | 12:35 or 19:45 | |
</TicketByDate> | ||||
<Penalties> | Option Penalty group | 0..1 | ||
@Refundable | Indicates if option is refundable. Values are: Y = Option refundable N = Option not refundable | [Y] [N] | 0..1 | Y |
@Reusable | Indicates if option is reusable. Values are: Y = Funds are reusable N = Funds are not reusable (default) | [Y] [N] | 0..1 | Y |
<Change> | Change penalty group | 0..1 | ||
@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) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] [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> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
<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/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</Penalties> | ||||
<Commission> | Commission amount or percentage for this option | 0..1 | ||
@Type | Commission type. Values are: P = Percent, A = Amount | [P] [A] | 1 | A |
</Commission> | ||||
<Endorsement> | Endorsements for this service. | 0..N | NONREF | |
<Text/> | Endorsement text. | 1 | ||
</Endorsement> | ||||
<ValidatingCarrier/> | Validating carrier code. Standard IATA 2-letter alphanumeric code. Allows to override the Validating Carrier assigned to the entire FareGroup | 0..1 | AF | |
<ReferenceKey/> | Unique reference key. If present in pricing response messages, must be included. | 0..1 | ||
<Attributes> | ATPCO S5 record attributes | 0..1 | ||
<Group> | Sample codes: BG = Baggage FF = Frequent Flyer GT = Ground Transportation and Non Air Services IE = In-flight entertainment LG = Lounge MD = Medical ML = Meal/Beverage PT = Pets RO = Rule Override SA = Prereserved Seat Assignment SB = Standby ST = Store TS = Travel Services UN = Unaccompanied Travel (Escort) UP = Upgrades WF = WiFi | 1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Group> | ||||
<SubGroup> | Sample codes for group "BG": CT = Container PP = Pre-paid excess baggage Sample codes for group "GT": BU = Bus LI = Limo, etc Sample codes for group "IE": IT = Internet access TV = Television, etc | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</SubGroup> | ||||
<Desc1> | Description codes. Examples: 05 = up to 5 kg 1Y = One Year AI = Aisle B1 = First Bag etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc1> | ||||
<Desc2> | Description codes. Examples: HT = Hot KO = Kosher etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc2> | ||||
</Attributes> | ||||
<BookingInstructions> | Contains instructions how to book this service with respective source | 0..1 | ||
<SSRCode/> | Special service request code. IATA standard. | 0..N | VGML | |
<OSIText/> | 0..N | |||
<UpgradeMethod> | Allowed Values: A = AutoUpgrade S = SSR request | 0..1 | ||
@NewClass | Instructs which new class to book | 0..1 | ||
</UpgradeMethod> | ||||
<Text/> | Any freeflow to instruct DC | 0..N | ||
</BookingInstructions> | ||||
<InstantPurchase/> | Instant Purchase indicator. CC = Purchase is immediately charged to CC AP = Purchase is using AirPass credit(s) PP = Purchase is charged via PayPal N = Not an instant purchase TT = Purchase is immediate after Ticketing time AU = EMD will be automatically issued without sending EMDIssueRQ | [CC] [AP] [PP] [N] [TT] [AU] | 0..1 | TT |
</Service> | ||||
</IncludedServices> | ||||
<ValidatingCarrier> | Validating carrier code. Standard IATA 2-letter alphanumeric code. | 0..N | AF | |
<AirlineCode/> | Airline code. | 1 | AA | |
<SegmentIDRef/> | The value of the SegmentIDRef element is the relative position of the corresponding FareGroup/OriginDestination/Flight/Segment element among a complete set of Segment elements. An Example - FareGroup OriginDestination[1] Flight[1] Segment A (pos 1) Segment B (pos 2) Flight[2] Segment C (pos 1) Segment D (pos 2) OriginDestination[2] Flight[1] Segment E (pos 3) Segment F (pos 4) Flight[2] Segment G (pos 3) Segment H (pos 4) A complete set of Segments consists of one OriginDestination[1]/Flight and one OriginDestination[2]/Flight element (as Flight elements within one OriginDestination are mutually exclusive alternative options). Therefore a SegmentIDRef value of 3 would refer to the first Segment of Flight Elements in OriginDestination[2] (E and G). | 0..N | ||
<AlternateAirlineCode/> | Airline code of alternate validating carriers. | 0..N | AA | |
</ValidatingCarrier> | ||||
</FareGroup> | ||||
</FareSearchRS> |
| 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