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 |
|---|---|---|---|---|
<FareQuoteRS> | Fare quote 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> | ||||
<Header> | Header group information (multiple Header elements will only occur in multi-source environments where one Header will be returned per source). | 1..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. | |
<OriginDestination> | Origin and Destination group | 1 | ||
<DepartureDate/> | Departure date in ISO 8601 format. | 1 | 2001-12-25 | |
<DepartureCityCode/> | Departure city code. | 1 | YYZ | |
<DepartureCityName/> | Departure or arrival airport name. | 0..1 | Munich, DE | |
<ArrivalCityCode/> | Arrival city code. | 1 | YVR | |
<ArrivalCityName/> | Departure airport name. | 0..1 | Miami, FL, US | |
<ReturnDate/> | Return date in ISO 8601 format. | 0..1 | 2001-12-31 | |
</OriginDestination> | ||||
<SpecificAirlineCode/> | Specific carrier searched for the fare quote. Example. AC | 0..1 | ||
<CarriersInMarket> | List of all other carriers in the market group | 1 | ||
<AirlineCode/> | Airline code. | 1..N | UA | |
</CarriersInMarket> | ||||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AlternateCurrencyCode> | Currency code of the carrier. | 0..1 | EUR | |
@NumberOfDecimals | Number of decimals in the specified currency. | 1 | 2 | |
</AlternateCurrencyCode> | ||||
<Information> | Information group containing message text | 0..1 | ||
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</Information> | ||||
<MPM> | maximum permitted mileage | 0..N | ||
@GlobalIndicator | Global directional indicator. IATA Global indicators are two-letter direction codes identifying the type of routing flown based on the area/sub-area locations of the terminal points and via points of such routing. | 0..1 | WH, AT | |
</MPM> | ||||
</Header> | ||||
<Fares> | Fares group | 0..N | ||
@FareType | Type of fare being returned. Values are: PUBL = published fare NEGO = negotiated/private fare UNDF = undefined, the type of fare is unknown 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 AMADEUS: Amadeus introduced so called Web Fares types in Mar 2010. These types will identify the type as Web for the following carriers AA, AS, CO, DL, NW, UA, US. Such fares will be displayed in XX/1 responses with WEB suffix appended to the fare type. For instance: CDDFWEB. | [NEGO] [PUBL] [UNDF] [A35F] [CA35] [CNFR] [DDFR] [A15F] [CA15] [CDDF] [NEGOWEB] [CNFRWEB] [DDFRWEB] [CDDFWEB] [A35FWEB] [A15FWEB] [CA15WEB] | 1 | NEGO |
@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. | |
<ElementNumber/> | ElementNumber or LineNumber | 0..1 | 01 | |
<FareBasisCode/> | Fare basis code. | 1 | J1 | |
<FareRefKey/> | Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ. | 0..1 | ||
<BaseFareAmount/> | Base fare amount. | 1 | 179800 | |
<AlternateBaseFareAmount/> | Base fare amount in alternate currency. | 0..1 | 192000 | |
<BookingClass/> | Booking class related to the fare basis code. | 1 | J | |
<AirlineCode/> | Airline code. | 1 | UA | |
<AirlineName/> | Airline name. | 0..1 | Delta Air | |
<Cabin/> | Cabin associated to the booking class. Values are: P = Premium First class F = First class J = Premium Business class C = Business class W = Premium Economy class Y = Coach class | 0..1 | Y | |
<TripType/> | Type of trip. Values are: O = One way only, directional fare R = Round trip fare, X = One way fare, A = Limited validity fare, CT = Circle trip fare, RW = Round the world fare | 0..1 | R | |
<RoutingNumber/> | Fare routing number. | 0..1 | 2 | |
<Rules> | Rules group attached to the fare basis code | 1 | ||
<Category/> | Fare rule category associated with the fare basis code. Values are: AP = ADVANCE PURCHASE BC = BOOKING CODE BK = BLACKOUTS CB = COMBINATIONS CT = CO-TERMINALS DC = DISCOUNTS DP = DEPOSIT DT = DAY/TIME ED = EFF/EXP DATES FA = FLT APPLICATION FR = FARE BY RULE GR = GROUP IC = INTL CONST MS = MISCELLANEOUS NG = NEGOTIATED FARES NS = MINIMUM STAY OR = OPEN RETURN PN = PENALTY RF = REFUNDS RO = ROUTINGS RR = REROUTE RT = RES/TKTG SG = SURCHARGES SN = SEASON SO = STOPOVERS SP = SPCL PROV TF = TRANSFERS TO = TOUR TR = TKT RESTRICTIONS XS = MAXIMUM STAY - | [AP] [BC] [BK] [CB] [CT] [DC] [DP] [DT] [ED] [FA] [FR] [GR] [IC] [MS] [NG] [NS] [OR] [PN] [RF] [RO] [RR] [RT] [SG] [SN] [SO] [SP] [TF] [TO] [TR] [XS] | 0..N | NG |
<AdvancePurchase> | Advance purchase information either in days or months. If Unit = X (more than one restriction applies), this element will be empty. | 0..1 | 14 | |
@Unit | Advance purchase unit. Values are: H = advance purchase in hours N = advance purchase in minutes D = advance purchase is in days M = advance purchase is in months X = more than one advance purchase restriction applies. | [H] [N] [D] [M] [X] | 1 | D |
@CheckFareRules | X = more than one advance purchase restriction applies, please check FareRules | [X] | 0..1 | |
</AdvancePurchase> | ||||
<MinimumStay> | Minimum stay. The value is either the number of days, a week day number, a month or empty(when Unit = X), depending on the Unit value. Week days are: 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday. | 0..1 | 1 | |
@Unit | Unit used for MinimumStay information. Values are: H = minimum stay is in hours D = minimum stay is in days W = minimum week day stay M = minimum stay is in months X = more than one minimum stay restriction applies. | [H] [D] [W] [M] [X] | 1 | D |
@CheckFareRules | X = more than one minimum stay restriction applies, please check FareRules | [X] | 0..1 | |
</MinimumStay> | ||||
<MaximumStay> | Maximum stay is in days, in months or empty (when Unit=X), depending on the attribute Unit. | 0..1 | 30 | |
@Unit | Unit used for MinimumStay information. Values are: H = maximum stay is in hours D = maximum stay is in days W = maximum week day stay M = maximum stay is in months X = more than one maximum stay restriction applies. | [H] [D] [W] [M] [X] | 1 | D |
@CheckFareRules | X = more than one maximum stay restriction applies, please check FareRules | [X] | 0..1 | |
</MaximumStay> | ||||
<Penalty> | Penalty indicator. May be amount, GDS defined code or text. | 0..1 | ||
@Amount | Normalized amount according to NumberOfDecimals or percentage value. | 0..1 | ||
@CheckFareRules | X = more than one penalty applies, please check FareRules | [X] | 0..1 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage. | [M] [P] | 0..1 | M |
</Penalty> | ||||
<ApplicationDate> | 0..N | |||
@ApplicationCode | A = Ticket After B = Ticket Before T = Travel Commencement Date C = Travel completion date (travel to be completed before this date) E = Effective date (first date travel can begin) F = Discontinue date (last date travel can begin) S = Season restrictions R = Blackout Date(s) ( = Seasonal codes apply to inbound travel. ) = Seasonal codes apply to outbound travel | [A] [B] [C] [E] [F] [R] [S] [T] [(] [)] | 0..1 | |
</ApplicationDate> | ||||
<Frequency/> | This indicates which days of the week the flight operates on- i.e. 1234567, 123, 467 1 = Monday 2 = Tuesday 3 = Wednesday 4 = Thursday 5 = Friday 6 = Saturday 7 = Sunday | 0..1 | 13456 | |
</Rules> | ||||
<GlobalIndicator/> | Global directional indicator. IATA Global indicators are two-letter direction codes identifying the type of routing flown based on the area/sub-area locations of the terminal points and via points of such routing. | 0..1 | WH, AT | |
<TravelerInfo> | Traveler (passenger) type this fare is associated with. See Type attribute. Example,: ADT, JCB, CHD | 0..1 | ||
@Type | 1 | |||
</TravelerInfo> | ||||
</Fares> | ||||
</FareQuoteRS> |
| 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