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 UserManagement.xsd

AIM Bookshelf Click for UM message overviews.
Message ID   Associated Complex types 
UM001 UserLoginRequestType 
UserLoginResponseType 
UM002 ChangePasswordRequestType
ChangePasswordResponseType


complexType AirlineKeysType
diagram UMSpec_p1.png
namespace http://www.jeppesen.com/aoc
children airlineCode airlineKeyValue airlineLevelRoleKeys
used by
element LoginResponseType/airlineKeys

element AirlineKeysType/airlineCode
diagram UMSpec_p2.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
IATA and/or ICAO code so the airline under which the user is logging in and that is associated with the airline-level key value pairs.  Common ICD.

element AirlineKeysType/airlineKeyValue
diagram UMSpec_p3.png
namespace http://www.jeppesen.com/aoc
type KeyValueType
properties
isRef 0
minOcc 0
maxOcc unbounded
content complex
children keyName keyValue
annotation
documentation
Airline's key value pair(s).

element AirlineKeysType/airlineLevelRoleKeys
diagram UMSpec_p4.png
namespace http://www.jeppesen.com/aoc
type RoleKeysType
properties
isRef 0
minOcc 0
maxOcc unbounded
content complex
children roleName roleKeyValue
annotation
documentation
Names of roles and all associated role-level key value pairs for the airline(s) for which the user is logging in.

complexType ChangePasswordRequestType
diagram UMSpec_p5.png
namespace http://www.jeppesen.com/aoc
children originalLoginInfo corporateCode airlineCode airlineCode newPassword
used by
element UserManagementType/changePasswordRequest
annotation
documentation
UM002 vB Change Password REQUEST

element ChangePasswordRequestType/originalLoginInfo
diagram UMSpec_p6.png
namespace http://www.jeppesen.com/aoc
type LoginType
properties
isRef 0
content complex
children userName password
annotation
documentation
Username and old password. Common ICD.

element ChangePasswordRequestType/corporateCode
diagram UMSpec_p7.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Corporate code. Must have a Corporate Code  or airline, but you may have both.

element ChangePasswordRequestType/airlineCode
diagram UMSpec_p8.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children iata icao icao other
annotation
documentation
Airline IATA and/or ICAO code. Must have a corporateCode or airline, but you may have both.Common ICD.

element ChangePasswordRequestType/airlineCode
diagram UMSpec_p9.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Airline IATA and/or ICAO code. Must have a corporateCode or airline, but you may have both. Common ICD.

element ChangePasswordRequestType/newPassword
diagram UMSpec_p10.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
New password entry. NOTE: When a user is created using the User Manager, the user's password is stored in the database using MD5 encryption. The value of the password element of LoginType elements in UM messages (UM001, UM002) must already be MD5 encrypted by the client product. Authentication is based on an exact match between the two strings. To ensure client products can reproduce the encrypted password string created by the User Manager application, client products should follow these guidelines:
- Use a MD5 hashing library that adheres to RFC 1321
- Only the user's password should be used to compute the hash
- The range of byte values of characters in the password (prior to encryption) should be 0x20 to 0x7E (ISO 8859-1 alphanumeric characters)
- The encrypted string should be a 24-character Base64-encoding of a 16-byte MD5 digest Example: the password abcd1234 should be represented by the encrypted string: 4Z1c1a8DeNoF9j+JHHRnrw==

complexType ChangePasswordResponseType
diagram UMSpec_p11.png
namespace http://www.jeppesen.com/aoc
children userPasswordChangeResponse error
used by
element UserManagementType/changePasswordResponse
annotation
documentation
UM002 vB Change Password RESPONSE

element ChangePasswordResponseType/userPasswordChangeResponse
diagram UMSpec_p12.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:boolean
properties
isRef 0
content simple
facets
Kind Value annotation 
pattern true 
annotation
documentation
Responds with True.

element ChangePasswordResponseType/error
diagram UMSpec_p13.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
An error is returned by the User Manager if one of the following conditions exist in the new password:
-  The password does not meet complexity requirements if the complexity requirements are mandated by the corporation.
-  The user has already used the password.
Common ICD.

complexType CorporateKeysType
diagram UMSpec_p14.png
namespace http://www.jeppesen.com/aoc
children corporateCode corporateName corporationKeyValue
used by
element LoginResponseType/corporateKeys

element CorporateKeysType/corporateCode
diagram UMSpec_p15.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Corporate code. Must have a corporateCode or airline, but you may have both.

element CorporateKeysType/corporateName
diagram UMSpec_p16.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
Name of the company.

element CorporateKeysType/corporationKeyValue
diagram UMSpec_p17.png
namespace http://www.jeppesen.com/aoc
type KeyValueType
properties
isRef 0
minOcc 0
maxOcc unbounded
content complex
children keyName keyValue
annotation
documentation
Corporate name and corporate-level key value pairs. Corporate key value pairs are configurable elements defined at the corporate level. Can be used only if corporateCode is defined. Use is optional even if corporateCode is defined.

complexType KeyValueType
diagram UMSpec_p18.png
namespace http://www.jeppesen.com/aoc
children keyName keyValue
used by
elements AirlineKeysType/airlineKeyValue CorporateKeysType/corporationKeyValue RoleKeysType/roleKeyValue UserKeysType/userKeysGroup/userKeyValue

element KeyValueType/keyName
diagram UMSpec_p19.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Name of key value pair.  Literal variable "fullname".  Example:  fullname (variable set by keyValue)

element KeyValueType/keyValue
diagram UMSpec_p20.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Value of key value pair. 

complexType LoginResponseType
diagram UMSpec_p21.png
namespace http://www.jeppesen.com/aoc
children authentication corporateKeys userKeys airlineKeys
used by
element UserLoginResponseType/loginResponse

element LoginResponseType/authentication
diagram UMSpec_p22.png
namespace http://www.jeppesen.com/aoc
type xs:boolean
properties
isRef 0
content simple
annotation
documentation
Responds with True or False; True = login success, False = login failure

element LoginResponseType/corporateKeys
diagram UMSpec_p23.png
namespace http://www.jeppesen.com/aoc
type CorporateKeysType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children corporateCode corporateName corporationKeyValue
annotation
documentation
Corporate code, corporate name, and corporate-level key value pairs.

element LoginResponseType/userKeys
diagram UMSpec_p24.png
namespace http://www.jeppesen.com/aoc
type UserKeysType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children userName userKeysGroup
annotation
documentation
User logging in.

element LoginResponseType/airlineKeys
diagram UMSpec_p25.png
namespace http://www.jeppesen.com/aoc
type AirlineKeysType
properties
isRef 0
minOcc 0
maxOcc unbounded
content complex
children airlineCode airlineKeyValue airlineLevelRoleKeys
annotation
documentation
Airline(s) for which the user is logging in and airline-level key value pairs for all the airlines.

complexType RoleKeysType
diagram UMSpec_p26.png
namespace http://www.jeppesen.com/aoc
children roleName roleKeyValue
used by
elements AirlineKeysType/airlineLevelRoleKeys UserKeysType/userKeysGroup/roleKeys

element RoleKeysType/roleName
diagram UMSpec_p27.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Name of role. roleName must match an existing defined role.  Example:  Supervisor, Dispatcher, etc

element RoleKeysType/roleKeyValue
diagram UMSpec_p28.png
namespace http://www.jeppesen.com/aoc
type KeyValueType
properties
isRef 0
minOcc 0
maxOcc unbounded
content complex
children keyName keyValue
annotation
documentation
Role's key value pair(s).

complexType UserKeysType
diagram UMSpec_p29.png
namespace http://www.jeppesen.com/aoc
children userName userKeysGroup
used by
element LoginResponseType/userKeys

element UserKeysType/userName
diagram UMSpec_p30.png
namespace http://www.jeppesen.com/aoc
type String80
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Identifies user logging in. Example: employeeID

element UserKeysType/userKeysGroup
diagram UMSpec_p31.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children userKeyValue roleKeys

element UserKeysType/userKeysGroup/userKeyValue
diagram UMSpec_p32.png
namespace http://www.jeppesen.com/aoc
type KeyValueType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children keyName keyValue
annotation
documentation
User-level key value pairs. Can be used only if "userName" is defined. Use is optional even if userName is defined.

element UserKeysType/userKeysGroup/roleKeys
diagram UMSpec_p33.png
namespace http://www.jeppesen.com/aoc
type RoleKeysType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children roleName roleKeyValue
annotation
documentation
Roles assigned to the user.

complexType UserLoginRequestType
diagram UMSpec_p34.png
namespace http://www.jeppesen.com/aoc
children login corporateCode airlineCode airlineCode roleName
used by
element UserManagementType/userLoginRequest
annotation
documentation
UM001 v2 User Login REQUEST

element UserLoginRequestType/login
diagram UMSpec_p35.png
namespace http://www.jeppesen.com/aoc
type LoginType
properties
isRef 0
content complex
children userName password
annotation
documentation
Username and password of account to verify. Common ICD.

element UserLoginRequestType/corporateCode
diagram UMSpec_p36.png
namespace http://www.jeppesen.com/aoc
type restriction of xs:string
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 80 
annotation
documentation
Corporate code. Must have a Corporate Code  or airline, but you may have both.

element UserLoginRequestType/airlineCode
diagram UMSpec_p37.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children iata icao icao other
annotation
documentation
Airline IATA and/or ICAO code. Must have a Corporate Code or Airline Code but you may have both. Common ICD.

element UserLoginRequestType/airlineCode
diagram UMSpec_p38.png
namespace http://www.jeppesen.com/aoc
type AirlineCodeType
properties
isRef 0
content complex
children iata icao icao other
annotation
documentation
Airline IATA and/or ICAO code. Must have a corporateCode or airline, but you may have both. Common ICD.

element UserLoginRequestType/roleName
diagram UMSpec_p39.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
Identifies a specific role under which a user logs in.

complexType UserLoginResponseType
diagram UMSpec_p40.png
namespace http://www.jeppesen.com/aoc
children loginResponse error
used by
element UserManagementType/userLoginResponse
annotation
documentation
UM001 v2 User Login RESPONSE

element UserLoginResponseType/loginResponse
diagram UMSpec_p41.png
namespace http://www.jeppesen.com/aoc
type LoginResponseType
properties
isRef 0
content complex
children authentication corporateKeys userKeys airlineKeys
annotation
documentation
Response provided by User Manager.

element UserLoginResponseType/error
diagram UMSpec_p42.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information
annotation
documentation
If any of the following conditions are true, an error is returned by the User Manager to the product:
-  The user enters an invalid user name
-  The user enters an invalid password
-  The user enters a corporate code that is not assigned to his or her user profile
-  The user enters an airline code that is not assigned to his or her user profile
-  The user's password has expired
-  This is the user's first time logging in
-  The user's attempts to log in exceeds the number of attempts permitted
-  The product in which the user is logging in has exceeded its maximum number of allowed users
-  The user enters an invalid role
-  Authentication from an external database does not grant the user access Common ICD.

complexType UserManagementType
diagram UMSpec_p43.png
namespace http://www.jeppesen.com/aoc
children userLoginRequest userLoginResponse changePasswordRequest changePasswordResponse error
annotation
documentation
The top level element for User 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.

element UserManagementType/userLoginRequest
diagram UMSpec_p44.png
namespace http://www.jeppesen.com/aoc
type UserLoginRequestType
properties
isRef 0
content complex
children login corporateCode airlineCode airlineCode roleName
annotation
documentation
UM001 v2 Login REQUEST

element UserManagementType/userLoginResponse
diagram UMSpec_p45.png
namespace http://www.jeppesen.com/aoc
type UserLoginResponseType
properties
isRef 0
content complex
children loginResponse error
annotation
documentation
UM001 v2 Login RESPONSE

element UserManagementType/changePasswordRequest
diagram UMSpec_p46.png
namespace http://www.jeppesen.com/aoc
type ChangePasswordRequestType
properties
isRef 0
content complex
children originalLoginInfo corporateCode airlineCode airlineCode newPassword
annotation
documentation
UM002 vB Change Password REQUEST

element UserManagementType/changePasswordResponse
diagram UMSpec_p47.png
namespace http://www.jeppesen.com/aoc
type ChangePasswordResponseType
properties
isRef 0
content complex
children userPasswordChangeResponse error
annotation
documentation
UM002 vB Change PASSWORD RESPONSE

element UserManagementType/error
diagram UMSpec_p48.png
namespace http://www.jeppesen.com/aoc
type ErrorType
properties
isRef 0
content complex
children code information

complexType AccessType
diagram UMSpec_p49.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 UMSpec_p50.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 UMSpec_p51.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 UMSpec_p52.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 UMSpec_p53.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 UMSpec_p54.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 UMSpec_p55.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 UMSpec_p56.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 UMSpec_p57.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 UMSpec_p58.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 UMSpec_p59.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 UMSpec_p60.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 UMSpec_p61.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 UMSpec_p62.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 UMSpec_p63.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 UMSpec_p64.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 UMSpec_p65.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 UMSpec_p66.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 UMSpec_p67.png
namespace http://www.jeppesen.com/aoc
children iata icao icao other
used by
elements UserLoginRequestType/airlineCode UserLoginRequestType/airlineCode ChangePasswordRequestType/airlineCode ChangePasswordRequestType/airlineCode AirlineKeysType/airlineCode FlightIdentifierType/airlineCode RouteKeyType/airlineCode
annotation
documentation
Uniquely identifies an airline using an IATA, ICAO, or other (customer defined).

element AirlineCodeType/iata
diagram UMSpec_p68.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 UMSpec_p69.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 UMSpec_p70.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 UMSpec_p71.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 UMSpec_p72.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 UMSpec_p73.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 UMSpec_p74.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 UMSpec_p75.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 UMSpec_p76.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 UMSpec_p77.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 UMSpec_p78.png
namespace http://www.jeppesen.com/aoc
children speed altitude
used by
element AltitudeCruiseModeType/altitudeCruiseModeGroup

element AltitudeCruiseModeGroupType/speed
diagram UMSpec_p79.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 UMSpec_p80.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 UMSpec_p81.png
namespace http://www.jeppesen.com/aoc
children altitudeCruiseModeGroup

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

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

element AltitudeMinMaxType/min
diagram UMSpec_p84.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 UMSpec_p85.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 UMSpec_p86.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 UMSpec_p87.png
namespace http://www.jeppesen.com/aoc
children poa customAirport

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

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

complexType AtmosphericPressureType
diagram UMSpec_p90.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 UMSpec_p91.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 UMSpec_p92.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 UMSpec_p93.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 UMSpec_p94.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 UMSpec_p95.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 UMSpec_p96.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 UMSpec_p97.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 UMSpec_p98.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 UMSpec_p99.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 UMSpec_p100.png
namespace http://www.jeppesen.com/aoc
children point radius
used by
element BoundingAreaType/circle

element BoundingAreaCircleType/point
diagram UMSpec_p101.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 UMSpec_p102.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 UMSpec_p103.png
namespace http://www.jeppesen.com/aoc
children point
used by
element BoundingAreaType/polygon

element BoundingAreaPolygonType/point
diagram UMSpec_p104.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 UMSpec_p105.png
namespace http://www.jeppesen.com/aoc
children polygon circle

element BoundingAreaType/polygon
diagram UMSpec_p106.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 UMSpec_p107.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 UMSpec_p108.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 UMSpec_p109.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 UMSpec_p110.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 UMSpec_p111.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 UMSpec_p112.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 UMSpec_p113.png
namespace http://www.jeppesen.com/aoc
children propertyClass propertyName

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

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

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

element CruiseModeType/machAirspeed
diagram UMSpec_p117.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 UMSpec_p118.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 UMSpec_p119.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 UMSpec_p120.png
namespace http://www.jeppesen.com/aoc
children customAirportId coordinates
used by
elements ArrivalAirportType/customAirport DepartureAirportType/customAirport

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

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

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

element CustomBagaFlightKeyType/gufiId
diagram UMSpec_p124.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 UMSpec_p125.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children regNoseSerial noseSerial serialNumber

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

element CustomBagaFlightKeyType/aircraftIdentifier/regNoseSerial/registrationNumber
diagram UMSpec_p127.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 UMSpec_p128.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 UMSpec_p129.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 UMSpec_p130.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children noseNumber serialNumber

element CustomBagaFlightKeyType/aircraftIdentifier/noseSerial/noseNumber
diagram UMSpec_p131.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 UMSpec_p132.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 UMSpec_p133.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 UMSpec_p134.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 UMSpec_p135.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 UMSpec_p136.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 UMSpec_p137.png
namespace http://www.jeppesen.com/aoc
type DepartureAirportType
properties
isRef 0
content complex
children pod customAirport

complexType CustomCommercialFlightKeyType
diagram UMSpec_p138.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 UMSpec_p139.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 UMSpec_p140.png
namespace http://www.jeppesen.com/aoc
type FlightIdentifierType
properties
isRef 0
content complex
children flightNumber airlineCode flightOriginDate operationalSuffix

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

complexType CustomFlightKeyChoiceType
diagram UMSpec_p142.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 UMSpec_p143.png
namespace http://www.jeppesen.com/aoc
type GufiFlightKeyType
properties
isRef 0
content complex
children gufiId departureAirport

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

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

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

element DelayCodeType/duration
diagram UMSpec_p147.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 UMSpec_p148.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 UMSpec_p149.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 UMSpec_p150.png
namespace http://www.jeppesen.com/aoc
children pod customAirport
used by
elements CustomBagaFlightKeyType/departureAirport CustomCommercialFlightKeyType/departureAirport GufiFlightKeyType/departureAirport

element DepartureAirportType/pod
diagram UMSpec_p151.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 UMSpec_p152.png
namespace http://www.jeppesen.com/aoc
type CustomAirportType
properties
isRef 0
content complex
children customAirportId coordinates

complexType DepthType
diagram UMSpec_p153.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 UMSpec_p154.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 UMSpec_p155.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 UMSpec_p156.png
namespace http://www.jeppesen.com/aoc
children dmiClass ataCode controlNumber aircraftId equipmentCode

element DmiIdentifierType/dmiClass
diagram UMSpec_p157.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 UMSpec_p158.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 UMSpec_p159.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 UMSpec_p160.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 UMSpec_p161.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 UMSpec_p162.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 UMSpec_p163.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 UMSpec_p164.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 UMSpec_p165.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 UMSpec_p166.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 UMSpec_p167.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 UMSpec_p168.png
namespace http://www.jeppesen.com/aoc
children code information
used by
elements UserManagementType/error UserLoginResponseType/error ChangePasswordResponseType/error

element ErrorType/code
diagram UMSpec_p169.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 UMSpec_p170.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 UMSpec_p171.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 UMSpec_p172.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 UMSpec_p173.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 UMSpec_p174.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 UMSpec_p175.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 UMSpec_p176.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 UMSpec_p177.png
namespace http://www.jeppesen.com/aoc
properties
isRef 0
content complex
children flightKey

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

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

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

element FlightKeyType/flightIdentifier
diagram UMSpec_p181.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 UMSpec_p182.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 UMSpec_p183.png
namespace http://www.jeppesen.com/aoc
children altitudeGroup
used by
element FpRequestScenarioType/altitude

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

element FpRequestAltitudeType/altitudeGroup/altitude
diagram UMSpec_p185.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 UMSpec_p186.png
namespace http://www.jeppesen.com/aoc
children altitude ranking

element FpRequestScenarioType/altitude
diagram UMSpec_p187.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 UMSpec_p188.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 UMSpec_p189.png
namespace http://www.jeppesen.com/aoc
children primaryCruiseMode primaryCostIndex

element FpRequestSpeedScheduleType/primaryCruiseMode
diagram UMSpec_p190.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 UMSpec_p191.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 UMSpec_p192.png
namespace http://www.jeppesen.com/aoc
children equipmentCode aircraftId

element FpResponseAircraftType/equipmentCode
diagram UMSpec_p193.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 UMSpec_p194.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 UMSpec_p195.png
namespace http://www.jeppesen.com/aoc
children airport coordinates elevation

element FpResponseAirportType/airport
diagram UMSpec_p196.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 UMSpec_p197.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 UMSpec_p198.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 UMSpec_p199.png
namespace http://www.jeppesen.com/aoc
children alternateLandingAirportGroup

element FpResponseAlternateAirportType/alternateLandingAirportGroup
diagram UMSpec_p200.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 UMSpec_p201.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 UMSpec_p202.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 UMSpec_p203.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 UMSpec_p204.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 UMSpec_p205.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 UMSpec_p206.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 UMSpec_p207.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 UMSpec_p208.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 UMSpec_p209.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 UMSpec_p210.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 UMSpec_p211.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 UMSpec_p212.png
namespace http://www.jeppesen.com/aoc
children airport
used by
elements FpResponseEtpType/etp/backwardAirport FpResponseEtpType/etp/forwardAirport

element FpResponseEtpAirportType/airport
diagram UMSpec_p213.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 UMSpec_p214.png
namespace http://www.jeppesen.com/aoc
children etp

element FpResponseEtpType/etp
diagram UMSpec_p215.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 UMSpec_p216.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 UMSpec_p217.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 UMSpec_p218.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 UMSpec_p219.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 UMSpec_p220.png
namespace http://www.jeppesen.com/aoc
children fpResponseFlightLevelGroup
used by
element FpResponseFlightType/flightLevelStep

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

element FpResponseFlightLevelType/fpResponseFlightLevelGroup/checkpoint
diagram UMSpec_p222.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 UMSpec_p223.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 UMSpec_p224.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 UMSpec_p225.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 UMSpec_p226.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 UMSpec_p227.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 UMSpec_p228.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 UMSpec_p229.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 UMSpec_p230.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 UMSpec_p231.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 UMSpec_p232.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 UMSpec_p233.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 UMSpec_p234.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 UMSpec_p235.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 UMSpec_p236.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 UMSpec_p237.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 UMSpec_p238.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 UMSpec_p239.png
namespace http://www.jeppesen.com/aoc
children departure taxiOut taxiIn arrival

element FpResponseFuelType/departure
diagram UMSpec_p240.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
Departure fuel

element FpResponseFuelType/taxiOut
diagram UMSpec_p241.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
Airport taxi out fuel

element FpResponseFuelType/taxiIn
diagram UMSpec_p242.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
Airport taxi in fuel

element FpResponseFuelType/arrival
diagram UMSpec_p243.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
Arrival fuel

complexType FpResponsePlanStatisticsType
diagram UMSpec_p244.png
namespace http://www.jeppesen.com/aoc
children flightPlanKey runDate

element FpResponsePlanStatisticsType/flightPlanKey
diagram UMSpec_p245.png
namespace http://www.jeppesen.com/aoc
type String30
properties
isRef 0
content simple
facets
Kind Value annotation 
maxLength 30 
annotation
documentation
Specific plan ID.

element FpResponsePlanStatisticsType/runDate
diagram UMSpec_p246.png
namespace http://www.jeppesen.com/aoc
type xs:dateTime
properties
isRef 0
content simple
annotation
documentation
Date and time plan was run.

complexType FpResponseRouteType
diagram UMSpec_p247.png
namespace http://www.jeppesen.com/aoc
children checkpoint segment

element FpResponseRouteType/checkpoint
diagram UMSpec_p248.png
namespace http://www.jeppesen.com/aoc
type FpResponseCheckpointType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children name coordinates altitude groundSpeed trueAirspeed firId fuelRemaining
attributes
Name  Type  Use  Default  Fixed  annotation
orderInteger1to1000required      
documentation
Record number - Ordered record number for recurring data
annotation
documentation
First checkpoint will always be the POD and the last checkpoint will always be the last POA; minimum of two checkpoints

element FpResponseRouteType/segment
diagram UMSpec_p249.png
namespace http://www.jeppesen.com/aoc
type FpResponseSegmentType
properties
isRef 0
minOcc 1
maxOcc unbounded
content complex
children airway distance fuel mach groundSpeed trueAirspeed
attributes
Name  Type  Use  Default  Fixed  annotation
orderInteger1to1000required      
documentation
Record number - Ordered record number for recurring data
annotation
documentation
Minimum of one segment

complexType FpResponseSegmentType
diagram UMSpec_p250.png
namespace http://www.jeppesen.com/aoc
children airway distance fuel mach groundSpeed trueAirspeed
used by
element FpResponseRouteType/segment
attributes
Name  Type  Use  Default  Fixed  annotation
orderInteger1to1000required      
documentation
Record number - Ordered record number for recurring data

attribute FpResponseSegmentType/@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 FpResponseSegmentType/airway
diagram UMSpec_p251.png
namespace http://www.jeppesen.com/aoc
type String10
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
maxLength 10 
annotation
documentation
Airway. Provide if on an airway

element FpResponseSegmentType/distance
diagram UMSpec_p252.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
Segment distance

element FpResponseSegmentType/fuel
diagram UMSpec_p253.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
Segment fuel. If calculated, segment fuel represents the fuel used since the most recent previous checkpoint where a segment fuel calculation was performed.

element FpResponseSegmentType/mach
diagram UMSpec_p254.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
Segment mach.  Only if in mach range.

element FpResponseSegmentType/groundSpeed
diagram UMSpec_p255.png
namespace http://www.jeppesen.com/aoc
type AirspeedType
properties
isRef 0
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 FpResponseSegmentType/trueAirspeed
diagram UMSpec_p256.png
namespace http://www.jeppesen.com/aoc
type AirspeedType
properties
isRef 0
content complex
facets
Kind Value annotation 
minInclusive 
maxInclusive 10000 
attributes
Name  Type  Use  Default  Fixed  annotation
unitsAirspeedUnitsEnumTyperequired