Briefing

Briefing pack

A customized briefing pack in PDF format can be obtained for each route. The syntax is as follows:

HTTP GET to https://api.autorouter.aero/v1.0/flightplan/<routeid>/briefing?<item_1>[&<item_n>]

The parameters denote the briefing pack components that are requested. Possible values include:

  1. navlog
    Navigation log, also known as “PLOG”.
  2. wb
    Mass & Balance calculation.
  3. distances
    Takeoff and landing distances.
  4. climb
    Climb data including graph.
  5. cruise
    Cruise performance data including graph.
  6. descent
    Descent data including graph.
  7. metartaf
    Route METAR/TAF information including map.
  8. gramet
    GRAMET vertical weather forecast.
  9. isobaric
    Horizontal weather forecast for MSL.
  10. skewt
    Predicted Skew-T diagrams.
  11. raobs
    Radiosonde Skew-T diagrams (balloon ascents).
  12. sigwx
    Significant weather chart.
  13. mslp
    MSLP weather forecast plates.
  14. temsi
    French TEMSI for Europe and France if the route applies.
  15. atcbriefing
    ATC related information such as flight plan addressing and FIRs crossed.
  16. notam
    NOTAM briefing including graphical overview.
  17. milbulletin
    Military bulletins about airspace reservations in certain countries.
  18. icaofpl
    ICAO flight plan form.
  19. raim
    Receiver Autonomous Integration Monitoring forecast from AUGUR, predicting GPS coverage issues.
  20. atcharges
    ATC enroute charge information if applicable.

The briefing pack will be returned as PDF. This can take several minutes, depending on the options selected and the complexity of the route. Make sure to adjust your HTTP stack’s timeout values accordingly.

If the route was updated to include references to alternate routes, the briefing pack’s navlog and GRAMET will include them as well.

The same functionality is available for flight plans that have already been filed, addressed by flight plan ID instead of route ID:

HTTP GET to https://api.autorouter.aero/v1.0/flightplan/file/<flightid>/briefing?<item_1>[&<item_n>]

Non blocking interface

Alternatively, there is a non blocking interface to obtain a briefing pack invoked via

HTTP POST to https://api.autorouter.aero/v1.0/flightplan/<routeid>/briefing

With the following HTTP POST parameters:

  • method
    Set to either “download” or “email”. In the email case, the pack will be sent to the current user’s email account once completed. In the download case, the call will return a token which can be used to poll for the briefing pack and download it.
  • items
    JSON array containing the briefing pack item names as listed above.

Once requesting a non blocking download, you can query for the finished briefing pack by using the token returned and the following call:

HTTP GET to https://api.autorouter.aero/v1.0/flightplan/<routeid>/briefing/<token>[?poll]

This call either returns 404 if the briefing pack is not (yet) available or 200 when the briefing pack is available. If the parameter poll is given, the briefing pack is not returned, only the status. It can then be obtained by calling again without the poll parameter.

For flight plans that have already been filed, use the equivalent endpoints under

HTTP POST to https://api.autorouter.aero/v1.0/flightplan/file/<flightid>/briefing

and

HTTP GET to https://api.autorouter.aero/v1.0/flightplan/file/<flightid>/briefing/<token>[?poll]

GRAMET

You can request a separate GRAMET as a single PDF file by issuing

HTTP GET to https://api.autorouter.aero/v1.0/met/gramet?fpl=<fpl>

The parameter fpl is the flight plan in ICAO format. Alternatively you can pass a list of waypoints with the following invocation format:

HTTP GET to https://api.autorouter.aero/v1.0/met/gramet?waypoints=<wpts>&altitude=<alt>&departuretime=<timestamp>&totaleet=<seconds>

The waypoints are given as a space separated string with designated points, airport ICAO IDs, navaid names. departuretime is given in seconds since the Unix epoch and totaleet specifies the length of the flight in seconds.

The following additional parameters are optional:

  • aircraftid / aircraftxml
    Use a specific aircraft’s actual climb/cruise/descent performance (either a stored aircraft ID, or a complete aircraft definition as described in the Aircraft documentation) to compute the vertical profile, instead of a generic default.
  • cruisesetting
    Name of the aircraft’s cruise power setting to use, together with aircraftid or aircraftxml.
  • recompute
    Whether the route given in fpl should be recomputed against current navigation data before charting. Defaults to true.
  • format
    Output format, either “pdf” (default) or “png”.
  • wxmodel
    Weather model to source the forecast from, defaults to “gfs”.