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.

Schema DocumentManagement.xsd

AIM Bookshelf Click for DM message overviews.
Message ID   Associated Complex types 
DM001 StoreDocumentRequestType 
StoreDocumentResponseType 
DM002 RetrieveDocumentRequestType 
RetrieveDocumentResponseType 
DM003 DeleteDocumentRequestType 
DeleteDocumentResponseType 
DM004 RetrieveDocumentNameListRequestType 
RetrieveDocumentNameListResponseType
 

complexType DeleteDocumentRequestType
diagram DMSpec_p1.png
namespace http://www.jeppesen.com/aoc
children workspace deleteByDocumentParentNode deleteByDocumentName deleteByUuid
used by
element DocumentManagementType/deleteDocumentRequest
annotation
documentation
DM003 vA Delete Document REQUEST

element DeleteDocumentRequestType/workspace
diagram DMSpec_p2.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 

element DeleteDocumentRequestType/deleteByDocumentParentNode
diagram DMSpec_p3.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Specifies the path location to the immediate document parent node of a document or group of documents. Use this if all of the documents associated with the indicated document parent node are to be deleted. Conditional on deletion of all of a document parent node’s associated documents.

element DeleteDocumentRequestType/deleteByDocumentName
diagram DMSpec_p4.png
namespace http://www.jeppesen.com/aoc
type SelectSpecificDocumentByNameType
properties
isRef 0
content complex
children documentParentNode documentName
annotation
documentation
Specifies the path location to the document parent node and the name of a specific child document to be deleted.  Conditional on selecting the deletion of specific documents associated with a single specific document parent node.

element DeleteDocumentRequestType/deleteByUuid
diagram DMSpec_p5.png
namespace http://www.jeppesen.com/aoc
type String36
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 36 
annotation
documentation
Universal Unique Identifier which specifies the unique identification of a specific document. Deletes all documents associated with the indicated document parent node UUID. A single document node may also be deleted by specifying its UUID in a DM003 request message.  Conditional on requesting the deletion of specific  ocuments associated with the specified UUID.

complexType DeleteDocumentResponseType
diagram DMSpec_p6.png
namespace http://www.jeppesen.com/aoc
children documentDeleteSuccessfulResponse deletionError
used by
element DocumentManagementType/deleteDocumentResponse
annotation
documentation
DM003 vA Delete Document RESPONSE

element DeleteDocumentResponseType/documentDeleteSuccessfulResponse
diagram DMSpec_p7.png
namespace http://www.jeppesen.com/aoc
type xs:boolean
properties
isRef 0
content simple
annotation
documentation
Responds only with 'true' if the delete is successful. Otherwise 'error' choice is returned. If the document node or property to be deleted does not exist, then 'true' will be returned.

element DeleteDocumentResponseType/deletionError
diagram DMSpec_p8.png
namespace http://www.jeppesen.com/aoc
type DeletionErrorType
properties
isRef 0
content complex
children deletionErrorGroup
annotation
documentation
Used if a deletion error occurs. Conditional on document deletion error detection.

complexType DeletionErrorGroupType
diagram DMSpec_p9.png
namespace http://www.jeppesen.com/aoc
children error documentName
used by
element DeletionErrorType/deletionErrorGroup

element DeletionErrorGroupType/error
diagram DMSpec_p10.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
Used if error is returned by the document deletion operation. Conditional on document deletion error detection. Typically the error is related to a specific document which is specified in documentName. Common ICD.

element DeletionErrorGroupType/documentName
diagram DMSpec_p11.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
minOcc 0
maxOcc 1
content simple

complexType DeletionErrorType
diagram DMSpec_p12.png
namespace http://www.jeppesen.com/aoc
children deletionErrorGroup
used by
element DeleteDocumentResponseType/deletionError

element DeletionErrorType/deletionErrorGroup
diagram DMSpec_p13.png
namespace http://www.jeppesen.com/aoc
type DeletionErrorGroupType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children error documentName

complexType DocumentContentType
diagram DMSpec_p14.png
namespace http://www.jeppesen.com/aoc
children base64BinaryValue booleanValue dateTimeValue doubleValue integerValue stringValue
used by
elements DocumentReturnType/documentContent DocumentStoreType/documentContent
annotation
documentation
The body or content of a document.

element DocumentContentType/base64BinaryValue
diagram DMSpec_p15.png
namespace http://www.jeppesen.com/aoc
type xs:base64Binary
properties
isRef 0
content simple
annotation
documentation
A binary document. Usually a MS Word or .pdf format document converted into base64Binary format for archiving. This field is nillable.

element DocumentContentType/booleanValue
diagram DMSpec_p16.png
namespace http://www.jeppesen.com/aoc
type xs:boolean
properties
isRef 0
content simple
annotation
documentation
A binary value for a property. Used to store flag values, true/false, and other binary information as a document. This field is nillable.

element DocumentContentType/dateTimeValue
diagram DMSpec_p17.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
content simple
annotation
documentation
A date/time value for a property. Used to store datetime information as a document. This field is nillable.

element DocumentContentType/doubleValue
diagram DMSpec_p18.png
namespace http://www.jeppesen.com/aoc
type xs:double
properties
isRef 0
content simple
annotation
documentation
A double float number value for a property. Used to store numbers with decimal fraction values as a  document. This field is nillable.

element DocumentContentType/integerValue
diagram DMSpec_p19.png
namespace http://www.jeppesen.com/aoc
type xs:integer
properties
isRef 0
content simple
annotation
documentation
An integer number value for a property. Used to store whole number (non-decimal fraction) values as a document. This field is nillable.

element DocumentContentType/stringValue
diagram DMSpec_p20.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
content simple
annotation
documentation
A text string value for a property. Used to store textual information such as text notes and comments as a document. This field is nillable.

complexType DocumentManagementType
diagram DMSpec_p21.png
namespace http://www.jeppesen.com/aoc
children storeDocumentRequest storeDocumentResponse retrieveDocumentRequest retrieveDocumentResponse deleteDocumentRequest deleteDocumentResponse retrieveDocumentNameListRequest retrieveDocumentNameListResponse
annotation
documentation
Top level type that acts as a container for all Document Management messages
documentation
Copyright © 2009-2020 Jeppesen.   All rights reserved.
Your use of the AOC 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 AOC 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 AOC Bookshelf at your own risk.  No support for the AOC Bookshelf is implied through its publication.
The AOC 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 AOC 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.
documentation
Top level of Document Management schema

element DocumentManagementType/storeDocumentRequest
diagram DMSpec_p22.png
namespace http://www.jeppesen.com/aoc
type StoreDocumentRequestType
properties
isRef 0
content complex
children documentStorageNode document
annotation
documentation
DM001 vA Store Documemnt REQUEST

element DocumentManagementType/storeDocumentResponse
diagram DMSpec_p23.png
namespace http://www.jeppesen.com/aoc
type StoreDocumentResponseType
properties
isRef 0
content complex
children storeDocumentResponseGroup error
annotation
documentation
DM001 vA Store Document RESPONSE

element DocumentManagementType/retrieveDocumentRequest
diagram DMSpec_p24.png
namespace http://www.jeppesen.com/aoc
type RetrieveDocumentRequestType
properties
isRef 0
content complex
children workspace retrieveByDocumentParentNode retrieveByDocumentName retrieveByUuid
annotation
documentation
DM002 vA Retrieve Document REQUEST

element DocumentManagementType/retrieveDocumentResponse
diagram DMSpec_p25.png
namespace http://www.jeppesen.com/aoc
type RetrieveDocumentResponseType
properties
isRef 0
content complex
children retrievedDocument error
annotation
documentation
DM002 vA Retrieve Document RESPONSE

element DocumentManagementType/deleteDocumentRequest
diagram DMSpec_p26.png
namespace http://www.jeppesen.com/aoc
type DeleteDocumentRequestType
properties
isRef 0
content complex
children workspace deleteByDocumentParentNode deleteByDocumentName deleteByUuid
annotation
documentation
DM003 vA Delete Document REQUEST

element DocumentManagementType/deleteDocumentResponse
diagram DMSpec_p27.png
namespace http://www.jeppesen.com/aoc
type DeleteDocumentResponseType
properties
isRef 0
content complex
children documentDeleteSuccessfulResponse deletionError
annotation
documentation
DM003 vA Delete Document RESPONSE

element DocumentManagementType/retrieveDocumentNameListRequest
diagram DMSpec_p28.png
namespace http://www.jeppesen.com/aoc
type RetrieveDocumentNameListRequestType
properties
isRef 0
content complex
children queryStyle queryString workspaceName
annotation
documentation
DM004 vA Retrieve Document Name List REQUEST

element DocumentManagementType/retrieveDocumentNameListResponse
diagram DMSpec_p29.png
namespace http://www.jeppesen.com/aoc
type RetrieveDocumentNameListResponseType
properties
isRef 0
content complex
children queryResults error
annotation
documentation
DM004 vA Retrieve Document Name List RESPONSE

complexType DocumentMetadataType
diagram DMSpec_p30.png
namespace http://www.jeppesen.com/aoc
children name type documentOriginator documentAlreadyCompressed documentDate retainUntilDate documentDescription
used by
elements DocumentReturnType/documentMetadata DocumentStoreType/documentMetadata
annotation
documentation
Basic document information.

element DocumentMetadataType/name
diagram DMSpec_p31.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 
annotation
documentation
A document’s specific name or identifier. Note: A whitespace character cannot be used as the first character in a name. Any Unicode character except: '/', ':', '[', ']', '*', ''', '"', '|' or any whitespace character may be used.

element DocumentMetadataType/type
diagram DMSpec_p32.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 
annotation
documentation
Standard MIME types supported. See listing in http://www.iana.org/assignments/media-types/ for valid MIME document types. The type field is used to specify the format of the document e.g. MS Word, pdf, text, etc.

element DocumentMetadataType/documentOriginator
diagram DMSpec_p33.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
The document author or generating system.

element DocumentMetadataType/documentAlreadyCompressed
diagram DMSpec_p34.png
namespace http://www.jeppesen.com/aoc
type xs:boolean
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
If true indicates that the document is compressed prior to being added to the AOC message. False indicates that the document is not compressed prior to being added to the AOC message.

element DocumentMetadataType/documentDate
diagram DMSpec_p35.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
Date or date and time that the original document was created. Can also be used to indicate when the last update was made to the document.

element DocumentMetadataType/retainUntilDate
diagram DMSpec_p36.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
Document cannot be modified or deleted before this date. On or after this date, the document may be retained or deleted.

element DocumentMetadataType/documentDescription
diagram DMSpec_p37.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 255 
annotation
documentation
Text description of the document or its contents.

complexType DocumentReturnType
diagram DMSpec_p38.png
namespace http://www.jeppesen.com/aoc
children documentUuid repositorySaveDate documentMetadata documentContent
used by
element RetrievedDocumentsType/document
annotation
documentation
Retrieved document.

element DocumentReturnType/documentUuid
diagram DMSpec_p39.png
namespace http://www.jeppesen.com/aoc
type String36
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 36 
annotation
documentation
Universal Unique Identifier which specifies the location of the document. Returns document UUID.

element DocumentReturnType/repositorySaveDate
diagram DMSpec_p40.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
content simple
annotation
documentation
DMS System Date and time that the document was added to the Document Repository (DMR system time).

element DocumentReturnType/documentMetadata
diagram DMSpec_p41.png
namespace http://www.jeppesen.com/aoc
type DocumentMetadataType
properties
isRef 0
content complex
children name type documentOriginator documentAlreadyCompressed documentDate retainUntilDate documentDescription
annotation
documentation
Basic document information.

element DocumentReturnType/documentContent
diagram DMSpec_p42.png
namespace http://www.jeppesen.com/aoc
type DocumentContentType
properties
isRef 0
content complex
children base64BinaryValue booleanValue dateTimeValue doubleValue integerValue stringValue
annotation
documentation
The body or content of a document.

complexType DocumentStoreType
diagram DMSpec_p43.png
namespace http://www.jeppesen.com/aoc
children documentMetadata documentContent
used by
element StoreDocumentRequestType/document
annotation
documentation
The content and metadata of the document to be stored.  This repeating group is used to store one or multiple different versions/formats of the same document.

element DocumentStoreType/documentMetadata
diagram DMSpec_p44.png
namespace http://www.jeppesen.com/aoc
type DocumentMetadataType
properties
isRef 0
content complex
children name type documentOriginator documentAlreadyCompressed documentDate retainUntilDate documentDescription
annotation
documentation
Basic document information.

element DocumentStoreType/documentContent
diagram DMSpec_p45.png
namespace http://www.jeppesen.com/aoc
type DocumentContentType
properties
isRef 0
content complex
children base64BinaryValue booleanValue dateTimeValue doubleValue integerValue stringValue
annotation
documentation
The body or content of a document.

complexType NodeKeyType
diagram DMSpec_p46.png
namespace http://www.jeppesen.com/aoc
children workspace documentParentNode
used by
elements RetrievedDocumentsType/documentParentNodeId StoreDocumentRequestType/documentStorageNode
annotation
documentation
The document parent node's location identifier.

element NodeKeyType/workspace
diagram DMSpec_p47.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Workspaces are allocated to specific products (applications). All of a product's documents are contained within its assigned workspace.

element NodeKeyType/documentParentNode
diagram DMSpec_p48.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Path from a workspace's root node to a document's parent node (see Appendix A). Conditional on selection of node location representation. Note: nodePath should be used in DM001 Store Document messages.

complexType RetrievedDocumentsType
diagram DMSpec_p49.png
namespace http://www.jeppesen.com/aoc
children documentParentNodeId document
used by
element RetrieveDocumentResponseType/retrievedDocument
annotation
documentation
Returns the requested document or documents. Conditional on successful document retrieval.

element RetrievedDocumentsType/documentParentNodeId
diagram DMSpec_p50.png
namespace http://www.jeppesen.com/aoc
type NodeKeyType
properties
isRef 0
content complex
children workspace documentParentNode
annotation
documentation
Contains the identifier of the document's parent node.

element RetrievedDocumentsType/document
diagram DMSpec_p51.png
namespace http://www.jeppesen.com/aoc
type DocumentReturnType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children documentUuid repositorySaveDate documentMetadata documentContent
annotation
documentation
Retrieved document.

complexType RetrieveDocumentNameListRequestType
diagram DMSpec_p52.png
namespace http://www.jeppesen.com/aoc
children queryStyle queryString workspaceName
used by
element DocumentManagementType/retrieveDocumentNameListRequest
annotation
documentation
DM004 vA Retrieve Document Name List REQUEST

element RetrieveDocumentNameListRequestType/queryStyle
diagram DMSpec_p53.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
enumeration XPATH 
enumeration SQL 
annotation
documentation
Type if query to be used: XPath or SQL-like query type. xpath = Indicates an XPath style query is to be used. sql = Indicates that an SQL style query is to be used. Note: only XPATH queries supported for V1.

element RetrieveDocumentNameListRequestType/queryString
diagram DMSpec_p54.png
namespace http://www.jeppesen.com/aoc
type String2048
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 2048 
annotation
documentation
Text of query string.

element RetrieveDocumentNameListRequestType/workspaceName
diagram DMSpec_p55.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Name of workspace used to store documents.

complexType RetrieveDocumentNameListResponseType
diagram DMSpec_p56.png
namespace http://www.jeppesen.com/aoc
children queryResults error
used by
element DocumentManagementType/retrieveDocumentNameListResponse
annotation
documentation
DM004 vA Retrieve Document Name List RESPONSE

element RetrieveDocumentNameListResponseType/queryResults
diagram DMSpec_p57.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
content simple
annotation
documentation
Returns the query results. Note that an empty record is a valid value and not an error. Otherwise 'error' is returned.

element RetrieveDocumentNameListResponseType/error
diagram DMSpec_p58.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
Used if error is returned by the Document Management Query operation. Conditional on Document Management system error detection.  Note that the return of a blank or zero-length string is a valid value and not an error. Common ICD.

complexType RetrieveDocumentRequestType
diagram DMSpec_p59.png
namespace http://www.jeppesen.com/aoc
children workspace retrieveByDocumentParentNode retrieveByDocumentName retrieveByUuid
used by
element DocumentManagementType/retrieveDocumentRequest
annotation
documentation
DM002 vA Retrieve Document REQUEST

element RetrieveDocumentRequestType/workspace
diagram DMSpec_p60.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 

element RetrieveDocumentRequestType/retrieveByDocumentParentNode
diagram DMSpec_p61.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Specifies the path location to the immediate document parent node of a document or group of documents. Use this if all of the documents associated with the indicated document parent node are to be retrieved. Conditional on retrieval of all of a document parent node’s associated documents.

element RetrieveDocumentRequestType/retrieveByDocumentName
diagram DMSpec_p62.png
namespace http://www.jeppesen.com/aoc
type SelectSpecificDocumentByNameType
properties
isRef 0
content complex
children documentParentNode documentName
annotation
documentation
Specifies the path location to the document parent node and the name of a specific child document to be retrieved. Conditional on retrieval of specific documents associated with a specific document parent node.

element RetrieveDocumentRequestType/retrieveByUuid
diagram DMSpec_p63.png
namespace http://www.jeppesen.com/aoc
type String36
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 36 
annotation
documentation
Universal Unique Identifier which specifies the unique identification of a specific document. Returns documents associated with the indicated UUIDs. Note: If more than one but less than the total number of documents need to be retrieved, multiple DM002 requests can be used to retrieve multiple documents, one at a time. Conditional on the retrieval of specific documents  associated with the specified UUIDs.

complexType RetrieveDocumentResponseType
diagram DMSpec_p64.png
namespace http://www.jeppesen.com/aoc
children retrievedDocument error
used by
element DocumentManagementType/retrieveDocumentResponse
annotation
documentation
DM002 vA Retrieve Document RESPONSE

element RetrieveDocumentResponseType/retrievedDocument
diagram DMSpec_p65.png
namespace http://www.jeppesen.com/aoc
type RetrievedDocumentsType
properties
isRef 0
content complex
children documentParentNodeId document
annotation
documentation
Returns the requested document or documents.  Conditional on successful document retrieval.

element RetrieveDocumentResponseType/error
diagram DMSpec_p66.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
Used if error is returned by the Document Management Retrieve operation. Conditional on Document Management system error detection. Common ICD.

complexType SelectSpecificDocumentByNameType
diagram DMSpec_p67.png
namespace http://www.jeppesen.com/aoc
children documentParentNode documentName
used by
elements DeleteDocumentRequestType/deleteByDocumentName RetrieveDocumentRequestType/retrieveByDocumentName
annotation
documentation
Specifies the path location to the document parent node and the name of a specific child document to be retrieved.  Use this if a single document associated with the indicated document parent node is to be retrieved. Note: If more than one but less than the total number of documents need to be retrieved, multiple DM002 requests can be used to retrieve multiple documents, one at a time. Conditional on retrieval of specific documents associated with a specific document parent node.

element SelectSpecificDocumentByNameType/documentParentNode
diagram DMSpec_p68.png
namespace http://www.jeppesen.com/aoc
type String512
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 512 
annotation
documentation
Specifies the path location of the document parent node associated with the specific document.

element SelectSpecificDocumentByNameType/documentName
diagram DMSpec_p69.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 
annotation
documentation
Indicates the name of a single specific document.

complexType StoreDocumentRequestType
diagram DMSpec_p70.png
namespace http://www.jeppesen.com/aoc
children documentStorageNode document
used by
element DocumentManagementType/storeDocumentRequest
annotation
documentation
DM001 vA Store Document REQUEST

element StoreDocumentRequestType/documentStorageNode
diagram DMSpec_p71.png
namespace http://www.jeppesen.com/aoc
type NodeKeyType
properties
isRef 0
content complex
children workspace documentParentNode
annotation
documentation
The document parent node's location identifier.

element StoreDocumentRequestType/document
diagram DMSpec_p72.png
namespace http://www.jeppesen.com/aoc
type DocumentStoreType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children documentMetadata documentContent
annotation
documentation
The content and metadata of the document to be stored.  This repeating group is used to store one or multiple different versions/formats of the same document.

complexType StoreDocumentResponseGroupType
diagram DMSpec_p73.png
namespace http://www.jeppesen.com/aoc
children documentName documentUuid
used by
element StoreDocumentResponseType/storeDocumentResponseGroup

element StoreDocumentResponseGroupType/documentName
diagram DMSpec_p74.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 
annotation
documentation
Indicates the name of a document added to the document repository.

element StoreDocumentResponseGroupType/documentUuid
diagram DMSpec_p75.png
namespace http://www.jeppesen.com/aoc
type String36
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 36 
annotation
documentation
UUID (Universal Unique Identifier) which specifies the location of the document parent node. Responds only with the UUID of the document.

complexType StoreDocumentResponseType
diagram DMSpec_p76.png
namespace http://www.jeppesen.com/aoc
children storeDocumentResponseGroup error
used by
element DocumentManagementType/storeDocumentResponse
annotation
documentation
DM001 vA Store Document RESPONSE

element StoreDocumentResponseType/storeDocumentResponseGroup
diagram DMSpec_p77.png
namespace http://www.jeppesen.com/aoc
type StoreDocumentResponseGroupType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children documentName documentUuid

element StoreDocumentResponseType/error
diagram DMSpec_p78.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
Used if an error is returned by the document store operation.   Conditional on document storage error detection.  Common ICD.

complexType AccessType
diagram DMSpec_p79.png
namespace http://www.jeppesen.com/aoc
children name key
annotation
documentation
Element group may be set to required or optional, and/or  be set to repeatable within a message.

element AccessType/name
diagram DMSpec_p80.png
namespace http://www.jeppesen.com/aoc
type String250
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 250 
annotation
documentation
Example name of the Value:  OperatorId.   String250, limited to 250 chars.

element AccessType/key
diagram DMSpec_p81.png
namespace http://www.jeppesen.com/aoc
type String250
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 250 
annotation
documentation
Example key or value of the named value for OperatorId value:  SWA1234.   String250, limited to 250 chars.

complexType AircraftIdentType
diagram DMSpec_p82.png
namespace http://www.jeppesen.com/aoc
children registrationNumber noseNumber serialNumber noseNumber serialNumber serialNumber other
used by
element DmiIdentifierType/aircraftId
annotation
documentation
Identifies an aircraft using registration, serial, nose number, or other (customer defined)

element AircraftIdentType/registrationNumber
diagram DMSpec_p83.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
Aircraft Registration Number.

element AircraftIdentType/noseNumber
diagram DMSpec_p84.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 
annotation
documentation
Aircraft Nose Number.

element AircraftIdentType/serialNumber
diagram DMSpec_p85.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element AircraftIdentType/noseNumber
diagram DMSpec_p86.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 
annotation
documentation
Aircraft Nose Number.

element AircraftIdentType/serialNumber
diagram DMSpec_p87.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element AircraftIdentType/serialNumber
diagram DMSpec_p88.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element AircraftIdentType/other
diagram DMSpec_p89.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
This represents a customer defined aircraft. For Jeppesen, this is may be used to identify the unique JetPlan aircraft ID.  For Jeppesen JetPlan data access, the system currently only identifies the aircraft by using this field. Any other informaiton received is assumed to be the JetPlan ID and could result in an error.

complexType AircraftIdType
diagram DMSpec_p90.png
namespace http://www.jeppesen.com/aoc
children registrationNumber noseNumber serialNumber noseNumber serialNumber serialNumber
used by
elements BagaFlightKeyType/aircraftId FpResponseAircraftType/aircraftId
annotation
documentation
Identifies an aircraft using registration, serial, and/or nosenumber

element AircraftIdType/registrationNumber
diagram DMSpec_p91.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
Aircraft Registration Number.

element AircraftIdType/noseNumber
diagram DMSpec_p92.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 
annotation
documentation
Aircraft Nose Number.

element AircraftIdType/serialNumber
diagram DMSpec_p93.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element AircraftIdType/noseNumber
diagram DMSpec_p94.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 
annotation
documentation
Aircraft Nose Number.

element AircraftIdType/serialNumber
diagram DMSpec_p95.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element AircraftIdType/serialNumber
diagram DMSpec_p96.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

complexType AirlineCodeType
diagram DMSpec_p97.png
namespace http://www.jeppesen.com/aoc
children iata icao icao other
used by
elements FlightIdentifierType/airlineCode RouteKeyType/airlineCode
annotation
documentation
Uniquely identifies an airline using an IATA, ICAO, or other (customer defined).

element AirlineCodeType/iata
diagram DMSpec_p98.png
namespace http://www.jeppesen.com/aoc
type IataAirlineType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{2} 
annotation
documentation
IATA Airline Code.

element AirlineCodeType/icao
diagram DMSpec_p99.png
namespace http://www.jeppesen.com/aoc
type IcaoAirlineType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{3} 
annotation
documentation
ICAO Airline Code.

element AirlineCodeType/icao
diagram DMSpec_p100.png
namespace http://www.jeppesen.com/aoc
type IcaoAirlineType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{3} 
annotation
documentation
ICAO Airline Code.

element AirlineCodeType/other
diagram DMSpec_p101.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{1,4} 
annotation
documentation
This represents a customer defined airline.  For Jeppesen, this is may be used to identifying the unique JetPlan customer ID.  For Jeppesen JetPlan data access, the system currently only identifies the customer by using this field. Any other informaiton received is assumed to be the JetPlan ID and could result in an error.

complexType AirportCodeType
diagram DMSpec_p102.png
namespace http://www.jeppesen.com/aoc
children iata icao icao other
used by
elements FpResponseAirportType/airport FpResponseAlternateAirportType/alternateLandingAirportGroup/airport FpResponseEtpAirportType/airport ArrivalAirportType/poa RouteKeyType/poa BagaFlightKeyType/pod DepartureAirportType/pod FlightKeyType/pod RouteKeyType/pod
annotation
documentation
Uniquely identifies an airport using IATA, ICAO, or other (customer defined).

element AirportCodeType/iata
diagram DMSpec_p103.png
namespace http://www.jeppesen.com/aoc
type IataAirportType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{3} 
annotation
documentation
IATA Airport Code.

element AirportCodeType/icao
diagram DMSpec_p104.png
namespace http://www.jeppesen.com/aoc
type IcaoAirportType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{4} 
annotation
documentation
ICAO Airport Code.

element AirportCodeType/icao
diagram DMSpec_p105.png
namespace http://www.jeppesen.com/aoc
type IcaoAirportType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{4} 
annotation
documentation
ICAO Airport Code.

element AirportCodeType/other
diagram DMSpec_p106.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{1,4} 
annotation
documentation
This represents a customer defined airport.  For Jeppesen, this is may be used to identifying the unique JetPlan aiport ID.  For Jeppesen JetPlan data access, the system currently only identifies the airport by using this field. Any other informaiton received is assumed to be the JetPlan ID and could result in an error.

complexType AirspeedType
diagram DMSpec_p107.png
namespace http://www.jeppesen.com/aoc
type extension of AirspeedRestriction
properties
base AirspeedRestriction
used by
elements FpResponseCheckpointType/groundSpeed FpResponseSegmentType/groundSpeed FpResponseTocTodType/groundSpeed FpResponseSegmentType/mach FpResponseCheckpointType/trueAirspeed FpResponseSegmentType/trueAirspeed FpResponseTocTodType/trueAirspeed WindGradientType/windVelocity
facets
Kind Value annotation 
minInclusive 
maxInclusive 10000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAirspeedUnitsEnumTyperequired      
documentation
kts - nautical miles per hour
kph - kilometers per hour
mph - statute miles per hour
mach - number times 100

attribute AirspeedType/@units
type AirspeedUnitsEnumType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration kts 
enumeration kph 
enumeration mph 
enumeration mach 
annotation
documentation
kts - nautical miles per hour
kph - kilometers per hour
mph - statute miles per hour
mach - number times 100

complexType AltitudeCruiseModeGroupType
diagram DMSpec_p108.png
namespace http://www.jeppesen.com/aoc
children speed altitude
used by
element AltitudeCruiseModeType/altitudeCruiseModeGroup

element AltitudeCruiseModeGroupType/speed
diagram DMSpec_p109.png
namespace http://www.jeppesen.com/aoc
type CruiseModeType
properties
isRef 0
content complex
children machAirspeed cruiseMode indicatedAirspeed
annotation
documentation
Speed of the aircraft. 

element AltitudeCruiseModeGroupType/altitude
diagram DMSpec_p110.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars
annotation
documentation
Altitude of the aircraft.

complexType AltitudeCruiseModeType
diagram DMSpec_p111.png
namespace http://www.jeppesen.com/aoc
children altitudeCruiseModeGroup

element AltitudeCruiseModeType/altitudeCruiseModeGroup
diagram DMSpec_p112.png
namespace http://www.jeppesen.com/aoc
type AltitudeCruiseModeGroupType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children speed altitude

complexType AltitudeMinMaxType
diagram DMSpec_p113.png
namespace http://www.jeppesen.com/aoc
children min max

element AltitudeMinMaxType/min
diagram DMSpec_p114.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars

element AltitudeMinMaxType/max
diagram DMSpec_p115.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars

complexType AltitudeType
diagram DMSpec_p116.png
namespace http://www.jeppesen.com/aoc
type extension of AltitudeRangeRestriction
properties
base AltitudeRangeRestriction
used by
elements AltitudeCruiseModeGroupType/altitude FpRequestAltitudeType/altitudeGroup/altitude FpResponseCheckpointType/altitude FpResponseTocTodType/altitude FuelDurationType/altitude HorizontalCoordinateType/altitude FpResponseFlightType/flightLevel FpResponseFlightLevelType/fpResponseFlightLevelGroup/flightLevel AltitudeMinMaxType/max AltitudeMinMaxType/min
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars

attribute AltitudeType/@units
type AltitudeHeightEnumType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration ft 
enumeration 
enumeration fl 
enumeration mb 
annotation
documentation
ft = feet
m = meters
fl = flight level
mb = millibars

complexType ArrivalAirportType
diagram DMSpec_p117.png
namespace http://www.jeppesen.com/aoc
children poa customAirport

element ArrivalAirportType/poa
diagram DMSpec_p118.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other

element ArrivalAirportType/customAirport
diagram DMSpec_p119.png
namespace http://www.jeppesen.com/aoc
type CustomAirportType
properties
isRef 0
content complex
children customAirportId coordinates

complexType AtmosphericPressureType
diagram DMSpec_p120.png
namespace http://www.jeppesen.com/aoc
type extension of xs:double
properties
base xs:double
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAtmosphericUnitTyperequired      
documentation
at = Technical atmosphere
Atmosphere
atm = Atmosphere measured in bars
bar = Atmosphere measured in millibars
Pa = Atmosphere measured in pascals
hPa = Atmosphere measured in hectopascals
kPA = Atmosphere measured in kilopascals
inchHg = Atmosphere measured in inches of Mercury
psi = Pounds per square inch
mmHg / Torr = Atmosphere measured in Mercury millimeters

attribute AtmosphericPressureType/@units
type AtmosphericUnitType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration at 
enumeration atm 
enumeration bar 
enumeration mbar 
enumeration Pa 
enumeration hPa 
enumeration kPa 
enumeration inchHg 
enumeration psi 
enumeration mmHg 
enumeration Torr 
annotation
documentation
at = Technical atmosphere
Atmosphere
atm = Atmosphere measured in bars
bar = Atmosphere measured in millibars
Pa = Atmosphere measured in pascals
hPa = Atmosphere measured in hectopascals
kPA = Atmosphere measured in kilopascals
inchHg = Atmosphere measured in inches of Mercury
psi = Pounds per square inch
mmHg / Torr = Atmosphere measured in Mercury millimeters

complexType BagaFlightKeyType
diagram DMSpec_p121.png
namespace http://www.jeppesen.com/aoc
children aircraftId flightOriginDate operationalSuffix departureTime pod
used by
element FlightKeyChoiceType/bagaFlightKey
annotation
documentation
Business, General Aviation  and Military Flight Key

element BagaFlightKeyType/aircraftId
diagram DMSpec_p122.png
namespace http://www.jeppesen.com/aoc
type AircraftIdType
properties
isRef 0
content complex
children registrationNumber noseNumber serialNumber noseNumber serialNumber serialNumber

element BagaFlightKeyType/flightOriginDate
diagram DMSpec_p123.png
namespace http://www.jeppesen.com/aoc
type xs:date
properties
isRef 0
content simple
annotation
documentation
The date that the first leg of a multi leg flight departs.

element BagaFlightKeyType/operationalSuffix
diagram DMSpec_p124.png
namespace http://www.jeppesen.com/aoc
type String1
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
Operational suffix - at a minimum will be used to uniquely identify a flight leg in cases where ground and/or air returns have occurred.

element BagaFlightKeyType/departureTime
diagram DMSpec_p125.png
namespace http://www.jeppesen.com/aoc
type xs:time
properties
isRef 0
content simple
annotation
documentation
hhmmssZ. Zulu Time of departure.

element BagaFlightKeyType/pod
diagram DMSpec_p126.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
POD is the Point of Departure.   FAA-Departure Point.  ICAO-Departure Aerodrome

complexType BiasType
diagram DMSpec_p127.png
namespace http://www.jeppesen.com/aoc
children doubleValue integerValue
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBiasEnumTyperequired      
documentation
percent = percentage of value
absolute = adjustment to the value

attribute BiasType/@units
type BiasEnumType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration percent 
enumeration absolute 
annotation
documentation
percent = percentage of value
absolute = adjustment to the value

element BiasType/doubleValue
diagram DMSpec_p128.png
namespace http://www.jeppesen.com/aoc
type xs:double
properties
isRef 0
content simple
annotation
documentation
Bias value expressed as a double.

element BiasType/integerValue
diagram DMSpec_p129.png
namespace http://www.jeppesen.com/aoc
type xs:integer
properties
isRef 0
content simple
annotation
documentation
Bias value expressed as an integer.

complexType BoundingAreaCircleType
diagram DMSpec_p130.png
namespace http://www.jeppesen.com/aoc
children point radius
used by
element BoundingAreaType/circle

element BoundingAreaCircleType/point
diagram DMSpec_p131.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude
annotation
documentation
Latitude and longitude.

element BoundingAreaCircleType/radius
diagram DMSpec_p132.png
namespace http://www.jeppesen.com/aoc
type DistanceType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive 0.0 
maxInclusive 50000.0 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicDistanceEnumTyperequired      
documentation
nm = nautical miles
km = kilometers
ft = feet
m = meters
annotation
documentation
Distance of the radius.

complexType BoundingAreaPolygonType
diagram DMSpec_p133.png
namespace http://www.jeppesen.com/aoc
children point
used by
element BoundingAreaType/polygon

element BoundingAreaPolygonType/point
diagram DMSpec_p134.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
minOcc 2
maxOcc unbounded
content complex
children latitude longitude
annotation
documentation
Latitude and longitude.

complexType BoundingAreaType
diagram DMSpec_p135.png
namespace http://www.jeppesen.com/aoc
children polygon circle

element BoundingAreaType/polygon
diagram DMSpec_p136.png
namespace http://www.jeppesen.com/aoc
type BoundingAreaPolygonType
properties
isRef 0
content complex
children point
annotation
documentation
Points defined by latitude and longitude that are joined together to form a polygon. 

element BoundingAreaType/circle
diagram DMSpec_p137.png
namespace http://www.jeppesen.com/aoc
type BoundingAreaCircleType
properties
isRef 0
content complex
children point radius
annotation
documentation
An area enclosed by a circle as defined latitude and longitude point and a radius.

complexType CheckpointType
diagram DMSpec_p138.png
namespace http://www.jeppesen.com/aoc
children coordinates waypoint userDefinedName dmeFix
used by
elements FpResponseFlightLevelType/fpResponseFlightLevelGroup/checkpoint FpResponseCheckpointType/name FpResponseEtpType/etp/name

element CheckpointType/coordinates
diagram DMSpec_p139.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude
annotation
documentation
Latitude and Longitude

element CheckpointType/waypoint
diagram DMSpec_p140.png
namespace http://www.jeppesen.com/aoc
type WaypointType
properties
isRef 0
content complex
children identifier icaoCode type
annotation
documentation
ARINC 424-defined waypoint.

element CheckpointType/userDefinedName
diagram DMSpec_p141.png
namespace http://www.jeppesen.com/aoc
type String12
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 12 
annotation
documentation
Name of a user-defined waypoint

element CheckpointType/dmeFix
diagram DMSpec_p142.png
namespace http://www.jeppesen.com/aoc
type String9
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
Waypoint and radial combination; for example, name of a VOR (3 chars) plus a radial (3 chars) plus a distance (3 chars); for example, PLL265065

complexType ClassNameType
diagram DMSpec_p143.png
namespace http://www.jeppesen.com/aoc
children propertyClass propertyName

element ClassNameType/propertyClass
diagram DMSpec_p144.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 

element ClassNameType/propertyName
diagram DMSpec_p145.png
namespace http://www.jeppesen.com/aoc
type String255
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 255 

complexType CruiseModeType
diagram DMSpec_p146.png
namespace http://www.jeppesen.com/aoc
children machAirspeed cruiseMode indicatedAirspeed
used by
elements FpRequestSpeedScheduleType/primaryCruiseMode AltitudeCruiseModeGroupType/speed

element CruiseModeType/machAirspeed
diagram DMSpec_p147.png
namespace http://www.jeppesen.com/aoc
type MachAirspeedRestriction
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern M[6-9][0-9] 
annotation
documentation
Cruise at Mach airspeed number.
M indicates Mach
xx indicates airspeed value.  Example:  M80, M84, M76

element CruiseModeType/cruiseMode
diagram DMSpec_p148.png
namespace http://www.jeppesen.com/aoc
type CruiseModeEnumType
properties
isRef 0
content simple
facets
Kind Value annotation 
length 
whiteSpace collapse 
enumeration CMC 
enumeration ECO 
enumeration HSC 
enumeration LRC 
enumeration MSR 
enumeration MRC 
enumeration MCT 
enumeration MSC 
enumeration NCT 
enumeration 925 
enumeration 945 
enumeration 1LE 
enumeration 2LE 
enumeration ECP 
enumeration MCP 
enumeration RCP 
annotation
documentation
CMC - Constant Mach cruise
ECO - Economy cruise
HSC - High speed cruise
LRC - Long range cruise
MSR - Maximum specific range
MRC - Maximum range cruise
MCT - Maximum cruise thrust
MSC - Maximum speed cruise
NCT - Normal cruise thrust
925 - 925 Turbine Inlet Temperature cruise
945 - 945 Turbine Inlet Temperature cruise
1LE - One less engine
2LE - Two less engines
ECP - Economy cruise power
MCP - Maximum cruise power
RCP - Recommended cruise power

element CruiseModeType/indicatedAirspeed
diagram DMSpec_p149.png
namespace http://www.jeppesen.com/aoc
type IndicatedAirspeedRestriction
properties
isRef 0
content simple
facets
Kind Value annotation 
minInclusive 100 
maxInclusive 400 
annotation
documentation
Indicated airspeed for flight plans

complexType CustomAirportType
diagram DMSpec_p150.png
namespace http://www.jeppesen.com/aoc
children customAirportId coordinates
used by
elements ArrivalAirportType/customAirport DepartureAirportType/customAirport

element CustomAirportType/customAirportId
diagram DMSpec_p151.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
minOcc 0
maxOcc 1
content simple

element CustomAirportType/coordinates
diagram DMSpec_p152.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude

complexType CustomBagaFlightKeyType
diagram DMSpec_p153.png
namespace http://www.jeppesen.com/aoc
children gufiId aircraftIdentifier flightOriginDate operationalSuffix departureTime departureAirport
used by
element CustomFlightKeyChoiceType/customBagaFlightKey

element CustomBagaFlightKeyType/gufiId
diagram DMSpec_p154.png
namespace http://www.jeppesen.com/aoc
type GufiId
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 36 

element CustomBagaFlightKeyType/aircraftIdentifier
diagram DMSpec_p155.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children regNoseSerial noseSerial serialNumber

element CustomBagaFlightKeyType/aircraftIdentifier/regNoseSerial
diagram DMSpec_p156.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children registrationNumber noseNumber serialNumber

element CustomBagaFlightKeyType/aircraftIdentifier/regNoseSerial/registrationNumber
diagram DMSpec_p157.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
Aircraft Registration Number.

element CustomBagaFlightKeyType/aircraftIdentifier/regNoseSerial/noseNumber
diagram DMSpec_p158.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 

element CustomBagaFlightKeyType/aircraftIdentifier/regNoseSerial/serialNumber
diagram DMSpec_p159.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 

element CustomBagaFlightKeyType/aircraftIdentifier/noseSerial
diagram DMSpec_p160.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children noseNumber serialNumber

element CustomBagaFlightKeyType/aircraftIdentifier/noseSerial/noseNumber
diagram DMSpec_p161.png
namespace http://www.jeppesen.com/aoc
type NoseNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [A-Z\d]{1,12} 

element CustomBagaFlightKeyType/aircraftIdentifier/noseSerial/serialNumber
diagram DMSpec_p162.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element CustomBagaFlightKeyType/aircraftIdentifier/serialNumber
diagram DMSpec_p163.png
namespace http://www.jeppesen.com/aoc
type SerialNumberType
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 25 
annotation
documentation
Aircraft Serial Number.

element CustomBagaFlightKeyType/flightOriginDate
diagram DMSpec_p164.png
namespace http://www.jeppesen.com/aoc
type xs:date
properties
isRef 0
content simple
annotation
documentation
The date that the first leg of a multi leg flight departs.

element CustomBagaFlightKeyType/operationalSuffix
diagram DMSpec_p165.png
namespace http://www.jeppesen.com/aoc
type String1
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
Operational suffix - at a minimum will be used to uniquely identify a flight leg in cases where ground and/or air returns have occurred.

element CustomBagaFlightKeyType/departureTime
diagram DMSpec_p166.png
namespace http://www.jeppesen.com/aoc
type xs:time
properties
isRef 0
content simple
annotation
documentation
hhmmssZ. Zulu Time of departure.

element CustomBagaFlightKeyType/departureAirport
diagram DMSpec_p167.png
namespace http://www.jeppesen.com/aoc
type DepartureAirportType
properties
isRef 0
content complex
children pod customAirport

complexType CustomCommercialFlightKeyType
diagram DMSpec_p168.png
namespace http://www.jeppesen.com/aoc
children gufiId flightIdentifier departureAirport
used by
element CustomFlightKeyChoiceType/customCommercialFlightKey
annotation
documentation
Commerical Flight Key:  gufiId, flightIdentifier (flightNumber, airlineCode, flightOriginDate, operationalSuffix), departureAirport (pod, customAirport/customAirportId, coordiantes)

element CustomCommercialFlightKeyType/gufiId
diagram DMSpec_p169.png
namespace http://www.jeppesen.com/aoc
type GufiId
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 36 

element CustomCommercialFlightKeyType/flightIdentifier
diagram DMSpec_p170.png
namespace http://www.jeppesen.com/aoc
type FlightIdentifierType
properties
isRef 0
content complex
children flightNumber airlineCode flightOriginDate operationalSuffix

element CustomCommercialFlightKeyType/departureAirport
diagram DMSpec_p171.png
namespace http://www.jeppesen.com/aoc
type DepartureAirportType
properties
isRef 0
content complex
children pod customAirport

complexType CustomFlightKeyChoiceType
diagram DMSpec_p172.png
namespace http://www.jeppesen.com/aoc
children gufiFlightKey customCommercialFlightKey customBagaFlightKey
annotation
documentation
A unique Flight Key Choice of one of three flight key types:   GUFI, Commercial, and BAGA flight keys.    Each of the flight key type allows for either an icao, iata, other departure airport, or a custom airport that includes name, and coordinates.

element CustomFlightKeyChoiceType/gufiFlightKey
diagram DMSpec_p173.png
namespace http://www.jeppesen.com/aoc
type GufiFlightKeyType
properties
isRef 0
content complex
children gufiId departureAirport

element CustomFlightKeyChoiceType/customCommercialFlightKey
diagram DMSpec_p174.png
namespace http://www.jeppesen.com/aoc
type CustomCommercialFlightKeyType
properties
isRef 0
content complex
children gufiId flightIdentifier departureAirport

element CustomFlightKeyChoiceType/customBagaFlightKey
diagram DMSpec_p175.png
namespace http://www.jeppesen.com/aoc
type CustomBagaFlightKeyType
properties
isRef 0
content complex
children gufiId aircraftIdentifier flightOriginDate operationalSuffix departureTime departureAirport

complexType DelayCodeType
diagram DMSpec_p176.png
namespace http://www.jeppesen.com/aoc
children duration code information

element DelayCodeType/duration
diagram DMSpec_p177.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:duration
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation

element DelayCodeType/code
diagram DMSpec_p178.png
namespace http://www.jeppesen.com/aoc
type String4
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
IATA Codes are used more often.

element DelayCodeType/information
diagram DMSpec_p179.png
namespace http://www.jeppesen.com/aoc
type String1000
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 1000 
annotation
documentation
Additional information that further clarifies the code.

complexType DepartureAirportType
diagram DMSpec_p180.png
namespace http://www.jeppesen.com/aoc
children pod customAirport
used by
elements CustomBagaFlightKeyType/departureAirport CustomCommercialFlightKeyType/departureAirport GufiFlightKeyType/departureAirport

element DepartureAirportType/pod
diagram DMSpec_p181.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
POD is the Point of Departure.   FAA-Departure Point.  ICAO-Departure Aerodrome

element DepartureAirportType/customAirport
diagram DMSpec_p182.png
namespace http://www.jeppesen.com/aoc
type CustomAirportType
properties
isRef 0
content complex
children customAirportId coordinates

complexType DepthType
diagram DMSpec_p183.png
namespace http://www.jeppesen.com/aoc
type extension of DepthRestriction
properties
base DepthRestriction
facets
Kind Value annotation 
minInclusive 
maxInclusive 10000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsDepthUnitsEnumTyperequired      
annotation
documentation
Precipitation depth on runway. Common ICD. Runway conditions. See SCAP Interface Specification-Takeoff, Annex for descriptions of POPT(15). Valid only if runway condition is 2, 3, 5, or 6 as described in the SCAP POPT(15).

attribute DepthType/@units
type DepthUnitsEnumType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration in 
enumeration ft 
enumeration mm 
enumeration cm 
enumeration 

complexType DistanceBiasType
diagram DMSpec_p184.png
namespace http://www.jeppesen.com/aoc
type extension of DistanceBiasRestriction
properties
base DistanceBiasRestriction
facets
Kind Value annotation 
minInclusive 0.0 
maxInclusive 2500.0 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicDistanceEnumTyperequired      
documentation
nm = nautical miles
km = kilometers
ft = feet
m = meters

attribute DistanceBiasType/@units
type BasicDistanceEnumType
properties
isRef 0
use required
annotation
documentation
nm = nautical miles
km = kilometers
ft = feet
m = meters

complexType DistanceType
diagram DMSpec_p185.png
namespace http://www.jeppesen.com/aoc
type extension of DistanceRestriction
properties
base DistanceRestriction
used by
elements FpResponseSegmentType/distance BoundingAreaCircleType/radius
facets
Kind Value annotation 
minInclusive 0.0 
maxInclusive 50000.0 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicDistanceEnumTyperequired      
documentation
nm = nautical miles
km = kilometers
ft = feet
m = meters

attribute DistanceType/@units
type BasicDistanceEnumType
properties
isRef 0
use required
annotation
documentation
nm = nautical miles
km = kilometers
ft = feet
m = meters

complexType DmiIdentifierType
diagram DMSpec_p186.png
namespace http://www.jeppesen.com/aoc
children dmiClass ataCode controlNumber aircraftId equipmentCode

element DmiIdentifierType/dmiClass
diagram DMSpec_p187.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
annotation
documentation
MEL - Minimum Equipment List
CDL - Configuration Deviation List
NEF - Nonessential Equipment and Furnishings (previously known as  - Priority Deferral List)
DMI - Deferred Maintenance Item
SEL - Special Equipment List

element DmiIdentifierType/ataCode
diagram DMSpec_p188.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
content simple
annotation
documentation
ATA or unique identifier for the DMI.  If the ATA code is not used as the unique identifier (e.g. JetPlan), then this field is used to input the unique customer defined identifier.

element DmiIdentifierType/controlNumber
diagram DMSpec_p189.png
namespace http://www.jeppesen.com/aoc
type xs:string
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
Control number issued for the DMI

element DmiIdentifierType/aircraftId
diagram DMSpec_p190.png
namespace http://www.jeppesen.com/aoc
type AircraftIdentType
properties
isRef 0
content complex
children registrationNumber noseNumber serialNumber noseNumber serialNumber serialNumber other
annotation
documentation
Specific aircraft identifier.  Common ICD.

element DmiIdentifierType/equipmentCode
diagram DMSpec_p191.png
namespace http://www.jeppesen.com/aoc
type EquipmentCodeType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children iata icao icao other
annotation
documentation
The type of aircraft by ICAO, IATA, or Other Common ICD.

complexType ElevationType
diagram DMSpec_p192.png
namespace http://www.jeppesen.com/aoc
type extension of ElevationRangeRestriction
properties
base ElevationRangeRestriction
used by
element FpResponseAirportType/elevation
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 30000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicHeightEnumTyperequired      
documentation
ft = feet
m = meters

attribute ElevationType/@units
type BasicHeightEnumType
properties
isRef 0
use required
facets
Kind Value annotation 
enumeration ft 
enumeration 
annotation
documentation
ft = feet
m = meters

complexType EquipmentCodeType
diagram DMSpec_p193.png
namespace http://www.jeppesen.com/aoc
children iata icao icao other
used by
elements DmiIdentifierType/equipmentCode FpResponseAircraftType/equipmentCode
annotation
documentation
Uniquely identifies the aircraft equipement code, also known as the type of aircraft within a customers fleet.  Identifies using the IATA, ICAO, or other (Customer Defined). 

element EquipmentCodeType/iata
diagram DMSpec_p194.png
namespace http://www.jeppesen.com/aoc
type IataEquipmentCodeType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{3} 
annotation
documentation
IATA Equipment Type.

element EquipmentCodeType/icao
diagram DMSpec_p195.png
namespace http://www.jeppesen.com/aoc
type IcaoEquipmentCodeType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{4} 
annotation
documentation
ICAO Equipment Type.

element EquipmentCodeType/icao
diagram DMSpec_p196.png
namespace http://www.jeppesen.com/aoc
type IcaoEquipmentCodeType
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern [0-9A-Z]{4} 
annotation
documentation
ICAO Equipment Type.

element EquipmentCodeType/other
diagram DMSpec_p197.png
namespace http://www.jeppesen.com/aoc
type String8
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
This represents a customer defined aircraft equipment code.  For Jeppesen, this is may be used to identifying the unique JetPlan ID.  For Jeppesen JetPlan data access, the system currently only identifies the aircraft equipment by using this field. Any other informaiton received is assumed to be the JetPlan ID and could result in an error.

complexType ErrorType
diagram DMSpec_p198.png
namespace http://www.jeppesen.com/aoc
children code information
used by
elements StoreDocumentResponseType/error RetrieveDocumentResponseType/error RetrieveDocumentNameListResponseType/error DeletionErrorGroupType/error

element ErrorType/code
diagram DMSpec_p199.png
namespace http://www.jeppesen.com/aoc
type String10
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 10 
annotation
documentation
Error code

element ErrorType/information
diagram DMSpec_p200.png
namespace http://www.jeppesen.com/aoc
type String1000
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 1000 
annotation
documentation
Additional information that further clarifies the code

complexType FlightIdentifierType
diagram DMSpec_p201.png
namespace http://www.jeppesen.com/aoc
children flightNumber airlineCode flightOriginDate operationalSuffix
used by
elements CustomCommercialFlightKeyType/flightIdentifier FlightKeyType/flightIdentifier FpResponseFlightType/flightIdentifier

element FlightIdentifierType/flightNumber
diagram DMSpec_p202.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 12 
annotation
documentation
Flight Number

element FlightIdentifierType/airlineCode
diagram DMSpec_p203.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Airline Code

element FlightIdentifierType/flightOriginDate
diagram DMSpec_p204.png
namespace http://www.jeppesen.com/aoc
type xs:date
properties
isRef 0
content simple
annotation
documentation
The date that the first leg of a multi leg flight departs.

element FlightIdentifierType/operationalSuffix
diagram DMSpec_p205.png
namespace http://www.jeppesen.com/aoc
type String1
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 
annotation
documentation
Operational suffix - at a minimum will be used to uniquely identify a flight leg in cases where ground and/or air returns have occurred.

complexType FlightKeyChoiceType
diagram DMSpec_p206.png
namespace http://www.jeppesen.com/aoc
children commericalFlightKey bagaFlightKey
annotation
documentation
Allows for a choice of appropriate flight key based on the business need.   FlightKey for Commerical.  BAGAFlightKey for Business, General Aviation.

element FlightKeyChoiceType/commericalFlightKey
diagram DMSpec_p207.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children flightKey

element FlightKeyChoiceType/commericalFlightKey/flightKey
diagram DMSpec_p208.png
namespace http://www.jeppesen.com/aoc
type FlightKeyType
properties
isRef 0
content complex
children flightIdentifier pod

element FlightKeyChoiceType/bagaFlightKey
diagram DMSpec_p209.png
namespace http://www.jeppesen.com/aoc
type BagaFlightKeyType
properties
isRef 0
content complex
children aircraftId flightOriginDate operationalSuffix departureTime pod

complexType FlightKeyType
diagram DMSpec_p210.png
namespace http://www.jeppesen.com/aoc
children flightIdentifier pod
used by
element FlightKeyChoiceType/commericalFlightKey/flightKey

element FlightKeyType/flightIdentifier
diagram DMSpec_p211.png
namespace http://www.jeppesen.com/aoc
type FlightIdentifierType
properties
isRef 0
content complex
children flightNumber airlineCode flightOriginDate operationalSuffix
annotation
documentation
Flight identifier

element FlightKeyType/pod
diagram DMSpec_p212.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
POD is the Point of Departure.   FAA-Departure Point.  ICAO-Departure Aerodrome

complexType FpRequestAltitudeType
diagram DMSpec_p213.png
namespace http://www.jeppesen.com/aoc
children altitudeGroup
used by
element FpRequestScenarioType/altitude

element FpRequestAltitudeType/altitudeGroup
diagram DMSpec_p214.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children altitude

element FpRequestAltitudeType/altitudeGroup/altitude
diagram DMSpec_p215.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars
annotation
documentation
Flight altitude levels.  A minimum of one altitude must be specified.

complexType FpRequestScenarioType
diagram DMSpec_p216.png
namespace http://www.jeppesen.com/aoc
children altitude ranking

element FpRequestScenarioType/altitude
diagram DMSpec_p217.png
namespace http://www.jeppesen.com/aoc
type FpRequestAltitudeType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children altitudeGroup
annotation
documentation
Altitude flight levels.

element FpRequestScenarioType/ranking
diagram DMSpec_p218.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
enumeration Cost 
enumeration Fuel 
enumeration Time 
annotation
documentation
Ranking value.

complexType FpRequestSpeedScheduleType
diagram DMSpec_p219.png
namespace http://www.jeppesen.com/aoc
children primaryCruiseMode primaryCostIndex

element FpRequestSpeedScheduleType/primaryCruiseMode
diagram DMSpec_p220.png
namespace http://www.jeppesen.com/aoc
type CruiseModeType
properties
isRef 0
content complex
children machAirspeed cruiseMode indicatedAirspeed
annotation
documentation
Cruise mode.  Conditional on Cruise or Cost Index preference.  One of either primaryCruiseMode or primaryCostIndex must be selected.

element FpRequestSpeedScheduleType/primaryCostIndex
diagram DMSpec_p221.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:integer
properties
isRef 0
content simple
facets
Kind Value annotation 
minInclusive 
maxInclusive 9999 
annotation
documentation
Cost index factor.  Conditional on Cruise or Cost Index preference.  One of either primaryCruiseMode or primaryCostIndex must be selected.

complexType FpResponseAircraftType
diagram DMSpec_p222.png
namespace http://www.jeppesen.com/aoc
children equipmentCode aircraftId

element FpResponseAircraftType/equipmentCode
diagram DMSpec_p223.png
namespace http://www.jeppesen.com/aoc
type EquipmentCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Aircraft type

element FpResponseAircraftType/aircraftId
diagram DMSpec_p224.png
namespace http://www.jeppesen.com/aoc
type AircraftIdType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children registrationNumber noseNumber serialNumber noseNumber serialNumber serialNumber
annotation
documentation
Aircraft identification

complexType FpResponseAirportType
diagram DMSpec_p225.png
namespace http://www.jeppesen.com/aoc
children airport coordinates elevation

element FpResponseAirportType/airport
diagram DMSpec_p226.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Airport code

element FpResponseAirportType/coordinates
diagram DMSpec_p227.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude
annotation
documentation
Airport geographic location

element FpResponseAirportType/elevation
diagram DMSpec_p228.png
namespace http://www.jeppesen.com/aoc
type ElevationType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 30000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicHeightEnumTyperequired      
documentation
ft = feet
m = meters
annotation
documentation
Airport elevation

complexType FpResponseAlternateAirportType
diagram DMSpec_p229.png
namespace http://www.jeppesen.com/aoc
children alternateLandingAirportGroup

element FpResponseAlternateAirportType/alternateLandingAirportGroup
diagram DMSpec_p230.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children airport fuel ete

element FpResponseAlternateAirportType/alternateLandingAirportGroup/airport
diagram DMSpec_p231.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Identification of alternate airport.
Common ICD.

element FpResponseAlternateAirportType/alternateLandingAirportGroup/fuel
diagram DMSpec_p232.png
namespace http://www.jeppesen.com/aoc
type FuelQuantityType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 25000000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsFuelQuantityUnitsEnumrequired      
documentation
kg = kilograms
lb = pounds
lt = liters
ig = imperial gallons
ug = U.S. gallons
densityxs:double      
documentation
If volume is used this value will be used to convert to weight.  If not supplied, then standard densities will be used.
annotation
documentation
Fuel required to alternate airport.
Common ICD.

element FpResponseAlternateAirportType/alternateLandingAirportGroup/ete
diagram DMSpec_p233.png
namespace http://www.jeppesen.com/aoc
type xs:duration
properties
isRef 0
content simple
annotation
documentation
Estimated flying time to alternate airport.

complexType FpResponseCheckpointType
diagram DMSpec_p234.png
namespace http://www.jeppesen.com/aoc
children name coordinates altitude groundSpeed trueAirspeed firId fuelRemaining
used by
element FpResponseRouteType/checkpoint
attributes
Name  Type  Use  Default  Fixed  annotation
orderInteger1to1000required      
documentation
Record number - Ordered record number for recurring data

attribute FpResponseCheckpointType/@order
type Integer1to1000
properties
isRef 0
use required
facets
Kind Value annotation 
minInclusive 
maxInclusive 1000 
annotation
documentation
Record number - Ordered record number for recurring data

element FpResponseCheckpointType/name
diagram DMSpec_p235.png
namespace http://www.jeppesen.com/aoc
type CheckpointType
properties
isRef 0
content complex
children coordinates waypoint userDefinedName dmeFix
annotation
documentation
Checkpoint name.  Includes the named checkpoints - "toc" and "tod".

element FpResponseCheckpointType/coordinates
diagram DMSpec_p236.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude
annotation
documentation
Checkpoint Latitude/Longitude; read only

element FpResponseCheckpointType/altitude
diagram DMSpec_p237.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars
annotation
documentation
Altitude

element FpResponseCheckpointType/groundSpeed
diagram DMSpec_p238.png
namespace http://www.jeppesen.com/aoc
type AirspeedType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 10000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAirspeedUnitsEnumTyperequired      
documentation
kts - nautical miles per hour
kph - kilometers per hour
mph - statute miles per hour
mach - number times 100
annotation
documentation
Ground speed

element FpResponseCheckpointType/trueAirspeed
diagram DMSpec_p239.png
namespace http://www.jeppesen.com/aoc
type AirspeedType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 10000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAirspeedUnitsEnumTyperequired      
documentation
kts - nautical miles per hour
kph - kilometers per hour
mph - statute miles per hour
mach - number times 100
annotation
documentation
True air speed

element FpResponseCheckpointType/firId
diagram DMSpec_p240.png
namespace http://www.jeppesen.com/aoc
type String4to4
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
FIR

element FpResponseCheckpointType/fuelRemaining
diagram DMSpec_p241.png
namespace http://www.jeppesen.com/aoc
type FuelQuantityType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 25000000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsFuelQuantityUnitsEnumrequired      
documentation
kg = kilograms
lb = pounds
lt = liters
ig = imperial gallons
ug = U.S. gallons
densityxs:double      
documentation
If volume is used this value will be used to convert to weight.  If not supplied, then standard densities will be used.
annotation
documentation
Used if the Flight Planning system performs fuel remaining calculations at checkpoints.

complexType FpResponseEtpAirportType
diagram DMSpec_p242.png
namespace http://www.jeppesen.com/aoc
children airport
used by
elements FpResponseEtpType/etp/backwardAirport FpResponseEtpType/etp/forwardAirport

element FpResponseEtpAirportType/airport
diagram DMSpec_p243.png
namespace http://www.jeppesen.com/aoc
type AirportCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Airport code

complexType FpResponseEtpType
diagram DMSpec_p244.png
namespace http://www.jeppesen.com/aoc
children etp

element FpResponseEtpType/etp
diagram DMSpec_p245.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children name coordinates forwardAirport backwardAirport
attributes
Name  Type  Use  Default  Fixed  annotation
orderInteger1to1000required      
documentation
Preserve ETP order

attribute FpResponseEtpType/etp/@order
type Integer1to1000
properties
isRef 0
use required
facets
Kind Value annotation 
minInclusive 
maxInclusive 1000 
annotation
documentation
Preserve ETP order

element FpResponseEtpType/etp/name
diagram DMSpec_p246.png
namespace http://www.jeppesen.com/aoc
type CheckpointType
properties
isRef 0
content complex
children coordinates waypoint userDefinedName dmeFix
annotation
documentation
Equal time point

element FpResponseEtpType/etp/coordinates
diagram DMSpec_p247.png
namespace http://www.jeppesen.com/aoc
type GeographicPointType
properties
isRef 0
content complex
children latitude longitude
annotation
documentation
Checkpoint Latitude/Longitude; read only

element FpResponseEtpType/etp/forwardAirport
diagram DMSpec_p248.png
namespace http://www.jeppesen.com/aoc
type FpResponseEtpAirportType
properties
isRef 0
content complex
children airport
annotation
documentation
Forward equal time point

element FpResponseEtpType/etp/backwardAirport
diagram DMSpec_p249.png
namespace http://www.jeppesen.com/aoc
type FpResponseEtpAirportType
properties
isRef 0
content complex
children airport
annotation
documentation
Backward equal time point

complexType FpResponseFlightLevelType
diagram DMSpec_p250.png
namespace http://www.jeppesen.com/aoc
children fpResponseFlightLevelGroup
used by
element FpResponseFlightType/flightLevelStep

element FpResponseFlightLevelType/fpResponseFlightLevelGroup
diagram DMSpec_p251.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children checkpoint flightLevel

element FpResponseFlightLevelType/fpResponseFlightLevelGroup/checkpoint
diagram DMSpec_p252.png
namespace http://www.jeppesen.com/aoc
type CheckpointType
properties
isRef 0
content complex
children coordinates waypoint userDefinedName dmeFix
annotation
documentation
Flight level checkpoint.  If multiple flight levels are provided, all flight levels after the first is expected to have a checkpoint associated.

element FpResponseFlightLevelType/fpResponseFlightLevelGroup/flightLevel
diagram DMSpec_p253.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars
annotation
documentation
Flight level altitude

complexType FpResponseFlightType
diagram DMSpec_p254.png
namespace http://www.jeppesen.com/aoc
children flightIdentifier callSign etd taxiOutTime taxiInTime eta ete payload departureWeight arrivalWeight flightLevel flightLevelStep averageWind averageTemp

element FpResponseFlightType/flightIdentifier
diagram DMSpec_p255.png
namespace http://www.jeppesen.com/aoc
type FlightIdentifierType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children flightNumber airlineCode flightOriginDate operationalSuffix
annotation
documentation
Flight Identifier

element FpResponseFlightType/callSign
diagram DMSpec_p256.png
namespace http://www.jeppesen.com/aoc
type CallSignType
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 
annotation
documentation
Call sign

element FpResponseFlightType/etd
diagram DMSpec_p257.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
content simple
annotation
documentation
Estimated time of departure

element FpResponseFlightType/taxiOutTime
diagram DMSpec_p258.png
namespace http://www.jeppesen.com/aoc
type Duration0to180Minutes
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minInclusive PT0M 
maxInclusive PT180M 
annotation
documentation
Airport taxi out time in minutes

element FpResponseFlightType/taxiInTime
diagram DMSpec_p259.png
namespace http://www.jeppesen.com/aoc
type Duration0to180Minutes
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minInclusive PT0M 
maxInclusive PT180M 
annotation
documentation
Airport taxi in time in minutes

element FpResponseFlightType/eta
diagram DMSpec_p260.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
Estimated time of arrival

element FpResponseFlightType/ete
diagram DMSpec_p261.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:duration
properties
isRef 0
content simple
facets
Kind Value annotation 
minInclusive PT0H 
maxInclusive PT48H 
annotation
documentation
Time enroute in hours

element FpResponseFlightType/payload
diagram DMSpec_p262.png
namespace http://www.jeppesen.com/aoc
type PayloadWeightType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 1000000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicWeightEnumTyperequired      
documentation
lb = pounds
kg = kilograms
annotation
documentation
Payload.  Always include unless asking for payload calculation

element FpResponseFlightType/departureWeight
diagram DMSpec_p263.png
namespace http://www.jeppesen.com/aoc
type TotalWeightType
properties
isRef 0
content complex
facets
Kind Value annotation 
maxInclusive 4000000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicWeightEnumTyperequired      
documentation
lb = pounds
kg = kilograms
annotation
documentation
Departure weight

element FpResponseFlightType/arrivalWeight
diagram DMSpec_p264.png
namespace http://www.jeppesen.com/aoc
type TotalWeightType
properties
isRef 0
content complex
facets
Kind Value annotation 
maxInclusive 4000000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsBasicWeightEnumTyperequired      
documentation
lb = pounds
kg = kilograms
annotation
documentation
Arrival weight

element FpResponseFlightType/flightLevel
diagram DMSpec_p265.png
namespace http://www.jeppesen.com/aoc
type AltitudeType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -2000 
maxInclusive 250000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAltitudeHeightEnumTyperequired      
documentation
ft = feet
m = meters
fl = flight level
mb = millibars
annotation
documentation
Flight level altitude.  This is the first flight level achieved.  If multiple flight levels are used, they are added using flightLevelStep.

element FpResponseFlightType/flightLevelStep
diagram DMSpec_p266.png
namespace http://www.jeppesen.com/aoc
type FpResponseFlightLevelType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children fpResponseFlightLevelGroup
annotation
documentation
Checkpoints and flight levels for a step flight.

element FpResponseFlightType/averageWind
diagram DMSpec_p267.png
namespace http://www.jeppesen.com/aoc
type SpeedType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -400 
maxInclusive 400 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsSpeedUnitsEnumTyperequired      
documentation
kts - nautical miles per hour
kph - kilometers per hour
mph - statute miles per hour
annotation
documentation
Average route wind speed

element FpResponseFlightType/averageTemp
diagram DMSpec_p268.png
namespace http://www.jeppesen.com/aoc
type TemperatureType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive -459 
maxInclusive 373 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsTemperatureUnitsEnumTyperequired      
documentation
C = Celcius
F = Fahrenheit
K = Kelvin
annotation
documentation
Average route temperature

complexType FpResponseFuelType
diagram DMSpec_p269.png
namespace http://www.jeppesen.com/aoc
children departure taxiOut taxiIn arrival

element FpResponseFuelType/departure
diagram DMSpec_p270.png
namespace http://www.jeppesen.com/aoc
type FuelQuantityType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 25000000 
attributes
Name  Type  Use