Flight Planning

System and Message Overviews

Document Version: 5.6

Date: November 15, 2016


Copyright © 2009-2021 Jeppesen. All rights reserved. Your use of the AIM Bookshelf and all supporting documentation is subject to a separate license agreement between you and Jeppesen, a copy of which is included in the zip file or can be obtained from Jeppesen. The AIM Bookshelf is delivered "AS IS" without warranty of any kind and is not guaranteed to be free from errors or defects. You rely on the AIM Bookshelf at your own risk. No support for the AIM Bookshelf is implied through its publication. The AIM Bookshelf is intended solely for use as a reference and examples of interfaces to Jeppesen systems. Jeppesen may revise, update or cease publication at any time, without notice. Building to the specifications set forth in the AIM Bookshelf does not mean that your intended integration needs will be met or that an interface will function as documented. We recommend contacting Jeppesen directly to discuss professional services options with respect to production application integration and validation efforts.

 


Document Revision History

The following revision history table reflects all substantive changes to this document.

Date

Description of Updates Made

04-August-08

No changes since previous release.

30-August-10

Updated links for new Bookshelf directory structure.

23-July-13 New XSD.
3-March-14 New XSD.
18-September-2014 The FP001 Flight Plan Request/Response is in the process of restructuring.
24-December-2014 New XSD.
FP001 changed to DRAFT version J
3-March-16 New XSD.
FP001 updated to version K. Added new element to request for "toalternate List of takeoff Alternates, from Sulu Interface Spec 7ab375c, 2015-06-11. Added on.MinFuel, in.MinFuel, on.ExtraFuel.
15-November-16 New XSD.
FP001 updated to version L. Added etp element to Request. FP001/EqualTimePoints/backwards and forwards airports, coord - make optional. This info is not a part of the JSON response.


Table Of Contents

 


1  Introduction

This document defines the interfaces which govern the interchange of data between a Flight Planning system and other systems within an Airline Operation Center (AOC).  Each AOC interface is represented by a message described in an associated XSD (XML Schema Definition). The XSD defines and enforces the required, optional, and conditional data that can be included in a message.

1.1  Audience

The intended audience for this document includes existing and potential Jeppesen customers, integration partners, and personnel with roles associated with application architecture, application development, system testing, implementation, and application support within flight planning operations.

1.2  Scope

This document discusses the Flight Planning messages currently supported by the Jeppesen Solution Integrator. Each message description includes the following:

  • Overview for common message uses within an AOC
  • Message Version Summary listing all available versions of each message
  • Links to the message specifications including direct links to XSD documentation, where you can explore the XSD hierarchy and interface specifications in a navigable HTML format
  • Links to the XSD source code
  • Links to sample XML messages for each AOC message

Other data interfaces or formats not included in this document will be considered custom and not supported.

1.3  XML Schema/XSD

The XML schema for this ICD is published in the following file: FlightPlanning.XSD

2  Message Summary

Table 2-1 lists the messages that can be sent or handled by the application. The messages originated by this application (messages that begin with “FP”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Request

Response

FP001

Flight Planning

 

X

X

 

3 AOC Interface Messages

The following messages are processed by the Flight Planning system.

3.1 FP001 - Flight Planning

3.1.1  Message Overview

The Flight Planning message provides a flight plan calculation for specified input, returning all of the calculations that are essential to the flight plan.

3.1.2  Message System Flow

This message interacts with the systems as shown in Figure 1.

FP001 message system flow

Figure 1. FP001 message system flow

3.1.3   Message Details

The following table provides details on the message version and includes links to the message’s technical specification.

Message Version

FP001 vL

Message Header Details (REQUEST/RESPONSE)

msgName: FP001
msgClass: REQUEST/RESPONSE
version: L

Message Specification

FP001 FlightPlanningRequestType
FP001 FlightPlanningResponseType

Defined in XSD

FlightPlanning.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Version 1
* Initial version

Version 2
* Created FP001 version 2 using version 2 FlightKeyType.
* Added the following fields to FP001 v2: speedSchedule, and scenario.
* Added FPRequestFuelType.

Version 3
* Removed choice structure from altitudeFlightRule in FpRequestRouteType.
* Created version 3 of FlightPlanningResponseType.
* Added FP001 v3 - Compute Flight Plan.
* Changed isaTemperature to isaTemperatureDeviation to match XSD.

Version J
* Changed WeatherType to FPCWeatherType; LevelType to FPCLevelType; removed FP001 FlightPlanType (not used); MountainDriftdownType to FPCMountainDriftdownType; FuelType to FPCFuelType; CostsType to FPCCostType; FlightPlanResponse to FPCFlightPlanResponse; RouteType to FPCRouteType.

Version K
* Added new element to request for "toalternate List of takeoff Alternates, from Sulu Interface Spec 7ab375c, 2015-06-11.
* Added on.MinFuel, in.MinFuel, on.ExtraFuel.

Version L
* Added etp element to Request. FP001/EqualTimePoints/backwards and forwards airports, coord - make optional. This info is not a part of the JSON response.