Level

Name

Type

Multiplicity

Description

/flights

/flights{id}

Remarks

0

errors

array

0..n

 List of errors

1

code

string

0..1

1

name

string 

0..1

1

description

string

0..1

1

severity

string

0..1

ERROR, WARNING or INFO

0

operationalFlights

array

0..n

1

flightNumber

number

1

Flight Number.

Example :1001

1

operationalSuffix

string

0..1

A code assigned by the administrating carrier for operational purposes.

Example : D,U,V,W

1

flightScheduleDate

string

1

The UTC date of the scheduled aircraft departure from the origin(head) station of flight.

Example : 2018-05-23

1

id

string

1

Identification of the flight: flightScheduleDate+AirlineCode+FlightNumber+operationalSuffix

Example : "20170803+KL+1644"

1

haul

string

0..1

LONG,MEDIUM

For AF flights haul type is not reliable information as its not coming from owner source who owns it.

1

route

array

1..n

complete route of the flight.

Example : AMS SIN DPS

1

airline

object

0..1

2

code

string

0..1

2-pos IATA airline code or 3-pos ICAO code

2

name

string

0..1

Full name of the operating airline

1

codeShareRelations

array

0..10

2

marketingFlightNumber

number

1

The Flight number that the code share partner uses on the operational flight.

Example :6698

2

operationalSuffix

string

0..1

 A code assigned by the administrating carrier for operational purposes.

2

flightScheduleDate

string

0..1

The UTC date of the scheduled aircraft departure from the origin(head) station of flight.

2

type

string

0..1

Indicates if the code-share partnership is valid for passengers or for freight.

Example : Passenger,Freight

2

code

string

0..1

Indicates code share Type if free flow or block seats.Possible marketing agreement codes: free flow (F), block-seats (B).

2

airline

array

1

3

code

string

0..1

2-pos IATA airline code or 3-pos ICAO code

3

name

string

0..1

Full name of Airline

1

flightStatusPublic

string

0..1

Flight status for public (Apps for customer and public) consumer which denotes state of flight.

Translation of 'flightStatusPublic' field in consumer requested language.

Eg. Translation for 'ON_TIME' status in "Dutch (nl)" language is "Op tijd"

NOTE: If translation is not available for requested language, then default language for translation is : English <<en>>

1

flightRelations

object

0..1

2

equivalentFlightData

object

0..1

3

id

string

0..1

Identification of the flight: flightScheduleDate+AirlineCode+FlightNumber+operationalSuffix

Example : "20170803+KL+1644"

3

flightScheduleDate

string

0..1

equivalent flight head station departure date in UTC.

Example: 2018-02-21

3

airlineCode

string

1

2-pos IATA airline code or 3-pos ICAO code2-pos IATA airline code or 3-pos ICAO code. Example: KL

3

flightNumber

string

1

equivalent flight number. Example : 0641

3

operationalSuffix

string

0..1

A code assigned by the administrating carrier for operational purposes.

2

onwardFlightData

object

0..1

NOTE: Available only for KL,WA operated flights.

'onward' is the inbound flight to AMS (Example: KL642 is onward of KL641) 

3

id

string

0..1

Identification of the onward flight:

flightScheduleDate+airlineCode+flightNumber+operationalSuffix

Example : "20170803+KL+1644"

3

flightScheduleDate

string

0..1

onward flight head station departure date in UTC.

3

airlineCode

string

1

2-pos IATA airline code or 3-pos ICAO code

3

flightNumber

string

1

onward flight number.

3

operationalSuffix

string

0..1

A code assigned by the administrating carrier for operational purposes.

2

previousFlightData

object

0..1

NOTE: Available only for KL,WA operated flights.

'previous' is the outbound flight from AMS (e.g. KL641 is previous of KL642)

3

id

string

0..1

identification of the previous flight:

flightScheduleDate+airlineCode+flightNumber+operationalSuffix

Example : "20170803+KL+1644"

3

flightScheduleDate

string

0..1

previous flight head station departure date in UTC.

3

airlineCode

string

1

2-pos IATA airline code or 3-pos ICAO code

3

flightNumber

string

1

previous flight number.

3

operationalSuffix

string

0..1

A code assigned by the administrating carrier for operational purposes.

1

flightLegs

array

0..n

2

status

string

0..1

Indicates the status of the leg.

Example:

AF: scheduled (S), new (N), cancelled (C), ground quick return flight (G) or air quick return flight (A).

KL: scheduled (blank), new (not available), cancelled (X), Forced return (F), or return to ramp (T)

2

statusName

string

0..1

C = Canceled, S = Scheduled, R = Return from Airborn, T = ReTurn to Ramp, G = Ground return,F = Forced return, A = Air return, N = New, E = New (only for AF flights), W = Cancelled (only for AF flights)

2

legStatusPublic

string

0..1

The flight leg status gives information about where flight is at a moment in time during handling or during flight.

Translation of 'legStatusPublic' field in consumer requested language.

Eg. Translation for 'ARRIVED' status in "Dutch (nl)" language is "Aangekomen"

NOTE: If translation is not available for requested language, then default language for translation is : English <<en>>

2

passengerCustomsStatus

string

0..1

Schengen or non Schengen status of the flight leg. 

SCHENGEN,NOT SCHENGEN

2

serviceType

string

0..1

IATA service type.

Example : J,F

2

serviceTypeName

string

0..1

IATA service type description

Example :J= Normal Service,S=Shuttle Mode

2

departureInformation

object

1

3

airport

object 

1

4

code

string

1

IATA airport identification. Example : AMS

4

name

string

0..1

Station name . Example :SCHIPHOL AIRPORT

4

city

object  

0..1

5

code

string

0..1

IATA City Code. Example : AMS, PAR

5

name

string

0..1

City Name . Example : PARIS, AMSTERDAM

5

country

 object  

0..1

6

areaCode

string

0..1

Area in which a location is placed.

Example : N = Netherlands; E = Europe; I = ICA (Intercontinental)

6

code

string

0..1

ISO Country code . Example :FR,NL

6

name

string

0..1

Country name. Example : FRANCE, NETHERLANDS

6

euroCountry

string

0..1

Indicate country have adopted  euro (€) as their common currency or not.

Example:Y ,N

6

euCountry

string

0..1

Indicate country have located primarily in European union or not.

Example:Y ,N

4

location

object 

0..1

5

latitude

number

0..1

Latitude coordinates in decimal degrees. Example:52.3083

5

longitude

number

0..1

Longitude coordinates in decimal degrees. Example:4.7681

4

places (departure)

 object

0..1

5

aerogareCode

string

0..1

Airport infrastructure where the passengers (dis) embark (AF only). Main terminal.

Example: W

5

boardingPier

string

0..1

Code that identifies the pier (the part of the terminal infrastructure that holds the gates). In Passenger Handling (specifically at Air France): the terminal/pier that is scheduled (used for check-in), is not the same as the terminal/pier from which the boarding takes place. After check-in the passengers must go to another pier for boarding.

Example: 3,F

5

boardingTerminal

string

0..1

 All building used for arrival and departure handling of aircraft.  For multiple terminal airports, the terminal identification used for a flight. An individual airline will operate flights into/out of specific terminals in a multiple terminal airport.

5

gateNumber

array

0..2

Location where passengers leave the station building for the departure of a flight. Example:31, D07,F08

5

boardingContactType

string

0..1

Example:

C = Contact (via avio bridge)
F = False (at gate, not in contact with aviobridge)
L = Large (buffer parking)

C:A real contact/ gate contact of an aircraft to the airport infrastructure (enter/leave aircraft by bridge).

F: A false contact/semi- remote contact needing to embark or disembark passengers by bus even if the aircraft is in contact with the airport infrastructure.

L: A non contact/ remote contact: airport at parking stand, embark by bus

5

boardingBusQuantity

string

0..1

If passengers embark or disembark by bus, quantity of buses allocated.

5

parkingPosition

string

0..1

Position of the aircraft while being parked, i.e. not being in a flight or towing movement. Example: U06

5

parkingPositionType

string

0..1

Indicates if the parking stand is physically equipped with a bridge or not. The meaning in French is “Contact” or “Large”.

Example: C=contact, L=large

5

departureTerminal

string

0..1

The identification of the terminal building from which handling of arriving and departing flights takes place. Example: W

5

parkingPositionCustomStatus

string

0..1

Customs status of the terminal from whom the parking depends.

Example:

Parking customs status

S = Schengen or Domestic,

I = International,

M = Mix,

T = Technical

5

checkInZone

array

0..2

The identification of the terminal building from which check-in takes place.

Example: 09,10,3B

5

piercode

string

0..1

Code that identifies the pier (the part of the terminal infrastructure that holds the gates). In this case the pier related to the check-in is meant.

Example: 3,D,C

5

profileLocation

string

0..1

Indicates the location on the airport where passengers need to go for the Profile check. (note: profile check is an extended security check). Note: in 2017 Amsterdam is the only location in which the process of profiling DL passengers before departure is implemented; so it is KLM/AMS only.
Example of Profiling clusters Amsterdam are: E1 and D1

Note: only for KL. All passengers travelling on Delta flights must go to the pre- assigned profile location.

Example: D01

5

terminalCode

string

0..1

The identification of the terminal building from which check-in takes place .

Example: 1,2F,A,W,B

5

checkInAerogare

string

0..1

Airport infrastructure where the passengers (dis)embark (AF only). Main terminal.

AF only. Example: W

3

times

object

1

4

scheduled

string

1

The scheduled departure date time of an aircraft from the terminal or departure gate/position at an airport expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

STD always refers to the off-block time of the aircraft's.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

modified

string

0..1

Modified departure date time is the new scheduled time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

For AF flights this is reliable information only on day of operation.

4

estimatedPublic

string

0..1

Estimated departure date time for public consumers expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

actual

string

0..1

Actual departure date time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

estimatedTakeOffTime

string

0..1

Estimated take off time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

actualTakeOffTime

string

0..1

Actual take off time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

2

arrivalinformation

object

1

3

airport

object 

1

4

code

string

1

IATA station.

Example: CDG, AMS

4

name

string

0..1

Station name

Example: JORGE CHAVEZ INTERNATIONAL

4

city

 object

0..1

5

code

string

0..1

IATA city code

Example: AMS, PAR

5

name

string

0..1

City Name

Example: PARIS, AMSTERDAM

5

country

object 

0..1

6

areaCode

string

0..1

Area in which location is placed.
Example:N = Netherlands; E = Europe; I = ICA (Intercontinental)

6

code

string

0..1

ISO Country code

Example: FR,NL

6

name

string

0..1

Country name

Example: FRANCE, NETHERLANDS

6

euroCountry

string

0..1

Indicate country have adopted  euro (€) as their common currency or not.

Example:Y ,N

6

euCountry

string

0..1

Indicate country have located primarily in European union or not.

Example:Y ,N

4

location

object

0..1

5

latitude

number

0..1

Latitude coordinates in decimal degrees. Example:52.3083

5

longitude

number

0..1

Longitude coordinates in decimal degrees. Example:4.7681

4

places (arrival)

object 

0..1

5

aerogareCode

string

0..1

Scheduled arrival  aerogare code

Airport infrastructure where the passengers (dis)embark (AF only). Main terminal.

5

arrivalPositionTerminal

string

0..1

Scheduled arrival terminal code.

AF ONLY

The identification of the terminal building from which handling of arriving and departing flights takes place.
Example:1,2F,A

5

arrivalpositionPier

string

0..1

Scheduled arrival pier code.

Code that identifies the pier (the part of the terminal infrastructure that holds the gates).In Passenger Handling (specifically at Air France): the terminal/pier that is scheduled (used for check-in), is not the same as the terminal/pier from which the boarding takes place. After check-in the passengers must go to another pier for boarding.

Example :1

5

bagageBelt

array

0..2

 Allocated belt where (after flight arrival), the baggage is placed for transportation to the passengers in the arrival hall. 

5

gateNumber

array

0..2

Disembarking gate code.

Location where passengers leave the station building for the departure of a flight, or enter the station building after arrival of a flight

5

parkingPosition

string

0..1

parking stand.

Code to identify a place on platform or in hangar, where the aircraft can be located. Example : D53

5

parkingPositionType

string

0..1

Parking stand type.

Indicates if the parking stand is physically equipped with a bridge or not. The meaning in French is “Contact” or “Large”.

Example:

C=contact

L=large

5

arrivalTerminal

string

0..1

Parking terminal.

The identification of the terminal building from which handling of arriving and departing flights takes place.

Example:

KL: Schiphol Airort ; 1,2,3, 1A

AF: Airport Charles de Gaulle: 1, 2F, A

5

parkingPositionCustomStatus

string

0..1

Parking customs status

S= Schengen or Domestic,

I = International,

M = Mix,

T = Technical

5

piercode

string

0..1

Disembarking pier code.

Code that identifies the pier (the part of the terminal infrastructure that holds the gates). In Passenger Handling (specifically at Air France): the terminal/pier that is scheduled (used for check-in), is not the same as the terminal/pier from which the boarding takes place. After check-in the passengers must go to another pier for boarding.

5

terminalCode

string

0..1

Disembarking terminal code.

The identification of the terminal building from which handling of arriving and departing flights takes place.

Example:

KL: Schiphol Airort ; 1,2,3, 1A

AF: Airport Charles de Gaulle: 1, 2F, A

5

disembarkingBusQuantity

string

0..1

If passengers embark or disembark by bus, quantity of busses allocated.

KL: not yet used

5

disembarkingContactType

string

0..1

Flight Contact Disembarking Type

C = real/gate contact (aircraft connected to bridge, (dis)embark by bridge)

F = false/semi-remote contact (aircraft at gate position, but bridge not connected, (dis)embark by bus)

L= non/remote contact (aircraft at parking stand, (dis)embark by bus)

5

disembarkingAerogare

string

0..1

Disembarking aerogare code.

Airport infrastructure where the passengers (dis)embark (AF only). Main terminal.

After flight arrival, this is the date time when first bag of flight is put on baggage belt.

Ex:

After flight arrival, this is the date time when last bag of flight is put on baggage belt.

3

times

 object

1

4

scheduled

string

1

The scheduled arrival date time of an aircraft to the terminal or departure gate/position at an airport expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

STA always refers to the in-block time of the aircraft.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

modified

string

0..1

Modified arrival date time is the new scheduled arrival time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

For AF flights this is reliable information only on day of operation.

4

estimatedArrival

string

0..1

Estimated arrival date time for public consumers expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

actual

string

0..1

Actual arrival date time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

estimatedTouchDownTime

string

0..1

Estimated landing date time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

4

actualTouchDownTime

string

0..1

Actual landing date time expressed in ISO 8601 Date/Time (YYYYMMDD+|- HHMM ) format.

Local date time of airport station with UTC offset.

Example:

2017-02-09T12:35:00.000+01:00

5

value

string

1 

2

scheduledFlightDuration

string

0.1

The duration of the flight in hours and minutes from the scheduled moment of push back(off-blocks) till the scheduled moment of on-blocks.

Given in ISO format PTnHnM

Example: PT12H40M

2

departureDateTimeDifference

string

0..1

Given in ISO format PTnHnM. Example: PT12H40M

2

arrivalDateTimeDifference

string

0..1

Given in ISO format PTnHnM .Example: PT12H40M

2

timeToArrival

string

0..1

This is time remaining to arrive at the gate.

Given in ISO format PTnHnM

Example: PT12H40M

Progression of a given flight in transit.
Completion percentage for a flight leg is in between 0 and 100.

If the flight has not taken off, the flight completion percent is 0.
Else If the flight has landed, the flight completion percent is 100.
Else the percent is computed by :
(currentUTCTime-actualDepartureUTCTime)/(estimatedArrivalUTCTime-actualDepartureUTCTime)

Example:

100

Time zone difference between leg arrival and departure station.

Expressed in ± HHMM format.

Ex. KL 0835 AMS-SIN

TimeZoneDifference= +0600

KL 0836 SIN-AMS

TimeZoneDifference=

-0600

+ value indicate arrival station time is ahead by HHMM compare to departure station

 - value indicate arrival station time is behind by HHMM compare to departure station

Example:

"timeZoneDifference": "-0700"

2

aircraft

 object

1

3

registration

string

0..1

String of characters which uniquely identifies a civil aircraft in accordance with the Convention on International Civil Aviation 

Example : PHBVF

3

typeCode

string

0..1

The ATA/IATA standard 3-character code that normally covers the manufacturer and main model of a commercial aircraft.

Example: 744 

3

typeName

string

0..1

Example:

Boeing 777-300ER

3

ownerAirlineCode

string

0..1

Legal party that acts as the owner of an aircraft.

Example: AF, KL A5, WA

3

OwnerAirlineName

string

0..1

Full name of the party that acts as the owner of an aircraft.

Example: KLM ROYAL DUTCH AIRLINES

3

physicalPaxConfiguration

string

0..1

Technical aircraft configuration.

Example: C24M64

3

physicalFreightConfiguration

string

0..1

Cargo configuration.

Example: P007L015 = 7 pallets and 15 ULD (unit load device) containers

3

operationalConfiguration

string

0..1

Commercial pax configuration

Example: C8M80

3

wifiEnabled

string

0..1

Wifi On board

Example: Y or N

NOTE: Available only for AF,A5,JN operated flights.

Multiple delay reason codes. These codes are derived by Flight Status based on IATA delay codes.
Example:
FSR01 (technical issues)
FSR02 (Operational issues)
FSR03 (weather issues)

Example:

FSR01

Translation of 'delayReasonCodePublic' field in consumer requested language.Eg. Translation for 'FSR02' status in "english(en)" language is "Sorry, this flight is disrupted due to operational issues"

NOTE: If translation is not available for requested language, then default language for translation is : English <<en>>

3

delayDurationPublic

string

0..1

3

delayDurationArrival

string

0..1

0

page

object 

0..1

pagination information

1

pageSize

number

0..1

Requested PageSize

1

pageNumber

number

0..1

Requested Pagenumber

1

fullCount

number

0..1

Total number of items matching request

1

pageCount

number

0..1

Total number of items on current page

1

totalPages

number

0..1

Total number of pages