Airport Hive logo
API docs by Redocly

Airport Hive - Flight Repository API (1.3.0)

Download OpenAPI specification:Download

E-mail: support@azinq.com URL: www.azinq.com

The Flight Repository API is a RESTful API hosted by Azinq's Airport Hive. It is the API used by clients to communicate with Airport Hive for exchanging flight information.

Flight

Get Flight Legs

Get a flight leg

Authorizations:
bearerAuth
query Parameters
fromDateTime
string <date-time>
toDateTime
string <date-time>
hoursBack
integer
hoursForward
integer
searchBasis
any
Enum: "A" "E" "M" "T" "S"

whether to use Actual, Estimated, Most Confident, Target or Scheduled block times for the search

arrivalDeparture
any
Enum: "A" "D" "B"

A/D/B when querying for flight data. Default will be B - both, meaning you will get Arrival and Departure data returned and other parameters will be applied to both where possible.

uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

flightNumber
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

aircraftRegistration
string or null (AircraftRegistration) [ 1 .. 10 ] characters

An aircraft registration is a unique alphanumeric string that identifies an aircraft. In accordance with the Convention on International Civil Aviation all aircraft must be registered with a national aviation authority and they must carry proof of this registration in the form of a legal document called a Certificate of Registration at all times when in operation.

An aircraft can be re-registered in special cases, for instance if it's sold to an operator in another country.

callSign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

aircraftIATAType
string (AircraftIATAType) [ 1 .. 3 ] characters

3 character code as designated by International Air Transport Association (IATA) to uniquely designate Aircraft Type. Local (non-IATA) codes can be added as required as long as they are unique for aircraft types within the defined context.

Reference Document: IATA codeset 7800.

aircraftICAOType
string (AircraftICAOType) [ 1 .. 4 ] characters

3-4 character code as designated by International Civil Aviation Organisation (ICAO) to uniquely designate Aircraft Type. Local (non-ICAO) codes can be added as required as long as they are unique for aircraft types within the defined context. Reference Document: ICAO document 8643.

airportIATA
string (AirportIATA) [ 1 .. 3 ] characters

IATA code which uniquely defines an airport. Where an official IATA code does not exist for an airport, it is the standard to use the ICAO code. Where neither exist, pseudo-codes can be created if required (e.g. oil rigs, grass strips, etc.)

The standard codes are defined in the ""Airline Coding Directory"".

airportICAO
string (AirportICAO) [ 1 .. 4 ] characters

ICAO code which uniquely defines an airport. Where an official ICAO code does not exist for an airport, it is the standard to use the IATA code. Where neither exist, pseudo-codes can be created if required (e.g. oil rigs, grass strips, etc.)

The standard codes are defined in ICAO Document 7910.

ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

modifiedDateTime
string <date-time>
includeDeleted
boolean
Default: false

Responses

Response Schema: application/json
Array
object (AircraftData)
required
object (ArrivalData)
atmCancelTimestamp
string <date-time>
callsign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

cancelReasonCode
string (CancelReasonCode) [ 1 .. 16 ] characters

A system dependent code that defines the reason for a cancellation.

Example values.

Code Description
ARPT Airfield restrictions
COMM Commercial reasons, demand or lack of demand
CREW Crew shortage
DAMA Aircraft damage
EQUI Equipment shortage
FUEL Fuel shortage
HDLG Ground handling
HOLI Holiday
INDU Industrial dispute
OPER Operational reasons
PERF Aircraft performance
POLI Political situation
POSI Aircraft positioning
REPO Aircraft re-positioning
ROTA Aircraft rotation
RTNS Return to normal schedule or reinstatement of flight status prior to issuance of ASM(s) (withdrawal of ASM change)
RUNW Runway restrictions
TECH Technical reasons, maintenance, etc.
WEAT Weather conditions
cancelReasonText
string (CancelReasonText) [ 1 .. 128 ] characters

A textual description of the reason for the cancellation. Typically associated with the CancelReasonCode.

Array of objects (CodeshareData)
required
object (DepartureData)
required
object (DisplayData)
flightDIIndicator
required
string (DIIndicator)
Enum: "D" "I" "S"

Indicator showing what kind of airport/flight/gate/etc. (domestic, international (Non Schengen), Schengen) this is.

flightId
string (FlightId) [ 1 .. 8 ] characters

IATA based identifier for this flight, usually issued long before the flight actually takes place.

FlightId is normally the concatenation of OperatingAirlineIATA, FlightNumber and OperationalSuffix.

FlightId typically identifies a flight to the majority of systems, but it is not unique across time. It's unique only in conjunction with SIBT/SOBT.

Exception: Some airlines use their ICAO code (OperatingAirlineICAO) instead of OperatingAirlineIATA. This might be because they aren't an IATA member or because they just prefer the ICAO code. Regardless, this means that it is allowed to use OperatingAirlineICAO as part of FlightId.

FlightId is then defined as the concatenation of AirlineIATA || AirportICAO, FlightNumber and OperationalSuffix.

flightNumber
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

flightIsMultiLeg
required
boolean
required
object (FlightLegMetadata)
flightLegSecurityIndicator
required
string (FlightLegSecurityIndicator)
Enum: "0" "1"

Indicates if there are security issues associated with the flight leg, or not.

  • '0': No security issues with this flight leg.
  • '1': There are security issues with this flight leg.
flightLegStatus
required
string (FlightLegStatus)
Enum: "ACT" "CAN" "DEL" "DIV" "FLS" "FPL" "LAN" "RER" "SCH" "SEQ" "UKN"

The status of a "FlightLeg". The following values are defined:

"SCH", "FPL", "FLS", "ACT", "CAN", "LAN", "RER", "DIV", "DEL", "UNK"
"SCH" Scheduled
The initial state for scheduled flights.
A known FlightLeg that is expected to depart and land according to the available information.
Can transition to: FPL, ACT, CAN
"FPL" Flight Plan
Initial state for flights that aren't scheduled.
The flight plan has been filed and is registered by ATM.
Can transition to: FLS, SEQ, ACT, CAN
"FLS" Flight Suspended
The flight has been suspended by ATM, but can be activated at any time.
Can transition to: FPL, CAN,
"SEQ" Sequenced
The flight has been sequenced by ATM.
Can transition to: ACT, CAN
"ACT" Active
The aircraft is “off block”, and might be airborne.
Can transition to: LAN, RER
"CAN" Cancelled
The FlightLeg has been cancelled.
End state.
"LAN" Landed
The aircraft has landed on the scheduled airport.
End state.
"RER" Rerouted
The aircraft is in the air, but the destination airport has been changed.
After landing the state will change to “DIV”.
The destination airport can be changed back to the original airport. It is then a regular flight leg, but possibly delayed.
Can transition to: DIV, ACT
"DIV" Diverted
The aircraft has landed on an unscheduled airport.
End state.
"DEL" Deleted
The FlightLeg appears to have been deleted/removed.
This is probably the result of missing schedule change information or some other data errors.
End state.
"UKN" Unknown
Unknown indicates missing information.
flightRouteIATA
required
Array of strings (FlightRouteIATA) non-empty [ items [ 1 .. 3 ] characters ]
flightServiceTypeExtended
required
string (FlightServiceTypeExtended) [ 1 .. 3 ] characters

Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.

Examples:

  • "01" Scheduled commercial passenger flights
  • "02" Unscheduled commercial passenger flights
  • "03" Freight
  • "04" Helicopter flights to offshore oil installations
  • "05" Other commercial helicopter flights
  • "06" Other commercial flights
  • "11" Civilian search and recue (SAR)
  • "12" Ambulance flight
  • "13" Civil flight school
  • "14" Positioning flight
  • "15" Technical return
  • "16" Navaid control flight
  • "17" General aviation (GA)
  • "21" Military flight - General code
  • "22" Ambulance flight performed by military aircraft
  • "23" Military flight school
  • "24" Military positioning flight
  • "25" Military test flight
  • "26" Military navaid control flight
  • "27" Search and rescue performed by military aircraft
  • "28" Military aircraft participating in exercise
  • "29" Military training flight
  • "30" Military operational flight
  • "99" Unknown
flightServiceTypeIATA
required
string (FlightServiceTypeIATA)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "U" "S" "V" "T" "W" "X" "Z"

IATA SSIM Appendix C Service Types.

Scheduled, Passenger

  • 'J' - Normal Service
  • 'S' - Shuttle Mode
  • 'U' - Service operated by surface vehicle

Scheduled, Cargo/Mail

  • 'F' - Loose loaded cargo and/or preloaded devices
  • 'V' - Service operated by surface vehicle
  • 'M' - Mail only
  • 'Q' - Passenger/Cargo in Cabin

Additional flights

  • 'G' - Passenger Normal Service
  • 'B' - Passenger Shuttle Mode
  • 'A' - Cargo/Mail
  • 'R' - Passenger/Cargo in Cabin

Charter

  • 'C' - Passenger Only
  • 'O' - Charter requiring special handling (e.g. Migrants/Immigrants)
  • 'H' - Cargo and/or Mail
  • 'L' - Passenger and Cargo and/or Mail

Others

  • 'P' - Non-revenue (Positioning/Ferry/Delivery/Demo)
  • 'T' - Technical Test
  • 'K' - Training (School/Crew check)
  • 'D' - General Aviation
  • 'E' - Special (FAA/Government)
  • 'W' - Military
  • 'X' - Technical Stop (for Chapter 6 applications only)
  • 'I' - State/Diplomatic
  • 'N' - Business Aviation / Air Taxi

Company specific (not IATA standard)

  • 'Z' - Unknown or other than any of the defined categories above. This might be because no information has been received, or because none of the IATA types cover this type of flight.
flightServiceTypeICAO
required
string (FlightServiceTypeICAO)
Enum: "S" "N" "G" "M" "X"

ICAO Flight Service Types.

Code Description
'S' Scheduled Air Transport
'N' Non-scheduled air transport operation
'G' General aviation
'M' Military
'X' other than any of the defined categories above
iataCancelTimestamp
string <date-time>
ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

isRerouted
required
boolean
operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

operatingAirlineName
string (AirlineName) [ 1 .. 40 ] characters

Name under which airline is recognised.

operatingAirlineOrganizationId
string (AirlineOrganizationId) [ 1 .. 32 ] characters
operatingAirlineTicketed
string or null (AirlineTicketed) [ 1 .. 3 ] characters

"The airline code which will appear on the passengers' tickets for this flight. This can be either the IATA or ICAO code. See AirlineIATA or AirlineICAO for definition of content."

object (PassengerData)
object (PreallocatedPRMData)
object (PRMData)
radioCallsign
string or null (RadioCallsign) [ 1 .. 24 ] characters

Radiotelephony callsigns are used in communication between pilots and air traffic management. RadioCallsign can be of different types, but all are strings of limited length. Usually the RadioCallsign stay the same during a flight leg, but it can change for a (short) period, typically at the request of an air traffic controller.

object
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

object (WeightData)

Response samples

Content type
application/json
[
  • {
    }
]

Update Flight Leg

Update a flight leg

Authorizations:
bearerAuth
Request Body schema: application/json
required

The flight leg data to be updated

object (AircraftDataInput)

defines what aircraft attributes can be passed in on flight creation/update

object (ArrivalDataPatch)
callsign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

Array of objects or null (CodeshareData) >= 0 items
object (DepartureDataPatch)
object (DisplayData)
flightDIIndicator
string (DIIndicator)
Enum: "D" "I" "S"

Indicator showing what kind of airport/flight/gate/etc. (domestic, international (Non Schengen), Schengen) this is.

flightId
string (FlightId) [ 1 .. 8 ] characters

IATA based identifier for this flight, usually issued long before the flight actually takes place.

FlightId is normally the concatenation of OperatingAirlineIATA, FlightNumber and OperationalSuffix.

FlightId typically identifies a flight to the majority of systems, but it is not unique across time. It's unique only in conjunction with SIBT/SOBT.

Exception: Some airlines use their ICAO code (OperatingAirlineICAO) instead of OperatingAirlineIATA. This might be because they aren't an IATA member or because they just prefer the ICAO code. Regardless, this means that it is allowed to use OperatingAirlineICAO as part of FlightId.

FlightId is then defined as the concatenation of AirlineIATA || AirportICAO, FlightNumber and OperationalSuffix.

flightNumber
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

flightIsMultiLeg
boolean
flightLegSecurityIndicator
string (FlightLegSecurityIndicator)
Enum: "0" "1"

Indicates if there are security issues associated with the flight leg, or not.

  • '0': No security issues with this flight leg.
  • '1': There are security issues with this flight leg.
flightLegStatus
string (FlightLegStatus)
Enum: "ACT" "CAN" "DEL" "DIV" "FLS" "FPL" "LAN" "RER" "SCH" "SEQ" "UKN"

The status of a "FlightLeg". The following values are defined:

"SCH", "FPL", "FLS", "ACT", "CAN", "LAN", "RER", "DIV", "DEL", "UNK"
"SCH" Scheduled
The initial state for scheduled flights.
A known FlightLeg that is expected to depart and land according to the available information.
Can transition to: FPL, ACT, CAN
"FPL" Flight Plan
Initial state for flights that aren't scheduled.
The flight plan has been filed and is registered by ATM.
Can transition to: FLS, SEQ, ACT, CAN
"FLS" Flight Suspended
The flight has been suspended by ATM, but can be activated at any time.
Can transition to: FPL, CAN,
"SEQ" Sequenced
The flight has been sequenced by ATM.
Can transition to: ACT, CAN
"ACT" Active
The aircraft is “off block”, and might be airborne.
Can transition to: LAN, RER
"CAN" Cancelled
The FlightLeg has been cancelled.
End state.
"LAN" Landed
The aircraft has landed on the scheduled airport.
End state.
"RER" Rerouted
The aircraft is in the air, but the destination airport has been changed.
After landing the state will change to “DIV”.
The destination airport can be changed back to the original airport. It is then a regular flight leg, but possibly delayed.
Can transition to: DIV, ACT
"DIV" Diverted
The aircraft has landed on an unscheduled airport.
End state.
"DEL" Deleted
The FlightLeg appears to have been deleted/removed.
This is probably the result of missing schedule change information or some other data errors.
End state.
"UKN" Unknown
Unknown indicates missing information.
object
flightIsCancelled
boolean (FlightIsCancelled)

Set to true if the flight operation is cancelled. For flight as with code share it's possible to only cancel the code shared flight.

flightRouteIATA
Array of strings (FlightRouteIATA) non-empty [ items [ 1 .. 3 ] characters ]
flightServiceTypeExtended
string (FlightServiceTypeExtended) [ 1 .. 3 ] characters

Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.

Examples:

  • "01" Scheduled commercial passenger flights
  • "02" Unscheduled commercial passenger flights
  • "03" Freight
  • "04" Helicopter flights to offshore oil installations
  • "05" Other commercial helicopter flights
  • "06" Other commercial flights
  • "11" Civilian search and recue (SAR)
  • "12" Ambulance flight
  • "13" Civil flight school
  • "14" Positioning flight
  • "15" Technical return
  • "16" Navaid control flight
  • "17" General aviation (GA)
  • "21" Military flight - General code
  • "22" Ambulance flight performed by military aircraft
  • "23" Military flight school
  • "24" Military positioning flight
  • "25" Military test flight
  • "26" Military navaid control flight
  • "27" Search and rescue performed by military aircraft
  • "28" Military aircraft participating in exercise
  • "29" Military training flight
  • "30" Military operational flight
  • "99" Unknown
flightServiceTypeIATA
string (FlightServiceTypeIATA)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "U" "S" "V" "T" "W" "X" "Z"

IATA SSIM Appendix C Service Types.

Scheduled, Passenger

  • 'J' - Normal Service
  • 'S' - Shuttle Mode
  • 'U' - Service operated by surface vehicle

Scheduled, Cargo/Mail

  • 'F' - Loose loaded cargo and/or preloaded devices
  • 'V' - Service operated by surface vehicle
  • 'M' - Mail only
  • 'Q' - Passenger/Cargo in Cabin

Additional flights

  • 'G' - Passenger Normal Service
  • 'B' - Passenger Shuttle Mode
  • 'A' - Cargo/Mail
  • 'R' - Passenger/Cargo in Cabin

Charter

  • 'C' - Passenger Only
  • 'O' - Charter requiring special handling (e.g. Migrants/Immigrants)
  • 'H' - Cargo and/or Mail
  • 'L' - Passenger and Cargo and/or Mail

Others

  • 'P' - Non-revenue (Positioning/Ferry/Delivery/Demo)
  • 'T' - Technical Test
  • 'K' - Training (School/Crew check)
  • 'D' - General Aviation
  • 'E' - Special (FAA/Government)
  • 'W' - Military
  • 'X' - Technical Stop (for Chapter 6 applications only)
  • 'I' - State/Diplomatic
  • 'N' - Business Aviation / Air Taxi

Company specific (not IATA standard)

  • 'Z' - Unknown or other than any of the defined categories above. This might be because no information has been received, or because none of the IATA types cover this type of flight.
flightServiceTypeICAO
string (FlightServiceTypeICAO)
Enum: "S" "N" "G" "M" "X"

ICAO Flight Service Types.

Code Description
'S' Scheduled Air Transport
'N' Non-scheduled air transport operation
'G' General aviation
'M' Military
'X' other than any of the defined categories above
ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

isRerouted
boolean
operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

object (PassengerDataIn)
object (PreallocatedPRMData)
object (PRMData)
radioCallsign
string or null (RadioCallsign) [ 1 .. 24 ] characters

Radiotelephony callsigns are used in communication between pilots and air traffic management. RadioCallsign can be of different types, but all are strings of limited length. Usually the RadioCallsign stay the same during a flight leg, but it can change for a (short) period, typically at the request of an air traffic controller.

object
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

object (WeightData)

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Request samples

Content type
application/json
{
  • "aircraftData": {
    },
  • "arrivalData": {
    },
  • "callsign": "string",
  • "codeshareData": [
    ],
  • "departureData": {
    },
  • "displayData": {
    },
  • "flightDIIndicator": "D",
  • "flightId": "string",
  • "flightNumber": "strin",
  • "operationalSuffix": "s",
  • "flightIsMultiLeg": true,
  • "flightLegSecurityIndicator": "0",
  • "flightLegStatus": "ACT",
  • "flightLegMetadata": {
    },
  • "flightIsCancelled": true,
  • "flightRouteIATA": [
    ],
  • "flightServiceTypeExtended": "str",
  • "flightServiceTypeIATA": "A",
  • "flightServiceTypeICAO": "S",
  • "ifplId": "string",
  • "isRerouted": true,
  • "operatingAirlineIATA": "str",
  • "operatingAirlineICAO": "str",
  • "passengerData": {
    },
  • "preallocatedPRMData": {
    },
  • "prmData": {
    },
  • "radioCallsign": "string",
  • "remarkData": {
    },
  • "uniqueFlightLegId": "string",
  • "weightData": {
    }
}

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string"
}

Create Flight Legs

Create a flight leg

Authorizations:
bearerAuth
Request Body schema: application/json
required

The flight leg data

object (FlightLegMetadataIn)
object (AircraftDataInput)

defines what aircraft attributes can be passed in on flight creation/update

required
object (ArrivalDataInput)
callsign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

Array of objects or null (CodeshareData)
required
object (DepartureDataInput)
object (DisplayData)
flightNumber
required
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

flightIsMultiLeg
boolean
flightLegSecurityIndicator
string (FlightLegSecurityIndicator)
Enum: "0" "1"

Indicates if there are security issues associated with the flight leg, or not.

  • '0': No security issues with this flight leg.
  • '1': There are security issues with this flight leg.
flightRouteIATA
Array of strings (FlightRouteIATA) non-empty [ items [ 1 .. 3 ] characters ]
flightServiceTypeExtended
string (FlightServiceTypeExtended) [ 1 .. 3 ] characters

Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.

Examples:

  • "01" Scheduled commercial passenger flights
  • "02" Unscheduled commercial passenger flights
  • "03" Freight
  • "04" Helicopter flights to offshore oil installations
  • "05" Other commercial helicopter flights
  • "06" Other commercial flights
  • "11" Civilian search and recue (SAR)
  • "12" Ambulance flight
  • "13" Civil flight school
  • "14" Positioning flight
  • "15" Technical return
  • "16" Navaid control flight
  • "17" General aviation (GA)
  • "21" Military flight - General code
  • "22" Ambulance flight performed by military aircraft
  • "23" Military flight school
  • "24" Military positioning flight
  • "25" Military test flight
  • "26" Military navaid control flight
  • "27" Search and rescue performed by military aircraft
  • "28" Military aircraft participating in exercise
  • "29" Military training flight
  • "30" Military operational flight
  • "99" Unknown
flightServiceTypeIATA
string (FlightServiceTypeIATA)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "U" "S" "V" "T" "W" "X" "Z"

IATA SSIM Appendix C Service Types.

Scheduled, Passenger

  • 'J' - Normal Service
  • 'S' - Shuttle Mode
  • 'U' - Service operated by surface vehicle

Scheduled, Cargo/Mail

  • 'F' - Loose loaded cargo and/or preloaded devices
  • 'V' - Service operated by surface vehicle
  • 'M' - Mail only
  • 'Q' - Passenger/Cargo in Cabin

Additional flights

  • 'G' - Passenger Normal Service
  • 'B' - Passenger Shuttle Mode
  • 'A' - Cargo/Mail
  • 'R' - Passenger/Cargo in Cabin

Charter

  • 'C' - Passenger Only
  • 'O' - Charter requiring special handling (e.g. Migrants/Immigrants)
  • 'H' - Cargo and/or Mail
  • 'L' - Passenger and Cargo and/or Mail

Others

  • 'P' - Non-revenue (Positioning/Ferry/Delivery/Demo)
  • 'T' - Technical Test
  • 'K' - Training (School/Crew check)
  • 'D' - General Aviation
  • 'E' - Special (FAA/Government)
  • 'W' - Military
  • 'X' - Technical Stop (for Chapter 6 applications only)
  • 'I' - State/Diplomatic
  • 'N' - Business Aviation / Air Taxi

Company specific (not IATA standard)

  • 'Z' - Unknown or other than any of the defined categories above. This might be because no information has been received, or because none of the IATA types cover this type of flight.
flightServiceTypeICAO
string (FlightServiceTypeICAO)
Enum: "S" "N" "G" "M" "X"

ICAO Flight Service Types.

Code Description
'S' Scheduled Air Transport
'N' Non-scheduled air transport operation
'G' General aviation
'M' Military
'X' other than any of the defined categories above
ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

isRerouted
boolean
operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

object (PassengerDataIn)
object (PreallocatedPRMData)
object (PRMData)
radioCallsign
string or null (RadioCallsign) [ 1 .. 24 ] characters

Radiotelephony callsigns are used in communication between pilots and air traffic management. RadioCallsign can be of different types, but all are strings of limited length. Usually the RadioCallsign stay the same during a flight leg, but it can change for a (short) period, typically at the request of an air traffic controller.

object
object (WeightData)

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Request samples

Content type
application/json
{
  • "flightLegMetadata": {
    },
  • "aircraftData": {
    },
  • "arrivalData": {
    },
  • "callsign": "string",
  • "codeshareData": [
    ],
  • "departureData": {
    },
  • "displayData": {
    },
  • "flightNumber": "strin",
  • "operationalSuffix": "s",
  • "flightIsMultiLeg": true,
  • "flightLegSecurityIndicator": "0",
  • "flightRouteIATA": [
    ],
  • "flightServiceTypeExtended": "str",
  • "flightServiceTypeIATA": "A",
  • "flightServiceTypeICAO": "S",
  • "ifplId": "string",
  • "isRerouted": true,
  • "operatingAirlineIATA": "str",
  • "operatingAirlineICAO": "str",
  • "passengerData": {
    },
  • "preallocatedPRMData": {
    },
  • "prmData": {
    },
  • "radioCallsign": "string",
  • "remarkData": {
    },
  • "weightData": {
    }
}

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string"
}

Get Flight Leg by Id

Get a specific flight leg by unique Flight Leg ID

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Responses

Response Schema: application/json
Array
object (AircraftData)
required
object (ArrivalData)
atmCancelTimestamp
string <date-time>
callsign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

cancelReasonCode
string (CancelReasonCode) [ 1 .. 16 ] characters

A system dependent code that defines the reason for a cancellation.

Example values.

Code Description
ARPT Airfield restrictions
COMM Commercial reasons, demand or lack of demand
CREW Crew shortage
DAMA Aircraft damage
EQUI Equipment shortage
FUEL Fuel shortage
HDLG Ground handling
HOLI Holiday
INDU Industrial dispute
OPER Operational reasons
PERF Aircraft performance
POLI Political situation
POSI Aircraft positioning
REPO Aircraft re-positioning
ROTA Aircraft rotation
RTNS Return to normal schedule or reinstatement of flight status prior to issuance of ASM(s) (withdrawal of ASM change)
RUNW Runway restrictions
TECH Technical reasons, maintenance, etc.
WEAT Weather conditions
cancelReasonText
string (CancelReasonText) [ 1 .. 128 ] characters

A textual description of the reason for the cancellation. Typically associated with the CancelReasonCode.

Array of objects (CodeshareData)
required
object (DepartureData)
required
object (DisplayData)
flightDIIndicator
required
string (DIIndicator)
Enum: "D" "I" "S"

Indicator showing what kind of airport/flight/gate/etc. (domestic, international (Non Schengen), Schengen) this is.

flightId
string (FlightId) [ 1 .. 8 ] characters

IATA based identifier for this flight, usually issued long before the flight actually takes place.

FlightId is normally the concatenation of OperatingAirlineIATA, FlightNumber and OperationalSuffix.

FlightId typically identifies a flight to the majority of systems, but it is not unique across time. It's unique only in conjunction with SIBT/SOBT.

Exception: Some airlines use their ICAO code (OperatingAirlineICAO) instead of OperatingAirlineIATA. This might be because they aren't an IATA member or because they just prefer the ICAO code. Regardless, this means that it is allowed to use OperatingAirlineICAO as part of FlightId.

FlightId is then defined as the concatenation of AirlineIATA || AirportICAO, FlightNumber and OperationalSuffix.

flightNumber
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

flightIsMultiLeg
required
boolean
required
object (FlightLegMetadata)
flightLegSecurityIndicator
required
string (FlightLegSecurityIndicator)
Enum: "0" "1"

Indicates if there are security issues associated with the flight leg, or not.

  • '0': No security issues with this flight leg.
  • '1': There are security issues with this flight leg.
flightLegStatus
required
string (FlightLegStatus)
Enum: "ACT" "CAN" "DEL" "DIV" "FLS" "FPL" "LAN" "RER" "SCH" "SEQ" "UKN"

The status of a "FlightLeg". The following values are defined:

"SCH", "FPL", "FLS", "ACT", "CAN", "LAN", "RER", "DIV", "DEL", "UNK"
"SCH" Scheduled
The initial state for scheduled flights.
A known FlightLeg that is expected to depart and land according to the available information.
Can transition to: FPL, ACT, CAN
"FPL" Flight Plan
Initial state for flights that aren't scheduled.
The flight plan has been filed and is registered by ATM.
Can transition to: FLS, SEQ, ACT, CAN
"FLS" Flight Suspended
The flight has been suspended by ATM, but can be activated at any time.
Can transition to: FPL, CAN,
"SEQ" Sequenced
The flight has been sequenced by ATM.
Can transition to: ACT, CAN
"ACT" Active
The aircraft is “off block”, and might be airborne.
Can transition to: LAN, RER
"CAN" Cancelled
The FlightLeg has been cancelled.
End state.
"LAN" Landed
The aircraft has landed on the scheduled airport.
End state.
"RER" Rerouted
The aircraft is in the air, but the destination airport has been changed.
After landing the state will change to “DIV”.
The destination airport can be changed back to the original airport. It is then a regular flight leg, but possibly delayed.
Can transition to: DIV, ACT
"DIV" Diverted
The aircraft has landed on an unscheduled airport.
End state.
"DEL" Deleted
The FlightLeg appears to have been deleted/removed.
This is probably the result of missing schedule change information or some other data errors.
End state.
"UKN" Unknown
Unknown indicates missing information.
flightRouteIATA
required
Array of strings (FlightRouteIATA) non-empty [ items [ 1 .. 3 ] characters ]
flightServiceTypeExtended
required
string (FlightServiceTypeExtended) [ 1 .. 3 ] characters

Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.

Examples:

  • "01" Scheduled commercial passenger flights
  • "02" Unscheduled commercial passenger flights
  • "03" Freight
  • "04" Helicopter flights to offshore oil installations
  • "05" Other commercial helicopter flights
  • "06" Other commercial flights
  • "11" Civilian search and recue (SAR)
  • "12" Ambulance flight
  • "13" Civil flight school
  • "14" Positioning flight
  • "15" Technical return
  • "16" Navaid control flight
  • "17" General aviation (GA)
  • "21" Military flight - General code
  • "22" Ambulance flight performed by military aircraft
  • "23" Military flight school
  • "24" Military positioning flight
  • "25" Military test flight
  • "26" Military navaid control flight
  • "27" Search and rescue performed by military aircraft
  • "28" Military aircraft participating in exercise
  • "29" Military training flight
  • "30" Military operational flight
  • "99" Unknown
flightServiceTypeIATA
required
string (FlightServiceTypeIATA)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "U" "S" "V" "T" "W" "X" "Z"

IATA SSIM Appendix C Service Types.

Scheduled, Passenger

  • 'J' - Normal Service
  • 'S' - Shuttle Mode
  • 'U' - Service operated by surface vehicle

Scheduled, Cargo/Mail

  • 'F' - Loose loaded cargo and/or preloaded devices
  • 'V' - Service operated by surface vehicle
  • 'M' - Mail only
  • 'Q' - Passenger/Cargo in Cabin

Additional flights

  • 'G' - Passenger Normal Service
  • 'B' - Passenger Shuttle Mode
  • 'A' - Cargo/Mail
  • 'R' - Passenger/Cargo in Cabin

Charter

  • 'C' - Passenger Only
  • 'O' - Charter requiring special handling (e.g. Migrants/Immigrants)
  • 'H' - Cargo and/or Mail
  • 'L' - Passenger and Cargo and/or Mail

Others

  • 'P' - Non-revenue (Positioning/Ferry/Delivery/Demo)
  • 'T' - Technical Test
  • 'K' - Training (School/Crew check)
  • 'D' - General Aviation
  • 'E' - Special (FAA/Government)
  • 'W' - Military
  • 'X' - Technical Stop (for Chapter 6 applications only)
  • 'I' - State/Diplomatic
  • 'N' - Business Aviation / Air Taxi

Company specific (not IATA standard)

  • 'Z' - Unknown or other than any of the defined categories above. This might be because no information has been received, or because none of the IATA types cover this type of flight.
flightServiceTypeICAO
required
string (FlightServiceTypeICAO)
Enum: "S" "N" "G" "M" "X"

ICAO Flight Service Types.

Code Description
'S' Scheduled Air Transport
'N' Non-scheduled air transport operation
'G' General aviation
'M' Military
'X' other than any of the defined categories above
iataCancelTimestamp
string <date-time>
ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

isRerouted
required
boolean
operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

operatingAirlineName
string (AirlineName) [ 1 .. 40 ] characters

Name under which airline is recognised.

operatingAirlineOrganizationId
string (AirlineOrganizationId) [ 1 .. 32 ] characters
operatingAirlineTicketed
string or null (AirlineTicketed) [ 1 .. 3 ] characters

"The airline code which will appear on the passengers' tickets for this flight. This can be either the IATA or ICAO code. See AirlineIATA or AirlineICAO for definition of content."

object (PassengerData)
object (PreallocatedPRMData)
object (PRMData)
radioCallsign
string or null (RadioCallsign) [ 1 .. 24 ] characters

Radiotelephony callsigns are used in communication between pilots and air traffic management. RadioCallsign can be of different types, but all are strings of limited length. Usually the RadioCallsign stay the same during a flight leg, but it can change for a (short) period, typically at the request of an air traffic controller.

object
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

object (WeightData)

Response samples

Content type
application/json
[
  • {
    }
]

Update Flight Leg by Id

Update a specific flight leg by unique Flight Leg ID

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Request Body schema: application/json
required

The flight leg data that is to be updated

object (AircraftDataInput)

defines what aircraft attributes can be passed in on flight creation/update

object (ArrivalDataPatch)
callsign
string (Callsign) [ 0 .. 20 ] characters

A call sign is used to uniquely identify an aircraft using the airspace around a particular airport. Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number. Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification. The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).

Array of objects or null (CodeshareData) >= 0 items
object (DepartureDataPatch)
object (DisplayData)
flightDIIndicator
string (DIIndicator)
Enum: "D" "I" "S"

Indicator showing what kind of airport/flight/gate/etc. (domestic, international (Non Schengen), Schengen) this is.

flightId
string (FlightId) [ 1 .. 8 ] characters

IATA based identifier for this flight, usually issued long before the flight actually takes place.

FlightId is normally the concatenation of OperatingAirlineIATA, FlightNumber and OperationalSuffix.

FlightId typically identifies a flight to the majority of systems, but it is not unique across time. It's unique only in conjunction with SIBT/SOBT.

Exception: Some airlines use their ICAO code (OperatingAirlineICAO) instead of OperatingAirlineIATA. This might be because they aren't an IATA member or because they just prefer the ICAO code. Regardless, this means that it is allowed to use OperatingAirlineICAO as part of FlightId.

FlightId is then defined as the concatenation of AirlineIATA || AirportICAO, FlightNumber and OperationalSuffix.

flightNumber
string (FlightNumber) [ 1 .. 5 ] characters

The number of the flight. Unique for one day within one operator, but not necessarily unique across operators. The part of the FlightId excluding the operator code (see "OperatingAirlineIATA"). This is sometimes referred to as the "Trip Number". Reference: IATA Standard Schedules Information Manual, Feb 1997, 2.2.62. Flight Numbers are assigned by a carrier as a multi-purpose reference in connection with the planning and control of the operation of flights.

operationalSuffix
string (OperationalSuffix) <= 1 characters

An optional single letter suffix sometimes appended to the flight number to give some additional information related to the flight number itself, e.g. "DY1349P" may indicate that this is a positioning flight. "R" may also be used to indicate a return from airborne operation.

flightIsMultiLeg
boolean
flightLegSecurityIndicator
string (FlightLegSecurityIndicator)
Enum: "0" "1"

Indicates if there are security issues associated with the flight leg, or not.

  • '0': No security issues with this flight leg.
  • '1': There are security issues with this flight leg.
flightLegStatus
string (FlightLegStatus)
Enum: "ACT" "CAN" "DEL" "DIV" "FLS" "FPL" "LAN" "RER" "SCH" "SEQ" "UKN"

The status of a "FlightLeg". The following values are defined:

"SCH", "FPL", "FLS", "ACT", "CAN", "LAN", "RER", "DIV", "DEL", "UNK"
"SCH" Scheduled
The initial state for scheduled flights.
A known FlightLeg that is expected to depart and land according to the available information.
Can transition to: FPL, ACT, CAN
"FPL" Flight Plan
Initial state for flights that aren't scheduled.
The flight plan has been filed and is registered by ATM.
Can transition to: FLS, SEQ, ACT, CAN
"FLS" Flight Suspended
The flight has been suspended by ATM, but can be activated at any time.
Can transition to: FPL, CAN,
"SEQ" Sequenced
The flight has been sequenced by ATM.
Can transition to: ACT, CAN
"ACT" Active
The aircraft is “off block”, and might be airborne.
Can transition to: LAN, RER
"CAN" Cancelled
The FlightLeg has been cancelled.
End state.
"LAN" Landed
The aircraft has landed on the scheduled airport.
End state.
"RER" Rerouted
The aircraft is in the air, but the destination airport has been changed.
After landing the state will change to “DIV”.
The destination airport can be changed back to the original airport. It is then a regular flight leg, but possibly delayed.
Can transition to: DIV, ACT
"DIV" Diverted
The aircraft has landed on an unscheduled airport.
End state.
"DEL" Deleted
The FlightLeg appears to have been deleted/removed.
This is probably the result of missing schedule change information or some other data errors.
End state.
"UKN" Unknown
Unknown indicates missing information.
object
flightIsCancelled
boolean (FlightIsCancelled)

Set to true if the flight operation is cancelled. For flight as with code share it's possible to only cancel the code shared flight.

flightRouteIATA
Array of strings (FlightRouteIATA) non-empty [ items [ 1 .. 3 ] characters ]
flightServiceTypeExtended
string (FlightServiceTypeExtended) [ 1 .. 3 ] characters

Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.

Examples:

  • "01" Scheduled commercial passenger flights
  • "02" Unscheduled commercial passenger flights
  • "03" Freight
  • "04" Helicopter flights to offshore oil installations
  • "05" Other commercial helicopter flights
  • "06" Other commercial flights
  • "11" Civilian search and recue (SAR)
  • "12" Ambulance flight
  • "13" Civil flight school
  • "14" Positioning flight
  • "15" Technical return
  • "16" Navaid control flight
  • "17" General aviation (GA)
  • "21" Military flight - General code
  • "22" Ambulance flight performed by military aircraft
  • "23" Military flight school
  • "24" Military positioning flight
  • "25" Military test flight
  • "26" Military navaid control flight
  • "27" Search and rescue performed by military aircraft
  • "28" Military aircraft participating in exercise
  • "29" Military training flight
  • "30" Military operational flight
  • "99" Unknown
flightServiceTypeIATA
string (FlightServiceTypeIATA)
Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "U" "S" "V" "T" "W" "X" "Z"

IATA SSIM Appendix C Service Types.

Scheduled, Passenger

  • 'J' - Normal Service
  • 'S' - Shuttle Mode
  • 'U' - Service operated by surface vehicle

Scheduled, Cargo/Mail

  • 'F' - Loose loaded cargo and/or preloaded devices
  • 'V' - Service operated by surface vehicle
  • 'M' - Mail only
  • 'Q' - Passenger/Cargo in Cabin

Additional flights

  • 'G' - Passenger Normal Service
  • 'B' - Passenger Shuttle Mode
  • 'A' - Cargo/Mail
  • 'R' - Passenger/Cargo in Cabin

Charter

  • 'C' - Passenger Only
  • 'O' - Charter requiring special handling (e.g. Migrants/Immigrants)
  • 'H' - Cargo and/or Mail
  • 'L' - Passenger and Cargo and/or Mail

Others

  • 'P' - Non-revenue (Positioning/Ferry/Delivery/Demo)
  • 'T' - Technical Test
  • 'K' - Training (School/Crew check)
  • 'D' - General Aviation
  • 'E' - Special (FAA/Government)
  • 'W' - Military
  • 'X' - Technical Stop (for Chapter 6 applications only)
  • 'I' - State/Diplomatic
  • 'N' - Business Aviation / Air Taxi

Company specific (not IATA standard)

  • 'Z' - Unknown or other than any of the defined categories above. This might be because no information has been received, or because none of the IATA types cover this type of flight.
flightServiceTypeICAO
string (FlightServiceTypeICAO)
Enum: "S" "N" "G" "M" "X"

ICAO Flight Service Types.

Code Description
'S' Scheduled Air Transport
'N' Non-scheduled air transport operation
'G' General aviation
'M' Military
'X' other than any of the defined categories above
ifplId
string or null (IFPLID) [ 1 .. 10 ] characters

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.

isRerouted
boolean
operatingAirlineIATA
string (AirlineIATA) [ 1 .. 3 ] characters

"2 or 3 character code as designated by International Air Transport Association (IATA) to uniquely designate an airline operator. Local (non-IATA) codes can be added as required as long as they are unique for airline operators within the defined context.

Ex: SK, DY. Two or three characters. IATA and ICAO codes can be identical. Reference Document: IATA Airline Coding Directory. The IATA standard uses 2 character codes, but in cases where no IATA standard code exists, an alternative code can be used. This can often be the 3 character ICAO code if one exists."

operatingAirlineICAO
string (AirlineICAO) [ 1 .. 3 ] characters

"2 or 3 character code as designated by the International Civil Aviation Organisation (ICAO) to uniquely designate an airline operator. Local (non-ICAO) codes can be added as required as long as they are unique for airline operators within the defined context.

ICAO defined code for the company owning the aircraft. Ex: SAS, NAX. Two or three characters. IATA and ICAO codes can be identical. The ICAO standard uses 3 character codes, but in cases where no ICAO standard code exists, an alternative code can be used. This can often be the 2 character IATA code if one exists.

Reference Document: ICAO document 8585"

object (PassengerDataIn)
object (PreallocatedPRMData)
object (PRMData)
radioCallsign
string or null (RadioCallsign) [ 1 .. 24 ] characters

Radiotelephony callsigns are used in communication between pilots and air traffic management. RadioCallsign can be of different types, but all are strings of limited length. Usually the RadioCallsign stay the same during a flight leg, but it can change for a (short) period, typically at the request of an air traffic controller.

object
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

object (WeightData)

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Request samples

Content type
application/json
{
  • "aircraftData": {
    },
  • "arrivalData": {
    },
  • "callsign": "string",
  • "codeshareData": [
    ],
  • "departureData": {
    },
  • "displayData": {
    },
  • "flightDIIndicator": "D",
  • "flightId": "string",
  • "flightNumber": "strin",
  • "operationalSuffix": "s",
  • "flightIsMultiLeg": true,
  • "flightLegSecurityIndicator": "0",
  • "flightLegStatus": "ACT",
  • "flightLegMetadata": {
    },
  • "flightIsCancelled": true,
  • "flightRouteIATA": [
    ],
  • "flightServiceTypeExtended": "str",
  • "flightServiceTypeIATA": "A",
  • "flightServiceTypeICAO": "S",
  • "ifplId": "string",
  • "isRerouted": true,
  • "operatingAirlineIATA": "str",
  • "operatingAirlineICAO": "str",
  • "passengerData": {
    },
  • "preallocatedPRMData": {
    },
  • "prmData": {
    },
  • "radioCallsign": "string",
  • "remarkData": {
    },
  • "uniqueFlightLegId": "string",
  • "weightData": {
    }
}

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string"
}

Service Request

Create Flight Leg Service Requests

Create Service Requests against a flight's arrival or departure leg

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

arrDepIndicator
required
string
Enum: "A" "D"
Request Body schema: application/json
required

An array of ServiceRequestData to be added to a flight leg.

Array
serviceRequestTypeCode
required
string (ServiceRequestTypeCode)

The Service Request code which is defined in the underlying system (i.e. AODB). This can be a number of pre-defined codes, for example

  • DEIC - De-icing fluid
  • FUEL - Aviation fuel
  • ENGT - Engine run-up test
  • COMP - Compass swing test
quantity
number or null >= 0

The quantity of items provided in the service request.

startDateTime
string <date-time>

The date and time when the delivery of the service request started

endDateTime
string <date-time>

The date and time when the delivery of the service request ended

duration
string (Duration) ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+...

A duration as defined by the ISO 8601 ABNF for “duration”. For example, P3D expresses a duration of 3 days.

remarks
string or null (RemarkText) >= 0 characters

Free text that is the actual remark.

fixedCost
number
approved
boolean
cancelled
boolean
providerId
string
poNumber
string
confirmed
boolean
confirmedRemarks
string
completedDateTime
string or null <date-time> (CompletedDateTime)

The time at which a service request was completed.

MATOReference
string
POSDeviceReference
string

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Array of objects (ServiceRequestData) [ items ]

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string",
  • "serviceRequestData": [
    ]
}

Update Flight Leg Service Requests by Id

Update Service Requests against a flight's arrival or departure leg

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

arrDepIndicator
required
string
Enum: "A" "D"
Request Body schema: application/json
required

An array of ServiceRequestData to be updated on a flight leg. Returns revised list of delays for arrival/departure end of the flight leg.

Array
serviceRequestId
required
string
serviceRequestTypeCode
string (ServiceRequestTypeCode)

The Service Request code which is defined in the underlying system (i.e. AODB). This can be a number of pre-defined codes, for example

  • DEIC - De-icing fluid
  • FUEL - Aviation fuel
  • ENGT - Engine run-up test
  • COMP - Compass swing test
quantity
number or null >= 0

The quantity of items provided in the service request.

startDateTime
string <date-time>

The date and time when the delivery of the service request started

endDateTime
string <date-time>

The date and time when the delivery of the service request ended

duration
string (Duration) ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+...

A duration as defined by the ISO 8601 ABNF for “duration”. For example, P3D expresses a duration of 3 days.

remarks
string or null (RemarkText) >= 0 characters

Free text that is the actual remark.

fixedCost
number
approved
boolean
cancelled
boolean
providerId
string
poNumber
string
confirmed
boolean
confirmedRemarks
string
completedDateTime
string or null <date-time> (CompletedDateTime)

The time at which a service request was completed.

MATOReference
string
POSDeviceReference
string

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Array of objects (ServiceRequestData) [ items ]

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string",
  • "serviceRequestData": [
    ]
}

Delay

Create Flight Leg Delay. This operation also allows a user to 'upsert', i.e. pass in the delay information, and the API will determine whether an insert, or update is required.

Add a delay to a flight leg

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

arrDepIndicator
required
string
Enum: "A" "D"
Request Body schema: application/json
required

an array of DelayData to be added to a flightLeg.

Array
delaySourceOrganization
required
string (SourceOrganization) [ 1 .. 32 ] characters
delayCodeNumeric
string (DelayOrDiversionCodeNumeric) <= 2 characters

Numeric IATA delay/diversion code. Codes are defined in the IATA Airport Handling Manual chapter 730

delayCodeAlpha
string (DelayOrDiversionCodeAlpha) <= 2 characters

Alpha IATA delay/diversion code. Codes are defined in the IATA Airport Handling Manual chapter 730

delayReason
string or null (DelayOrDiversionReason)

Textual description for the DelayOrDiversionCode.

delaySubCode
string (DelayOrDiversionSubCode) [ 1 .. 2 ] characters

Additional specification of the DelayOrDiversionCode term. The sub codes relates to a particular DelayOrDiversionCode, and are not unique across codes.

delayDuration
string (Duration) ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+...

A duration as defined by the ISO 8601 ABNF for “duration”. For example, P3D expresses a duration of 3 days.

delayStartDateTime
required
string <date-time>
delayEndDateTime
string <date-time>

end time of the delay, must be supplied if delayDuration is not.

approved
boolean

true/false depending on whether the delay has been approved

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Array of objects (DelayData)

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string",
  • "delayData": [
    ]
}

Update Flight Leg Delay

Update a flight leg's delay by Id

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

arrDepIndicator
required
string
Enum: "A" "D"
Request Body schema: application/json
required

an array of DelayData to be updated on a flightLeg. returns revised list of delays for arriva/departure end of the flightLeg.

Array
delayId
required
string

unique id for a delay recorded against a flightLeg.

delayCodeNumeric
string (DelayOrDiversionCodeNumeric) <= 2 characters

Numeric IATA delay/diversion code. Codes are defined in the IATA Airport Handling Manual chapter 730

delayCodeAlpha
string (DelayOrDiversionCodeAlpha) <= 2 characters

Alpha IATA delay/diversion code. Codes are defined in the IATA Airport Handling Manual chapter 730

delayReason
string or null (DelayOrDiversionReason)

Textual description for the DelayOrDiversionCode.

delaySubCode
string (DelayOrDiversionSubCode) [ 1 .. 2 ] characters

Additional specification of the DelayOrDiversionCode term. The sub codes relates to a particular DelayOrDiversionCode, and are not unique across codes.

delayDuration
string (Duration) ^(-?)P(?=\d|T\d)(?:(\d+)Y)?(?:(\d+)M)?(?:(\d+...

A duration as defined by the ISO 8601 ABNF for “duration”. For example, P3D expresses a duration of 3 days.

delayStartDateTime
string <date-time>
delayEndDateTime
string <date-time>

end time of the delay, must be supplied if delayDuration is not.

approved
boolean

true/false depending on whether the delay has been approved

cancelled
boolean

true/false depending on whether the delay has been cancelled

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Array of objects (DelayData)

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string",
  • "delayData": [
    ]
}

Delete Flight Leg Delay by Id

Delete a flight leg's delay by Id

Authorizations:
bearerAuth
path Parameters
uniqueFlightLegId
required
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

arrDepIndicator
required
string
Enum: "A" "D"
delayId
required
string

Responses

Response Schema: application/json
uniqueFlightLegId
string (UniqueFlightLegId) [ 1 .. 36 ] characters

A system specific unique identifier for a flight leg. Can be anything, and doesn't have to be meaningful in any way. Proposed terms will never change and will never be reused.

Array of objects (DelayData)

Response samples

Content type
application/json
{
  • "uniqueFlightLegId": "string",
  • "delayData": [
    ]
}