A special optional parameter,
extendedOptions, adjusts the format and content of the response. Extended options are specified by mnemonic strings.
The following options (described below) are common to most of the Flex APIs:
useHTTPErrors(available for all Flex APIs)
useInlinedReferences(available on many Flex APIs)
includeNewFields(available on all Flex APIs)
:xx(available on many Flex APIs)
To specify these options in a REST-style request, simply include them as an optional parameter. Any of the following are valid:
extendedOptions=useHTTPErrors extendedOptions=usehTTpeRRors // (not case sensitive) extendedOptions=usehttperrors+useInlinedReferences
Unrecognized options are silently ignored.
useHTTPErrors is specified, the error will be reported as the HTTP status of the response, with details about the error in the body of the error message. A full response object will not be returned.
Inline versus Appendix Details
By default, potentially repetitive data in responses for some APIs is summarized in the
appendix element. For example, in
flightStatus elements, airports are referenced as
departureAirportFsCode. Details on each airport referenced would appear in an
airports element in the appendix.
If you prefer to have this information embedded in the main response element, pass
Accessing Extended Fields
By default, API requests return the frozen Long Term Support data for a given version (see Version Policy for details).
If there are new fields available for the requested version they can be included by specifying the option
Some APIs offer localization of strings in the response data. Specify the desired language by providing the option
languageCode:xx, substituting the appropriate two-letter language code for
xx. If you supply an unrecognized code, you will get responses with localized strings in the default, English.
APIs Supporting Localization
|Airports||airport names, city names, street addresses, countries, districts, regions|
|Alerts||airport names, city names, street addresses, countries, districts, regions, airline names, equipment names|
|Delay Index||airport names, city names, street addresses, countries, districts, regions|
|FlightStatus||airport names, city names, street addresses, countries, districts, regions, airline names, equipment names|
|FIDS||airport names, city names, airline names, "prevailing conditions" weather tags, timeliness remarks|
|Ratings||airport names, city names, street addresses, countries, districts, regions, airline names|
|Weather||airport names, city names, street addresses, countries, districts, regions, "prevailing conditions" tags|