AirAvailability request 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
<AirAvailabilityRQ>
Air availability request root element1
@version
Version number. 0..1 1.0
@ScheduleOnly
Schedule only indicator. Values are: Y = get flight schedules without availability, N = get flight schedules and availability. [Y] [N] 0..1 Y
@NumberOfAlternates
Maximum number of Flight elements to be returned in the response for each OriginDestination (O/D).

The service will collect flights for each O/D until this number is reached or the provider returns no more flights (whatever happens first). The resulting set of flights per O/D 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 max. number of requested flights per O/D or 'ALL' to retrieve all of them.

0..1 10
<NumberInParty/>
Number of passengers. The element specifies the lower limit of available seats in a class for the class to be displayed in the response (supported only by Amadeus). [0] to [9]0..1 1
<OriginDestination>
Origin and destination group

Either departure OR arrival date must be specified. Only some CRS support search by both.
1..N
<Departure>
Origin departure group1
<CityCode/>
Departure or arrival city code. 1 MIA
<Date/>
Departure date in ISO 8601 format (YYYY-MM-DD). 0..1 2001-11-30
</Departure>
<Arrival>
Destination group1
<CityCode/>
Departure or arrival city code. 1 MIA
<Date/>
Arrival date in ISO 8601 format (YYYY-MM-DD). 0..1 2001-11-30
</Arrival>
<Preferences>
Preferences group0..1
@Sort
Indicates how the response should be sorted. Values are:
DEPARTURE = by departure time
ARRIVAL = by arrival time
ELAPSED = by elapsed time

NEUTRAL = as defined by the provider
[DEPARTURE] [ARRIVAL] [ELAPSED] [NEUTRAL] 0..1 DEPARTURE
@MultiAirport
In case a city code refers to a multi-airport city and one of the cities airports at the same time, the search will include all airports belonging to the city when set to "Y".

Values are: Y = Yes, N = No.
[Y] [N] 0..1 N
<ClassOfService/>
Class of service. 1 B
<Cabin/>
Specifies cabin preference. Valid 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] 1 F
<Time>
1
</Time>
<TimeWindow>
Time window group0..1
<HoursBefore/>
Number of hours before the Time specified.

Values: 0-24

If left out, defaults to zero.

[0] to [24]0..1 3
<HoursAfter/>
Number of hours afterthe Time specified.

Values: 0-24

If left out, defaults to zero.

[0] to [24]0..1 3
<HoursTotal/>
Specifies the total number of hours the journey is not to exceed. Value from 01-24. [01] to [24]0..1 11
</TimeWindow>
<Airline>
Airline preference group0..1
<Include/>
Airline code.
Include specified carriers only, but no interline connections with other carriers.
1..3 AA
<Exclude/>
Airline code.
Excludes designated vendors
1..3 AA
<Biased/>
Airline code.
Include designated vendors and interline connections with other vendors
1 AA
</Airline>
<Connection>
Connection preference group0..1
<Include/>
Airpory/city code. 1..3 LHR
<Exclude/>
Airport/City Code. 1..2 NYC
</Connection>
<FlightSpecific>
Flight specific search criteria 0..4
<AirlineCode/>
Airline code. 1 AA
<FlightNumber>
Flight number - an integer value within the range of [0,9999].

1 1234
@Suffix
Flight number alpha qualifier.
Values are:
A
B
C
D

[A] [B] [C] [D] 0..1 A
</FlightNumber>
</FlightSpecific>
<AllianceCode/>
Search by alliance code. Values are: *O = One World
*A = Star Alliance
*S = Sky Team.

0..1 *S
<FlightType>
Specifies the flight type preferences. If absent, get all flights. Maxi value in attributes means all below level are taken into account.0..1
@NoStopDirect
Non-stop direct flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@StopDirect
Stop direct flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 M
@OneConnectSingleAirline
Single online connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@TwoConnectSingleAirline
Double online connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@ThreeConnectSingleAirline
Triple online connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@OneConnectMultipleAirline
Single interline connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@TwoConnectMultipleAirline
Double interline connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
@ThreeConnectMultipleAirline
Triple interline connection flights. Values are: Y = Yes, M = Maximum. [Y] [M] 0..1 Y
</FlightType>
<DayWindow>
Day window group0..2
@Type
attribute indicates type of day window, possible values are DEPARTURE and ARRIVAL; default value is DEPARTURE[DEPARTURE] [ARRIVAL] 0..1
<DaysBefore/>
Number of days before departure. Value from 01-10. [0] to [3]1 03
<DaysAfter/>
Number of days after departure. Value from 01-10. [0] to [3]1 02
</DayWindow>
</Preferences>
</OriginDestination>
<DirectAccess>
Direct access group information.0..1
<AirlineCode/>
Airline code. 1 AA
<AppendText/>
Text to append to the direct access command. 0..1 /T
</DirectAccess>
<MoreFlightsToken/>
Token used to request more flights following a previous air availability response. This token number is sent back in the previous air availability response while in other cases it could contain the Y (yes) or N (no) indicator.
If specifying this element, the behaviour is only defined if working in a sessioned environment and the preceding AirAvailabilityRQ only contained a single OriginDestination element.
1 124523467899 or Y
</AirAvailabilityRQ>

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