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 |
|---|---|---|---|---|
<FareQuoteRQ> | Fare quote request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@NumberOfAlternates | Maximum number of options requested. The service will collect options until this number is reached or the provider returns no more options (whatever happens first). The resulting set of options will be returned to the client. CAUTION: Depending on the value this can be a time consuming transaction! Values are: Either a positive integer value identifying the number of requested options or 'ALL' to retrieve all of them. | 0..1 | ||
@QueryID | Optional, alphanumeric. Used only for internal tracking purposes. | 0..1 | ||
@DetailedFareType | Controls display of more detailed fare type info (only Amadeus for now, information is not returned by all GDS): in case this attribute is set to 'Y' more detailed fare types will be displayed in the response; default value is 'N' which results in fare types PUBL or NEGO; (possible values are Y, N) | [Y] [N] | 0..1 | |
<OriginDestination> | Origin and Destination group | 1 | ||
<DepartureDate/> | Departure date in ISO 8601 format. | 1 | 2001-12-25 Search for fares applicaple to exactly this outbound departure date. | |
<ReturnDate> | Return date in ISO 8601 format. | 0..1 | 2001-12-31 Search for fares applicaple to exactly this return travel date (and the outbound departure date ). | |
</ReturnDate> | ||||
<DepartureDateRange> | Departure date range group. Search for fares for a range of outbound departure dates. | 1 | ||
<StartDate/> | Start date in ISO 8601 format. | 1 | 2001-12-25 | |
<EndDate/> | End date in ISO 8601 format. | 1 | 2001-12-31 | |
</DepartureDateRange> | ||||
<DepartureCityCode/> | Departure city code. | 1 | YYZ | |
<ArrivalCityCode/> | Arrival city code. | 1 | YVR | |
<FareType/> | Type of fare. Values are: PUBL = published fare NEGO = negotiated/private fare BOTH = published and negotiated fares | [PUBL] [NEGO] [BOTH] | 0..1 | NEGO |
<TripType/> | Type of trip. Values are: O = return one way fares only R = return round trip fares only CT = return circle trip fares only RW = return round the world fares only | 0..1 | O If left out, one way and round trip fares are returned. | |
<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 | |
</OriginDestination> | ||||
<FareOptions> | Fare quote options group | 0..1 | ||
<AirlineCode/> | Restrict search to a specific airline specified by AirlineCode. Multiple airline codes can be entered. The number of permitted codes may vary depending on GDS. | 1..N | AC | |
<BookingCode/> | Restrict search to the specified airline and additionally to the booking class of service specified by BookingCode. | 0..1 | Y | |
<PrivateFares> | Negotiated fares (Private fares) group (multiple PrivateFares elements are only supported in multi-source environments where one PrivateFares element can be specified per source). | 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. | |
<Office> | Pseudo city under which private fares are stored. | 1..N | 18C6 | |
</Office> | ||||
<Corporate> | Corporate info group | 0..N | ||
<Account> | Specifies the corporate account number to use to price private fares. | 0..1 | PASS | |
@Code | Requests Account Code fares. Values are: Y = Request Account Code only Fares N = Request Account Code and Published Fares | [Y] [N] | 0..1 | Y |
</Account> | ||||
<Contract/> | Specifies the contract code, to use to price private fares. | 0..1 | 00001 | |
</Corporate> | ||||
</PrivateFares> | ||||
<FareQualifier/> | Fare qualifier. | 0..3 | PL | |
<Cabin/> | Cabin 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 | |
<CurrencyCode> | Desired currency code. | 0..1 | USD | |
</CurrencyCode> | ||||
<TaxInclude/> | Indicates if tax is included in the rate returned. Values are: Y = return fares including taxes, N = return fares without taxes. | [Y] [N] | 0..1 | N |
<Restrictions> | Fare Restrictions for mimimum/maximum stay, advance purchase and penalties. | 0..1 | ||
@ExcludeAll | This attribute also excludes restrictions which are not covered by the other attributes. Y = Excludes all fares with any kind of restriction (other attributes have no effect) N = Don't exclude all fares with any kind of restriction (other attributes can be used to allow further restrictions) Default: N | [Y] [N] | 0..1 | |
@MinimumStay | Y = Allow Minimum stay with fare N = Don't Allow Minimum stay with fare Default: Y | [Y] [N] | 0..1 | |
@MaximumStay | Y = Allow Maximum stay with fare N = Don't Allow Maximum stay with fare Default: Y | [Y] [N] | 0..1 | |
@Advance | Y = Allow Advance Purchase with fare N = Don't Allow advance Purchase with fare Default: Y | [Y] [N] | 0..1 | |
@Penalty | Y = Allow Penalties with fare N = Don't Allow penalties with fare Default: Y | [Y] [N] | 0..1 | |
@Refundable | Y = Return refundable fares only N = Return non-refundable fares only Default: If not defined mixed results can be returned, depending on the other Restriction settings. | [Y] [N] | 0..1 | |
</Restrictions> | ||||
<TravelerInfo> | Traveler type for which fare quotes will be requested. | 0..4 | ||
@Type | Passenger type requested for pricing. If the passenger type sent to the GDS is not in the below predefined list, then it is passed as is to the GDS. Predefined values are : ADT= Adult CHD = Child INF = Infant GOV = Government MIL = Military SRC = Senior citizen STD = Student YTH = Youth | 1 | CHD | |
</TravelerInfo> | ||||
<ClassOfService/> | Class of service. | 0..1 | B | |
</FareOptions> | ||||
<HistoricalPricingInfo> | Historical pricing group. Required if OriginDestination group includes past date segments. | 0..1 | ||
<ReservationDateTime> | This timestamp indetifies when PNR was created client application requests historical pricing for. | 0..1 | ||
<Date/> | Specifies departure or arrival date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<Time/> | Departure or arrival time in ISO 8601 twenty-four hour clock format. | 0..1 | 14:00 | |
</ReservationDateTime> | ||||
<TicketedDateTime> | Timestamp of ticket issuance for past date segments in OriginDestination section. | 1 | ||
<Date/> | Specifies departure or arrival date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<Time/> | Departure or arrival time in ISO 8601 twenty-four hour clock format. | 0..1 | 14:00 | |
</TicketedDateTime> | ||||
</HistoricalPricingInfo> | ||||
</FareQuoteRQ> |
| 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