Scheduled Flight Response element

The Scheduled Flight Response Element is returned for the following request type:

Table of Contents
Scheduled Flight
Top
Element Cardinality Description
<scheduledFlight> 0..n Holder element for a scheduled flight
<carrier>...</carrier> 0..1 Details for the operating carrier of the flight (if using the extended options to include inlined references, otherwise the airline details will be present in the appendix). Airline Fields
<carrierFsCode>AA</carrierFsCode> 0..1 The Cirium unique code for the operating carrier to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used).
<flightNumber>100</flightNumber> 1..1 The flight identification number and any additional characters (String).
<departureAirport> ... </departureAirport> 0..1 Details for the departure airport (if using the extended options to include inlined references, otherwise the airport details will be present in the appendix). Airport Fields
<departureAirportFsCode>JFK</departureAirportFsCode> 0..1 The Cirium unique code for the departure airport to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used).
<arrivalAirport> ... </arrivalAirport> 0..1 Details for the arrival airport (if using the extended options to include inlined references, otherwise the airport details will be present in the appendix). Airport Fields
<arrivalAirportFsCode>LHR</arrivalAirportFsCode> 0..1 The Cirium unique code for the arrival airport to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used).
<stops>0<stops> 1..1 The number of stops between the departure and arrival airport. This will always be 0 unless the extended option "includeDirects" is specified.
<departureTerminal>8</departureTerminal> 0..1 The terminal from which the flight departed or will depart.
<arrivalTerminal>3</arrivalTerminal> 0..1 The terminal into which the flight arrived or will arrive.
<departureTime>2013-05-21T18:05:00.000</departureTime> 1..1 The published departure time (local to the airport) for the flight provided by the airline's operating schedule.
<arrivalTime>2013-05-22T06:20:00.000</arrivalTime> 1..1 The published arrival time (local to the airport) for the flight provided by the airline's operating schedule.
<flightEquipment> ... </flightEquipment> 0..1 The equipment scheduled to be flown (if using the extended options to include inlined references, otherwise the equipment details will be present in the appendix). Equipment Fields
<flightEquipmentIataCode>777</flightEquipmentIataCode> 0..n The IATA code for the equipment scheduled to be flown to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used)
<isCodeshare>false</isCodeshare> 1..1 Boolean value indicating if the marketed flight is a codeshare.
<isWetlease>false</isWetlease> 1..1 Boolean value indicating if the marketed flight is a wetlease.
<serviceType>J</serviceType> 1..1 The type of service offered for the flight:
Value Description Passenger Cargo Surface
J Scheduled Passenger (Normal Service) Y N N
S Scheduled Passenger (Shuttle Service) Y N N
G Non-scheduled Passenger (Normal Service) Y N N
B Non-scheduled Passenger (Shuttle Service) Y N N
C Charter (Passenger Only) Y N N
O Charter (Special handling - Migrants/Immigrants) Y N N
L Charter (Passenger and Cargo and/or Mail) Y Y N
R Additional Flights - Passenger/Cargo Y Y N
Q Scheduled Passenger/Cargo in Cabin Y Y N
F Scheduled Cargo/Mail (Loose loaded cargo and/or preloaded devices) N Y N
M Scheduled Cargo/Mail (Mail Only) N Y N
A Non-scheduled Cargo/Mail N Y N
H Charter (Cargo and/or Mail) N Y N
V Scheduled Cargo/Mail (Surface Vehicle) N Y Y
U Scheduled Passenger (Service Vehicle) Y N Y
<serviceClasses> 0..1 IATA service classes offered for the flight.
<serviceClass>R</serviceClass> 1..n IATA service class offered for the flight.
</serviceClasses>
<trafficRestrictions> 0..1 IATA restrictions imposed on the flight.
<trafficRestriction>Q</trafficRestriction> 1..n IATA restriction imposed on the flight. (One-letter string)
</trafficRestrictions>
<operator> 0..1 The operator's flight information, which appears only when the marketed flight is a codeshare (isCodeshare is true).
<carrier>...</carrier> 0..1 Details for the operating carrier of the flight (if using the extended options to include inlined references, otherwise the airline details will be present in the appendix). Airline Fields
<carrierFsCode>LY</carrierFsCode> 0..1 The Cirium unique code for the carrier operating carrier to use as a reference for finding the entry in the appendix (unless the extended option 'useInlinedReferences' is used).
<flightNumber>2627</flightNumber> 1..1 Flight Number assigned by the operating carrier.
<serviceType>J</serviceType> 0..n The type of service offered for the flight (see serviceType above).
<serviceClasses> 0..n IATA service classes offered for the flight.
<serviceClass>F</serviceClass> 1..n IATA service class offered for the flight.
</serviceClasses>
<trafficRestrictions> 0..1 IATA restrictions imposed on the flight.
<trafficRestriction>O</trafficRestriction> 1..n IATA restriction imposed on the flight. (One-letter string)
</trafficRestrictions>
</operator>
<codeshares> 0..1 Any codeshares for this operated flight. Codeshares are only possible if this flight leg is not itself a codeshare (the codeshare field must be false).
<codeshare> 1..n codeshare for this operated flight.
<carrier>...</carrier> 0..1 Details for the operating carrier of the flight (if using the extended options to include inlined references, otherwise the airline details will be present in the appendix). Airline Fields
<carrierFsCode>LY</carrierFsCode> 0..1 The Cirium unique code for the carrier that is marketing the codeshare (this may be the operator or a codeshare partner) to use as a reference for finding the entry in the appendix (unless the extended option 'useInlinedReferences' is used).
<flightNumber>8051</flightNumber> 1..1 The flight number marketed by the codeshare partner.
<serviceType>J</serviceType> 0..n The type of service offered for the flight (see serviceType above).
<serviceClasses> 0..n IATA service classes offered for the flight.
<serviceClass>F</serviceClass> 1..n IATA service class offered for the flight.
</serviceClasses>
<trafficRestrictions> 0..1 IATA restrictions imposed on the flight.
<trafficRestriction>Q</trafficRestriction> 1..n IATA restriction imposed on the flight. (One-letter string)
</trafficRestrictions>
<referenceCode>10418424</referenceCode> 0..1 Reference code for Cirium' troubleshooting purposes.
</codeshare>
</codeshares>
<referenceCode>708-1673128--</referenceCode> 1..1 Reference code for Cirium' troubleshooting purposes.
</scheduledFlight>
Airline
Top
Element Cardinality Description
<fs>AA<fs> 1..1 The Cirium code for the carrier, globally unique across time (String).
<iata>AA<iata> 0..1 The IATA code for the carrier (String).
<icao>AAL<icao> 0..1 The ICAO code for the carrier (String).
<name>American Airlines<name> 1..1 The name of the carrier (String).
<phoneNumber>1-800-433-7300</phoneNumber> 0..1 The primary customer service phone number for the carrier (String).
<active>true</active> 1..1 Boolean value indicating if the airline is currently active (Boolean).
<category>A</category> 0..1 NEW The category of operation of the airline:
Value Description Passenger Cargo
A Scheduled Passenger Carrier Y N
B Non-Scheduled Passenger Carrier Y N
C Scheduled Cargo Carrier N Y
D Non-scheduled Cargo Carrier N Y
I Scheduled Passenger/Cargo Carrier Y Y
J Non-scheduled Passenger/Cargo Carrier Y Y
K Railway Service Y Y
Fields marked as NEW will only be returned if the extended option "includeNewFields" is used. See the Flex API Version Policy page for details.
Airport
Top
Element Cardinality Description
<fs>PDX</fs> 1..1 The Cirium code for the airport, globally unique across time (String).
<iata>PDX</iata> 0..1 The IATA code for the airport (String).
<icao>KPDX</icao> 0..1 The ICAO code for the airport (String).
<faa>PDX</faa> 0..1 The FAA code for the airport (String).
<name>Portland International Airport</name> 0..1 The name of the airport (String).
<street1>7000 Northeast, Airport Way</street1> 0..1 The street address of the airport, part 1 (String).
<street2></street2> 0..1 Street address of the airport, part 2 (String).
<city>Portland</city> 1..1 The city with which the airport is associated (String).
<cityCode>PDX</cityCode> 0..1 The city code with which the airport is associated (String).
<district>Chaoyang</district> 0..1 NEW The district of the city in which the airport is located (String).
<stateCode>OR</stateCode> 0..1 The State in which the airport is located (String).
<postalCode>97216</postalCode> 0..1 The postal code in which the airport resides (String).
<countryCode>US</countryCode> 1..1 The code for the country in which the airport is located (String).
<countryName>United States</countryName> 1..1 The name of the country in which the Airport is located (String).
<regionName>North America</regionName> 1..1 The name of the region in which the Airport is located (String).
<timeZoneRegionName>America/Los_Angeles</timeZoneRegionName> 1..1 The name of the Time Zone region in which the Airport is located (String).
<weatherZone>ORZ006</weatherZone> 0..1 The NOAA weather zone (US only) in which the Airport is located (String).
<localTime>2012-08-09T11:02:59.571</localTime> 1..1 The local time at the Airport when the request was made in ISO-8601 format. yyyy-MM-dd'T'HH:mm:ss.SSS.
<utcOffsetHours>-7.0</utcOffsetHours> 1..1 The current UTC offset at the Airport when the request was made (Double).
<latitude>40.642335</latitude> 1..1 The latitude of the airport in decimal degrees (Double).
<longitude>-73.78817</longitude> 1..1 The longitude of the airport in decimal degrees (Double).
<elevationFeet>30</elevationFeet> 1..1 The elevation above sea level of the airport in feet (Integer).
<classification>1</classification> 1..1 The Cirium classification of the airport, 1(max) to 5(min). (Integer).
<active>true</active> 1..1 Boolean value indicating if the airport is currently operational (Boolean).
Fields marked as NEW will only be returned if the extended option "includeNewFields" is used. See the Flex API Version Policy page for details.
Equipment
Top
Element Cardinality Description
<iata>777</iata> 1..1 The IATA code for the equipment type. (String)
<name>Boeing 777 Passenger</name> 1..1 The descriptive name for the equipment type. (String)
<turboProp>false</turboProp> 1..1 Boolean value indicating if the equipment type uses TurboProp propulsion (Boolean).
<jet>true</jet> 1..1 Boolean value indicating if the equipment type uses jet propulsion (Boolean).
<widebody>true</widebody> 1..1 Boolean value indicating if the equipment type is a wide-body airframe (Boolean).
<regional>false</regional> 1..1 Boolean value indicating if the equipment type is a regional airframe (Boolean).
Example XML Output
Top
The following example is a partial response and uses inline references for simplicity.
<scheduledFlight> <carrier> <fs>AA</fs> <iata>AA</iata> <icao>AAL</icao> <name>American Airlines</name> <phoneNumber>1-800-433-7300</phoneNumber> <active>true</active> </carrier> <flightNumber>100</flightNumber> <departureAirport> <fs>JFK</fs> <iata>JFK</iata> <icao>KJFK</icao> <faa>JFK</faa> <name>John F. Kennedy International Airport</name> <street1>JFK Airport</street1> <city>New York</city> <cityCode>NYC</cityCode> <stateCode>NY</stateCode> <postalCode>11430</postalCode> <countryCode>US</countryCode> <countryName>United States</countryName> <regionName>North America</regionName> <timeZoneRegionName>America/New_York</timeZoneRegionName> <weatherZone>NYZ178</weatherZone> <localTime>2013-05-20T17:04:41.205</localTime> <utcOffsetHours>-4.0</utcOffsetHours> <latitude>40.642335</latitude> <longitude>-73.78817</longitude> <elevationFeet>13</elevationFeet> <classification>1</classification> <active>true</active> </departureAirport> <arrivalAirport> <fs>LHR</fs> <iata>LHR</iata> <icao>EGLL</icao> <name>London Heathrow Airport</name> <city>London</city> <cityCode>LON</cityCode> <stateCode>EN</stateCode> <countryCode>GB</countryCode> <countryName>United Kingdom</countryName> <regionName>Europe</regionName> <timeZoneRegionName>Europe/London</timeZoneRegionName> <localTime>2013-05-20T22:04:41.205</localTime> <utcOffsetHours>1.0</utcOffsetHours> <latitude>51.469603</latitude> <longitude>-0.453566</longitude> <elevationFeet>80</elevationFeet> <classification>1</classification> <active>true</active> </arrivalAirport> <stops>0</stops> <departureTerminal>8</departureTerminal> <arrivalTerminal>3</arrivalTerminal> <departureTime>2013-05-21T18:05:00.000</departureTime> <arrivalTime>2013-05-22T06:20:00.000</arrivalTime> <flightEquipment> <iata>777</iata> <name>Boeing 777 Passenger</name> <turboProp>false</turboProp> <jet>true</jet> <widebody>true</widebody> <regional>false</regional> </flightEquipment> <isCodeshare>false</isCodeshare> <isWetlease>false</isWetlease> <serviceType>J</serviceType> <serviceClasses> <serviceClass>R</serviceClass> <serviceClass>F</serviceClass> <serviceClass>J</serviceClass> <serviceClass>Y</serviceClass> </serviceClasses> <trafficRestrictions/> <codeshares> <codeshare> <carrier> <fs>LY</fs> <iata>LY</iata> <icao>ELY</icao> <name>El Al</name> <active>true</active> </carrier> <flightNumber>8051</flightNumber> <serviceType>J</serviceType> <serviceClasses> <serviceClass>F</serviceClass> <serviceClass>J</serviceClass> <serviceClass>Y</serviceClass> </serviceClasses> <trafficRestrictions> <trafficRestriction>O</trafficRestriction> </trafficRestrictions> <referenceCode>10418424</referenceCode> </codeshare> <codeshare> <carrier> <fs>BA</fs> <iata>BA</iata> <icao>BAW</icao> <name>British Airways</name> <phoneNumber>1-800-AIRWAYS</phoneNumber> <active>true</active> </carrier> <flightNumber>1511</flightNumber> <serviceType>J</serviceType> <serviceClasses> <serviceClass>R</serviceClass> <serviceClass>F</serviceClass> <serviceClass>J</serviceClass> <serviceClass>Y</serviceClass> </serviceClasses> <trafficRestrictions/> <referenceCode>10418423</referenceCode> </codeshare> <codeshare> <carrier> <fs>IB</fs> <iata>IB</iata> <icao>IBE</icao> <name>Iberia</name> <active>true</active> </carrier> <flightNumber>4218</flightNumber> <serviceType>J</serviceType> <serviceClasses> <serviceClass>R</serviceClass> <serviceClass>F</serviceClass> <serviceClass>J</serviceClass> <serviceClass>Y</serviceClass> </serviceClasses> <trafficRestrictions/> <referenceCode>10418422</referenceCode> </codeshare> <codeshare> <carrier> <fs>GF</fs> <iata>GF</iata> <icao>GFA</icao> <name>Gulf Air</name> <active>true</active> </carrier> <flightNumber>6654</flightNumber> <serviceType>J</serviceType> <serviceClasses> <serviceClass>J</serviceClass> <serviceClass>Y</serviceClass> </serviceClasses> <trafficRestrictions> <trafficRestriction>Q</trafficRestriction> </trafficRestrictions> <referenceCode>10418421</referenceCode> </codeshare> </codeshares> <referenceCode>708-1673128--</referenceCode> </scheduledFlight>
Example JSON Output (whitespace added for clarity)
Top
The following example is a partial response and uses inline references for simplicity.
{ "carrier": { "fs": "AA", "iata": "AA", "icao": "AAL", "name": "American Airlines", "phoneNumber": "1-800-433-7300", "active": true }, "flightNumber": "100", "departureAirport": { "fs": "JFK", "iata": "JFK", "icao": "KJFK", "faa": "JFK", "name": "John F. Kennedy International Airport", "street1": "JFK Airport", "city": "New York", "cityCode": "NYC", "stateCode": "NY", "postalCode": "11430", "countryCode": "US", "countryName": "United States", "regionName": "North America", "timeZoneRegionName": "America/New_York", "weatherZone": "NYZ178", "localTime": "2013-05-20T17:16:59.655", "utcOffsetHours": -4.0, "latitude": 40.642335, "longitude": -73.78817, "elevationFeet": 13, "classification": 1, "active": true }, "arrivalAirport": { "fs": "LHR", "iata": "LHR", "icao": "EGLL", "name": "London Heathrow Airport", "city": "London", "cityCode": "LON", "stateCode": "EN", "countryCode": "GB", "countryName": "United Kingdom", "regionName": "Europe", "timeZoneRegionName": "Europe/London", "localTime": "2013-05-20T22:16:59.655", "utcOffsetHours": 1.0, "latitude": 51.469603, "longitude": -0.453566, "elevationFeet": 80, "classification": 1, "active": true }, "stops": 0, "departureTerminal": "8", "arrivalTerminal": "3", "departureTime": "2013-05-21T18:05:00.000", "arrivalTime": "2013-05-22T06:20:00.000", "flightEquipment": { "iata": "777", "name": "Boeing 777 Passenger", "turboProp": false, "jet": true, "widebody": true, "regional": false }, "isCodeshare": false, "isWetlease": false, "serviceType": "J", "serviceClasses": ["R", "F", "J", "Y"], "trafficRestrictions": [], "codeshares": [ { "carrier": { "fs": "LY", "iata": "LY", "icao": "ELY", "name": "El Al", "active": true }, "flightNumber": "8051", "serviceType": "J", "serviceClasses": ["F", "J", "Y"], "trafficRestrictions": ["O"], "referenceCode": 10418424 }, { "carrier": { "fs": "BA", "iata": "BA", "icao": "BAW", "name": "British Airways", "phoneNumber": "1-800-AIRWAYS", "active": true }, "flightNumber": "1511", "serviceType": "J", "serviceClasses": ["R", "F", "J", "Y"], "trafficRestrictions": [], "referenceCode": 10418423 }, { "carrier": { "fs": "IB", "iata": "IB", "icao": "IBE", "name": "Iberia", "active": true }, "flightNumber": "4218", "serviceType": "J", "serviceClasses": ["R", "F", "J", "Y"], "trafficRestrictions": [], "referenceCode": 10418422 }, { "carrier": { "fs": "GF", "iata": "GF", "icao": "GFA", "name": "Gulf Air", "active": true }, "flightNumber": "6654", "serviceType": "J", "serviceClasses": ["J", "Y"], "trafficRestrictions": ["Q"], "referenceCode": 10418421 } ], "referenceCode": "708-1673128--" }
Full Sample Responses
Top