Ratings Response element

The Ratings Response Element is returned for the following request type:

Table of Contents
Rating
Top
Element Cardinality Description
<rating> 0..n Holder element for a flight rating
<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>PDX</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>HNL</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).
<airline> ... </airline> 0..1 Details for the airline operating this flight (if using the extended options to include inlined references, otherwise the airline details will be present in the appendix). Airline Fields
<airlineFsCode>HA</airlineFsCode> 0..1 The Cirium unique code for the airline to use as a reference for finding the entry in the appendix (unless the extended option to include inlined references is used).
<flightNumber>25</flightNumber> 1..1 The flight identifier of the flight, typically a number.
<codeshares>0</codeshares> 1..1 The number of codeshare observations in the rating.
<directs>0</directs> 1..1 The number of direct flights in the rating.
<observations>61</observations> 1..1 The number of observations in the sample for ontime performance.
<ontime>54</ontime> 1..1 The number of observations classified as "ontime" (<15 minutes late).
<late15>4</late15> 1..1 The number of observations classified as "late" (15 - 29 minutes).
<late30>1</late30> 1..1 The number of observations classified as "very late" (30 - 44 minutes).
<late45>1</late45> 1..1 The number of observations classified as "excessively late" (45 + minutes).
<cancelled>0</cancelled> 1..1 The number of observations cancelled.
<diverted>0</diverted> 1..1 The number of observations diverted.
<ontimePercent>0.8852459016393442</ontimePercent> 1..1 The percent of ontime observations.
<delayObservations>22</delayObservations> 1..1 The number of observations that arrived later than scheduled time (> 1 minute late).
<delayMean>15.0</delayMean> 1..1 The mean delay.
<delayStandardDeviation>20.030712349525597</delayStandardDeviation> 1..1 The standard deviation of the delay.
<delayMin>0</delayMin> 1..1 The minimum delay value observed.
<delayMax>79</delayMax> 1..1 The maximum delay value observed.
<allOntimeCumulative>0.9713</allOntimeCumulative> 1..1 How the flight ranks relative to peers on ontime performance (better than %).
<allOntimeStars>4.9</allOntimeStars> 1..1 The rating for this flight's ontime performance (0-5 scale) compared to all flights.
<allDelayCumulative>0.8643</allDelayCumulative> 1..1 How the flight ranks relative to peers on delay performance (better than %).
<allDelayStars>4.3</allDelayStars> 1..1 The rating for this flight's delay performance (0-5 scale) compared to all flights.
<allStars>4.6</allStars> 1..1 The avg of All_ontime_stars and All_delay_stars yielding the overall performance measure of this flight compared to all flights.
</rating>
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
E Railway Company Y Y
F Ferry Company N Y
G Non-airline ULD N Y
H Computer Reservation System n/a n/a
I Scheduled Passenger/Cargo Carrier Y Y
J Non-scheduled Passenger/Cargo Carrier Y Y
K Bus Company Y Y
S Miscellaneous/Other n/a n/a
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.
Example XML Output
Top
The following example is a partial response and uses inline references for simplicity.
See Full Sample Responses for a complete response.
<rating> <departureAirportFsCode>PDX</departureAirportFsCode> <arrivalAirportFsCode>HNL</arrivalAirportFsCode> <airlineFsCode>HA</airlineFsCode> <flightNumber>25</flightNumber> <codeshares>0</codeshares> <directs>0</directs> <observations>61</observations> <ontime>54</ontime> <late15>4</late15> <late30>1</late30> <late45>2</late45> <cancelled>0</cancelled> <diverted>0</diverted> <ontimePercent>0.8852459016393442</ontimePercent> <delayObservations>22</delayObservations> <delayMean>15.0</delayMean> <delayStandardDeviation>20.030712349525597</delayStandardDeviation> <delayMin>0</delayMin> <delayMax>79</delayMax> <allOntimeCumulative>0.9713</allOntimeCumulative> <allOntimeStars>4.9</allOntimeStars> <allDelayCumulative>0.8643</allDelayCumulative> <allDelayStars>4.3</allDelayStars> <allStars>4.6</allStars> </rating>
Example JSON Output (whitespace added for clarity)
Top
The following example is a partial response and uses inline references for simplicity.
See Full Sample Responses for a complete response.
{ departureAirportFsCode: "PDX", arrivalAirportFsCode: "HNL", airlineFsCode: "HA", flightNumber: "25", codeshares: 0, directs: 0, observations: 61, ontime: 54, late15: 4, late30: 1, late45: 2, cancelled: 0, diverted: 0, ontimePercent: 0.8852459016393442, delayObservations: 22, delayMean: 15, delayStandardDeviation: 20.030712349525597, delayMin: 0, delayMax: 79, allOntimeCumulative: 0.9713, allOntimeStars: 4.9, allDelayCumulative: 0.8643000000000001, allDelayStars: 4.3, allStars: 4.6 }
Full Sample Responses
Top