FareInformation response message

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.

NodeDescriptionValuesOccursExample
<FareInformationRS>
Request root element1
@version
Version number. 0..1 1.0
@Lang
ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'.0..1
<InfoGroup>
Error and information group0..1
<ForInfo>
Information group0..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 group0..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>
<FareFamily>
1..N
<AirlineCode/>
Airline code. 1 AA
<PriceClassComments>
Description and remarks associated to a PriceClass.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>
<Departure>
Departure group0..1
<CityCode/>
City code. 0..1 MIA
<Date/>
Date in ISO 8601format (yyyy-mm-dd). 0..1 2002-02-22
</Departure>
<Arrival>
Arrival group0..1
<CityCode/>
City code. 0..1 MIA
</Arrival>
<IncludedServices>
Services that are included in the ticket fare, or free of charge due to the frequent flyer status of a traveler.0..1
<Service>
Service Details

If the service can only be booked for the complete booking, no SegmentIDRef and no TravelerIDRef are returned.

If the service can be booked per traveler, the service will be displayed for each FareSearchRQ/TravelerIDs element referencing the FareSearchRQ/TravelerIDs/@AssociationID in the TravelerIDRef.

If the service can be booked per segment, the service will be displayed separate for each segment, specifying the position of the segment in the SegmentIDRef as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef.

If the service can only be booked per OriginDestination, the service will be displayed separate for each OriginDestination, specifying the positions of the segments in multiple SegmentIDRef elements as defined in /FareSearchRS/FareGroup/TravelerGroup/FareRules/FareInfo/RelatedSegment/SegmentIDRef.



0..N
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@Method
Values are:

F = FareIntegrated
EA = EMD Associated
ES = EMD Standalone
MA = Flight Associated but settled via MCO
MS = Standalone but settle via MCO
D = DirectSettlement
[F] [EA] [MA] [ES] [MS] [D] 1
@Airline
This is the airline code of the Marketing carrier, the carrier actually offering the service.
1
@TypeValue
EMD Type Value as defined by ATPCO

1 = Standalone
2 = Associated to a flight
3 = Standalone associated to a ticket (but not flight)
4 = no EMD, carrier directed type
5 = E-Ticket
0..1
@SaleStatus
Allowed Values:

"Offered"
"Pending"
"Booked"
"Issued"
"Canceled"


"Issued" represents those services which have been issued and have a valid EMDInfo node

"Booked" represent items sold/booked but not yet issued

Values are returned in the response
[Offered] [Booked] [Issued] [Pending] [Canceled] 0..1
@ServiceType
The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)':

F = Flight (TypeValue=2)
R = Rule Buster (Type Value = 5)
T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other)
M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other)
0..1
@ReasonCode
IATA RFIC (ReasonFor IssuanceCode, a 1-character main code)
Example of RFIC: A

Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs.

A = Air Transportation
B = Surface Transportation/Non Air services
C = Baggage
D = Financial Impact
E = Airport Services
F = Merchandise
G = in-flight Services
I = Individual Airline Use
1
@SubCode
ATPCO RFIS (ReasonForIssuance Subcode).
Example of RFIS: 0CC
1
@ServiceCode
Additional unique ATPCO code.
0..1 OC
@FareBrand
Service is part of a bundle associated to this fare brand0..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 promotion0..1
@Type
Indicator if this option is a discount or a surcharge;

Values are:
"Discount" 1)
"Surcharge"
"Included" 2)
"Not applicable" 3)

1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution)

2) This item is free of charge due to FQTV status or chosen Price Class

3) This item is not available/applicable due to FQTV status or chosen Price Class.

Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler.
[Discount] [Surcharge] [Included] [Not applicable] 1
@FQTVAirline
The 2-character airline code of the Frequent Flyer membership

0..1 AA
@FQTVStatus
The status (tier level) of the traveler's FQTV account.

This is available as a query results against the airline's FQTV database.

Samples:
AA(American AAdvantage):
-- Gold
-- Platinum
-- Executive Platinum

LH (Miles and More):
-- Frequent Traveller
-- Senator
-- HON Circle

EK (Emirates Skywards):
-- Silver
-- Gold
0..1
@FQTVNumber
This is the actual FrequentFlyer number associated to the FQTVStatus. This will allow the POS GUI to associate the actual traveler with the respective option/price0..1
@NotValidBefore
Option is not available/usable until the date entered0..1
@NotValidAfter
Option is not available/usable after the date entered0..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
<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 service0..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 Service1
@Amount
Net price of service
1 6750
</BasePrice>
<Taxes>
Tax Group0..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 mandatory0..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 Option1
@Amount
Net price of option.
1 6750
</BasePrice>
<Taxes>
Tax Group0..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/>
Ticket by date in ISO 8601 format (yyyy-mm-dd). 0..1 2001-12-25
<Penalties>
Option Penalty group0..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 group1
@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 amount0..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..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 group0..1
@Amount
Total taxes amount. 1 30000
<Tax>
Tax break down information group0..N
@Amount
Individual tax amount. 1 2500
<Designator/>
Tax or surcharge designator. 0..1 US
<Nature/>
Tax nature. 0..1 US2
<Description/>
Tax or surcharge description. 0..1 US national transportation
<CollectionPoint>
For XF and ZP taxes.
Tax data break down for each collection point.

The sum of individual amounts entered here must be equal to the Amount entered in the Tax element.
0..N
@Amount
Individual amount for collection point.
0..1 2500
<CurrencyCode>
Currency code. 0..1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<AirportAmount/>
The amount actually filed by the airport in the currency applicable to the geographical location of the airport.0..1
<AirportCode/>
Segment departure or arrival airport code. 1 JFK
</CollectionPoint>
</Tax>
</Taxes>
</Change>
<Cancel>
Cancel penalty group1
@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 amount0..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..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 group0..1
@Amount
Total taxes amount. 1 30000
<Tax>
Tax break down information group0..N
@Amount
Individual tax amount. 1 2500
<Designator/>
Tax or surcharge designator. 0..1 US
<Nature/>
Tax nature. 0..1 US2
<Description/>
Tax or surcharge description. 0..1 US national transportation
<CollectionPoint>
For XF and ZP taxes.
Tax data break down for each collection point.

The sum of individual amounts entered here must be equal to the Amount entered in the Tax element.
0..N
@Amount
Individual amount for collection point.
0..1 2500
<CurrencyCode>
Currency code. 0..1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<AirportAmount/>
The amount actually filed by the airport in the currency applicable to the geographical location of the airport.0..1
<AirportCode/>
Segment departure or arrival airport code. 1 JFK
</CollectionPoint>
</Tax>
</Taxes>
</Cancel>
</Penalties>
<Commission>
Commission amount or percentage for this option0..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 attributes0..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 source0..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 book0..1
</UpgradeMethod>
<Text/>
Any freeflow to instruct DC0..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>
</FareFamily>
</FareInformationRS>

Legend

ColumnDescription
NodeName 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.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum 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.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server