Airport Analysis

System and Message Overviews

Document Version: 5.19

Date: 21-July-2021

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

Added runway (RunwayIdType) to the following common data types: ComputeTakeoffResponseType, and ComputeLandingResponseType. The runway field is mandatory in both responses. Updated the following field names in the ProfileOverrideType: flapSetting to flaps, airConditioningSetting to airConditioning, antiIceSetting to antiIce.
Updated message summary table.

01-July-09 Added new message AA007 Compute Single Point Calculation.
01-April-10 Renamed element "units" to "scap_units".
31-May-10 Updated AA007 and added new messages AA008, AA009, AA011, AA012, and AA013.
Removed OpsDataRunwayDescriptorGroupType.
Updated ConfiguredInputsQueryResponseType. Removed groups and updated with types.
Removed opsDataAircraftDescriptorGroup and replaced it with AircraftDescriptorType
Removed ScapParameterValueGroup and ScapParameterValueDisplayGroup. Replaced them with types, which include elements "scapDefinition" and "displayDefinition."
Updated lengthAdjustment element.
Updated miniTableSettings.
Updated Airportdata with airportCode, airportName, and airportLocation.
Updated AA009 with ProfileName.
Updated the profileOverridesType.
Added profileName element to the ComputePointCalcTakeoffResponse.
30-August-10 Restructured document.
24-February-11 New XSD for multiple updates.
24-March-11 New XSD.
8-June-11 New XSD. New sample messages AA007, AA008, AA009, AA010, AA011, AA013.
30-August-11 Updated XSD.
Updated AA009 Response - phase of flight - change enums from: takeoff, landing, na to: takeoff, landing, both.
Changed all profileName to optional. In order to reduce the size of the msgs,this was made optional rather than nillable.
Remove special "" characters out of commented section to prevent JaxB from failing.
Add type:string to scapName, and scapValue in ProfileOverridesType.
In scapDefinitionType (throughout xsd), make all name as optional. Index will remain as Value will remain as required.
AA009 Configured Inputs Response - made configuredUnitsType (contains all UOM) as optional.
Updated AA007 Point Calc Response - takeoff - make opsDataAircraftType optional, and airportDataType optional, and RunwayResultsType: tora, toda, asda, slope optional elements.
Updated AA007 Point Calc Response - landing - make RunwayResultsType: lda, slope optional elements. 
Changed "arrival" to "approach".
5-October-11 Updated XSD.
15-November-11 New XSD.
Updated message AA007 -
ComputePointCalcTakeoffResponse: runwayData/runwayResults/calcGroup/pointResult/scapError (errorFlag, errorMessage) – made optional
runwayData/runwayResults/calcGroup/pointResult/outsideAirTemperature – made optional
runwayData/runwayResults/calcGroup/pointResult/windDirection – made optional
runwayData/runwayResults/calcGroup/pointResult/windSpeed – made optional
runwayData/runwayResults/calcGroup/pointResult/headwindComp – made optional
runwayData/runwayResults/calcGroup/pointResult/MTOW  -- made optional
runwayData/runwayResults/calcGroup/pointResult/descriptor (name, value) – value made optional
profileOverrides  -- group of elements made optional
referenceId – made optional
ComputePointCalcLandingResponse:  OpsDataAircraft  (series, engine) – made optional
AirportData  (airportCode, airportName, airportLocation, fieldElevation) – made optional
runwayData/runwayResults/calcGroup/pointResult/scapError (errorFlag, errorMessage) – made optional
runwayData/runwayResults/calcGroup/pointResult/outsideAirTemperature – made optional
runwayData/runwayResults/calcGroup/pointResult/windDirection – made optional
runwayData/runwayResults/calcGroup/pointResult/windSpeed – made optional
runwayData/runwayResults/calcGroup/pointResult/headwindComp – made optional
runwayData/runwayResults/calcGroup/pointResult/descriptor (name, value) – value made optional
profileOverrides – group of elements made optional referenceId – made optional
Updated message AA013 - Added PhaseOfFlight to airportCode
26-February-13 New XSD.
Updated message AA007 - Added an optional element (xs:string) to the AA007 response that houses a description describing the correction. Also added an optional attribute (xs:string) on the correction element that conveys the units, if applicable, for the correction. 2) Added an optional element (xs:string) named "calculationType" to the AA009 request. This is used to filter out SCAP parameters, real or otherwise, that don't apply to the specified calculation type.
23-July-13 New XSD.
Added AA018 - Added new message to xsd, and common.xsd. Add version annotations to each message. Add missing AA0017 back into the Common.xsd.
3-March-14 New XSD.
24-December-14 New XSD.
Updated AA007, AA009, and AA013 to version 4 - Added AccessType.
26-May-15 New XSD.
Updated AA013 to version 5 - Added optional elements to detail the last changed date and reason for an airport, its runways and sdp. Response only.
30-January-17 New XSD.
Updated AA007 to version 5 and AA015 to version 2 - Added elements to support FMC specific data: line 11 - ALT, Airfield Pressure Altitude = AA007, AA0015 added new element "palt"; ICD, line 16 RWY-HDG Takeoff Runway Heading = AA007, AA015 added element & attribute "heading reference= "; ICD line 28 AIRFIELD-MAG-VAR Airfield Magnetic Variation = AA007, AA015 magVar.
1-May-18 New XSD.
Updated AA007 to version 6, AA015 to version 3, and AA016 to version 2. Added optional, string element "description" to both request and response.
15-October-18

New XSD.
Updated AA007 to version 7 - Added AA007 request, airportUpdateDate, required, xs:date; AA007 response optional.
Updated AA015 to version 4 - AA015 response only, optional.
New AA019 version 1 for authentication.

25-October-18

New XSD.
Updated AA007 to version 8 - Added request for NOTAMs.
Updated AA019 to version 2 - Added airlineCode, required for AA019 request/response.
New AA020 version 1 - Added new AA020 message to retrieve notams for individual runways.

25-January-19

New XSD.
Updated AA007 to version 9, AA015 to version 5, and AA020 to version 2 - Added runwayAdjustments element group.

2-October-19

New XSD.
Updated AA007 to version 10, AA015 to version 6 - Added tempRef (temperature reference) element to AA007, AA015 request/response as an optional string, 40 charater length restriction to requests/responses for the AA007, and AA015.

10-March-20

New XSD.
Updated AA016 to version 3 - Created repeatable, optional, pod and poa airports to both the request and response to allow for a list of each airport.

26-January-2021

New XSD.
Added new AA021 version 1 - Added new message to xsd. Added AA021 sample Messages.

21-July-2021

New XSD.
Updated AA007 to v11 - Added crosswindComponent to AirportAnalysisType/computePointCalcResponse/computePointCalcLandingResponse/runwayData/runwayResults/calcGroup/pointResult/crosswindComponent.

 


Table Of Contents


1  Introduction

This document defines the interfaces which govern the interchange of data between an Airport Analysis 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.

Airport Analysis systems are used to compute the take-off and landing performance for aircraft.

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 Dispatch which is a system that is used to create flight documents that are used in the safe dispatch of an aircraft.

1.2  Scope

This document discusses the Airport Analysis 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 AIM 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: AirportAnalysis.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 “AA”) are further discussed in Section 3 AOC Interface Messages.

Table 2-1 Message Summary

ID

Message

Publish

Subscribe

Request

Response

AA001

Compute Airport Analysis

 

 

X

X

AA002

Compute Airport Analysis Publish

X

 

 

 

AA003

Compute Airport Analysis Subscribe

 

X

 

 

AA004

Airport Analysis Report Publish

X

 

 

 

AA005

Airport Analysis Report Subscribe

 

X

 

 

AA006

Active Airport Analysis Plan

X

 

 

 

AA007 Point Calculation

 

 

X

X

AA008

Airport Availability Query

 

 

X

X

AA009

Configured Inputs Query

 

 

X

X

AA010

Customer Aircraft Profiles Query

 

 

X

X

AA011

Customer Aircraft Query

 

 

X

X

AA012

Departure Procedure Query

 

 

X

X

AA013

Runway Data Query

 

 

X

X

AA014

Compute Point Calc Takeoff

X

 

 

 

AA015

Point Calc Results Query

 

 

X

X

AA016

Point Calc Results List Query

 

 

X

X

AA017

Point Calc Results Action

 

 

X

X

AA018

Customer Configuration

 

 

X

X

AA019

Retrieve User Profile

 

 

X

X

AA020

Retrieve Runway Adjustments

 

 

X

X

AA021

PointCalc Reference Id Status Request

 

 

X

X

 

3 AOC Interface Messages

The following messages are processed by the Airport Analysis system.

3.1 AA001 - Compute Airport Analysis

3.1.1  Message Overview

The Compute Airport Analysis message defines the request to perform a takeoff and/or landing computation based on actual aircraft and airport conditions, and provides the response containing aircraft takeoff and/or landing parameters. 

Note: This message is used to provide computational data and analysis to the dispatcher for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.
This message can be used to:

  • Calculate the takeoff parameters – based on current or estimated conditions at the POD
  • Calculate the landing parameters – based on estimated conditions for the ETA at the POA
  • Calculate both the takeoff and landing parameters – based on current or estimated conditions at the POD and estimated conditions for the ETA at the POA

AA001 is structured as a request/response—the Dispatch system requests the airport analysis data and the Airport Analysis system provides the response containing the requested analysis. Figure 1 shows the typical AA001 message usage.

 

AA001 Message Overview

Figure 1 . AA001 Request / Response

 

Related Messages:
The Compute Airport Analysis message is used to calculate and provide data to the dispatcher for flight planning purposes. The following messages are related:

AA002 Compute Airport Analysis Publish

Asynchronous message used to request airport analysis data without requiring a message-based response. AA002 used in conjunction with AA003 will provide the same data as gathered by an AA001 request/response.

AA003 Compute Airport Analysis Subscribe

Asynchronous message used to provide airport analysis data without requiring a message-based request. AA003 used in conjunction with AA002 will provide the same data as gathered by an AA001 request/response.

Note: The above messages are used to provide data to the dispatcher for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.

 

3.1.2  Message System Flow

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

AA001 Message System Flow

Figure 2. AA001 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

AA001 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA001
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA001 ComputeAirportAnalysisRequestType
AA001 ComputeAirportAnalysisResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA001v1ComputeAirportAnalysisTakeoffRequest.xml
AA001v1ComputeAirportAnalysisTakeoffResponse.xml
AA001v1ComputeAirportAnalysisLandingRequest.xml
AA001v1ComputeAirportAnalysisLandingResponse.xml
AA001v1ComputeAirportAnalysisTakeoffLandingRequest.xml
AA001v1ComputeAirportAnalysisTakeoffLandingResponse.xml

Message Version History

Renamed AA001 to Airport Analysis Report.

 

3.2 AA002 - Compute Airport Analysis Publish

3.2.1 Message Overview

The Compute Airport Analysis Request message defines the request to perform a takeoff and/or landing computation based on actual aircraft and airport conditions. 
Note: This message is used by the dispatcher to request computational data and analysis for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.
This message can be used to request:

  • Takeoff parameters – based on current conditions at the POD
  • Landing parameters – based on estimated conditions for the ETA at the POA
  • Both the takeoff and landing parameters – based on current or estimated conditions at the POD and estimated conditions for the ETA at the POA

AA002 can be used with the response AA003 in a similar manner as the request/response message AA001 (as shown in Figure 1 ); however, because AA002 is an asynchronous message (i.e. does not require a direct response to the request), alternate implementation can be supported.

3.2.1.1 Performing manual operations between the request and response

Airport analysis and dispatch systems often require human intervention when planning a flight. For example, the dispatcher may need to update runway surface conditions at the POD and POA, or specifying the current visibility for the takeoff or landing calculations. The asynchronous AA002 can support the following process:

  1. Dispatcher requests airport analysis data using AA002.
  2. Dispatcher performs manual processes related to Airport Analysis. For example, the Dispatcher updates the Surface conditions through a custom GUI.  For this step, the dispatch system may be required to provide weather and NOTAM information related to the requested airport.
  3. Dispatcher iterates the airport analysis settings through the GUI or Airport Analysis system.
  4. Airport Analysis system sends the data back to the Dispatch System using AA003.
  5. Airport Analysis data displayed to the Dispatcher.

Figure 3 illustrates this process.

AA002 Message Overview Diagram

Figure 3. Performing manual operations between the request and response

 

Related Messages:
The Compute Airport Analysis Request message is used by the dispatcher to request data for flight planning purposes. The following messages are related:

AA003 Compute Airport Analysis Subscribe

Asynchronous message used to provide airport analysis data without requiring a message-based request. AA003 used in conjunction with AA002 will provide the same data as gathered by an AA001 request/response.

AA001 Compute Airport Analysis

Request/response (synchronous) message used to provide airport analysis data.

Note: The above messages are used to provide data to the dispatcher for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.

 

3.2.2  Message System Flow

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

AOC002 Message System Flow

Figure 4. AA002 message system flow

3.2.3  Message Details

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

Message Version

AA002 v1

Message Header Details

msgName: AA002
msgClass: PUBLISH
version: 1

Message Specification

AA002 ComputeAirportAnalysisPublishType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA002v1ComputeAirportAnalysisTakeoffPublish.xml
AA002v1ComputeAirportAnalysisLandingPublish.xml
AA002v1ComputeAirportAnalysisTakeoffLandingPublish.xml

Message Version History

Changed repeating group <calc> to <calcGroup>.

 

3.3  AA003 – Compute Airport Analysis Subscribe

3.3.1  Message Overview

The Compute Airport Analysis Response message provides takeoff and/or landing computational data based on actual aircraft and airport conditions. 
Note: This message is to provide the dispatcher with computational data and analysis for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.
This message can be used to provide:

  • Takeoff parameters – based on current conditions at the POD
  • Landing parameters – based on estimated conditions for the ETA at the POA
  • Both the takeoff and landing parameters – based on current and estimated conditions at the POD and estimated conditions for the ETA at the POA

AA003 can be used with the response AA002 in a similar manner as the request/response message AA001 (as shown in Figure 1 ); however, because AA003 is an asynchronous message (i.e. does not require a direct response to the request), alternate implementations can be supported. One such implementation is discussed in section 3.3.1.1 Performing manual operations between the request and response on page 13. Another implementation is discussed below.

Related Messages:
The Compute Airport Analysis Request message is used by the dispatcher to request data for flight planning purposes. The following messages are related:

AA002 Compute Airport Analysis Publish

Asynchronous message used to request airport analysis data without requiring a message-based response. AA002 used in conjunction with AA003 can provide the same data as gathered by an AA001 request/response; however, using AA002 and AA003 provide additional flexibility in the implementation.

AA001 Compute Airport Analysis

Request/response (synchronous) message used to provide airport analysis data.

Note: The above messages are used to provide data to the dispatcher for flight planning purposes. For messages related to the airport analysis report, which is used in the final flight paperwork, refer to messages AA004 and AA005.

 

3.3.2  Message System Flow

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

AA003 Message System Flow

Figure 5. AA003 message system flow

3.3.3  Message Details

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

Message Version

AA003 v1

Message Header Details

msgName: AA003
msgClass: SUBSCRIBE
version: 1

Message Specification

AA003 ComputeAirportAnalysisSubscribeType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA003v1ComputeAirportAnalysisTakeoffSubscribe.xml
AA003v1ComputeAirportAnalysisLandingSubscribe.xml
AA003v1ComputeAirportAnalysisTakeoffLandingSubscribe.xml

Message Version History

No changes since original publication.

 

3.4  AA004 – Airport Analysis Report Publish

3.4.1   Message Overview

An airport analysis report is calculated and included as part of the required flight paperwork. This report is provided to the crew after the final flight plan has been created. This usually occurs between one and two hours prior to the departure of a flight. This report considers:

  • airport factors such as elevation, runway conditions and physical characteristics
  • aircraft factors such as deferred maintenance items (DMIs).

The AA004 (Airport Analysis Report Publish) message typically serves as the request to the AA005 (Airport Analysis Report Subscribe) message, as shown in Figure 6 .

AA004 as a request to AA005

Figure 6. AA004 as a request to AA005


Because AA004 is an asynchronous message, it does not need to spawn a response from another AOCi message (AA005). Therefore, AA004 can be used to get (or pull) an airport analysis report into a Dispatch system through means other than an AOCi responding message. This allows airlines additional flexibility when developing their business processes—they can institute a request/response as shown in Figure 3 , or they can employ a programmatic retrieval process initiated from their Dispatch system.

Figure 7 shows how an AA004 message can be used to retrieve the airport analysis report without a formal response through the AOCi message system.

AA004 used to retrieve the report without a message-based response

Figure 7. AA004 used to retrieve the report without a message-based response

 

Related Messages:
The Airport Analysis Report Request message is used to request the airport analysis report prior to a flight. The following messages are related:

AA005 Airport Analysis Report Subscribe

Used to provide the airport analysis report. This message is typically used to respond to a request from AA004.  

 

3.4.2  Message System Flow

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

AA004 message system flow

Figure 8. AA004 message system flow

3.4.3  Message Details

Message Version

AA004 v1

Message Header Details

msgName: AA004
msgClass: PUBLISH
version: 1

Message Specification

AA004 AirportAnalysisReportPublishType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA004v1AirportAnalysisReportPublish.xml

Message Version History

No changes since original publication.

 

3.5  AA005 – Airport Analysis Report Subscribe

3.5.1  Message Overview

An airport analysis report is calculated and included as part of the required flight paperwork. This report is normally provided to the crew after the final flight plan has been created. This usually occurs between one and two hours prior to the departure of a flight. This report considers:

  • airport factors such as elevation, runway conditions and physical characteristics
  • aircraft factors such as deferred maintenance items (DMIs)

The AA005 (Airport Analysis Report Subscribe) message typically serves as the response to the AA004 (Airport Analysis Report Publish) message, as shown in Figure 9.

AA004 as a request to AA005

Figure 9. AA005 as a response to AA004

Because AA005 is an asynchronous message, it does not need to be requested from another AOCi message (AA004). Therefore, AA005 can be used to put (or push) an airport analysis report into a Dispatch system without a formal request for the report. This allows airlines additional flexibility when developing their business processes—they can institute a request/response as shown in Figure 5 , or they can employ a publish process initiated from their Airport Analysis system.
Figure 10 shows how an AA005 message can be used to publish the airport analysis report without a formal request through the AOCi message system. 

AA005 used to publish without a formal request

Figure 10. AA005 used to publish without a formal request

Related Messages:
The Airport Analysis Report Subscribe message is used to provide the airport analysis report to the crew before the flight. The following messages are related:

AA004 Airport Analysis Report Publish

Used to request the airport analysis report. This message is typically used to request a response via AA005.  

 

3.5.2  Message System Flow

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

AA005 Message System Flow

Figure 11. AA005 message system flow

3.5.3  Message Details

Message Version

AA005 v1

Message Header Details

msgName: AA005
msgClass: SUBSCRIBE
version: 1

Message Specification

AA005 AirportAnalysisReportSubscribeType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA005v1AirportAnalysisReportSubscribe.xml

Message Version History

No changes since original publication.

 

3.6 AA006 – Active Airport Analysis Plan

3.6.1  Message Overview

This message informs the airport analysis system which Airport Analysis report is the active report that will be used for the flight.  This is needed because multiple reports can be requested and the AA system may need to know which plan was used for metrics purposes.

This information can also be provided to the pilot before the flight. The pilot then has access to the most current airport analysis information and takeoff and landing numbers. Figure 12 illustrates a sample scenario using AA006. 

Sample scenario using AA006

Figure 12. Sample scenario using AA006

 

3.6.2  Message System Flow

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

AA006 Message System Flow

Figure 13. AA006 message system flow

3.6.3  Message Details

Message Version

AA006 v1

Message Header Details

msgName: AA006
msgClass: SUBSCRIBE
version: 1

Message Specification

AA006 ActiveAirportAnalysisPlanType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA006v1ActiveAirportAnalysisPlan.xml

Message Version History

No changes since original publication.

 

 

3.7 AA007 – Point Calculation

3.7.1  Message Overview

The Point Calculation message defines the request to perform a dynamic runway analysis point calculation based on specified aircraft and airport conditions, and provides the response containing aircraft takeoff or landing parameters. Each calculation request must include the following information:

  • Customer making request
  • Airport
  • Runway
  • Aircraft Identification
  • Wind speed
  • Wind Direction
  • Outside air temperature

Each calculation request can optionally include:

  • Profile Overrides
  • QNH
  • Mini-Table Settings
  • Additional computational outputs

AA007 is structured as a request/response message—the client system (for example, Dispatch, Flight Planning, Crew Portal or Operations Control system) requests the calculation and the Airport Analysis system provides the response containing the requested analysis.

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

3.7.2  Message System Flow

AA007 message system flow

Figure 14. AA007 message system flow

3.7.3  Message Details

Message Version

AA007 v11

Message Header Details (REQUEST/RESPONSE)

msgName: AA007
msgClass: REQUEST/RESPONSE
version: 11

Message Specification

AA007 ComputePointCalcRequestType
AA007 ComputePointCalcResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Original publication.
* Added an optional element (xs:string) to the AA007 response that houses a description describing the correction. Also added an optional attribute (xs:string) on the correction element that conveys the units, if applicable, for the correction.
* Added an optional element (xs:string) named "calculationType" to the AA009 request. This is used to filter out SCAP parameters, real or otherwise, that don't apply to the specified calculation type.

Version 4
* Added AccessType.

Version 5
* Added elements to support FMC specific data: line 11 - ALT, Airfield Pressure Altitude = AA007, AA0015 added new element "palt"; ICD, line 16 RWY-HDG Takeoff Runway Heading = AA007, AA015 added element & attribute "heading reference= "; ICD line 28 AIRFIELD-MAG-VAR Airfield Magnetic Variation = AA007, AA015 magVar.

Version 6
* Added optional, string element "description" to both request and response.

Version 7
* Added AA007 request, airportUpdateDate, required, xs:date; AA007 response optional.

Version 8
* Added AA007 request for NOTAMs.

Version 9
* Added runwayAdjustments element group.

Version 10
* Added tempRef (temperature reference) element to AA007, AA015 request/response as an optional string, 40 charater length restriction to requests/responses for the AA007, and AA015.

Version 11
* Added crosswindComponent to AirportAnalysisType/computePointCalcResponse/computePointCalcLandingResponse/runwayData/runwayResults/calcGroup/pointResult/crosswindComponent.

 

3.8 AA008 – Airport Availability Query

3.8.1  Message Overview

This message is used to determine if the specified airport is available for Single Point calculations. If it is not, the "notAvailable" element is returned with the reason why.

3.8.2  Message System Flow

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

AA008 message system flow

Figure 15. AA008 message system flow

3.8.3  Message Details

Message Version

AA008 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA008
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA008 AirportAvailableQueryRequestType
AA008 AirportAvailableQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA008v1AirportAvailabilityQueryRequest.xml
AA008v1AirportAvailabilityQueryResponse.xml

Message Version History

Original publication.

 

3.9 AA009 – Configured Inputs Query

3.9.1  Message Overview

This message is used to retrieve the SCAP inputs that have been configured for override for the specified customer and profile. The data details whether the input is an entry or a selection and optionally includes min, max, and default values for entries and the list of valid selections and which one is the default for the selection types. It is intended that this data is used to present a data-driven dynamic GUI offering a combination of entry and selection controls.

3.9.2  Message System Flow

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

AA009 message system flow

Figure 16. AA009 message system flow

3.9.3  Message Details

Message Version

AA009 v4

Message Header Details (REQUEST/RESPONSE)

msgName: AA009
msgClass: REQUEST/RESPONSE
version: 4

Message Specification

AA009 ConfiguredInputsQueryRequestType
AA009 ConfiguredInputsQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Original publication.

Version 4
* Added AccessType.

 

3.10 AA010 – Customer Aircraft Profiles Query

3.10.1  Message Overview

This message is used to retrieve the list of profiles that are configured for the specified customer and aircraft series and engine.

3.10.2  Message System Flow

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

AA010 message system flow

Figure 17. AA010 message system flow

3.10.3  Message Details

Message Version

AA010 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA010
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA010 CustomerAircraftProfilesQueryRequestType
AA010 CustomerAircraftProfilesQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA010v1CustomerAircraftProfilesQueryRequest.xml
AA010v1CustomerAircraftProfilesQueryResponse.xml

Message Version History

Original publication.

 

3.11 AA011 – Customer Aircraft Query

3.11.1  Message Overview

This message is used to retrieve the configured aircraft for the specified customer.

3.11.2  Message System Flow

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

AA011 message system flow

Figure 18. AA011 message system flow

3.11.3  Message Details

Message Version

AA011 v2

Message Header Details (REQUEST/RESPONSE)

msgName: AA011
msgClass: REQUEST/RESPONSE
version: 2

Message Specification

AA011 CustomerAircraftQueryRequestType
AA011 CustomerAircraftQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA011v2CustomerAircraftQueryRequest.xml
AA011v2CustomerAircraftQueryResponse.xml

Message Version History

Original publication.

 

 

3.12 AA012 – Departure Procedure Query

3.12.1  Message Overview

This message is used to retrieve a special departure procedure for the customer. The data represents a PDF document.

3.12.2  Message System Flow

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

AA012 message system flow

Figure 19. AA012 message system flow

3.12.3  Message Details

Message Version

AA012 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA012
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA012 DepartureProcedureQueryRequestType
AA012 DepartureProcedureQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Original publication.

 

3.13 AA013 – Runway Data Query

3.13.1  Message Overview

This message is used to retrieve runway data, including runway IDs and lengths (TORA), for the specified airport for the specified customer. Included in the data is an optional element that denotes the runway as being not available and an associated reason indicating why this is so. Further, if the requested airport isn't available, an optional element is populated with the reason.

3.13.2  Message System Flow

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

AA013 message system flow

Figure 20. AA013 message system flow

3.13.3  Message Details

Message Version

AA013 v5

Message Header Details (REQUEST/RESPONSE)

msgName: AA013
msgClass: REQUEST/RESPONSE
version: 5

Message Specification

AA013 RunwayDataQueryRequestType
AA013 RunwayDataQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Added optional attribute named “units” that denotes the desired units for any returned airport information distance/height.

Version 4
* Added AccessType.

Version 5
* Added optional elements to detail the last changed date and reason for an airport, its runways and sdp. Response only.

 

3.14 AA014 – Compute Point Calc Takeoff

3.14.1  Message Overview

This message is used to provide basic information to uniquely identify a flight.

3.14.2  Message System Flow

A sample System Flow is not yet available.

3.14.3  Message Details

Message Version

AA014 v1

Message Header Details

msgName: AA014
msgClass:PUBLISH
version: 1

Message Specification

AA014 ComputePointCalcTakeoffPublishType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History Original publication.

 

3.15 AA015 – Point Calc Results Query

3.15.1  Message Overview

A Message Overview is not yet available.

3.15.2  Message System Flow

A sample System Flow is not yet available.

3.15.3  Message Details

Message Version

AA015 v6

Message Header Details (REQUEST/RESPONSE)

msgName: AA015
msgClass: REQUEST/RESPONSE
version: 6

Message Specification

AA015 PointCalcResultsQueryRequestType
AA015 PointCalcResultsQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Original publication.

Version 2
* Added elements to support FMC specific data: line 11 - ALT, Airfield Pressure Altitude = AA007, AA0015 added new element "palt"; ICD, line 16 RWY-HDG Takeoff Runway Heading = AA007, AA015 added element & attribute "heading reference= "; ICD line 28 AIRFIELD-MAG-VAR Airfield Magnetic Variation = AA007, AA015 magVar.

Version 3
* Added optional, string element "description" to both request and response.

Version 4
* AA015 response only, optional.

Version 5
* Added runwayAdjustments element group.

Version 6
* Added tempRef (temperature reference) element to AA007, AA015 request/response as an optional string, 40 charater length restriction to requests/responses for the AA007, and AA015.

 

3.16 AA016 – Point Calc Results List Query

3.16.1  Message Overview

A Message Overview is not yet available.

3.16.2  Message System Flow

A sample System Flow is not yet available.

3.16.3  Message Details

Message Version

AA016 v3

Message Header Details (REQUEST/RESPONSE)

msgName: AA016
msgClass: REQUEST/RESPONSE
version: 3

Message Specification

AA016 PointCalcResultsListQueryRequestType
AA016 PointCalcResultsListQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not available for this message version.

Message Version History Original publication.

Version 2
* Added optional, string element "description" to both request and response.

Version 3
* Created repeatable, optional, pod and poa airports to both the request and response to allow for a list of each airport.

 

3.17 AA017 – Point Calc Results Action

3.17.1  Message Overview

A Message Overview is not yet available.

3.17.2  Message System Flow

A sample System Flow is not yet available.

3.17.3  Message Details

Message Version

AA017 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA017
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA017 PointCalcResultsActionRequestType
AA017 PointCalcResultsActionResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History

Original publication.

 

3.18 AA018 – Customer Configuration Query

3.18.1  Message Overview

A Message Overview is not yet available.

3.18.2  Message System Flow

A sample System Flow is not yet available.

3.18.3  Message Details

Message Version

AA018 v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA018
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA018 CustomerConfigurationQueryRequestType
AA018 CustomerConfigurationQueryResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA018v1CustomerConfigurationQueryRequest.xml
AA018v1CustomerConfigurationQueryResponse.xml

Message Version History

Original publication.

 

3.19 AA019 – Retrieve User Profile

3.19.1  Message Overview

A Message Overview is not yet available.

3.19.2  Message System Flow

A sample System Flow is not yet available.

3.19.3  Message Details

Message Version

AA019 v2

Message Header Details (REQUEST/RESPONSE)

msgName: AA019
msgClass: REQUEST/RESPONSE
version: 2

Message Specification

AA019 RetrieveUserProfileRequestType
AA019 RetrieveUserProfileResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History Original publication.

Version 2
* Updated AA019 to version 2 - Added airlineCode, required for AA019 request/response.

 

3.20 AA020 – Retrieve Runway Adjustments

3.20.1  Message Overview

A Message Overview is not yet available.

3.20.2  Message System Flow

A sample System Flow is not yet available.

3.20.3  Message Details

Message Version

AA020v2

Message Header Details (REQUEST/RESPONSE)

msgName: AA020
msgClass: REQUEST/RESPONSE
version: 2

Message Specification

AA020 RetrieveRunwayAdjustmentsRequestType
AA020 RetrieveRunwayAdjustmentsResponseType

Defined in XSD

AirportAnalysis.xsd

Sample Messages

Samples not yet available for this message version.

Message Version History Original publication: Added new AA020 message to retrieve notams for individual runways.

Version 2
* Added runwayAdjustments element group.

 

3.21 AA021 – PointCalc Reference Id Status Request

3.21.1  Message Overview

A Message Overview is not yet available.

3.21.2  Message System Flow

A sample System Flow is not yet available.

3.21.3  Message Details

Message Version

AA021v1

Message Header Details (REQUEST/RESPONSE)

msgName: AA021
msgClass: REQUEST/RESPONSE
version: 1

Message Specification

AA021v1_PointCalcReferenceIdStatusRequest.xml
AA021v1_PointCalcReferenceIdStatusResponse.xml

Defined in XSD

AirportAnalysis.xsd

Sample Messages

AA021v1_PointCalcReferenceIdStatusRequest.xml
AA021v1_PointCalcReferenceIdStatusResponse.xml

Message Version History Version 1
* Added runwayAdjustments element group.