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 |
|---|---|---|---|---|
<FlightPriceRS> | Flight price 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] | 0..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. | 0..1 | 380000 | |
@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. | |
@HistoricPricingDate | Specifies the historic date used to price this FareGroup. Date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
@ReissueOnly | Indicates that the fare was priced to reissue a partially flown ticket, i.e. the price does include already flown segments but is only associated to the unflown segments to be ticketed in the reissue process. Values are: Y/N | [Y] [N] | 0..1 | |
@FareNumber | Unique (for this response) identifier of fare priced. | 0..1 | ||
@PricingInfoID | Contains the position number of the PricingInfo element of the FlightPriceRQ request that this FareGroup belongs to. This is only relevant if multiple PricingInfo elements are used in the request, to be able to know which FareGroups are results for which FlightPriceRQ/PricingInfo. | 0..1 | If there are 2 PricingInfo elements in the FlightPriceRQ, then all FareGroups that are results for the 1st PricingInfo have the PricingInfoID=1. All FareGroups that are results for the 2nd PricingInfo have the PricingInfoID=2,... | |
@Availability | Availability status of the FareGroup. For BestPricing values L or LC it is possible that lowest possible fares are no longer available. To mark the fares with insufficient availability the Availability-attribute will be returned with N. If no Availability-attribute is returned the availability of the fare should be given. | [N] [Y] | 0..1 | N |
<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 being requested for pricing. If the passenger type sent by the GDS is not in the below predefined list, then it is shown as is. Predefined values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth | 1 | CHD | |
@TypePriced | Passenger type being priced. This type can be different from the type requested if there is no available fare for the requested type. For example the requested type is GOV and the priced type is ADT because there is no available fare for type GOV and there is an available fare for type ADT. If the passenger type sent by the GDS is not the below predefined list, then it is shown as is. Predefined values are: ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth | 1 | 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. | 1 | 200000 | |
<TravelerIDRef/> | Reference to a TravelerIDs in the corresponding request (by its @AssociationID value) | 0..N | T1 | |
<Price> | Price group | 1 | ||
@Total | Total Fare amount for the specified passenger type. Total price = base fare amount + taxes amount. | 1 | 300000 | |
<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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<FareRules> | Fare rules applicable for this fare and passenger type. All regular XX/1 provider adapters will always return exactly one FareRules element as the respective rules apply to the complete fare. Only 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. | 1..N | ||
<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 of the segment related to that FareInfo group. | 1 | 2002-12-25 | |
<DepartureCode/> | Departure airport or city code. | 1 | MIA | |
<ArrivalCode/> | Arrival airport or city code. | 1 | NYC | |
<RelatedSegment> | A FareInfo element refers to one or more Flight elements in the request. It has one RelatedSegment element for each Flight element it refers to. | 1..N | ||
@MarriedSegment | Indicates married segment. Values are: B= beginning of married segments group E = end of married segments group | [B] [E] | 0..1 | B |
<SegmentIDRef> | The value of the SegmentIDRef element is the relative position of the corresponding FlightPriceRQ/OriginDestination/Flight element among all Flight elements of the request in document order. | 1 | A value of 3 would refer to the third Flight element in the request (irrespective of grouping into OriginDestinations). | |
@FlightRefKey | Unique ID to bind request and response, allows to associate RQ and RS with an arbitrary values. If present in the FlightPriceRQ it must be returned in the FlightPriceRS | 0..1 | ||
</SegmentIDRef> | ||||
<Cabin/> | Cabin code. Possible 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 | |
<AirlineCode/> | Airline code. | 0..1 | AA | |
<DepartureDate/> | Fare info departure date. Indicates the departure date of the segment related to that FareInfo group. | 0..1 | 2002-12-25 | |
<DepartureCode/> | Departure airport or city code. | 0..1 | MIA | |
<ArrivalCode/> | Arrival airport or city code. | 0..1 | NYC | |
<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> | ||||
<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 | Y26CH | |
<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 | 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 | ||
@Amount | Individual surcharge amount. | 1 | 270 | |
@Segment | Segment number to which the surcharge applies. | 0..1 | 1 | |
<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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</FareComponent> | ||||
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<Discount> | The discount granted. | 0..1 | 20 | |
@Type | The type of discount. Values are P (for percentage) or A (for amount). | [A] [P] | 0..1 | P |
</Discount> | ||||
<TicketDesignator/> | Ticket designator code. | 0..1 | ATM1 | |
<AirlineCode/> | Airline code. | 1 | AA | |
<CorporateFares> | Corporate fares group | 0..N | ||
@Priced | Indicates whether this corporate fare information was actually used to price. Possible values are 'Y' for Yes and 'U' for Unknown. | [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> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Change> | Change penalty group | 0..N | ||
@Type | Determines whether penalty applies to reissues or revalidation RI = Reissue RV= Revalidation If attribute is not present, no information to which type of change the penalty applies is available. | 0..1 | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for changes. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..N | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for cancellation. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
<Failure> | Failure to confirm penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Failure> | ||||
<Replace> | Replacement penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Replace> | ||||
</Penalty> | ||||
<Restrictions> | Restrictions group showing if or not respective restrictions apply. | 0..1 | ||
@AdvancePurchase | AdvancePurchase indicates if the fare rules require the reservation for the flight segment(s) to be made within a specific time window relative to the departure of the first flight. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@AdvanceReservation | AdvanceReservation indicates if the fare rules require the ticket to be issued within a specific time window relative to the point in time when the reservation for the flight segment(s) was made. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@AdvanceDeparture | AdvanceDeparture indicates if the fare rules require the ticket to be issued within a specific time window relative to the departure of the first flight. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@MinimumStay | Indicates whether MinimumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@MaximumStay | Indicates whether MaximumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
</Restrictions> | ||||
<AdvancePurchase> | Advance purchase restrictions. The type is defined by the Advance Unit attribute. If for example this number is 3 and the unit is D, the advance purchase restriction is 3 days. | 0..2 | 3 | |
@Unit | Advance purchase restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvancePurchase> | ||||
<AdvanceTicketing> | Advance ticketing group | 0..1 | ||
<AdvanceReservation> | Advance ticketing reservation restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 24 and the unit is H and the permitted is latest (value L), that means that ticketing must be at the latest 24 hours after purchase. If permitted was on time (value O), the ticketing must be 24 hours after purchase. | 0..2 | 24 | |
@Unit | Advance ticketing reservation restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase ticketing restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceReservation> | ||||
<AdvanceDeparture> | Advance ticketing departure restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 14 and the unit is D and the permitted is latest (value L), that means that ticketing must be at the latest 14 days before the departure. If permitted was on time (value O), the ticketing must be 14 days before departure. | 0..2 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance ticketing departure restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceDeparture> | ||||
</AdvanceTicketing> | ||||
<MinimumStay> | Minimum stay rules group | 0..1 | ||
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MinimumStay> | ||||
<MaximumStay> | Maximum stay rules group | 0..1 | ||
@Application | Maximum Stay applicability. Possible values are: CP = Travel must be Completed before CC = Travel must Commence before | [CP] [CC] | 0..1 | CP |
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MaximumStay> | ||||
<PriceClassComments> | Description and remarks associated to a PriceClass returned in the Flight/PriceGroup element, e.g. TANGO | 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 | |
<Text/> | Describing the highlights of the PriceClass. | 0..N | ||
</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> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Change> | Change penalty group | 0..N | ||
@Type | Determines whether penalty applies to reissues or revalidation RI = Reissue RV= Revalidation If attribute is not present, no information to which type of change the penalty applies is available. | 0..1 | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for changes. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..N | ||
@Application | Penalty application type. Values: AFTER_DEP = After departure (passenger has flown his first flight) AFTER_DEP_NS = No show after departure of first flight segment (passenger has flown his first flight but missed subsequent) NO_SHOW = No show (general) PRIOR_DEP = Prior to departure (first flight not yet departed) PRIOR_DEP_NS = No show before departure (passenger missed his first flight) NO_SHOW_PRIOR_DEP = check-in not done NO_SHOW_AFTER_DEP = check-in done, boarding not done | [AFTER_DEP] [AFTER_DEP_NS] [NO_SHOW] [PRIOR_DEP] [PRIOR_DEP_NS] [NO_SHOW_PRIOR_DEP] [NO_SHOW_AFTER_DEP] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
@Allowed | Determines whether changes are allowed for the situation defined by Type and Application attributes. Values: Y = Allowed without restrictions R = Allowed with restrictions N = Not allowed | [Y] [R] [N] | 0..1 | |
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Date/> | Date restriction for cancellation. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes on Penalty group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
<Failure> | Failure to confirm penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Failure> | ||||
<Replace> | Replacement penalty group | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..3 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] [MAXTKT] | 0..1 | MIN = Minimum penalty amount MAX = Maximum penalty amount MAXTKT = Maximum penalty amount for the entire ticket. Equal across all FareInfo elements, but only applicable once per transaction. |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</Replace> | ||||
</Penalty> | ||||
<Restrictions> | Restrictions group showing if or not respective restrictions apply. | 0..1 | ||
@AdvancePurchase | AdvancePurchase indicates if the fare rules require the reservation for the flight segment(s) to be made within a specific time window relative to the departure of the first flight. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@AdvanceReservation | AdvanceReservation indicates if the fare rules require the ticket to be issued within a specific time window relative to the point in time when the reservation for the flight segment(s) was made. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@AdvanceDeparture | AdvanceDeparture indicates if the fare rules require the ticket to be issued within a specific time window relative to the departure of the first flight. Values are: Y = Yes N = No | [Y] [N] | 0..1 | Y |
@MinimumStay | Indicates whether MinimumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@MaximumStay | Indicates whether MaximumStay restrictions apply. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
</Restrictions> | ||||
<AdvancePurchase> | Advance purchase restrictions. The type is defined by the Advance Unit attribute. If for example this number is 3 and the unit is D, the advance purchase restriction is 3 days. | 0..1 | 3 | |
@Unit | Advance purchase restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvancePurchase> | ||||
<AdvanceTicketing> | Advance ticketing group | 0..1 | ||
<AdvanceReservation> | Advance ticketing reservation restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 24 and the unit is H and the permitted is latest (value L), that means that ticketing must be at the latest 24 hours after purchase. If permitted was on time (value O), the ticketing must be 24 hours after purchase. | 0..2 | 24 | |
@Unit | Advance ticketing reservation restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance purchase ticketing restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceReservation> | ||||
<AdvanceDeparture> | Advance ticketing departure restrictions. The type is defined by the Unit and Permitted attributes. If for example this number is 14 and the unit is D and the permitted is latest (value L), that means that ticketing must be at the latest 14 days before the departure. If permitted was on time (value O), the ticketing must be 14 days before departure. | 0..2 | 14 | |
@Unit | Advance ticketing departure restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
@Permitted | Advance ticketing departure restriction permitted attribute. Possible values are: L = Latest E = Earliest O = On time | [L] [E] [O] | 1 | L |
</AdvanceDeparture> | ||||
</AdvanceTicketing> | ||||
<MinimumStay> | Minimum stay rules group | 0..1 | ||
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MinimumStay> | ||||
<MaximumStay> | Maximum stay rules group | 0..1 | ||
@Application | Maximum Stay applicability. Possible values are: CP = Travel must be Completed before CC = Travel must Commence before | [CP] [CC] | 0..1 | CP |
<Value> | Minimum or maximum stay value. The type of value is defined by the value Unit attribute. If for example this number is 7 and the unit is D, the minimum (or maximum) stay is 7 days. | 0..1 | 7 | |
@Unit | Minimum or maximum stay restriction value unit. Possible values are: H = Hours D = Days M = Months F = Full Date in ISO 8601 format (yyyy-mm-dd). | [H] [D] [M] [F] | 1 | H |
</Value> | ||||
<DayOfWeek> | Minimum or maximum stay in days of week. If for example this value is 1 and the attribute Days is 7 this means that the minimum (or maximum) stay is 1 Sunday. | 0..1 | 1 | |
@Day | Minimum or maximum stay day of the week. The number of days is in the element DaysOfWeek. Possible values are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | [1] [2] [3] [4] [5] [6] [7] | 1 | 1 |
</DayOfWeek> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</MaximumStay> | ||||
<TicketByDate> | Ticket by date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2002-12-25 | |
@Time | Time in ISO 8601 format. | 0..1 | 12:35 or 19:45 | |
</TicketByDate> | ||||
<Remark/> | Fare rules miscellaneous remarks. | 0..N | See fare rules | |
<Endorsement> | Fare endorsements. | 0..N | NONREF | |
<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> | ||||
<FeeGroup> | Fees claimed for all services charged with this Ticket. | 0..1 | ||
@Amount | Total fee amount for the Fare | 1 | 200000 | |
<Fee> | 1..N | |||
@ServiceCode | Additional unique ATPCO code. Please refer to FLX Codeset document for acceptable values. | 0..1 | OC | |
@SubCode | ATPCO RFISC (ReasonForIssuance Subcode). Example of RFISC: 0CC | 0..1 | ||
@Refundable | Indicates if fee is refundable. Values are: Y = Fee refundable N = Fee not refundable. If attribute is not there then default is Y. | 0..1 | ||
<Amount/> | Fee amount. | 1 | 2000 | |
<Description/> | Title description (Commercial Name) of Fee. | 0..1 | "Credit Card Fee" | |
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
</Fee> | ||||
</FeeGroup> | ||||
</TravelerGroup> | ||||
<OptionalServices> | Services that have been purchased individually and that were not included in the ticket fare and that will be charged for by the carrier. | 0..1 | ||
<Service> | Service Details | 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) "Fee Formula" 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] [Fee Formula] | 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 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</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 | 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) "Fee Formula" 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] [Fee Formula] | 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 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</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. All regular XX/1 provider adapters will always return one ValidatingCarrier element at the most. Only the Pass SuperPNR component may return two ValidatingCarrier elements per TravelerGroup and only for FareGroups created by merging two one-way fares. This is necessary as the validating carrier may differ for the two one-way fares. Only in this case SegmentIDRef child elements will be returned to specify to which segments each ValidatingCarrier element refers. | 0..N | ||
<AirlineCode/> | Airline code. | 1 | AA | |
<SegmentIDRef/> | If SegmentIDRef elements are returned, the ValidatingCarrier element only refers to the respective segments. If no SegmentIDRef elments are returned, the ValidatingCarrier element refers to all segments. The value of the SegmentIDRef element is the relative position of the corresponding FlightPriceRQ/OriginDestination/Flight element among all Flight elements of the request in document order. | 0..N | A value of 3 would refer to the third Flight element in the request (irrespective of grouping into OriginDestinations). | |
<AlternateAirlineCode/> | Airline code of alternate validating carriers. | 0..N | AA | |
</ValidatingCarrier> | ||||
</FareGroup> | ||||
<OptionalServices> | This node is returned when merchandizing options are available for any of the selected flights. Only returned if FlightPriceRQ/PricingInfo/@RequestOptions=Y. | 0..N | ||
@FareGroupID | Contains the FareNumber of the FareGroup element that this OptionalServices element belongs to. This is only relevant if multiple FareGroups are returned in FlightPriceRS, to be able to know which Services can be booked for which Fare. | 0..1 | ||
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Images> | contains any images used for the services offered | 0..1 | ||
<Image> | Image in base64 code | 1..N | ||
@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. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
@Caption | The caption used for this image | 0..1 | ||
</Image> | ||||
<Media> | Image or media available at an URL | 1..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
<Preview> | Preview of the referenced media content (e.g. thumbnail of the picture). | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
</Preview> | ||||
<Description> | Media content description (e.g. exterior view). | 0..1 | ||
@Type | OTA code type. PIC .. Content Code | [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 3 | |
@Description | OTA code name. | 0..1 | Pool view | |
</Description> | ||||
<Caption/> | Title for the media. | 0..1 | Exterior | |
@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. | 1 | ||
@SubCode | ATPCO RFIS (ReasonForIssuance Subcode). Example of RFIS: 0CC | 1 | ||
</Media> | ||||
</Images> | ||||
<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 FlightPriceRQ/TravelerIDs element referencing the FlightPriceRQ/TravelerIDs/@AssociationID in the TravelerIDRef. If the service can be booked per segment, the service will be displayed separate for each segment. If the service can only be booked per OriginDestination, the service will be displayed separate for each OriginDestination. In both cases SegmentIDRef elements will indicate to which Flights the Service pertains. The value of a SegmentIDRef element is the relative position of the corresponding FlightPriceRQ/OriginDestination/Flight element among all Flight elements of the request in document order. | 1..N | A value of 3 would refer to the third Flight element in the request (irrespective of grouping into OriginDestinations). | |
@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) "Fee Formula" 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] [Fee Formula] | 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 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..1 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 1 | M |
</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 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | Segment departure or arrival airport code. | 1 | JFK | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</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> | ||||
</FlightPriceRS> |
| 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