See below for a reference list of response field names, and their corresponding descriptions.
Field Name |
Name in the response |
Description |
||||||||||||||||||||
Data Status |
status |
Indicates if the schedule was new, updated (=changed), or deleted |
||||||||||||||||||||
Data updated at |
updatedAt |
The UTC date & time of the update |
||||||||||||||||||||
Carrier Code |
carrierCode |
This field contains a carrier designator code assigned by either: · IATA (International Air Transport Association) a two-character code of the carrier · ICAO (International Civil Aviation Organization) a three-character code of the carrier. |
||||||||||||||||||||
Service Suffix |
serviceSuffix |
A code assigned by the administrating carrier for operational purposes. |
||||||||||||||||||||
Flight Number |
flightNumber |
The numeric part (up to 4 digits) of the flight number of the operation. |
||||||||||||||||||||
Document Type |
documentType |
Meta data the denotes the data category represented in the alert e.g. “ScheduleInstance” or “ScheduleStatus” |
||||||||||||||||||||
Sequence Number |
sequenceNumber |
Sequence of stopping points starting at 0. |
||||||||||||||||||||
Departure |
departure |
Contains field values related to departure, i.e. Airport, Terminal, Time, Date |
||||||||||||||||||||
Departure Airport |
airport |
The three-letter code assigned by IATA to the departure port. |
||||||||||||||||||||
Departure Terminal |
terminal |
The departure terminal code. |
||||||||||||||||||||
Departure Time |
passengerLocalTime |
The local departure time in 24-hour format HHMM, e.g. 0925. |
||||||||||||||||||||
Departure Date |
date |
The departure date of the flight in yyyy-mm-dd format |
||||||||||||||||||||
Arrival |
arrival |
Contains field values related to arrival, i.e. Airport, Terminal, Time, Date |
||||||||||||||||||||
Arrival Airport |
airport |
The three-letter code assigned by IATA to the arrival port. |
||||||||||||||||||||
Arrival Terminal |
terminal |
The arrival terminal code. |
||||||||||||||||||||
Arrival Time |
passengerLocalTime |
The local arrival time in 24-hour format HHMM, e.g. 1430. |
||||||||||||||||||||
Arrival Date |
date |
The arrival date of the flight in yyyy-mm-dd format |
||||||||||||||||||||
Aircraft Type |
aircraftType |
General equipment type is the IATA generic equipment type code used to describe one or more equipment of a particular type. A 747 equipment type could describe a 747, 741, 742 or a 74R specific equipment type. Specific (or input) equipment type is the specific IATA equipment type code.
|
||||||||||||||||||||
Service Type |
serviceTypeCode |
Indicates the utilization of the equipment whether passenger, cargo etc. Please refer to this page for a list of service type codes and their descriptions. |
||||||||||||||||||||
Arrival Interval Days |
arrivalIntervalDays |
Shows if the leg/segment arrives on a different day to when it departed
|
||||||||||||||||||||
Leg Arrival Interval Days |
legArrivalIntervalDays |
The interval day of the leg |
||||||||||||||||||||
Segment Info |
segmentInfo |
Contains field values related to fight the segment, i.e. number of stops, intermediate airports |
||||||||||||||||||||
Stops |
numberOfStops |
This is the total number of stops for the operation |
||||||||||||||||||||
Intermediate Airports |
intermediateAirports |
The ports at which any stops occur. These are shown as 3 letter IATA port codes. |
||||||||||||||||||||
Schedule Fingerprint* |
oagFingerprint* |
Unique identifier for the schedule instances version in time. It is based on the schedule flight leg primary key effective on and data load timestamp* |
||||||||||||||||||||
Codeshare |
codeshare |
A marker to show if the carrier is operating or non-operating when a codeshare relationship exists. For operations with no code share the entry will be blank. O = Operating N = Non-Operating |
||||||||||||||||||||
Operating Airline Disclosure |
operatingAirlineDisclosure |
Denotes the operating carrier of a flight where seats/space can be sold by one or more airline under its own Carrier code in a codeshare agreement. If null assume carrier code is the operator. |
||||||||||||||||||||
Operating Airline Disclosure Code |
code |
Shows the carrier that operates the service in a shared airline agreement. Where an airline integrates their schedules with another airline and sometimes shares the airline code. In a typical case some or all the services operated by a commuter airline are identified with the code of the airline with which it has a special agreement. In some cases, both carriers will show a schedule for the operation. |
||||||||||||||||||||
Operating Airline Disclosure Name |
name |
The name relating to the operator of the operation. |
||||||||||||||||||||
Operating Airline Disclosure Number |
number |
DEI number relating to operating airline disclosure (will be DEI 29 OR 127) |
||||||||||||||||||||
Aircraft Owner |
aircraftOwner |
The Carrier code and/or name of the owner of the equipment. |
||||||||||||||||||||
Aircraft Owner Code |
code |
The Carrier code of the owner of the equipment. |
||||||||||||||||||||
Aircraft Owner Name |
name |
The Carrier name of the owner of the equipment. |
||||||||||||||||||||
Cockpit Crew Employer |
cockpitCrewEmployer |
The Carrier code and/or name of the provider of the cockpit crew. |
||||||||||||||||||||
Cockpit Crew Employer Code |
code |
The Carrier code of the provider of the cockpit crew. |
||||||||||||||||||||
Cockpit Crew Employer Name |
name |
The Carrier name of the provider of the cockpit crew. |
||||||||||||||||||||
Cockpit Crew Employer Number |
number |
The Carrier number of the provider of the cockpit crew. |
||||||||||||||||||||
Joint Operation Airline Designators |
jointOperationAirlineDesignators |
The Carrier codes, name and/or number that denote when two or three carriers jointly operate the flight. |
||||||||||||||||||||
Joint Operation Airline Designators Code |
code |
The Carrier codes that denote when two or three carriers jointly operate the flight. |
||||||||||||||||||||
Joint Operation Airline Designators Name |
name |
The Carrier names that denote when two or three carriers jointly operate the flight. |
||||||||||||||||||||
Joint Operation Airline Designators Number |
number |
The Carrier numbers that denote when two or three carriers jointly operate the flight. |
||||||||||||||||||||
Comment 010 |
comment010 |
Duplicate flight identifier for an Operating Flight. Here the Marketing Carrier Code and Service number(s) are displayed. |
||||||||||||||||||||
Comment 010 Code |
code |
Carrier code |
||||||||||||||||||||
Comment 010 Service Number |
serviceNumber |
Service Number |
||||||||||||||||||||
Comment 010 Suffix |
Suffix |
Relates to the operation suffix |
||||||||||||||||||||
Comment 050 |
comment050 |
Duplicate flight indicator for a Marketing Flight. Here the Operating Carrier Code and Service Number is displayed. |
||||||||||||||||||||
Comment 050 Code |
code |
Operating Carrier Code for the Marketing Flight |
||||||||||||||||||||
Comment 050 Service Number |
serviceNumber |
Service Number for the Marketing Flight |
||||||||||||||||||||
Comment 050 Suffix |
suffix |
Relates to the operation suffix |
||||||||||||||||||||
Booking Classes |
bookingClasses |
Information relating to the Passenger Reservations Booking Designator (PRBD) and Meals. |
||||||||||||||||||||
Booking Classes Code |
code |
The Passenger Reservations Booking Designator (PRBD) as per IATA standard. |
||||||||||||||||||||
Booking Classes Meals |
Meals |
The meal/s available in relation to the Passenger Reservations Booking Designator. Please see this page for a reference list of IATA meal codes. |
||||||||||||||||||||
Booking Classes Modifier |
modifier |
Indicates applicable fare modifications, e.g. night class. |
||||||||||||||||||||
Freight Classes |
freightClasses |
The freight classes indicate the type of cargo that can be loaded onto the equipment. |
||||||||||||||||||||
Freight Classes Code |
code |
A code for the type of cargo loaded e.g., Q = Passenger/Cargo in Cabin (pax cum freighter) |
||||||||||||||||||||
Restrictions |
restrictions |
Information provided by a carrier to specify restrictions on carrying traffic or limitations to the carriage of traffic. |
||||||||||||||||||||
Restrictions Number |
number |
The traffic restriction number |
||||||||||||||||||||
Restrictions Code |
code |
The traffic restriction code. |
||||||||||||||||||||
Restrictions Pax |
Alerts: Pax, Cargo, Mail, BoardPoint, OffPoint |
True/False value showing application of traffic restriction for this usage type. |
||||||||||||||||||||
Restrictions Cargo |
cargo |
True/False value showing application of traffic restriction for this usage type. |
||||||||||||||||||||
Restrictions Mail |
|
True/False value showing application of traffic restriction for this usage type. |
||||||||||||||||||||
Restrictions BoardPoint |
boardPoint |
True/False value showing if traffic restriction applies at the board point. |
||||||||||||||||||||
Restrictions OffPoint |
offPoint |
True/False value showing if traffic restriction applies at the off point. |
||||||||||||||||||||
Plane change without aircraft change |
planeChangeWithoutAircraftChange |
True/False value showing if there is an equipment change enroute where the IATA Aircraft Type code is the same on each leg. |
||||||||||||||||||||
On Time Performance |
onTimePerformance |
A percentage indication of operations that arrive within 15 mins of the scheduled arrival time. |
||||||||||||||||||||
On Time Performance Indicator |
indicator |
Shows on-time performance for the flight. 0 - 0-9 Percent |
||||||||||||||||||||
On Time Performance Delays & Cancellations Indicator |
delaysAndCancellationsIndicator |
Represents; · Operations on time arriving within 15 minutes of the scheduled arrival time (provided in DEI 501) · Operations that were more than 30 minutes late · Operations that were late more than 30 minutes more than 50% of the time · Operation cancelled, where this was more than 5% of an airline’s operation |
||||||||||||||||||||
Inflight Service |
inFlightServices |
Denotes the use of in-flight services in relation to the IATA standard. This is a “/” separated string. Please see this page for a reference list of in-flight service codes. |
||||||||||||||||||||
Automated Check-in |
automatedCheckIn |
Identifies if the carrier offers automated check-in for the flight leg |
||||||||||||||||||||
Electronic Ticketing |
electronicTicketing |
Used to identify if a flight leg is an electronic ticketing candidate |
||||||||||||||||||||
Secure Flight |
secureFlightIndicator |
This data element is present when there is a legal requirement to disclose full Secure Flight passenger data for flights that are operated by a carrier (operating and marketing) flying to/from/within/over the U.S. S indicates TSA regulations apply. |
||||||||||||||||||||
Government Approval |
governmentApproval |
Marker to show service is subject to government approval. |
||||||||||||||||||||
Schedule Key |
scheduleInstanceKey |
Unique identifier for this specific scheduled flight. It is based on the schedule flight leg primary key effective on and data load timestamp and will be carried over for changes in the schedule related to the same flight. |
||||||||||||||||||||
Status Key |
statusKey |
Unique identifier for this specific scheduled flight, to be used to track status updates. Users who have a status subscription would be able to use this value to connect to flight status updates for this specific flight. |
*Please note that this field is intended for deprecation - it is advised that you do not put in place any logic in your application that relies on the availability of that field. Use of the alternate field (which has the same value) schedulesInstanceKey is highly recommended.
Seats Information (Optional)
The below fields are also available in the response if registered for in your profile/alert but may come with additional charges.
totalSeats |
Available seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |
firstClass |
Available First Class seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |
businessClass |
Available Business Class seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |
premiumEconomyClass |
Available Premium Economy seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |
economyPlusClass |
Available Economy Plus seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |
economyClass |
Available Economy seats for the operation. The value is taken from information from the operating carrier where applicable. Where specific seats data by carrier is not available the value is calculated using a proprietary data model. |