NM 27.

0 - NM B2B Reference Manual

NM B2B Team

Edition: 6 - 2023-12-06: 27.1.0.1.209

Table of Contents
Document Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
I: Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Revision Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Edition 6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Edition 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Edition 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Edition 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Edition 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
NM B2B Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
NM B2B 27.0 Version Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Decommissioned Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Impact on Previous Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
TB-445 / CR-051513 - Access control re-implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
TB-445 / CR-051018 - Service Usage Control Improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
FB-996 / CR-050322 - Occupancy Regulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic) . . . . . . . . . . . . . . . . . . . 9
FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements . . . . . . . . . . . . . . . . . 9
FB-1191 / CR-052011 - Restriction model for dynamic activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
FB-1191 / CR-052020 - Single CDR Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
I2-125780 - Incorrect usage of HTTP 400 - Bad Request status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
I2-126566 - Error message constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Migration Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
TB-445 / CR-051510 - P/S services re-organisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
TB-445 / CR-051017 - ReroutingApplyRequest.filedFrom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic). . . . . . . . . . . . . . . . . . 13
FB-1172 / CR-052021 - ATFCM Situation Improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
FB-1186 / CR-050218 - Mixer route source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements . . . . . . . . . . . . . . . . 14
FB-1191 / CR-052011 - Restriction model for dynamic activation . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
FB-1191 / CR-052020 - Single CDR Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
FB-1192 / CR-052317 - FFICE Service Group Improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
FFICE_PUBLICATION P/S Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
FFICE Upgrade to FIXM 4.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
FB-1202 / CR-049216 - Alternate Aerodrome Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
FB-1202 / CR-052415 - Export NM descriptor as part of Navaid/DesignatedPoint . . . . . . . . . . . . . 16
I2-127792 - Flight Information Update ATFM Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
I2-128134 - Rename TrafficVolumeFilter to TrafficVolumeSelection . . . . . . . . . . . . . . . . . . . . . . . . 17
NM B2B 27.0 Version - Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Cross Service Group Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
TB-445 / CR-051017 - B2B Acting Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
TB-445 / CR-051018 - Service Usage Control Improvements. . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
TB-445 / CR-051510 - P/S services re-organisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
TB-445 / CR-051513 - Access control re-implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
TB-445 / CR-051719 - Publish/Subscribe subscription re-initialisation . . . . . . . . . . . . . . . . . . 24
Change Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic) . . . . . . . . . . . . . 25
FB-1192 / CR-052317 - FFICE Service Group Improvements / FFICE_PUBLICATION P/S
Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
CR-053431 - Functional missing ANU addresses in Flight/FLIGHT_PLAN and FF-
ICE/FFICE_PUBLICATION P/S topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
I2-125780 - Incorrect usage of HTTP 400 - Bad Request status . . . . . . . . . . . . . . . . . . . . . . . . . 28
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Common Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
I2-126566 - Error message constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
General Information Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Airspace Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements . . . . . . . . . . . . 30
FB-1191 / CR-052011 - Restriction model for dynamic activation . . . . . . . . . . . . . . . . . . . . . . . 30
FB-1191 / CR-052012 - Dynamic RAD Restriction Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
FB-1191 / CR-052020 - Single CDR Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
FB-1193 / CR-052312 - FLOS (Flight Level Orientation Scheme) Type in PointUsage . . . . . . 32
FB-1202 / CR-52415 - Export NM descriptor as part of Navaid/DesignatedPoint. . . . . . . . . . 33
TB-445 / CR-050607 - Adding the Group name in the AIXM output . . . . . . . . . . . . . . . . . . . . . 33
TB-445 / CR-052207 - Expose ATS Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
I2-128110 - Dependent applicability offsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Flight Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
 FB-1125 / CR-049109 - A-CDM Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
FB-1158 / CR-050215 - Turn / Yoyo enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
FB-1186 / CR-050218 - Rerouting feedback submission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
FB-1186 / CR-050218 - Mixer route source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
FB-1192 / CR-052317 - SELCAL32 evolution leftover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
FB-1197 / CR-049012 - Expose highest model fuel consumption and route charges. . . . . . . 41
FB-1202 / CR-049216 - Alternate Aerodrome Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
FB-1202 / CR-049908 - Expose IATA flight designator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
FB-1202 / CR-052208 - Flight Retrieval by IATA flight designator . . . . . . . . . . . . . . . . . . . . . . . 44
FB-1203 / CR-051019 - Expose cdmEstimatedOffBlockTime in P/S . . . . . . . . . . . . . . . . . . . . . . 44
FB-1208 / CR-051818 - Slot Swap Candidate List field on Flight List . . . . . . . . . . . . . . . . . . . . . 45
TB-445 / CR-051614 - Expose flight plan originators in P/S FlightPlanMessage history . . . . 46
CR-052512 - RoutingAssistanceRequest: Expose current routes in system. . . . . . . . . . . . . . . 46
CR-052806 - Ready pre-sequenced flights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
CR-053206 - ATC Coordinated Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
CR-053506 - Rerouting Opportunities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
I2-126750 - Colour_DataType incorrect naming / packaging . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
I2-127464 - Point DAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
I2-127491 - Rename CDM AirportType attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
I2-127792 - Flight Information Update ATFM Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
I2-128108 - Remove unused types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
I2-128134 - Rename TrafficVolumeFilter to TrafficVolumeSelection . . . . . . . . . . . . . . . . . . . . 52
I2-127447 - New constraint on FlightPlanUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
I2-130446 - Functional missing data items from the FLIGHT_PLAN P/S topic . . . . . . . . . . . . 54
Flow Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
FB-996 / CR-050322 - Occupancy Regulations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
FB-1172 / CR-052021 - ATFCM Situation Improvements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
FB-1186 / CR-051215 - Rerouting Id in Group Rerouting Summary and Proposal
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
FB-1198 / CR-050314 - STAM RRP process improvement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
CR-053430 - Delete Draft CP Regulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
I2-127575 - Fix OTMVSustained crossingOccurences range. . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
I2-128109 - Remove unused types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
I2-130481 - Fix ATFCM Situation Request INCONSISTENT_DAY_AND_DATASET_TYPE
constraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
 Ffice Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Enhancements & New Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
FB-1192 / CR-052317 - FFICE Service Group Improvements / Upgrade to FIXM 4.3 . . . . . . . 62
Change Impacts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CR-053508 - Functional identified PTR causing level off not shown in agreed trajectory . 64
Fixes and Corrections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CR-053507 - Functional missing data items from the FFICE_PUBLICATION P/S topic . . . . . 64
Known Issues and Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
II: Essentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.1. Organisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.2. Intended Readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.3. Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
2. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.1. General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
2.2. SWIM Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3. Service Contract Organisation & Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.2. Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.3. Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.4. Service Group Reference Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
3.5. WSDL and XSDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4. Service Lifecycle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.2. NM Releases and NM B2B Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
4.3. Backward Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
4.4. NM B2B Documentation Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
5. Message Exchange Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1. Messaging Essentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1.1. Requests and Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1.2. File Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1.3. Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1.3.1. Message Time-To-Live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5.1.3.2. Message Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
5.1.3.3. Pattern Specific Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.2. Synchronous Request / Reply (S-R/R). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.3. Asynchronous Request / Reply (A-R/R) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.3.2. Correlation Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
 5.3.3. Request Processing Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
5.3.4. Queue Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
5.3.5. Asynchronous Reply Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
5.3.5.1. Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.4. Publish / Subscribe (P/S) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
5.4.2. Subscription Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
5.4.3. P/S Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
5.4.3.1. Technical Messages vs Business Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
5.4.3.2. Delta vs Self-Contained Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
5.4.3.3. Message Timeliness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
5.4.3.4. Message Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
5.4.3.5. Message Ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.4.4. Building a Client Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.4.4.1. Subscription Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
5.4.4.2. Client Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.4.4.3. Message Consumption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.4.4.4. Publish/Subscribe Example Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
5.5. File Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.5.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
5.5.2. Computing the File Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
6. Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.1. Exchange Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.2. Security Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.2.1. Data Encryption and Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.2.2. Cryptographic Algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.3. Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
6.3.1. Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
6.3.2. Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
6.3.3. Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
6.4. Protocol Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
7. Platforms, Service Locations and Client Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.1. Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.1.1. Pre-operational (PREOPS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
7.1.2. Operational (OPS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.1.3. ENVPREVAL.NEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.1.4. ENVPREVAL.ADHOC and ENVPREVAL.ADHOC5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
7.1.5. Contingency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
7.2. Service Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
7.2.1. Request / Reply Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
 7.2.2. File Download Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.2.3. Message Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.3. Client Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
7.3.1. Source IP Addresses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
7.3.2. Client Connection (and Disconnection) to the NM B2B Broker . . . . . . . . . . . . . . . . . . . . . 102
8. Access to Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
8.1. Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
8.1.1. Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
8.1.2. Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
8.2. Access Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
8.2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
8.2.2. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
8.2.2.1. Resource Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
8.2.2.2. Identifying Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
8.2.3. Air Navigation Unit (ANU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.2.3.1. ANU Exposure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.2.3.2. Acting ANU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.2.4. Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
8.2.4.1. Certificate Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.2.4.2. ANU Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
8.2.5. Checking Resource Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.2.6. Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.2.6.1. Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
8.2.6.2. Binding the Exchange Model to the Resource Model. . . . . . . . . . . . . . . . . . . . . . . . . . 114
8.2.7. User Information Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
9. Quality of Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.1. Throughput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.2. Response Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
9.3. Availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
10. Service Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
10.1. Usage Control Principles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
10.2. Parallel Request Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
10.3. Time Window Request Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
10.4. Bandwidth Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
10.5. Resource Overload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
10.6. Overall View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
11. Exchange Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
11.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
11.2. Strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
11.2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
 11.2.2. Grammar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
11.2.3. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
11.2.4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.3. Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.3.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.4. Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.4.1. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
11.4.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
11.4.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
11.4.3.1. Common Services <<class>> LastUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
11.4.3.2. Airspace Services <<class>> ReferenceLocationAerodrome. . . . . . . . . . . . . . . . . . . . . 127
11.4.3.3. Flight Services <<class>> FlightOperationalLogEntry . . . . . . . . . . . . . . . . . . . . . . . . 127
11.4.4. Special remark on the mapping of Classes to XSD Types . . . . . . . . . . . . . . . . . . . . . . . . . 129
11.5. Unions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
11.5.1. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
11.5.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
11.5.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
11.5.3.1. Flight Services <<union>> FlightPlanInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
11.6. Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
11.6.1. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
11.6.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
11.7. Typedefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
11.7.1. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
11.7.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
11.7.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
11.7.3.1. Airspace Services <<typedef[string]>> AerodromeICAOId. . . . . . . . . . . . . . . . . . . . . . 134
11.8. Service Requests / Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
11.8.1. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
11.8.2. XSD Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
11.8.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
11.8.3.1. Flight Services <<request>> FlightPlanValidationRequest . . . . . . . . . . . . . . . . . . . . 135
11.8.3.2. Flight Services <<reply>> FlightPlanValidationReply . . . . . . . . . . . . . . . . . . . . . . . . 135
12. Error and Warning Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
12.1. Principles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
12.2. Attribute Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
12.3. Protocol Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
12.3.1. HTTP 400 - Bad Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
12.3.2. HTTP 404 - Not Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
12.3.3. HTTP 413 error - Request Entity Too Large . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
 13. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
III: Service Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
14. Resource Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
14.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
14.2. Resource Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
14.3. Resource Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
15. Common. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
15.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
15.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
15.3. SubscriptionManagement Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
15.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
15.3.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
15.3.2.1. Subscription States. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
15.3.2.2. Subscription Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
15.3.2.3. Subscription Synchronisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
15.3.2.4. Subscription’s last update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
15.3.2.5. Subscription Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
15.3.2.6. Message Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
15.3.2.7. Message Customisation (payload configuration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
15.3.2.8. Subscriptions and NM B2B Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
15.3.2.9. Maximum Number of Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
15.3.2.10. Subscription Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
15.3.2.11. Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
15.3.2.12. Available Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
15.3.3. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
15.3.3.1. SubscriptionPauseRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
15.3.3.2. SubscriptionResumeRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
15.3.3.3. SubscriptionDeletionRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
15.3.3.4. SubscriptionListRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
15.3.3.5. SubscriptionHistoryRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
15.3.3.6. SubscriptionSynchronisationRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . 169
15.3.3.7. SubscriptionSynchronisationAbortRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . 172
15.4. Messaging Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
15.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
15.4.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
15.4.2.1. MessagePullRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
15.5. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
15.5.1. AirNavigationUnitId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
15.5.2. ARMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
15.5.3. AsyncReply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
15.5.4. AsyncReplyInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
15.5.5. AsyncRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
15.5.6. Base64Encoded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
15.5.7. Bearing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
15.5.8. BusinessPSMessage (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
15.5.9. Colours (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
15.5.10. CorrelationId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
15.5.11. Cost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
15.5.12. Dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
15.5.13. DatasetType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
15.5.14. DateTimeMinute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
15.5.15. DateTimeMinutePeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
15.5.16. DateTimeMinutePeriodWithUFN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
15.5.17. DateTimeSecond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
15.5.18. DateYearMonthDay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
15.5.19. DateYearMonthDayPeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
15.5.20. DistanceM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
15.5.21. DistanceNM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
15.5.22. Duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
15.5.23. DurationHourMinute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
15.5.24. DurationHourMinuteSecond. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
15.5.25. DurationMinute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
15.5.26. Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
15.5.27. ErrorCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
15.5.28. ErrorType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
15.5.29. EstimateQualifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
15.5.30. ExecutionEnvironment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
15.5.31. File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
15.5.32. FileId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
15.5.33. FileType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
15.5.34. FlightLevelM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
15.5.35. HeartbeatTechnicalMessage (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
15.5.36. LastUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
15.5.37. Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
15.5.38. LatitudeSide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
15.5.39. LogicalOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
15.5.40. LongDurationHourMinute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
15.5.41. Longitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
15.5.42. LongitudeSide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
15.5.43. Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
15.5.44. MessageExchangePattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
15.5.45. MessagePullReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
15.5.46. MessagingErrorType (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
15.5.47. NMB2BProviderVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
15.5.48. NMB2BVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
15.5.49. NMPlatform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
15.5.50. NMRelease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
15.5.51. PlanDataId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
15.5.52. Position. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
15.5.53. PSMessage (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
15.5.54. PSMessageElement (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
15.5.55. PSMessageType (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
15.5.56. QueueName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
15.5.57. ReceivedOrSent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
15.5.58. Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
15.5.59. ReplyStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
15.5.60. Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
15.5.61. ServiceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
15.5.62. ShiftHourMinute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
15.5.63. Sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
15.5.64. SignedDistanceNM (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
15.5.65. SignedDurationHourMinute (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
15.5.66. SignedDurationHourMinuteSecond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
15.5.67. SignedWeightKg (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
15.5.68. SimulationId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
15.5.69. SimulationIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
15.5.70. SimulationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
15.5.71. SimulationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
15.5.72. Subscription (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
15.5.73. SubscriptionCreationRequest (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
15.5.74. SubscriptionDeletionReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
15.5.75. SubscriptionField (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
15.5.76. SubscriptionHistoryItem (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
15.5.77. SubscriptionHistoryReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
15.5.78. SubscriptionListReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
15.5.79. SubscriptionManagementErrorType (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
15.5.80. SubscriptionPauseReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
15.5.81. SubscriptionResumeReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
15.5.82. SubscriptionRetrievalRequest (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
15.5.83. SubscriptionState (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
 15.5.84. SubscriptionSummary (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
15.5.85. SubscriptionSynchronisationAbortReason (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . 221
15.5.86. SubscriptionSynchronisationAbortReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 221
15.5.87. SubscriptionSynchronisationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
15.5.88. SubscriptionSynchronisationStatus (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
15.5.89. SubscriptionSynchronisationSummary (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
15.5.90. SubscriptionSynchronisationTechnicalMessage (new 27.0). . . . . . . . . . . . . . . . . . . . . 223
15.5.91. SubscriptionTechnicalMessage (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
15.5.92. SubscriptionTopic (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
15.5.93. SubscriptionUpdateReason (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
15.5.94. SubscriptionUpdateRequest (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
15.5.95. TechnicalPSMessage (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
15.5.96. TechnicalTopic (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
15.5.97. TextReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
15.5.98. TimeHourMinute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
15.5.99. TimeHourMinutePeriod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
15.5.100. Timestamp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
15.5.101. UserId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
15.5.102. UUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
15.5.103. VersionNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
15.5.104. WeekDay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
15.5.105. WeeklySchedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
15.5.106. WeeklyScheduleItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
15.5.107. WeightKg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Appendix A: AIRM Semantic Correspondence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Appendix B: Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
15.B.1. Request / Reply Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
15.B.2. Time Window Request / Reply Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
15.B.3. P/S Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
16. General Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.2.1. AIM P/S Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.3. AIMs Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.3.2. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.3.2.1. ATM_INFORMATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
16.3.3. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
16.3.3.1. AIMListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
16.3.3.2. AIMRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
 16.4. NMB2BInfo Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
16.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
16.4.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
16.4.2.1. NMB2BReferenceManualsRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
16.4.2.2. NMB2BWSDLsRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
16.4.2.3. NMB2BScenariosRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
16.4.2.4. NMB2BAddendaErrataRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
16.4.2.5. NMReleaseInformationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
16.4.2.6. UserInformationRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
16.5. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
16.5.1. AIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
16.5.2. AimId_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
16.5.3. AIMListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
16.5.4. AIMRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
16.5.5. AIMSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
16.5.6. AIMSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
16.5.7. AIMSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
16.5.8. AIMSubscriptionUpdateReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
16.5.9. AIMSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
16.5.10. B2BInfoFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
16.5.11. NMB2BAddendaErrataReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
16.5.12. NMB2BReferenceManualsReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
16.5.13. NMB2BScenariosReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
16.5.14. NMB2BWSDLsReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
16.5.15. NMReleaseInformationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
16.5.16. UserInformationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Appendix C: AIRM Semantic Correspondence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Appendix D: Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
16.D.1. Request / Reply Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
16.D.2. Time Window Request / Reply Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
16.D.3. P/S Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
17. Airspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
17.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
17.1.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
17.1.2. AIXM / ADR Extension Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
17.1.2.1. ADR Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
17.1.2.2. Temporality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
17.1.2.3. Feature / Object Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
17.1.2.4. Feature References. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
17.1.3. AIXM and ADR Extension Coverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
 17.1.3.1. Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
17.1.3.2. Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
17.1.3.3. Choice types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
17.1.3.4. Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
17.1.3.5. Miscellania . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
17.1.4. Airblocks and Airspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
17.1.4.1. Airblocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
17.1.4.2. Airspaces Composed of Airblocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
17.1.4.3. Airspaces Composed of Other Airspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
17.1.5. FUA (Flexible Use of Airspace) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
17.1.5.1. Flexible Use Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
17.1.5.2. Air Route Classification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
17.1.5.3. RSA Activation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
17.1.6. Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
17.1.6.1. Exposed Restriction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
17.1.6.2. Dependent Applicability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
17.1.6.3. AUP/UUP Manageable Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
17.1.6.4. Restriction Enablement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
17.1.7. Operational Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
17.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.2.1. NAT Tracks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.2.2. AIRSPACE_DATA P/S Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.2.3. AUP/UUP Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.2.3.1. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.2.3.2. PREOPS Platform Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
17.3. AirspaceAvailability Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
17.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
17.3.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
17.3.2.1. AUP Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
17.3.2.2. EAUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
17.3.2.3. Draft EAUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
17.3.2.4. ASM Scenario Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
17.3.2.5. ADR Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
17.3.3. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
17.3.3.1. EAUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
17.3.4. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
17.3.4.1. AUPChainRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
17.3.4.2. AUPRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
17.3.4.3. AUPCreationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
17.3.4.4. AUPUpdateRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
 17.3.4.5. AUPValidationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
17.3.4.6. AUPDeletionRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
17.3.4.7. AUPRSAAllocationExpansionRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
17.3.4.8. AUPServiceConfigurationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
17.3.4.9. EAUPChainRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
17.3.4.10. EAUPCDRRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
17.3.4.11. EAUPCDRCompareRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
17.3.4.12. EAUPRSARequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
17.3.4.13. EAUPRSACompareRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
17.3.4.14. AUPGetManageableRoutesForAMCRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . 411
17.3.4.15. AUPGetManageableRouteSegmentsForAMCAndRouteRequest/Reply . . . . . . . . 413
17.3.4.16. DraftEAUPsRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
17.3.4.17. DraftEAUPRSARequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
17.3.4.18. DraftEAUPCDRRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
17.3.4.19. ASMScenarioListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
17.3.4.20. ASMScenarioActivationListRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
17.3.4.21. ASMScenarioActivationCreationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
17.3.4.22. ASMScenarioActivationUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
17.3.4.23. ASMScenarioActivationDeletionRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
17.3.4.24. RADRestrictionActivationListRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . 425
17.3.4.25. RADRestrictionActivationsUpdateRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . 426
17.3.4.26. EAUPRADRestrictionActivationRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . 428
17.3.4.27. EAUPRADRestrictionActivationCompareRequest/Reply (new 27.0) . . . . . . . . . . 430
17.3.4.28. DraftEAUPRADRestrictionActivationRequest/Reply (new 27.0). . . . . . . . . . . . . . 431
17.4. AirspaceStructure Port Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
17.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
17.4.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
17.4.2.1. Airspace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
17.4.2.2. AIXM Temporality Model Profile for NM B2B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
17.4.2.3. Complete / Incremental Airspace Dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
17.4.2.4. Filtered Airspace Dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
17.4.2.5. Airspace Data Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
17.4.2.6. Airspace Dataset Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
17.4.2.7. Getting Airspace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
17.4.2.8. Recommended Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
17.4.2.9. NAT Tracks Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
17.4.2.10. Airport/Heliport without ICAO/IATA Designator . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
17.4.2.11. Restrictions Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
17.4.2.12. Lead AMC Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
17.4.3. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
 17.4.3.1. AIRSPACE_DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
17.4.4. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
17.4.4.1. CompleteAIXMDatasetRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
17.4.4.2. IncrementalAIXMDatasetRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
17.4.4.3. AirspaceDataIncrementListRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
17.4.4.4. AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage . . . . . . . . . . . . . . . 516
17.4.4.5. AirspaceDataRetrievalRequest/Reply/ReplyMessage. . . . . . . . . . . . . . . . . . . . . . . . . 518
17.5. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
17.5.1. AbstractEAUPCDRRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
17.5.2. AbstractEAUPRSARequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
17.5.3. AerodromeIATAId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
17.5.4. AerodromeIATAOrICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
17.5.5. AerodromeICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
17.5.6. AerodromeICAOIdWildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
17.5.7. AerodromeOrPublishedPointId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
17.5.8. AerodromeOrPublishedPointIdType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
17.5.9. AerodromeSetId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
17.5.10. AIRACId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
17.5.11. AiracIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
17.5.12. AirspaceDataFilter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
17.5.13. AirspaceDataIncrementListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
17.5.14. AirspaceDataIncrementRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
17.5.15. AirspaceDataIncrementSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
17.5.16. AirspaceDataMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
17.5.17. AirspaceDataMessagePayload (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
17.5.18. AirspaceDataRetrievalReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
17.5.19. AirspaceDataSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
17.5.20. AirspaceDataSubscriptionCreationReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . 532
17.5.21. AirspaceDataSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 532
17.5.22. AirspaceDataSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . 532
17.5.23. AirspaceDataUpdateId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
17.5.24. AirspaceId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
17.5.25. AirspaceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
17.5.26. AirSpeed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
17.5.27. AirSpeed_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
17.5.28. AIXMDatasetType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
17.5.29. AIXMFeatureType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
17.5.30. AIXMFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
17.5.31. AIXMTemporality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
17.5.32. ASMScenarioActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
17.5.33. ASMScenarioActivationCreationReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
17.5.34. ASMScenarioActivationDeletionReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
17.5.35. ASMScenarioActivationListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
17.5.36. ASMScenarioActivationSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
17.5.37. ASMScenarioActivationUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
17.5.38. ASMScenarioListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
17.5.39. ASMScenarioStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
17.5.40. AUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
17.5.41. AUPChain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
17.5.42. AUPChainRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
17.5.43. AUPComputedEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
17.5.44. AUPCreationReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
17.5.45. AUPDeletionReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
17.5.46. AUPGetManageableRouteSegmentsForAMCAndRouteReplyData . . . . . . . . . . . . . . . . 547
17.5.47. AUPGetManageableRoutesForAMCReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
17.5.48. AUPId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
17.5.49. AUPManualEntries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
17.5.50. AUPRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
17.5.51. AUPRSAAllocationExpansionReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
17.5.52. AUPServiceConfigurationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
17.5.53. AUPState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
17.5.54. AUPSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
17.5.55. AUPType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
17.5.56. AUPUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
17.5.57. AUPValidationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
17.5.58. CompleteAIXMDatasetReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
17.5.59. CompleteDatasetQueryCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
17.5.60. CompleteDatasetSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
17.5.61. DBEOrPublishedPointId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
17.5.62. DBEPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
17.5.63. DBEPointId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
17.5.64. DraftEAUPRADRestrictionActivationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . 557
17.5.65. DraftEAUPsRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
17.5.66. DraftEAUPSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
17.5.67. EAUPCDRCompareReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
17.5.68. EAUPCDRReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
17.5.69. EAUPChain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
17.5.70. EAUPChainRetrievalReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
17.5.71. EAUPIdentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
17.5.72. EAUPPayloadConfiguration (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
17.5.73. EAUPRADRestrictionActivationCompareReplyData (new 27.0) . . . . . . . . . . . . . . . . . 562
17.5.74. EAUPRADRestrictionActivationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . 563
17.5.75. EAUPRSACompareReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
17.5.76. EAUPRSAReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
17.5.77. EAUPSubscription (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
17.5.78. EAUPSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
17.5.79. EAUPSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
17.5.80. EAUPSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
17.5.81. EAUPSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
17.5.82. ErrorCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
17.5.83. ErrorType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
17.5.84. FIRICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
17.5.85. FlightLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
17.5.86. FlightLevel_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
17.5.87. FlightLevelRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
17.5.88. FlightLevelUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
17.5.89. FlightPlanProcessing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
17.5.90. GeoPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
17.5.91. ICAOPoint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
17.5.92. IncrementalAIXMDatasetReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
17.5.93. IncrementalDatasetQueryCriteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
17.5.94. IncrementalDatasetSummary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
17.5.95. IRDesignatorFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
17.5.96. IRFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
17.5.97. IRUUIDFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
17.5.98. LoadState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
17.5.99. Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
17.5.100. NetworkAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
17.5.101. NetworkAddress_DataType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
17.5.102. NonPublishedPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
17.5.103. OceanicAreaControlCentre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
17.5.104. PublishedPointId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
17.5.105. RADRestrictionActivationListReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . 597
17.5.106. RADRestrictionActivationsUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 597
17.5.107. ReferenceLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
17.5.108. ReferenceLocationAerodrome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
17.5.109. ReferenceLocationAerodromeSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
17.5.110. ReferenceLocationAirspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
17.5.111. ReferenceLocationDBEPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
17.5.112. ReferenceLocationPublishedPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
 17.5.113. ReferenceLocationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
17.5.114. ReferencePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
17.5.115. RestrictionId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
17.5.116. RouteId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
17.5.117. RouteOrTerminalProcedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
17.5.118. RunwayId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
17.5.119. SpeedUnit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
17.5.120. TerminalProcedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
17.5.121. TerminalProcedureIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
17.5.122. TrafficVolumeId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
17.5.123. TrafficVolumeIdWildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
17.5.124. TrafficVolumeLocationInfo (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
17.5.125. TrafficVolumeSetId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
17.5.126. TrafficVolumeSetIdWildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Appendix E: AIRM Semantic Correspondence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Appendix F: Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
17.F.1. Request / Reply Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
17.F.2. Time Window Request / Reply Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
17.F.3. A-R/R Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
17.F.4. P/S Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Appendix G: AIXM Temporality Model Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
17.G.1. Need for an AIXM Temporality Model Profile in NM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
17.G.2. Differences with respect to AIXM Temporality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
17.G.3. AIXM Temporality Model Profile for NM usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
17.G.3.1. Timeslices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
17.G.3.2. PERMDELTA examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
18. FFICE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
18.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
18.1.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
18.1.2. Units of Measurement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
18.1.3. Guidelines for Provision of Approach Portion of the Flight Route (SID/STAR) . . . . . . 632
18.1.4. Error Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
18.1.5. Formats of Planned Trajectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
18.1.6. Manual Request Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
18.1.7. Flight Set Definition (for FFICE_PUBLICATION subscriptions) . . . . . . . . . . . . . . . . . . . . 634
18.1.8. Concerned Air Traffic Services (ATS) Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
18.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
18.3. FilingService Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
18.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
18.3.2. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
 18.3.2.1. FFICE_FLIGHT_FILING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
18.3.3. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
18.3.3.1. FiledFlightPlanRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
18.3.3.2. FlightPlanUpdateRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
18.3.3.3. FlightPlanCancellationRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
18.4. TrialService Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
18.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
18.4.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
18.4.2.1. TrialRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
18.5. FlightDataRequestService Port Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
18.5.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
18.5.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
18.5.2.1. FlightDataRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
18.5.2.2. SubmissionStatusRetrievalRequest/Reply (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . 652
18.6. NotificationService Port Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
18.6.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
18.6.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
18.6.2.1. FlightDepartureRequest/Reply (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
18.6.2.2. FlightArrivalRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
18.7. PublicationService Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
18.7.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
18.7.2. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
18.7.2.1. FFICE_PUBLICATION (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
18.8. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
18.8.1. AerodromeICAOIdWildcard (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
18.8.2. AircraftOperatorFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
18.8.3. FficeFlightFilingMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
18.8.4. FficeFlightFilingSubscription (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
18.8.5. FficeFlightFilingSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . 667
18.8.6. FficeFlightFilingSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . 667
18.8.7. FficeFlightFilingSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 668
18.8.8. FficePublicationMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
18.8.9. FficePublicationPayloadConfiguration (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
18.8.10. FficePublicationSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
18.8.11. FficePublicationSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . 670
18.8.12. FficePublicationSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . 670
18.8.13. FficePublicationSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . 671
18.8.14. FiledFlightPlanReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
18.8.15. FilingId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
18.8.16. FlightArrivalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
 18.8.17. FlightDataReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
18.8.18. FlightDepartureReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
18.8.19. FlightPlanCancellationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
18.8.20. FlightPlanEvent (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
18.8.21. FlightPlanEventHistoryItem (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
18.8.22. FlightPlanEventType (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
18.8.23. FlightPlanUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
18.8.24. FlightSetDefinitionElement (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
18.8.25. RevalidationInformation (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
18.8.26. RevalidationStatus (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678
18.8.27. SubmissionStatusRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
18.8.28. TrialReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Appendix H: AIRM Semantic Correspondence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Appendix I: Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
18.I.1. Request / Reply Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
18.I.2. Time Window Request / Reply Count Quotas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
18.I.3. P/S Message Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Appendix J: NM Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Appendix K: FIXM Message Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
18.K.1. Reader Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
18.K.2. FF-ICE FlightArrival Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
18.K.2.1. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
18.K.2.2. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
18.K.2.3. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
18.K.2.4. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
18.K.2.5. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
18.K.3. FF-ICE FlightCancellation Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
18.K.3.1. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
18.K.3.2. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
18.K.3.3. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
18.K.3.4. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
18.K.3.5. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
18.K.4. FF-ICE FlightDeparture Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
18.K.4.1. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
18.K.4.2. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
18.K.4.3. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
18.K.4.4. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
18.K.4.5. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
18.K.5. FF-ICE FlightDataResponse Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
18.K.5.1. AircraftOperatorType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
 18.K.5.2. AircraftTypeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
18.K.5.3. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
18.K.5.4. ContactInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
18.K.5.5. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
18.K.5.6. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
18.K.5.7. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
18.K.5.8. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
18.K.5.9. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
18.K.5.10. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
18.K.5.11. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
18.K.5.12. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
18.K.5.13. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
18.K.5.14. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
18.K.5.15. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
18.K.5.16. FlightRouteInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
18.K.5.17. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
18.K.5.18. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
18.K.5.19. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
18.K.5.20. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
18.K.5.21. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 694
18.K.5.22. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 694
18.K.5.23. PersonOrOrganizationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
18.K.5.24. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
18.K.5.25. ProfilePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
18.K.5.26. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
18.K.5.27. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
18.K.5.28. RouteChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
18.K.5.29. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
18.K.5.30. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
18.K.5.31. RouteTrajectoryGroupContainerType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
18.K.5.32. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
18.K.5.33. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
18.K.5.34. SpeedConstraintType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
18.K.5.35. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
18.K.5.36. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
18.K.5.37. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
18.K.5.38. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
18.K.5.39. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
18.K.6. FF-ICE FlightDataRequest Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
18.K.6.1. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
 18.K.6.2. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
18.K.6.3. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
18.K.6.4. NmSubmissionStatusExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
18.K.7. FF-ICE FiledFlightPlan Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
18.K.7.1. AircraftOperatorType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
18.K.7.2. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
18.K.7.3. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
18.K.7.4. ContactInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
18.K.7.5. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701
18.K.7.6. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
18.K.7.7. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
18.K.7.8. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
18.K.7.9. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
18.K.7.10. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
18.K.7.11. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
18.K.7.12. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
18.K.7.13. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
18.K.7.14. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
18.K.7.15. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
18.K.7.16. FlightRouteInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
18.K.7.17. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
18.K.7.18. GeographicalPositionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
18.K.7.19. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
18.K.7.20. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
18.K.7.21. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
18.K.7.22. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 706
18.K.7.23. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 706
18.K.7.24. PerformanceProfileType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
18.K.7.25. PersonOrOrganizationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
18.K.7.26. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
18.K.7.27. Point4DTimeChoiceType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
18.K.7.28. ProfilePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
18.K.7.29. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
18.K.7.30. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
18.K.7.31. RelativePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
18.K.7.32. RequestedInformationChoiceType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
18.K.7.33. RouteChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
18.K.7.34. RouteDesignatorToNextElementChoiceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 709
18.K.7.35. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
18.K.7.36. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
 18.K.7.37. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
18.K.7.38. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
18.K.7.39. SpeedConstraintType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
18.K.7.40. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
18.K.7.41. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
18.K.7.42. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
18.K.7.43. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
18.K.7.44. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
18.K.7.45. TrajectoryPointReferenceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
18.K.8. FF-ICE FFICE_PUBLICATION P/S Message Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
18.K.8.1. AircraftOperatorType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
18.K.8.2. AircraftTypeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
18.K.8.3. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
18.K.8.4. ContactInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
18.K.8.5. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
18.K.8.6. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
18.K.8.7. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
18.K.8.8. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
18.K.8.9. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
18.K.8.10. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
18.K.8.11. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
18.K.8.12. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
18.K.8.13. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
18.K.8.14. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
18.K.8.15. FlightRouteInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
18.K.8.16. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
18.K.8.17. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
18.K.8.18. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
18.K.8.19. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
18.K.8.20. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 718
18.K.8.21. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 718
18.K.8.22. NmSubmissionStatusExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
18.K.8.23. PersonOrOrganizationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
18.K.8.24. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
18.K.8.25. ProfilePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
18.K.8.26. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
18.K.8.27. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
18.K.8.28. RouteChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
18.K.8.29. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
18.K.8.30. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
 18.K.8.31. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
18.K.8.32. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
18.K.8.33. SpeedConstraintType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
18.K.8.34. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
18.K.8.35. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
18.K.8.36. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
18.K.8.37. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
18.K.8.38. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
18.K.9. FF-ICE FlightPlanUpdate Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
18.K.9.1. AircraftOperatorType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
18.K.9.2. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
18.K.9.3. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
18.K.9.4. ContactInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
18.K.9.5. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.6. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.7. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.8. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.9. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.10. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724
18.K.9.11. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
18.K.9.12. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
18.K.9.13. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
18.K.9.14. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
18.K.9.15. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
18.K.9.16. FlightRouteInformationType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
18.K.9.17. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
18.K.9.18. GeographicalPositionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
18.K.9.19. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 727
18.K.9.20. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
18.K.9.21. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
18.K.9.22. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . 728
18.K.9.23. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 728
18.K.9.24. PerformanceProfileType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
18.K.9.25. PersonOrOrganizationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
18.K.9.26. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
18.K.9.27. Point4DTimeChoiceType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
18.K.9.28. ProfilePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
18.K.9.29. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
18.K.9.30. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
18.K.9.31. RelativePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
 18.K.9.32. RequestedInformationChoiceType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
18.K.9.33. RouteChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
18.K.9.34. RouteDesignatorToNextElementChoiceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 731
18.K.9.35. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
18.K.9.36. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
18.K.9.37. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
18.K.9.38. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
18.K.9.39. SpeedConstraintType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
18.K.9.40. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
18.K.9.41. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
18.K.9.42. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
18.K.9.43. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
18.K.9.44. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
18.K.9.45. TrajectoryPointReferenceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
18.K.10. FF-ICE FilingStatus Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
18.K.10.1. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
18.K.10.2. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
18.K.10.3. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
18.K.10.4. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
18.K.10.5. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
18.K.10.6. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
18.K.10.7. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
18.K.10.8. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
18.K.10.9. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
18.K.10.10. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
18.K.10.11. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
18.K.10.12. FlightType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
18.K.10.13. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
18.K.10.14. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
18.K.10.15. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
18.K.10.16. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 738
18.K.10.17. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . 739
18.K.10.18. NmRouteTrajectoryGroupContainerExtensionType Rules . . . . . . . . . . . . . . . . . 739
18.K.10.19. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
18.K.10.20. ProfilePointType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
18.K.10.21. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
18.K.10.22. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
18.K.10.23. RouteChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
18.K.10.24. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
18.K.10.25. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 740
 18.K.10.26. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
18.K.10.27. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
18.K.10.28. SpeedConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.K.10.29. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.K.10.30. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.K.10.31. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.K.10.32. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.K.10.33. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
18.K.11. FF-ICE SubmissionResponse Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
18.K.11.1. AircraftTypeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
18.K.11.2. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
18.K.11.3. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
18.K.11.4. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
18.K.11.5. NmSubmissionStatusExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
18.K.11.6. SubmissionStatusType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 744
18.K.12. FF-ICE TrialResponse Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
18.K.12.1. CruiseClimbStartType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
18.K.12.2. CruisingLevelChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
18.K.12.3. CruisingSpeedChangeType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
18.K.12.4. DangerousGoodsDimensionsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
18.K.12.5. DangerousGoodsPackageGroupType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
18.K.12.6. DangerousGoodsPackageType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
18.K.12.7. DangerousGoodsType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
18.K.12.8. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
18.K.12.9. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
18.K.12.10. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
18.K.12.11. FlightType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
18.K.12.12. LevelConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
18.K.12.13. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
18.K.12.14. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 748
18.K.12.15. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . 748
18.K.12.16. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
18.K.12.17. PlanningStatusType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
18.K.12.18. ProfilePointType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
18.K.12.19. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
18.K.12.20. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
18.K.12.21. RouteChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
18.K.12.22. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
18.K.12.23. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
18.K.12.24. RouteTrajectoryGroupContainerType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
 18.K.12.25. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
18.K.12.26. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
18.K.12.27. SpeedConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
18.K.12.28. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
18.K.12.29. SupplementaryInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
18.K.12.30. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
18.K.12.31. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
18.K.12.32. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
18.K.13. FF-ICE TrialRequest Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
18.K.13.1. ArrivalType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
18.K.13.2. AtmServiceProviderType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
18.K.13.3. DepartureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 752
18.K.13.4. FficeMessageType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
18.K.13.5. FlightEmergencyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
18.K.13.6. FlightIdentificationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
18.K.13.7. FlightType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
18.K.13.8. GeographicalPositionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
18.K.13.9. MeteorologicalDataType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
18.K.13.10. NmFficeMessageExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
18.K.13.11. NmFlightExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
18.K.13.12. NmFlightRouteInformationExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . . 755
18.K.13.13. NmRouteTrajectoryElementExtensionType Rules . . . . . . . . . . . . . . . . . . . . . . . . 755
18.K.13.14. PerformanceProfileType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
18.K.13.15. PlannedDelayType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
18.K.13.16. Point4DTimeChoiceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
18.K.13.17. ProfilePointType Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
18.K.13.18. RadioCommunicationFailureType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
18.K.13.19. RadioactiveMaterialType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756
18.K.13.20. RelativePointType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
18.K.13.21. RouteChangeType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
18.K.13.22. RouteDesignatorToNextElementChoiceType Rules. . . . . . . . . . . . . . . . . . . . . . . . 757
18.K.13.23. RouteTrajectoryConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757
18.K.13.24. RouteTrajectoryElementType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
18.K.13.25. RouteTrajectoryGroupType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
18.K.13.26. ShippingInformationType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
18.K.13.27. SpeedConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
18.K.13.28. SpeedScheduleType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
18.K.13.29. TimeConstraintType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
18.K.13.30. TrajectoryPoint4DType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
18.K.13.31. TrajectoryPointPropertyType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
 18.K.13.32. TrajectoryPointReferenceType Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
19. Flight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
19.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
19.1.1. Flight Set Definition (for FLIGHT_DATA and FLIGHT_PLANS and
FFICE_PUBLICATION subscriptions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
19.1.2. Concerned Air Traffic Services (ATS) Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
19.1.3. Flight Plan and Flight Data Distribution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
19.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
19.3. FlightPreparation Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
19.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
19.3.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
19.3.2.1. FlightPlanValidationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
19.3.2.2. RoutingAssistanceRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
19.3.2.3. EvaluateFlowImpactRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
19.3.2.4. ReroutingApplyRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
19.4. FlightFiling Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
19.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
19.4.2. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
19.4.2.1. FLIGHT_FILING_RESULT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
19.4.3. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
19.4.3.1. FlightPlanCreationRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
19.4.3.2. FlightPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
19.4.3.3. FlightPlanCancellationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
19.4.3.4. FlightDelayRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
19.4.3.5. FlightDepartureRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
19.4.3.6. FlightArrivalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
19.4.3.7. FilingStatusRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
19.5. FlightManagement Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
19.5.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
19.5.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
19.5.2.1. Forecast and Operational Datasets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
19.5.2.2. Simulation Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
19.5.2.3. Proposal Flights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
19.5.2.4. Flight Visibility (a.k.a. Invisible Flights) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
19.5.2.5. DPI - Departure Planning Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
19.5.2.6. API - Arrival Planning Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
19.5.3. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 814
19.5.3.1. FLIGHT_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
19.5.3.2. FLIGHT_DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
19.5.4. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
 19.5.4.1. FlightPlanListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
19.5.4.2. FlightListByKeysRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
19.5.4.3. FlightListByAircraftOperatorRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
19.5.4.4. FlightListByAerodromeRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
19.5.4.5. FlightListByAerodromeSetRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
19.5.4.6. FlightListByAirspaceRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
19.5.4.7. FlightListByPointRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
19.5.4.8. FlightListByTrafficVolumeRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
19.5.4.9. FlightListByMeasureRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
19.5.4.10. FlightListByHotspotRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
19.5.4.11. FlightListByAircraftRegistrationMarkRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . 866
19.5.4.12. FlightRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 869
19.5.4.13. EarlyDPIRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875
19.5.4.14. TargetDPITargetRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
19.5.4.15. TargetDPISequencedRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
19.5.4.16. ATCDPIRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
19.5.4.17. CancelDPIRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
19.5.4.18. PredictedDPIRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
19.5.4.19. FlightUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
19.5.4.20. ACDMAlertRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 889
19.5.4.21. GeneralAPIRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
19.5.4.22. TargetTakeOffAPIRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
19.5.4.23. TargetTimeOverAPIRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
19.5.4.24. FlightConfirmationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
19.5.4.25. SlotMissedRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
19.5.4.26. ReadyToDepartRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
19.5.4.27. SlotImprovementModeRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
19.5.4.28. ReroutingProposalRejectedRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
19.5.4.29. SlotProposalFeedbackRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
19.5.4.30. FlightCriticalityRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
19.5.4.31. ReroutingFeedbackRequest/Reply (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
19.6. FlightSafety Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
19.6.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
19.6.2. Requests/Replies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
19.6.2.1. ACC3AccreditationListReplacementRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . 915
19.6.2.2. TCOAuthorisationListReplacementRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
19.6.2.3. TCOAuthorisationListUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
19.7. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
19.7.1. ACC3Accreditation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
19.7.2. ACC3AccreditationId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
19.7.3. ACC3AccreditationListReplacementReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
19.7.4. ACDMAlertCode (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
19.7.5. ACDMAlertData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
19.7.6. ACDMAlertReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
19.7.7. ACDMAlertSeverity (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
19.7.8. ActualTimeAtTarget. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
19.7.9. Aerodrome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
19.7.10. AerodromeDAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
19.7.11. AerodromeName_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
19.7.12. AerodromeNameLocationDescription_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
19.7.13. AerodromeRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
19.7.14. AerodromesOfDestination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
19.7.15. AirborneFilingReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
19.7.16. AircraftIATAId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
19.7.17. AircraftIATAIdFromDataSource (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
19.7.18. AircraftICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
19.7.19. AircraftIdDataSource (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
19.7.20. AircraftIdentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
19.7.21. AircraftIdentificationUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
19.7.22. AircraftOperatorFilter (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
19.7.23. AircraftOperatorIATAOrICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
19.7.24. AircraftOperatorICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
19.7.25. AircraftOperatorName_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
19.7.26. AircraftPerformanceCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
19.7.27. AircraftPositionReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
19.7.28. AircraftRegistrationMark. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
19.7.29. AircraftType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
19.7.30. AircraftTypeIATAId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
19.7.31. AircraftTypeICAOId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
19.7.32. AirFiledData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
19.7.33. AirportSlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
19.7.34. AllowedIFPSErrorViolations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
19.7.35. AlternateAerodrome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
19.7.36. AlternateAerodrome_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
19.7.37. AlternativeRouteInfo (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
19.7.38. APISubmissionRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
19.7.39. ArrivalInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
19.7.40. ArrivalPlanningInformationRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
19.7.41. ATCDPIReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
19.7.42. ATFMError (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
19.7.43. ATFMMessageType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
19.7.44. ATSMessageType (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
19.7.45. AtsUnitId_DataType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
19.7.46. ATVFlightStatusInbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
19.7.47. ATVFlightStatusOutbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
19.7.48. BasicTrajectoryData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
19.7.49. CancelDPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
19.7.50. CDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
19.7.51. CDMInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
19.7.52. CDMStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
19.7.53. CfmuFlightType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
19.7.54. CTOTLimitReason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
19.7.55. DatalinkCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
19.7.56. DataLinkCapabilities_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
19.7.57. DelayCharacteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
19.7.58. DeltaEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
19.7.59. DepartureAirportType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
19.7.60. DepartureData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
19.7.61. DepartureInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
19.7.62. DeparturePlanningInformationRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
19.7.63. DepartureStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
19.7.64. DepartureTolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
19.7.65. Dinghies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
19.7.66. DistanceAtLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
19.7.67. EarlyDPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
19.7.68. EnrouteDelay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
19.7.69. EnRouteInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
19.7.70. EntryExit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
19.7.71. EquipmentCapabilityAndStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
19.7.72. EquipmentStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
19.7.73. ErrorCategory (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
19.7.74. EstimatedElapsedTimeAtLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
19.7.75. EURSTSIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
19.7.76. EvaluateFlowImpactReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
19.7.77. ExclusionFromRegulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
19.7.78. ExtendedAircraftICAOId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
19.7.79. FAMStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
19.7.80. FilingId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
19.7.81. FilingReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
19.7.82. FilingRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
19.7.83. FilingResultQueued . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
19.7.84. FilingResultRejected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
19.7.85. FilingResultValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
19.7.86. FilingRule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
19.7.87. FilingStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
19.7.88. FilingStatusFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
19.7.89. FilingStatusReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
19.7.90. Flight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
19.7.91. FlightAirspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
19.7.92. FlightArrivalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
19.7.93. FlightConfirmationReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
19.7.94. FlightCriticalityIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
19.7.95. FlightCriticalityKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1003
19.7.96. FlightCriticalityReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
19.7.97. FlightDataMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
19.7.98. FlightDataPayloadConfiguration (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
19.7.99. FlightDataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
19.7.100. FlightDataSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
19.7.101. FlightDataSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . 1007
19.7.102. FlightDataSubscriptionRetrievalReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . 1007
19.7.103. FlightDataSubscriptionUpdateReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . 1008
19.7.104. FlightDataVersionNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
19.7.105. FlightDelayReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
19.7.106. FlightDepartureReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
19.7.107. FlightEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
19.7.108. FlightEventType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
19.7.109. FlightField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
19.7.110. FlightFilingResultMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
19.7.111. FlightFilingResultSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
19.7.112. FlightFilingResultSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . 1028
19.7.113. FlightFilingResultSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . 1029
19.7.114. FlightFilingResultSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . 1029
19.7.115. FlightIdentificationInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
19.7.116. FlightIdentificationOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
19.7.117. FlightInformationUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
19.7.118. FlightInformationUpdateRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
19.7.119. FlightKeys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
19.7.120. FlightListByAerodromeReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.121. FlightListByAerodromeSetReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.122. FlightListByAircraftOperatorReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.123. FlightListByAircraftRegistrationMarkReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.124. FlightListByAirspaceReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.125. FlightListByHotspotReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
19.7.126. FlightListByKeysReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
19.7.127. FlightListByLocationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
19.7.128. FlightListByLocationRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
19.7.129. FlightListByMeasureMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
19.7.130. FlightListByMeasureReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
19.7.131. FlightListByPointReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
19.7.132. FlightListByTrafficVolumeReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
19.7.133. FlightListReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
19.7.134. FlightListRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
19.7.135. FlightOperationalLogEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1046
19.7.136. FlightOperationalLogEntryType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1047
19.7.137. FlightOrFlightPlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
19.7.138. FlightPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
19.7.139. FlightPlanCancellationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
19.7.140. FlightPlanCreationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
19.7.141. FlightPlanEvent (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
19.7.142. FlightPlanEventHistoryItem (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
19.7.143. FlightPlanEventType (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
19.7.144. FlightPlanHistory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
19.7.145. FlightPlanHistoryInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
19.7.146. FlightPlanInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
19.7.147. FlightPlanListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
19.7.148. FlightPlanMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
19.7.149. FlightPlanMessageStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062
19.7.150. FlightPlanMessageType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062
19.7.151. FlightPlanOriginator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064
19.7.152. FlightPlanOrInvalidFiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064
19.7.153. FlightPlanPayloadConfiguration (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
19.7.154. FlightPlanStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
19.7.155. FlightPlanSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066
19.7.156. FlightPlanSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . 1067
19.7.157. FlightPlanSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . 1067
19.7.158. FlightPlanSubscriptionUpdateReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . 1067
19.7.159. FlightPlanSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067
19.7.160. FlightPlanUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068
19.7.161. FlightPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
19.7.162. FlightPlanValidationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
19.7.163. FlightPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
19.7.164. FlightRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
19.7.165. FlightRetrievalReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
19.7.166. FlightRules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
19.7.167. FlightSetDefinitionElement (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
19.7.168. FlightState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076
19.7.169. FlightTrafficVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
19.7.170. FlightTrend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
19.7.171. FlightType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
19.7.172. FlightUpdateChoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080
19.7.173. FlightUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080
19.7.174. FlightVisibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
19.7.175. FourDFlightPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082
19.7.176. FourDPosition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
19.7.177. FreezePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
19.7.178. FrequencyOnAircraft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
19.7.179. GeneralAPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
19.7.180. IATAFlightKeys (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
19.7.181. ICAOAircraftAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1084
19.7.182. ICAOSTSIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1085
19.7.183. IFPIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086
19.7.184. IFPLId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1087
19.7.185. IFPSError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
19.7.186. ImpactSeverityIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1088
19.7.187. IntervalPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
19.7.188. IntruderKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
19.7.189. InvalidFiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
19.7.190. LandingInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1090
19.7.191. Latitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
19.7.192. LifeJacketEquipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
19.7.193. LoadStateAtReferenceLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
19.7.194. Longitude. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
19.7.195. ManualProcessingFilingStatus (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
19.7.196. MessageOriginator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
19.7.197. ModeSCapabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
19.7.198. NumberOfDinghies_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
19.7.199. OceanicInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
19.7.200. OtherAerodromeDesignation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095
19.7.201. OtherAircraftTypeDesignation_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
19.7.202. OtherInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
19.7.203. PerformanceBasedNavigationCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
19.7.204. PointDAL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
19.7.205. Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
19.7.206. PredictedDPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
19.7.207. ProfileValidity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
19.7.208. ProfileValidityKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
19.7.209. ProposalInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
19.7.210. ProposalKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104
19.7.211. PSFlightField (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
19.7.212. ReadyStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110
19.7.213. ReadyToDepartReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110
19.7.214. ReasonForDPICancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110
19.7.215. ReclearanceInFlight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1112
19.7.216. Relative4DPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1112
19.7.217. RequestedFlightLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
19.7.218. ReroutableStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
19.7.219. ReroutingApplyReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1114
19.7.220. ReroutingApplyReplyDataResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1114
19.7.221. ReroutingFeedback (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
19.7.222. ReroutingFeedbackAction (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
19.7.223. ReroutingFeedbackKind (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116
19.7.224. ReroutingFeedbackReason (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116
19.7.225. ReroutingFeedbackReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
19.7.226. ReroutingIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
19.7.227. ReroutingOpportunities (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1118
19.7.228. ReroutingProposalRejectedReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119
19.7.229. ReroutingProposalStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119
19.7.230. ReroutingReason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
19.7.231. ReroutingRouteId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
19.7.232. ReroutingRouteType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1122
19.7.233. ReroutingState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123
19.7.234. RevalidationInformation (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123
19.7.235. RevalidationStatus (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1124
19.7.236. RevisionTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1124
19.7.237. RouteInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
19.7.238. RoutingAssistanceApplyKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
19.7.239. RoutingAssistanceReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1127
19.7.240. RoutingAssistanceReplyDataResult. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
19.7.241. SelectiveCallingCode (altered 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
19.7.242. SlotImprovementModeReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
19.7.243. SlotImprovementStrategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
19.7.244. SlotMissedReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
19.7.245. SlotProposalFeedbackReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
19.7.246. SlotSwapCandidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
19.7.247. SlotSwapCounter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
19.7.248. SlotZone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
19.7.249. SpecialHandlingIndicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
19.7.250. SSRCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
19.7.251. SSRInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
19.7.252. SSRMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
19.7.253. StandardRouteId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
19.7.254. StayInformation_DataType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
19.7.255. StructuredFlightPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
19.7.256. StructuredFlightPlanData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
19.7.257. StructuredFlightPlanUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
19.7.258. SupplementaryInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
19.7.259. SurveillanceEquipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
19.7.260. SurvivalEquipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
19.7.261. SuspensionStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1139
19.7.262. TargetAPIRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
19.7.263. TargetAPIUseCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
19.7.264. TargetDPIRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
19.7.265. TargetDPISequencedReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
19.7.266. TargetDPITargetReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
19.7.267. TargetTakeOffAPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
19.7.268. TargetTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
19.7.269. TargetTimeOverAPIReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
19.7.270. TaxiTimeAndProcedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
19.7.271. TaxiTimeSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
19.7.272. TCOAuthorisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1145
19.7.273. TCOAuthorisationId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
19.7.274. TCOAuthorisationListReplacementReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
19.7.275. TCOAuthorisationListUpdateReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
19.7.276. TCOAuthorisationUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
19.7.277. TCOAuthorisationUpdateType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
19.7.278. TerminalOrApronStandName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
19.7.279. TimeAndModel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
19.7.280. TotalCapacity_DataType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
19.7.281. TrafficType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
19.7.282. TrafficVolumeSelection (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
 19.7.283. TurnFlightForLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
19.7.284. TurnFlightForLocationKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
19.7.285. UpdateDPIRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
19.7.286. WakeTurbulenceCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
19.7.287. YoYoFlightForLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
19.7.288. YoYoFlightForLocationKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
Appendix L: AIRM Semantic Correspondence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1158
Appendix M: Default Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
19.M.1. Request / Reply Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
19.M.2. Time Window Request / Reply Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
19.M.3. P/S Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
20. Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.1. Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.2. PREOPS Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.2.1. REGULATION P/S Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.3. TrafficCounts Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.3.2. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.3.2.1. TrafficCountsByAircraftOperatorRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
20.3.2.2. TrafficCountsByAerodromeRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
20.3.2.3. TrafficCountsByAerodromeSetRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212
20.3.2.4. TrafficCountsByAirspaceRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1215
20.3.2.5. TrafficCountsByPointRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217
20.3.2.6. TrafficCountsByTrafficVolumeRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
20.3.2.7. TrafficCountsByMeasureRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
20.4. Measures Port Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
20.4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
20.4.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
20.4.2.1. Update Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229
20.4.2.2. Transaction and Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
20.4.2.3. Allowed Times for Retrievals and Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
20.4.2.4. Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
20.4.2.5. Overload Protection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
20.4.3. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
20.4.3.1. REGULATIONS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
20.4.3.2. REROUTINGS (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1239
20.4.4. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
20.4.4.1. RegulationListRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
20.4.4.2. RegulationCreationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
20.4.4.3. RegulationUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
 20.4.4.4. RegulationCancelRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
20.4.4.5. RegulationProposalListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
20.4.4.6. RegulationProposalFilingRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
20.4.4.7. RegulationProposalUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
20.4.4.8. RegulationProposalRevocationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1274
20.4.4.9. ReroutingListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1278
20.4.4.10. ReroutingCreationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
20.4.4.11. ReroutingUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
20.4.4.12. ReroutingCancelRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1288
20.4.4.13. MeasureOpLogRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1291
20.4.4.14. UpdateFlightsInMeasureRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1294
20.4.4.15. SimulationMeasureRevertRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
20.4.4.16. ATFCMSituationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301
20.4.4.17. NetworkImpactAssessmentRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . 1303
20.5. Mcdm Port Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
20.5.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
20.5.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
20.5.2.1. MCDM Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1308
20.5.2.2. Update Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
20.5.3. Publish/Subscribe Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
20.5.3.1. MCDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
20.5.4. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
20.5.4.1. MCDMTopicListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1316
20.5.4.2. MCDMTopicUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
20.5.4.3. MCDMStateUpdateRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
20.5.4.4. EhelpDeskTicketCreationRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1323
20.5.4.5. EhelpDeskTicketUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1330
20.5.4.6. EhelpDeskTicketRevocationRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1335
20.6. TacticalUpdates Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
20.6.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
20.6.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
20.6.2.1. CACD Retrievals vs. Tactical Situation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
20.6.2.2. Daily Plan Update Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1338
20.6.2.3. Transactions and Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1341
20.6.2.4. Allowed Times for Retrievals and Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1342
20.6.3. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
20.6.3.1. SectorConfigurationPlanRetrievalRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . 1343
20.6.3.2. SectorConfigurationPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1345
20.6.3.3. CapacityPlanRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1347
20.6.3.4. CapacityPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1349
 20.6.3.5. TrafficVolumeActivationPlanRetrievalRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . 1351
20.6.3.6. TrafficVolumeActivationPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . 1352
20.6.3.7. OTMVPlanRetrievalRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1354
20.6.3.8. OTMVPlanUpdateRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356
20.6.3.9. RunwayConfigurationPlanRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . 1358
20.6.3.10. RunwayConfigurationPlanUpdateRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . 1360
20.6.3.11. HotspotListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
20.6.3.12. HotspotPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1365
20.6.3.13. RestrictionActivationPlanRetrievalRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . 1367
20.6.3.14. RestrictionActivationPlanUpdateRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . 1368
20.7. Simulations Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
20.7.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
20.7.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
20.7.2.1. Simulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
20.7.3. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
20.7.3.1. SimulationListRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1373
20.7.3.2. SimulationAvailabilityRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1375
20.7.3.3. SimulationStartRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377
20.7.3.4. SimulationStopRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378
20.7.3.5. SimulationResetRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1380
20.8. ScenarioRepository Port Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
20.8.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
20.8.2. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
20.8.2.1. Scenario Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1382
20.8.3. Requests/Replies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
20.8.3.1. ScenarioRegulationRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384
20.8.3.2. ScenarioReroutingRetrievalRequest/Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1385
20.8.3.3. ScenarioListRequest/Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1387
20.9. Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
20.9.1. AerodromeLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389
20.9.2. AirspaceLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
20.9.3. AllFlightsLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
20.9.4. AoLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
20.9.5. ATFCMSituationCounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
20.9.6. ATFCMSituationDelays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1391
20.9.7. ATFCMSituationRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392
20.9.8. ATFCMSituationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1393
20.9.9. AvoidAirspaceReroutingKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
20.9.10. AvoidViaAirspaceReroutingConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394
20.9.11. AvoidViaPointReroutingConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1395
20.9.12. AvoidViaReroutingType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
20.9.13. Capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
20.9.14. CapacityPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
20.9.15. CapacityPlans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
20.9.16. CapacityPlanUpdateReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1397
20.9.17. CherryPickedLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
20.9.18. ConcernedRegulationTimeOver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
20.9.19. Counts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
20.9.20. CountsCalculationType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
20.9.21. CountsCalculationTypeAndInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
20.9.22. CountsInterval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1401
20.9.23. CountSubTotalComputeMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1402
20.9.24. CountsValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
20.9.25. DatasetReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
20.9.26. DatasetReferenceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404
20.9.27. DelayLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404
20.9.28. DeltaATFCMSituation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404
20.9.29. DeltaATFCMSituationCounts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405
20.9.30. DeltaATFCMSituationDelays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1406
20.9.31. DeltaATFCMSituationRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1407
20.9.32. DeltaCounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1407
20.9.33. DeltaLevelReroutingConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
20.9.34. EhelpDeskAddFlightInFmpStamRerouting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
20.9.35. EhelpDeskAddFlightsInFmpStamRerouting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
20.9.36. EhelpDeskExcludeReIncludeFlightInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
20.9.37. EhelpDeskExtendSlotInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
20.9.38. EhelpDeskExtendSlotInRegulationType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1410
20.9.39. EhelpDeskFlightId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411
20.9.40. EhelpDeskForceFlightInRegulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1411
20.9.41. EhelpDeskForceFlightsInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
20.9.42. EhelpDeskImproveSlotInRegulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1412
20.9.43. EhelpDeskImproveSlotInRegulationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1413
20.9.44. EhelpDeskInformationTicket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
20.9.45. EhelpDeskInformationTicketType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
20.9.46. EhelpDeskOtherTicket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
20.9.47. EhelpDeskOtherTicketType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416
20.9.48. EhelpDeskRemoveFlightsFromFmpStamRerouting . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
20.9.49. EhelpDeskRuleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
20.9.50. EhelpDeskSwapSlotsInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
20.9.51. EhelpDeskSwapSlotsInRegulationType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
20.9.52. EhelpDeskTicket. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
20.9.53. EhelpDeskTicketChoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1421
20.9.54. EhelpDeskTicketCreationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423
20.9.55. EhelpDeskTicketFlightInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
20.9.56. EhelpDeskTicketRequestDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1424
20.9.57. EhelpDeskTicketResponseDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1425
20.9.58. EhelpDeskTicketRevocationReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
20.9.59. EhelpDeskTicketUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
20.9.60. EhelpDeskUnforceFlightInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
20.9.61. EhelpDeskUnforceFlightsInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
20.9.62. ExcludeReIncludeFlightInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
20.9.63. FlightAtfcmMcdmOnlyLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
20.9.64. FlightAtfcmMeasureLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
20.9.65. FlightAtfcmRegulationLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
20.9.66. FlightAtfcmReroutingLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429
20.9.67. FlightHotspotLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
20.9.68. FlightMCDMInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
20.9.69. FlightRegulationLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
20.9.70. Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
20.9.71. FlowId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1433
20.9.72. FlowRoleSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1433
20.9.73. FlowType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1434
20.9.74. ForceFlightInRegulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435
20.9.75. FreezeTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1436
20.9.76. GroupReroutingIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1437
20.9.77. GroupReroutingSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1437
20.9.78. HorizontalReroutingSourcesAndConstraints (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 1438
20.9.79. Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
20.9.80. HotspotId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
20.9.81. HotspotKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
20.9.82. HotspotListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
20.9.83. HotspotPlans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
20.9.84. HotspotPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
20.9.85. HotspotSeverity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
20.9.86. HotspotStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1445
20.9.87. KindOfRestriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
20.9.88. LevelAndSpeedReroutingConstraint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
20.9.89. LevelConstraintKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
20.9.90. LifeCycleEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
20.9.91. LifeCycleEventType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
20.9.92. Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
20.9.93. MCDMApprovalState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
20.9.94. MCDMCoordinationLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
20.9.95. MCDMDeadlines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
20.9.96. MCDMFlightTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1450
20.9.97. MCDMMeasureTopic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452
20.9.98. MCDMMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
20.9.99. MCDMMessagePayload (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1455
20.9.100. MCDMPayloadConfiguration (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1456
20.9.101. MCDMRole. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1456
20.9.102. MCDMRoleUserCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1457
20.9.103. MCDMState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1458
20.9.104. MCDMStatefulTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1461
20.9.105. MCDMStateUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
20.9.106. MCDMSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
20.9.107. MCDMSubscriptionCreationReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
20.9.108. MCDMSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
20.9.109. MCDMSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1465
20.9.110. MCDMTopic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1465
20.9.111. MCDMTopicField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1467
20.9.112. MCDMTopicId. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
20.9.113. MCDMTopicListReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
20.9.114. MCDMTopicListRequestSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1469
20.9.115. MCDMTopicUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1469
20.9.116. MCDMUserAndRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1469
20.9.117. MCDMUserCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
20.9.118. MCDMUserRoleAndApprovalState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1472
20.9.119. Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1472
20.9.120. MeasureFromScenarioRepository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
20.9.121. MeasureId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
20.9.122. MeasureIdAndTV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
20.9.123. MeasureListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
20.9.124. MeasureListRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1479
20.9.125. MeasureOpLogRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
20.9.126. MeasureSubType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
20.9.127. NetworkImpactAssessmentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1484
20.9.128. NetworkImpactAssessmentFlightChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
20.9.129. NetworkImpactAssessmentKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486
20.9.130. NetworkImpactAssessmentPayload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486
20.9.131. NetworkImpactAssessmentRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486
20.9.132. NetworkImpactFlightData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1487
20.9.133. NetworkImpactFlightRegulationChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1488
20.9.134. NMOCManagedSimulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1489
20.9.135. OtherReroutingConstraint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1490
20.9.136. OTMV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1490
20.9.137. OtmvAlert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
20.9.138. OTMVPeak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1491
20.9.139. OTMVPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1492
20.9.140. OTMVPlanForDuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1493
20.9.141. OTMVPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1494
20.9.142. OTMVPlans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1494
20.9.143. OTMVPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496
20.9.144. OtmvStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1496
20.9.145. OTMVSustained . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
20.9.146. OTMVThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
20.9.147. OTMVThresholds (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497
20.9.148. OTMVWithDuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
20.9.149. PlanDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
20.9.150. PlannedCapacities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
20.9.151. PlannedCapacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1500
20.9.152. PlannedOTMV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1501
20.9.153. PlannedRestrictionActivation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502
20.9.154. PlannedRestrictionActivations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1504
20.9.155. PlannedRunwayConfigurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
20.9.156. PlannedSectorConfigurationActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
20.9.157. PlannedTrafficVolumeActivation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
20.9.158. PlannedTrafficVolumeActivations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508
20.9.159. PointLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1509
20.9.160. ReferenceRequestedFlightLevel (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1509
20.9.161. Regulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1509
20.9.162. RegulationCancelReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1510
20.9.163. RegulationCause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1511
20.9.164. RegulationCreationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1511
20.9.165. RegulationExceptionalConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1511
20.9.166. RegulationField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1513
20.9.167. RegulationId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1515
20.9.168. RegulationIdWildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1515
20.9.169. RegulationInitialConstraint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
20.9.170. RegulationListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
20.9.171. RegulationLocationCategory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
20.9.172. RegulationMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518
20.9.173. RegulationOccupancyConstraint (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518
20.9.174. RegulationOrMCDMOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1519
20.9.175. RegulationOrMCDMOnlyListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1528
20.9.176. RegulationOrMCDMOnlyListRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1528
20.9.177. RegulationPayloadConfiguration (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1529
20.9.178. RegulationProposal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530
20.9.179. RegulationProposalAction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1533
20.9.180. RegulationProposalField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1534
20.9.181. RegulationProposalFilingReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1536
20.9.182. RegulationProposalKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
20.9.183. RegulationProposalListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
20.9.184. RegulationProposalRevocationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
20.9.185. RegulationProposalUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1538
20.9.186. RegulationReason . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1538
20.9.187. RegulationState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1540
20.9.188. RegulationSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1540
20.9.189. RegulationSubscriptionCreationReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . 1541
20.9.190. RegulationSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . 1541
20.9.191. RegulationSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . 1542
20.9.192. RegulationSupplementaryConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1542
20.9.193. RegulationUpdateReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1542
20.9.194. Rerouting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1543
20.9.195. ReroutingApplyKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
20.9.196. ReroutingCancelReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1546
20.9.197. ReroutingConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1546
20.9.198. ReroutingConstraintSet (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
20.9.199. ReroutingCreationReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
20.9.200. ReroutingField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1547
20.9.201. ReroutingId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1549
20.9.202. ReroutingIdWildcard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1549
20.9.203. ReroutingLengthLimit (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1549
20.9.204. ReroutingListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
20.9.205. ReroutingManualConstraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
20.9.206. ReroutingMeasureState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1551
20.9.207. ReroutingMessageFilter (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
20.9.208. ReroutingPayloadConfiguration (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
20.9.209. ReroutingPurpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
20.9.210. ReroutingSourcesAndConstraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1553
20.9.211. ReroutingSubscription (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1554
20.9.212. ReroutingSubscriptionCreationReplyData (new 27.0). . . . . . . . . . . . . . . . . . . . . . . . 1555
20.9.213. ReroutingSubscriptionRetrievalReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . 1555
20.9.214. ReroutingSubscriptionUpdateReplyData (new 27.0) . . . . . . . . . . . . . . . . . . . . . . . . . 1556
20.9.215. ReroutingUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
20.9.216. RestrictionActivationPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
20.9.217. RestrictionActivationPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
20.9.218. RestrictionActivationPlans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1558
20.9.219. RestrictionActivationPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
20.9.220. RestrictionLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1560
20.9.221. RunwayConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1560
20.9.222. RunwayConfigurationPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
20.9.223. RunwayConfigurationPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1563
20.9.224. RunwayConfigurationPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1564
20.9.225. RunwayUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1564
20.9.226. ScenarioAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1565
20.9.227. ScenarioEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1568
20.9.228. ScenarioId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1568
20.9.229. ScenarioImpact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1568
20.9.230. ScenarioLevelConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569
20.9.231. ScenarioListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1570
20.9.232. ScenarioMeasureRetrievalRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1570
20.9.233. ScenarioName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1571
20.9.234. ScenarioPublicationStatus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1571
20.9.235. ScenarioRegulationRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1571
20.9.236. ScenarioReroutingRetrievalReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1572
20.9.237. ScenarioTrafficVolumeMatchingKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1572
20.9.238. ScenarioType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1573
20.9.239. SectorConfigurationId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
20.9.240. SectorConfigurationPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1574
20.9.241. SectorConfigurationPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
20.9.242. SectorConfigurationPlanUpdateReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
20.9.243. SegmentLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
20.9.244. SetOfAerodromesLocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
20.9.245. SignificantDeltaCount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1577
20.9.246. SignificantDeltaDuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1577
20.9.247. Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1578
20.9.248. SimulationAvailability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1579
20.9.249. SimulationAvailabilityReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
20.9.250. SimulationListReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
20.9.251. SimulationMeasureRevertReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
 20.9.252. SimulationName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
20.9.253. SimulationResetReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
20.9.254. SimulationStartReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
20.9.255. SimulationStopReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
20.9.256. StandaloneSimex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
20.9.257. SubTotalsRegulationDetailedType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1581
20.9.258. SubTotalsTrafficCountsType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1583
20.9.259. TacticalConfigurationPlan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1584
20.9.260. TacticalConfigurationRetrievalRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1585
20.9.261. TrafficCountsByAerodromeReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
20.9.262. TrafficCountsByAerodromeSetReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
20.9.263. TrafficCountsByAircraftOperatorReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1586
20.9.264. TrafficCountsByAirspaceReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1587
20.9.265. TrafficCountsByMeasureReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1587
20.9.266. TrafficCountsByPointReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1587
20.9.267. TrafficCountsByTrafficVolumeReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1587
20.9.268. TrafficCountsReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1587
20.9.269. TrafficCountsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1589
20.9.270. TrafficVolumeActivationPlan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593
20.9.271. TrafficVolumeActivationPlanRetrievalReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1595
20.9.272. TrafficVolumeActivationPlans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1595
20.9.273. TrafficVolumeActivationPlanUpdateReplyData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1596
20.9.274. TrafficVolumeLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1597
20.9.275. TrafficVolumeScenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1598
20.9.276. UpdateFlightInMeasure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1599
20.9.277. UpdateFlightInMeasureChoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1600
20.9.278. UpdateFlightsInMeasureReplyData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1600
20.9.279. UserManagedSimulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1601
Appendix N: AIRM Semantic Correspondence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1602
Appendix O: Default Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1627
20.O.1. Request / Reply Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1627
20.O.2. Time Window Request / Reply Count Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1628
20.O.3. P/S Message Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1631
IV: Appendixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634
Main Abbreviations and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1637
Document Final Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1650
Document Title: NM 27.0 - NM B2B Reference Manual

Document Control
Copyright Notice

© 2023 European Organisation for the Safety of Air Navigation (EUROCONTROL). All
rights reserved.

No part of this publication may be reproduced, stored in a retrieval system, or

transmitted in any form or by any means, electronic, mechanical, photocopying,
recording or otherwise, without the prior written permission of EUROCONTROL.

Document Identification

Document Title: NM 27.0 - NM B2B Reference Manual

Document Reference: NMB2B/27.0

Edition: 27.0 6 1
Document Title: NM 27.0 - NM B2B Reference Manual

Approval Table

Authority Date Signature

Author

NM B2B Team

Head of NMD/TEC

Enrico Vigliani

Head of NMD/TEC/IAS

Javad Heshmati

Head of NMD/TEC/DAD

Alex Willem

Head of NMD/NOM/IBC

Chris Peregrine

Head of NMD/ACD/STR

Razvan Bucuroiu

Edition: 27.0 6 2
Document Title: NM 27.0 - NM B2B Reference Manual

Part I: Release Notes

Edition: 27.0 6 3
Document Title: NM 27.0 - NM B2B Reference Manual

Revision Notes
Edition 6
1. This edition corrects and complements the Edition 5 of the NM 27.0 - NM B2B Documentation.

2. Most changes can be found in the HTML or PDF documentation by searching for "27.0 - Edition
6".

3. Here is a short list of the main modifications:

a. Updated documentatin of the ReplyStatus enumeration

b. Fixed broken links

Edition 5
1. This edition corrects and complements the Edition 4 of the NM 27.0 - NM B2B Documentation.

CR-053206, CR-053430 and CR-053506 introduce new capabilities

respectively to the flight list requests/replies, e.g.
FlightListByAerodromeRequest/Reply, and to the
RegulationProposalRevocationRequest/Reply.

IMPORTANT All changes are backward compatible and have no impact on the client
application using the 27.0 version.

However, to benefit from these new capabilities, client applications must

download and use the new edition of the XSD Flight and/or Flow
schemas.

2. Most changes can be found in the HTML or PDF documentation by searching for "27.0 - Edition
5".

3. Here is a short list of the changes:

a. CR-053206 - ATC Coordinated Route - see new version note

b. CR-053430 - Delete Draft CP Regulation - see new version note

c. CR-053506 - Rerouting Opportunities - see new version note

d. CR-053431 - Functional missing ANU addresses in FLIGHT_PLANS and FFICE_PUBLICATION

P/S topics - see new version note

e. CR-053508 - Functional identified PTR causing level off not shown in agreed trajectory - see
new version note

f. CR-053507 - Functional missing data items from the FFICE_PUBLICATION P/S topic - see new
version note

g. I2-130481 - Fix ATFCM Situation Request INCONSISTENT_DAY_AND_DATASET_TYPE

constraint - see new version note

Edition: 27.0 6 4
Document Title: NM 27.0 - NM B2B Reference Manual

4. Here is a short list of the known issues:

a. I2-130446 - Functional missing data items from the FLIGHT_PLAN P/S topic - see version note

Edition 4
1. This edition corrects and complements the Edition 3 of the NM 27.0 - NM B2B Documentation.

2. Most changes can be found in the HTML or PDF documentation by searching for "27.0 - Edition
4".

3. Here is a short list of the main modifications:

a. Updated appendix FIXM Message Rules in the FF-ICE service group documentation

Edition 3
1. This edition corrects and complements the Edition 2 of the NM 27.0 - NM B2B Documentation.

2. Most changes can be found in the HTML or PDF documentation by searching for "27.0 - Edition
3".

3. Here is a short list of the main modifications:

a. New chapter Quality of Service in Essentials and provision of response time estimates for all
Requests/Replies

b. New section Restrictions in Airspace

c. New section ADR Messages in Airspace to describe the contents of the AIXM/ADR-E messages
exchanged in the context of the Airspace Availability services

d. TB-445 / CR-051018 - Service Usage Control Improvements - see new previous version impact
and version note

e. FB-996 / CR-050322 - Occupancy Regulations - see updated version note

f. FB-1191 / CR-050020 - Single CDR Category - see new previous version impact, migration
guideline and version note

Edition 2
1. This edition corrects and complements the Edition 1 of the NM 27.0 - NM B2B Documentation.

2. Most changes can be found in the HTML or PDF documentation by searching for "27.0 - Edition
2".

3. Here is a short list of the main modifications:

a. Updated chapter Access to Services in Essentials

b. Updated chapter Service Usage in Essentials

c. Updated appendix FIXM Message Rules in FF-ICE service group

d. FB-996 / CR-050322 - Occupancy Regulations - see new previous version impact

e. FB-1078 / CR-051607, CR052315 - iOAT (improved Operational Air Traffic) - see new previous

Edition: 27.0 6 5
Document Title: NM 27.0 - NM B2B Reference Manual

version impact, migration guideline and version note

f. FB-1172 / CR-052021 - ATFCM Situation Improvements - see new migration guideline and
updated version note

g. FB-1186 / CR-050218 - Mixer route source - see new migration guideline and version note

h. FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements - see new
previous version impact , migration guideline and version note

i. FB-1191 / CR-052011 - Restriction model for dynamic activation - see new previous version
impact , migration guideline and version note

j. FB-1192 / CR-052317 - FFICE Service Group Improvements / Upgrade to FIXM 4.3 - see
updated migration guideline

k. FB-1193 / CR-052312 - FLOS (Flight Level Orientation Scheme) Type in PointUsage - see new
version note

l. FB-1202 / CR-52415 - Export NM descriptor as part of Navaid/DesignatedPoint - see new

version note

m. TB-445 / CR-051513 - Access control re-implementation - see new version note

n. TB-445 / CR-051614 - Expose flight plan originators in P/S FlightPlanMessage history - see
new version note

o. CR-052806 - Ready pre-sequenced flights - see new version note

p. I2-125780 - Incorrect usage of HTTP 400 - Bad Request status - see new version note

q. I2-128110 - Dependent applicability offsets - see new version note

Edition: 27.0 6 6
Document Title: NM 27.0 - NM B2B Reference Manual

NM B2B Versions
NM B2B 27.0 Version Deployment
1. A new 27.0 version of the NM B2B Services is deployed.

2. For more details see NM B2B 27.0 Version - Notes.

Decommissioned Versions
1. The following versions of the NM B2B Services are decommissioned:

a. NM B2B 25.0

Edition: 27.0 6 7
Document Title: NM 27.0 - NM B2B Reference Manual

Impact on Previous Version

TB-445 / CR-051513 - Access control re-implementation
1. The NM B2B access control layer was partially re-implemented. The change might lead to
slightly different access error reporting.

2. Moreover, a serious effort was realised to better align the PREOPS platform with the OPS
platform in terms of service and resource access enablement. Therefore, some service /
resource accesses, previously enabled on the PREOPS platform only, might be disabled (on
PREOPS) after the deployment of NM release 27.0. For example, problem hotspot
(/hotspots?kind=PROBLEM) access is disabled.

3. Users can obtain detailed information about the enabled service and resource accesses thanks
to the UserInformationRequest/Reply.

4. For change details, see TB-445 / CR-051513 - Access control re-implementation.

TB-445 / CR-051018 - Service Usage Control Improvements

1. Change TB-445 / CR-051018 - Service Usage Control Improvements introduces new parallel
request count quotas.

2. In order to avoid impact on the NM B2B clients, the initial threshold was fixed on the basis of
the past usage of the most demanding users.

The current threshold value has been selected to not impact the current NM
B2B users.

IMPORTANT
However, NM strongly recommends to the NM B2B users to ensure that their
code is capable to handle the PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED reply
status that could be returned in case of quotas exceeded.

FB-996 / CR-050322 - Occupancy Regulations

1. Change FB-996 / CR-050322 - Occupancy Regulations consists in supporting the occupancy
regulations via B2B.

2. However, occupancy regulations are not supported by the NM B2B 26.0 version.

3. Therefore, in case an occupancy regulation is activated, client applications that use the NM B2B
26.0 version might experience some inconsistencies.

4. For example, a client application using the NM B2B 26.0 version will not be able to retrieve the
most penalising regulation of a flight if this regulation is an occupancy one.

Edition: 27.0 6 8
Document Title: NM 27.0 - NM B2B Reference Manual

FB-1078 / CR-051607, CR-052315 - iOAT (improved

Operational Air Traffic)
1. Change FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic) consists in
supporting the improved Operational Air Traffic.

2. Newly created FlightRestriction’s where the iOAT attribute is set to IOAT_ONLY or ALL_FLIGHTS are
exported with the code feature usage WITHHELD.

3. Client applications using version NM B2B 26.0 will receive only the content of restrictions that
apply strictly to GAT flights.

FB-1191 / CR-050624 - ASM Scenario usability and

flexibility improvements
1. Change FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements adds a new
MANAGED_MONITORED ScenarioCategoryType.

2. NM B2B 26.0 exports this new value as OTHER:__ADR__MANAGED_MONITORED. Client applications shall
be ready to process this value.

FB-1191 / CR-052011 - Restriction model for dynamic

activation
1. Change FB-1191 / CR-052011 - Restriction model for dynamic activation impacts the restriction
model.

2. The restrictions that have the new attribute isAupRAD set to YES, are exported as WITHHELD (see
Operational Usage).

FB-1191 / CR-052020 - Single CDR Category

1. After FB-1191 / CR-052020 - Single CDR Category, CDR_2’s should not be used.

2. Any AUP containing a CDR_2 opening will be rejected with error AUP_CDR_UPDATE_OPENING_CDR_TYPE
error with message CDR_2 opening is disabled as shown in the example below.

Edition: 27.0 6 9
Document Title: NM 27.0 - NM B2B Reference Manual

<airspace:AUPUpdateReply xmlns:airspace="eurocontrol/cfmu/b2b/AirspaceServices">
<requestReceptionTime>2023-03-18 12:21:59</requestReceptionTime>
<requestId>B2B_CUR:583</requestId>
<sendTime>2023-03-18 12:22:42</sendTime>
<status>INVALID_INPUT</status>
<inputValidationErrors>
<attributes>
<item>@ID=ID_7_1679141177035_3</item>
</attributes>
<group>AIRSPACE</group>
<category>FUA</category>
<type>AUP_CDR_UPDATE_OPENING_CDR_TYPE</type>
<message>CDR_2 opening is disabled</message>
</inputValidationErrors>
</airspace:AUPUpdateReply>

3. Client applications shall ensure that they do not try to open CDR_2 via AUP or shall be capable to
handle the returned error.

4. Since almost all CDR_2’s have already been decommissioned, such an error is very unlikely.

I2-125780 - Incorrect usage of HTTP 400 - Bad Request

status
1. An HTTP 400 - Bad Request status was previously returned in case of parsing error occurring
after the request type was recognised.

2. B2B now returns a structured reply as soon as it could recognise the request type.

3. See I2-125780 - Incorrect usage of HTTP 400 - Bad Request status.

I2-126566 - Error message constraint

1. Change I2-126566 - Error message constraint increases the common.Error.message maximum
length from 1000 to 2000 characters.

2. Client applications shall be ready to receive error messages with a maximum length of 200
characters.

Edition: 27.0 6 10
Document Title: NM 27.0 - NM B2B Reference Manual

Migration Guidelines
1. The objective of these guidelines is to assist the NM B2B customer to migrate client applications
from NM B2B Version 26.0 to NM B2B Version 27.0.

2. However, the NM B2B customer should not consider these guidelines as exhaustive.

3. The NM B2B customer is invited to read the complete NM 27.0 release notes before starting the
migration from NM B2B Version 26.0 to NM B2B Version 27.0.

TB-445 / CR-051510 - P/S services re-organisation

1. Change TB-445 / CR-051510 - P/S services re-organisation results in a cross service group re-
organisation of all P/S services.

2. The change can be summarised as follows:

a. The SubscriptionManagement and Messaging port types have been moved from the former
PublishSubscribe service group to the Common service group.

b. P/S topics, subscription types and message types are now declared and documented by the
service group / port type to which they belongs.

For example:

▪ the FLIGHT_DATA P/S topic is declared and documented by the Flight / FlightManagement
service group / port type.

▪ the FlightDataSubscription type is declared and documented by the Flight service group.

▪ the FlightDataMessage type is declared and documented by the Flight service group.

c. The P/S topic dependent subscription management S-R/R (

SubscriptionCreationRequest/Reply, SubscriptionRetrievalRequest/Reply and
SubscriptionUpdateRequest/Reply) are removed from the SubscriptionManagement port type
and replaced by a S-R/R pattern that is reproduced, for each P/S topic.

For example the FLIGHT_DATA P/S topic subscription management relies now on the following
P/S topic specific S-R/R:

▪ S-R/R FlightDataSubscriptionCreationRequest/Reply

Creates a FLIGHT_DATA P/S topic subscription.

▪ S-R/R FlightDataSubscriptionRetrievalRequest/Reply

Retrieves a FLIGHT_DATA P/S topic subscription.

▪ S-R/R FlightDataSubscriptionUpdateRequest/Reply

Updates a FLIGHT_DATA P/S topic subscription.

Edition: 27.0 6 11
Document Title: NM 27.0 - NM B2B Reference Manual

3. P/S services consumers have to adapt their application as follows:

a. For subscription creation, retrieval and update, use the topic specific namespace, e.g.
eurocontrol/cfmu/b2b/FlightServices, and request / reply types instead of the former
PublishSubscribe namespace (eurocontrol/cfmu/b2b/PublishsubscribeServices) and request /
reply types.

For example, instead of sending:

<ns:SubscriptionCreationRequest
xmlns:ns="eurocontrol/cfmu/b2b/PublishsubscribeServices">
<endUserId>tstxb2b</endUserId>
<sendTime>2022-10-18 10:29:20</sendTime>
<topic>FLIGHT_DATA</topic>
<description>some description</description>
<messageFilter>
...
</messageFilter>
<payloadConfiguration>
...
</payloadConfiguration>
</ns:SubscriptionCreationRequest>

The application has to send:

<ns:FlightDataSubscriptionCreationRequest
xmlns:ns="eurocontrol/cfmu/b2b/FlightServices">
<endUserId>tstxb2b</endUserId>
<sendTime>2022-10-18 10:29:20</sendTime>
<description>some description</description>
<messageFilter>
...
</messageFilter>
<payloadConfiguration>
...
</payloadConfiguration>
</ns:FlightDataSubscriptionCreationRequest>

b. For any other subscription management request, use the Common namespace
(eurocontrol/cfmu/b2b/CommonServices) instead of the former PublishSubscribe one
(eurocontrol/cfmu/b2b/PublishsubscribeServices). The request / reply type names and
structures are preserved.

For example, instead of sending:

Edition: 27.0 6 12
Document Title: NM 27.0 - NM B2B Reference Manual

<ns:SubscriptionResumeRequest
xmlns:ns="eurocontrol/cfmu/b2b/PublishsubscribeServices">
...
</ns:SubscriptionResumeRequest>

The application has to send:

<ns:SubscriptionResumeRequest
xmlns:ns="eurocontrol/cfmu/b2b/CommonServices">
...
</ns:SubscriptionResumeRequest>

c. For message consumption, use the topic specific namespace, e.g.

eurocontrol/cfmu/b2b/FlightServices.

For example, instead of consuming:

<ns:FlightDataMessage
xmlns:ns="eurocontrol/cfmu/b2b/PublishsubscribeServices">
...
</ns:FlightDataMessage>

The application has to consume:

<ns:FlightDataMessage
xmlns:ns="eurocontrol/cfmu/b2b/FlightServices">
...
</ns:FlightDataMessage>

TB-445 / CR-051017 - ReroutingApplyRequest.filedFrom

1. To avoid possible confusions, change TB-445 / CR-051017 - B2B Acting Unit renamed the
ReroutingApplyRequest.fileOnBehalfOf attribute to ReroutingApplyRequest.filedFrom.

2. Customers should adapt their code accordingly.

FB-1078 / CR-051607, CR-052315 - iOAT (improved

Operational Air Traffic)
1. Change FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic) consists in
supporting the improved Operational Air Traffic.

2. The existing FlightRestriction’s get the extra attribute iOAT with the default value NON_IOAT.
Newly created FlightRestriction’s might have another value for the iOAT attribute. The client

Edition: 27.0 6 13
Document Title: NM 27.0 - NM B2B Reference Manual

application should decide what to do with the values IOAT_ONLY and ALL_FLIGHTS.

FB-1172 / CR-052021 - ATFCM Situation Improvements

1. In order to improve the naming consistency, change FB-1172 / CR-052021 - ATFCM Situation
Improvements renamed several ATFCMSituationCounts, ScenarioImpact and
DeltaATFCMSituationCounts attributes.

2. Customers using ATFCMSituationRequest/Reply and/or NetworkImpactAssessmentRequest/Reply or

working with ScenarioImpact should adapt their code accordingly.

FB-1186 / CR-050218 - Mixer route source

1. Change FB-1186 / CR-050218 - Mixer route source, by introducing a new route source, impacts
the ReroutingSourcesAndConstraints model.

2. Customers using the following services should adapt their code to this model change:

◦ S-R/R RoutingAssistanceRequest/Reply

◦ S-R/R ReroutingCreationRequest/Reply

◦ S-R/R ReroutingUpdateRequest/Reply

FB-1191 / CR-050624 - ASM Scenario usability and

flexibility improvements
1. Change FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements adds a new
conflictingScenario bi-directional association to the ASMScenario feature.

2. Client applications should pay attention to the processing of this new association.

FB-1191 / CR-052011 - Restriction model for dynamic

activation
1. Change FB-1191 / CR-052011 - Restriction model for dynamic activation impacts the restriction
model.

2. The restrictions that can be dynamically activated have the new attribute isAupRAD set to YES.

FB-1191 / CR-052020 - Single CDR Category

1. Change FB-1191 / CR-052020 - Single CDR Category impacts the route availability modelling.

2. The AirspaceStructure service now exports former CDR_3 as ATC_DISCRETION.

3. The AirspaceAvailability now relies only on the RouteAvailability status to express the closure of
CDR_1. It does not use the conditionalRouteType.

Edition: 27.0 6 14
Document Title: NM 27.0 - NM B2B Reference Manual

FB-1192 / CR-052317 - FFICE Service Group

Improvements
FFICE_PUBLICATION P/S Topic

1. To improve the compartmentalisation of the NM B2B services, change FB-1192 / CR-052317 -

FFICE Service Group Improvements / FFICE_PUBLICATION P/S Topic splits the FLIGHT_PLANS P/S
topic:

a. The FLIGHT_PLANS P/S topic is preserved but supports only the NM_B2B format.

b. A new FFICE_PUBLICATION P/S topic is created in a new FFICE.FFICE_PUBLICATION port type.

It allows the subscriptions to FFICE_PUBLICATION message in FIXM format.

2. Customers that were subscribing to the FLIGHT_PLANS P/S topic in FIXM format should subscribe
instead to the FFICE_PUBLICATION P/S topic and adapt to the new model:

a. Re-define their message filter according to the new FficePublicationMessageFilter

b. Re-define their payload configuration according to the new

FficePublicationPayloadConfiguration
c. Process published messages according to the new FficePublicationMessage

FFICE Upgrade to FIXM 4.3

1. Taking the opportunity of the upgrade of FB-1192 / CR-052317 - FFICE Service Group
Improvements / Upgrade to FIXM 4.3 the NM B2B FFICE services have been re-organised.

2. Hence, customer using the FF-ICE services have to adapt their code to:

a. the upgrade from FIXM 4.2 to FIXM 4.3

b. the FFICE service group API evolution

3. The main changes related to the FIXM upgrade are:

a. flight.gufi:

i. is moved to flight.flightIdentification.gufi

ii. structure has changed (new mandatory fields creationTime, namespaceDomain and
namespaceIdentifier)

b. flight.departure.departure is renamed to flight.departure.departureAerodrome

c. aircraft.formationCount has disappeared (see aircraft.aircraftType.aircractCount)

d. flight.aircraft.aircraftType.numberOfAircraft is renamed to
flight.aircraft.aircraftType.aircraftCount
e. flight.aircraft.aircraftType.type.icaoAircraftTypeDesignator is moved to
flight.aircraft.aircraftType.icaoAircraftTypeDesignator
f. flight.aircraft.aircraftType.type.otherAircraftType is moved to
flight.aircraft.aircraftType.otherAircraftType
g. flight.routeTrajectoryGroup.filed is replaced by flight.routeTrajectoryGroup.desired

Edition: 27.0 6 15
Document Title: NM 27.0 - NM B2B Reference Manual

h. flight.routeTrajectoryGroup.*.element.enRouteDeplay is renamed to
flight.routeTrajectoryGroup.*.element.plannedDeplay
i. flight.FlightRouteInformation

▪ cruisingLevel structure is now a FlightLevelOrAltitudeOrVfrChoiceType

▪ flightRulesCategory is moved to flight.flightRulesCategory

j. All DateTimeUtcType are expressed without millisecond

k. In the NM FIXM Extension 1.5:

▪ iataFlightNumber is moved to a structured

flight.flightIdentification.iataFlightDesignator

4. The re-organisation of the NM B2B FFICE services mainly consisted in a better alignment of the
NM B2B FFICE services to the FF-ICE messages:

◦ The FilingService now exposes three distinct S-R/R’s for FiledFlightPlan, FlightPlanUpdate
and FlightPlanCancellation messages

◦ The NotificationService now exposes two distinct S-R/R’s for FlightDeparture and
FlightArrival messages

◦ The FlightDataRequestService now exposes two distinct S-R/R’s for FlightDataRequest and
SubmissionStatusRetrieval messages

FB-1202 / CR-049216 - Alternate Aerodrome Role

1. For clarification purpose, change FB-1202 / CR-049216 - Alternate Aerodrome Role renamed
AerodromeRole BOTH to GLOBAL with same meaning: DEPARTURE or ARRIVAL.

2. Customers that were previously using the BOTH value in FlightListByAerodromeRequest,

FlightListByAerodromeSetRequest, TrafficCountsByAerodromeRequest, or
TrafficCounstByAerodromeSetRequest have to replace it by the new GLOBAL value.

FB-1202 / CR-052415 - Export NM descriptor as part of

Navaid/DesignatedPoint
1. Change FB-1202 / CR-52415 - Export NM descriptor as part of Navaid/DesignatedPoint consists in
exporting the old DBE point id as nmDesignator on the DesignatedPoint and Navaid features.

2. The client application should save and index the new attribute nmDesignator to understand the
flight replies that use a FlightPlan. More in particular the AirFiledData.startingPoint can use a
DBEPoint.

I2-127792 - Flight Information Update ATFM Comments

1. Change I2-127792 - Flight Information Update ATFM Comments improved the warning / error
reporting of the flight information updates.

2. The ATFM comments are now mapped to one Error either in warnings or in

Edition: 27.0 6 16
Document Title: NM 27.0 - NM B2B Reference Manual

inputValidationErrors attribute of Reply.

3. Customers shall adapt their code accordingly, i.e. read ATFM comments from the warnings or
inputValidationErrors attributes.

I2-128134 - Rename TrafficVolumeFilter to

TrafficVolumeSelection
1. Change I2-128134 - Rename TrafficVolumeFilter to TrafficVolumeSelection renamed attribute /
type trafficVolumeFilter / TrafficVolumeFilter to trafficVolumeSelection /
TrafficVolumeSelection.

2. FLIGHT_DATA subscribers that were defining a trafficVolumeFilter in their subscriptions shall

adapt to the new naming.

Edition: 27.0 6 17
Document Title: NM 27.0 - NM B2B Reference Manual

NM B2B 27.0 Version - Notes

Cross Service Group Changes
Cross service group changes impact more than one (potentially all) NM B2B Service
NOTE
Groups.

Enhancements & New Features

TB-445 / CR-051017 - B2B Acting Unit

Context

1. A client application might consume the NM B2B services in the name of different units. For
example, an ANSP application might consume Flight and Flow services in the name of distinct
airports / FMP’s.

2. Thanks to the new Request.onBehalfOfUnit attribute, the client application has the possibility to
communicate to NM the identifier of the acting Air Navigation Unit (ANU). See Acting Air
Navigation Unit.

In the context of this change, and to avoid possible confusions, the former
NOTE ReroutingApplyRequest.fileOnBehalfOf attribute was renamed to
ReroutingApplyRequest.filedFrom.

Change Details

1. New class attributes

Request.onBehalfOfUnit , ReroutingApplyRequest.filedFrom

2. Removed class attributes

ReroutingApplyRequest.fileOnBehalfOf , EhelpDeskTicketCreationRequest.onBehalfOf ,
EhelpDeskTicketUpdateRequest.onBehalfOf

Change Impacts

1. All requests.

TB-445 / CR-051018 - Service Usage Control Improvements

Context

1. In order to better protect the NM system while ensuring the same quality of service to all users,
the service usage control is improved as follows:

a. Possibility for a user to demand to NM the allocation of specific time window counts and
bandwidth quotas.

Edition: 27.0 6 18
Document Title: NM 27.0 - NM B2B Reference Manual

NOTE Such a demand shall be duly motivated.

b. Introduction of parallel request count quotas that consist in controlling that a user does not
submit too many requests simultaneously.

In order to avoid impact on the NM B2B clients, the initial threshold

was fixed on the basis of the past usage of the most demanding users.

However, it is the intention of NM, amongst other measures, to

progressively reduce this number to accommodate the growing
IMPORTANT
number of users.

NM strongly recommends the users to ensure that their client

application either sequences its B2B requests or correctly handles the
PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED reply status.

Change Details

1. In case of parallel request count quotas exceeded, NM B2B returns a reply with status
PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED.

2. See in Essentials the updated chapter Service Usage.

Change Impacts

1. All requests.

TB-445 / CR-051510 - P/S services re-organisation

Context

1. NM B2B services are organised as a set of business oriented service groups: Common, Airspace,
General Information, FF-ICE, Flight and Flow.

2. These business service groups were previously complemented by a Publish/Subscribe technical

service group, which was aggregating all P/S services out of their natural business service
groups.

3. This organisation was creating within each service group an artificial separation between R/R
and P/S services. The Publish/Subscribe service group had dependencies on all business service
groups, leading to a heavy XML schema loading/processing when using P/S services.

4. This change removes the artificial separation / dependencies by moving each P/S service to its
natural service group / port type.

5. The generic subscription management and messaging services, as well as their used data types,
are moved to the Common service group.

a. The new SubscriptionManagement port type exposes the subscription management services
that do not depend on the subscription type:

▪ query subscriptions;

Edition: 27.0 6 19
Document Title: NM 27.0 - NM B2B Reference Manual

▪ pause, resume and delete subscription;

▪ retrieve subscription history.

b. The Messaging port type now belongs to the Common service group.

6. The subscription management services that depend on the subscription type (create, retrieve
and update subscription) are now exposed by the service group / port type to which the P/S
topic belongs, see SubscriptionManagement Port Type.

To better support the consultation of the subscription history, each retrieve

NOTE service now supports an optional versionNumber attribute, see Subscription Last
Update.

Change Details

1. New S-R/R’s

AIMSubscriptionCreationRequest/Reply , AIMSubscriptionUpdateRequest/Reply ,
AIMSubscriptionRetrievalRequest/Reply , EAUPSubscriptionCreationRequest/Reply ,
EAUPSubscriptionUpdateRequest/Reply , EAUPSubscriptionRetrievalRequest/Reply ,
AirspaceDataSubscriptionCreationRequest/Reply , AirspaceDataSubscriptionUpdateRequest/Reply ,
AirspaceDataSubscriptionRetrievalRequest/Reply ,
FficeFlightFilingSubscriptionCreationRequest/Reply ,
FficeFlightFilingSubscriptionUpdateRequest/Reply ,
FficeFlightFilingSubscriptionRetrievalRequest/Reply ,
FlightFilingResultSubscriptionCreationRequest/Reply ,
FlightFilingResultSubscriptionUpdateRequest/Reply ,
FlightFilingResultSubscriptionRetrievalRequest/Reply ,
FlightDataSubscriptionCreationRequest/Reply , FlightDataSubscriptionUpdateRequest/Reply ,
FlightDataSubscriptionRetrievalRequest/Reply , FlightPlanSubscriptionCreationRequest/Reply ,
FlightPlanSubscriptionUpdateRequest/Reply , FlightPlanSubscriptionRetrievalRequest/Reply ,
MCDMSubscriptionCreationRequest/Reply , MCDMSubscriptionUpdateRequest/Reply ,
MCDMSubscriptionRetrievalRequest/Reply , RegulationSubscriptionCreationRequest/Reply ,
RegulationSubscriptionUpdateRequest/Reply , RegulationSubscriptionRetrievalRequest/Reply ,
MessagePullRequest/Reply , SubscriptionPauseRequest/Reply , SubscriptionResumeRequest/Reply ,
SubscriptionDeletionRequest/Reply , SubscriptionListRequest/Reply ,
SubscriptionHistoryRequest/Reply

2. New P/S messages

EAUPMessage , AIMMessage , RegulationMessage , AirspaceDataMessage , FficeFlightFilingMessage ,

FlightPlanMessage , FlightDataMessage , FlightFilingResultMessage , MCDMMessage ,
HeartbeatTechnicalMessage , SubscriptionTechnicalMessage

3. New classes

AIMSubscriptionCreationRequest , SubscriptionCreationRequest , AIMSubscriptionCreationReply ,

AIMSubscriptionCreationReplyData , AIMSubscription , Subscription , SubscriptionSummary ,

Edition: 27.0 6 20
Document Title: NM 27.0 - NM B2B Reference Manual

AIMSubscriptionUpdateRequest , SubscriptionUpdateRequest , AIMSubscriptionUpdateReply ,

AIMSubscriptionUpdateReplyData , AIMSubscriptionRetrievalRequest ,
SubscriptionRetrievalRequest , AIMSubscriptionRetrievalReply ,
AIMSubscriptionRetrievalReplyData , EAUPSubscriptionCreationRequest , EAUPPayloadConfiguration
, EAUPSubscriptionCreationReply , EAUPSubscriptionCreationReplyData , EAUPSubscription ,
EAUPSubscriptionUpdateRequest , EAUPSubscriptionUpdateReply , EAUPSubscriptionUpdateReplyData ,
EAUPSubscriptionRetrievalRequest , EAUPSubscriptionRetrievalReply ,
EAUPSubscriptionRetrievalReplyData , AirspaceDataSubscriptionCreationRequest ,
AirspaceDataMessageFilter , AirspaceDataSubscriptionCreationReply ,
AirspaceDataSubscriptionCreationReplyData , AirspaceDataSubscription ,
AirspaceDataSubscriptionUpdateRequest , AirspaceDataSubscriptionUpdateReply ,
AirspaceDataSubscriptionUpdateReplyData , AirspaceDataSubscriptionRetrievalRequest ,
AirspaceDataSubscriptionRetrievalReply , AirspaceDataSubscriptionRetrievalReplyData ,
FficeFlightFilingSubscriptionCreationRequest , FficeFlightFilingMessageFilter ,
AircraftOperatorFilter , FficeFlightFilingSubscriptionCreationReply ,
FficeFlightFilingSubscriptionCreationReplyData , FficeFlightFilingSubscription ,
FficeFlightFilingSubscriptionUpdateRequest , FficeFlightFilingSubscriptionUpdateReply ,
FficeFlightFilingSubscriptionUpdateReplyData , FficeFlightFilingSubscriptionRetrievalRequest ,
FficeFlightFilingSubscriptionRetrievalReply , FficeFlightFilingSubscriptionRetrievalReplyData
, FlightFilingResultSubscriptionCreationRequest , FlightFilingResultMessageFilter ,
AircraftOperatorFilter , FilingStatusFilter , FlightFilingResultSubscriptionCreationReply ,
FlightFilingResultSubscriptionCreationReplyData , FlightFilingResultSubscription ,
FlightFilingResultSubscriptionUpdateRequest , FlightFilingResultSubscriptionUpdateReply ,
FlightFilingResultSubscriptionUpdateReplyData ,
FlightFilingResultSubscriptionRetrievalRequest , FlightFilingResultSubscriptionRetrievalReply
, FlightFilingResultSubscriptionRetrievalReplyData , FlightDataSubscriptionCreationRequest ,
FlightDataMessageFilter , FlightSetDefinitionElement , FlightDataPayloadConfiguration ,
FlightDataSubscriptionCreationReply , FlightDataSubscriptionCreationReplyData ,
FlightDataSubscription , FlightDataSubscriptionUpdateRequest ,
FlightDataSubscriptionUpdateReply , FlightDataSubscriptionUpdateReplyData ,
FlightDataSubscriptionRetrievalRequest , FlightDataSubscriptionRetrievalReply ,
FlightDataSubscriptionRetrievalReplyData , FlightPlanSubscriptionCreationRequest ,
FlightPlanMessageFilter , FlightPlanPayloadConfiguration , FlightPlanSubscriptionCreationReply
, FlightPlanSubscriptionCreationReplyData , FlightPlanSubscription ,
FlightPlanSubscriptionUpdateRequest , FlightPlanSubscriptionUpdateReply ,
FlightPlanSubscriptionUpdateReplyData , FlightPlanSubscriptionRetrievalRequest ,
FlightPlanSubscriptionRetrievalReply , FlightPlanSubscriptionRetrievalReplyData ,
MCDMSubscriptionCreationRequest , MCDMMessageFilter , MCDMPayloadConfiguration ,
MCDMSubscriptionCreationReply , MCDMSubscriptionCreationReplyData , MCDMSubscription ,
MCDMSubscriptionUpdateRequest , MCDMSubscriptionUpdateReply , MCDMSubscriptionUpdateReplyData ,
MCDMSubscriptionRetrievalRequest , MCDMSubscriptionRetrievalReply ,
MCDMSubscriptionRetrievalReplyData , RegulationSubscriptionCreationRequest ,
RegulationMessageFilter , RegulationPayloadConfiguration , RegulationSubscriptionCreationReply
, RegulationSubscriptionCreationReplyData , RegulationSubscription ,
RegulationSubscriptionUpdateRequest , RegulationSubscriptionUpdateReply ,
RegulationSubscriptionUpdateReplyData , RegulationSubscriptionRetrievalRequest ,
RegulationSubscriptionRetrievalReply , RegulationSubscriptionRetrievalReplyData ,

Edition: 27.0 6 21
Document Title: NM 27.0 - NM B2B Reference Manual

MessagePullRequest , MessagePullReply , MessagePullReplyData , SubscriptionPauseRequest ,

SubscriptionPauseReply , SubscriptionPauseReplyData , SubscriptionResumeRequest ,
SubscriptionResumeReply , SubscriptionResumeReplyData , SubscriptionDeletionRequest ,
SubscriptionDeletionReply , SubscriptionDeletionReplyData , SubscriptionListRequest ,
SubscriptionListReply , SubscriptionListReplyData , SubscriptionHistoryRequest ,
SubscriptionHistoryReply , SubscriptionHistoryReplyData , SubscriptionHistoryItem , EAUPMessage
, BusinessPSMessage , PSMessage , AIMMessage , RegulationMessage , AirspaceDataMessage ,
AirspaceDataMessagePayload , FficeFlightFilingMessage , FlightPlanMessage ,
StructuredFlightPlanData , FlightPlanEventHistoryItem , FlightPlanEvent ,
RevalidationInformation , FlightDataMessage , FlightFilingResultMessage , MCDMMessage ,
HeartbeatTechnicalMessage , TechnicalPSMessage , SubscriptionTechnicalMessage

4. New enums

SubscriptionTopic , SubscriptionState , SubscriptionUpdateReason , ATSMessageType ,

ManualProcessingFilingStatus , PSFlightField , FlightPlanEventType , PSMessageType ,
RevalidationStatus , TechnicalTopic , SubscriptionField

5. New typedefs

FIXMAircraftOperatorDesignator_v4_3 , PSMessageElement

6. New unions

MCDMMessagePayload

7. Removed S-R/R’s

S-R/R MessagePullRequest/Reply , S-R/R SubscriptionCreationRequest/Reply , S-R/R

SubscriptionUpdateRequest/Reply , S-R/R SubscriptionPauseRequest/Reply , S-R/R
SubscriptionResumeRequest/Reply , S-R/R SubscriptionDeletionRequest/Reply , S-R/R
SubscriptionListRequest/Reply , S-R/R SubscriptionRetrievalRequest/Reply , S-R/R
SubscriptionHistoryRequest/Reply

8. Removed classes

MessagePullRequest , MessagePullReply , MessagePullReplyData , SubscriptionCreationRequest ,

SubscriptionMessageFilter , FlightFilingResultMessageFilter , AircraftOperatorFilter ,
FilingStatusFilter , AirspaceDataMessageFilter , RegulationMessageFilter , MCDMMessageFilter ,
FlightPlanMessageFilter , FlightSetDefinitionElement , FlightDataMessageFilter ,
FficeFlightFilingMessageFilter , SubscriptionPayloadConfiguration , EAUPPayloadConfiguration ,
MCDMPayloadConfiguration , FlightPlanPayloadConfiguration , FlightDataPayloadConfiguration ,
TrafficVolumeFilter , RegulationPayloadConfiguration , SubscriptionCreationReply ,
SubscriptionCreationReplyData , Subscription , SubscriptionUpdateRequest ,
SubscriptionUpdateReply , SubscriptionUpdateReplyData , SubscriptionPauseRequest ,
SubscriptionPauseReply , SubscriptionPauseReplyData , SubscriptionResumeRequest ,
SubscriptionResumeReply , SubscriptionResumeReplyData , SubscriptionDeletionRequest ,
SubscriptionDeletionReply , SubscriptionDeletionReplyData , SubscriptionListRequest ,
SubscriptionListReply , SubscriptionListReplyData , SubscriptionRetrievalRequest ,
SubscriptionRetrievalReply , SubscriptionRetrievalReplyData , SubscriptionHistoryRequest ,

Edition: 27.0 6 22
Document Title: NM 27.0 - NM B2B Reference Manual

SubscriptionHistoryReply , SubscriptionHistoryReplyData , SubscriptionHistoryItem

9. Removed enums

SubscriptionTopic , ATSMessageType , ManualProcessingFilingStatus , FlightPlanEventType ,

PSFlightField , SubscriptionState , SubscriptionUpdateReason

10. Removed typedefs

PSMessageElement

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

NONE.

3. Impacted messages

NONE.

TB-445 / CR-051513 - Access control re-implementation

Context

1. The change mainly consists in an internal redesign of the NM B2B access control
implementation.

2. The change has no impact on valid requests. However, it clarifies the access error reporting as
follows:

a. Any attempt to access a disabled service/resource is reported to the client application as a

Reply with status SERVICE_UNAVAILABLE.

The disabled service/resource accesses are reported in the reason attribute.

b. Any attempt to access a not authorised service/resource is reported to the client application
as a Reply with status NOT_AUTHORISED.

The not authorised service/resource accesses are reported in the reason attribute.

Change Details

1. See Access Control.

Change Impacts

1. Any reply if a service/resource access is denied.

Edition: 27.0 6 23
Document Title: NM 27.0 - NM B2B Reference Manual

TB-445 / CR-051719 - Publish/Subscribe subscription re-initialisation

Context

1. The Subscription Management port type provides a new S-R/R

SubscriptionSynchronisationRequest/Reply to "synchronise" an existing subscription (note that
for the moment the functionality is only available to the FLIGHT_DATA topic). The S-R/R takes as
input a time interval [wef, til] which represents the time period during which the
subscription was out-of-sync.

2. Upon synchronisation request, NM will republish the latest message of each flight matching the
subscription that was published (but potentially not consumed by the client) during the given
time interval, allowing the client application to quickly rebuild the most up-to-date view of the
flights.

3. See Subscription Synchronisation.

Change Details

1. New S-R/R’s

SubscriptionSynchronisationRequest/Reply , SubscriptionSynchronisationAbortRequest/Reply

2. New P/S messages

SubscriptionSynchronisationTechnicalMessage

3. New classes

SubscriptionSynchronisationSummary , SubscriptionSynchronisationRequest ,
SubscriptionSynchronisationReply , SubscriptionSynchronisationReplyData ,
SubscriptionSynchronisationAbortRequest , SubscriptionSynchronisationAbortReply ,
SubscriptionSynchronisationAbortReplyData , SubscriptionSynchronisationTechnicalMessage

4. New enum values

FlightEventType.RPU , TechnicalTopic.SYNCHRONISATION

5. New enums

SubscriptionSynchronisationStatus , SubscriptionSynchronisationAbortReason

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,

Edition: 27.0 6 24
Document Title: NM 27.0 - NM B2B Reference Manual

FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,

FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply ,
FlightDataSubscriptionRetrievalReply

3. Impacted messages

FlightDataMessage

FB-1078 / CR-051607, CR-052315 - iOAT (improved Operational Air Traffic)

Context

1. The Single European Sky Regulations govern the provision of services for aircraft operating as
general air traffic (GAT).

2. Belgium, Germany, and France have accepted to be pilot States for the improved operational air
traffic (iOAT) flight plan initial implementation.

3. Restrictions might be applicable to GAT or iOAT flights, or both. The restriction model is
extended with a flag that indicates to which flights they apply.

4. Some points cannot be part of a GAT flight plan. These points have the point usage type
MILITARY. The point usage type MILITARY is renamed to OAT.

5. See A Flight Plan for military Operational Air Traffic.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated section:

◦ FlightRestriction Feature

◦ CodeFlightStatusType

◦ CodePointUsageType

2. New enum values

EURSTSIndicator.OAT

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain FlightRestriction/DesignatedPoint

/Navaid features.

2. Impacted requests

FlightPlanCreationRequest, FlightPlanUpdateRequest , FlightPlanValidationRequest ,

RoutingAssistanceRequest , EvaluateFlowImpactRequest , ReroutingApplyRequest

3. Impacted replies

FlightPlanCreationReply, FlightPlanUpdateReply , FlightDelayReply , FlightRetrievalReply

4. Impacted messages

Edition: 27.0 6 25
Document Title: NM 27.0 - NM B2B Reference Manual

FlightPlanMessage

FB-1192 / CR-052317 - FFICE Service Group Improvements / FFICE_PUBLICATION P/S Topic

Context

1. To improve the compartmentalisation of the NM B2B services, the FLIGHT_PLANS P/S topic is split:

a. The FLIGHT_PLANS P/S topic is preserved but supports only the NM_B2B format.

b. A new FFICE_PUBLICATION P/S topic is created in a new FFICE.FFICE_PUBLICATION port type.

It allows the subscriptions to FFICE_PUBLICATION message in FIXM format.

2. The dependency to FIXM is now encapsulated in the FFICE service group. The Flight service
group does not depend on FIXM.

3. Semantically, the FFICE_PUBLICATION message filter, payload configuration and message contain
the same information as the FLIGHT_PLANS message filter, payload configuration and message.

Change Details

1. New S-R/R’s

FficePublicationSubscriptionCreationRequest/Reply ,
FficePublicationSubscriptionUpdateRequest/Reply ,
FficePublicationSubscriptionRetrievalRequest/Reply

2. New P/S messages

FficePublicationMessage

3. New class attributes

FlightPlanCreationReplyData.structuredFlightPlan ,
FlightPlanUpdateRequest.structuredFlightPlanUpdate ,
FlightPlanUpdateReplyData.structuredFlightPlan ,
FlightRetrievalReplyData.structuredFlightPlan

4. New classes

FficePublicationSubscriptionCreationRequest , FficePublicationMessageFilter ,
FlightSetDefinitionElement , FficePublicationPayloadConfiguration ,
FficePublicationSubscriptionCreationReply , FficePublicationSubscriptionCreationReplyData ,
FficePublicationSubscription , FficePublicationSubscriptionUpdateRequest ,
FficePublicationSubscriptionUpdateReply , FficePublicationSubscriptionUpdateReplyData ,
FficePublicationSubscriptionRetrievalRequest , FficePublicationSubscriptionRetrievalReply ,
FficePublicationSubscriptionRetrievalReplyData , FficePublicationMessage ,
FlightPlanEventHistoryItem , FlightPlanEvent , RevalidationInformation

5. New enum values

SubscriptionTopic.FFICE_PUBLICATION

6. New enums

Edition: 27.0 6 26
Document Title: NM 27.0 - NM B2B Reference Manual

FlightPlanEventType , RevalidationStatus

7. New typedefs

FIXMAircraftRegistration_v4_3 , AerodromeICAOIdWildcard , FIXMCountPositive_v4_3

8. Removed class attributes

FlightPlanCreationReplyData.flightPlanOutput , FlightPlanUpdateRequest.flightPlanUpdateInput ,
FlightPlanUpdateReplyData.flightPlanOutput , FlightRetrievalRequest.requestedDataFormat ,
FlightRetrievalReplyData.latestFlightPlan

9. Removed class constraints

FlightPlanCreationRequest.FIXM_FORMAT_NOT_ALLOWED ,
FlightRetrievalRequest.FIXM_FORMAT_DEPRECATED ,
FlightPlanValidationRequest.FIXM_FORMAT_NOT_ALLOWED ,
RoutingAssistanceRequest.INVALID_FIXM_FLIGHT_PLAN ,
EvaluateFlowImpactRequest.INVALID_FIXM_FLIGHT_PLAN

10. Removed enums

FlightExchangeModel

11. Removed union choices

FlightPlanInput.fixm_v4_2

12. Removed unions

FlightPlanOutput , FlightPlanUpdateInput

Change Impacts

1. Impacted requests

FlightPlanCreationRequest, FlightPlanUpdateRequest , FlightRetrievalRequest ,

FlightPlanValidationRequest , RoutingAssistanceRequest , EvaluateFlowImpactRequest ,
ReroutingApplyRequest

2. Impacted replies

FlightPlanCreationReply, FlightPlanUpdateReply , FlightRetrievalReply ,

FlightDataSubscriptionCreationReply , FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply , SubscriptionListReply

3. Impacted messages

HeartbeatTechnicalMessage, SubscriptionTechnicalMessage

Edition: 27.0 6 27
Document Title: NM 27.0 - NM B2B Reference Manual

CR-053431 - Functional missing ANU addresses in Flight/FLIGHT_PLAN and FF-

ICE/FFICE_PUBLICATION P/S topics

Context

The Point In Airspace, TWR, ADEP, and ADES ANUs have been added to the FLIGHT_PLANS and
FFICE_PUBLICATION P/S topics. In addition, the IFPS re-addressing (see IFPS users manual) addresses
have also been added. Subscribers to the FLIGHT_PLANS and FFICE_PUBLICATION P/S topics can
now replicate their AFTN addressing needs.

Change Details

None.

Change Impacts

None.

Fixes and Corrections

I2-125780 - Incorrect usage of HTTP 400 - Bad Request status

Context

1. The NM B2B services now make use of the standard HTTP 400 - Bad Request status only if one of
the following conditions is met:

◦ The request is not a well-formed XML and the request type cannot be read

◦ The request type is unknown

2. An HTTP 400 - Bad Request status was previously returned in case of parsing error occurring
after the request type was recognised. NM B2B now returns a structured reply as soon as it
could recognise the request type.

Change Details

1. See HTTP 400 error - Bad Request.

Change Impacts

1. Responses to erroneous requests of which type could be recognised but of which payload could
not be entirely parsed.

Known Issues and Limitations

NONE.

Common Services
1. This section describes the changes introduced in NM 27.0 (common to all B2B service groups).

Edition: 27.0 6 28
Document Title: NM 27.0 - NM B2B Reference Manual

Enhancements & New Features

NONE.

Fixes and Corrections

I2-126566 - Error message constraint

Context

1. The common.Error.message maximum length is increased from 1000 to 2000 characters.

Change Details

1. Altered class attributes

Error.message

Change Impacts

1. All replies.

Known Issues and Limitations

NONE.

General Information Services

1. This section describes the changes introduced to the B2B Generalinformation service group.

Enhancements & New Features

NONE.

Fixes and Corrections

NONE.

Known Issues and Limitations

NONE.

Airspace Services
1. This section describes the changes introduced in NM 27.0 to the B2B Airspace service group.

Edition: 27.0 6 29
Document Title: NM 27.0 - NM B2B Reference Manual

Enhancements & New Features

FB-1191 / CR-050624 - ASM Scenario usability and flexibility improvements

Context

1. Feedback from initial usage of ASM scenarios in operations resulted in the request for a number
of small improvements.

a. Detect conflicting ASM scenarios

b. Delete RSA from ASM scenario activation

c. Support managed and monitored ASM Scenarios with the same scenario identifier

d. Detect P3 activation of RSA in monitored ASM scenario

Change Details

For details about the AIXM / ADR Extension Coverage impact, see updated sections:

• ASMScenario

• ScenarioCategoryType

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain ASMScenario features.

FB-1191 / CR-052011 - Restriction model for dynamic activation

Context

1. NM B2B now supports dynamic activation of restrictions via AUP/UUP.

2. The benefits are:

a. More dynamic management of restrictions

b. Allows to replace permanent restrictions by restrictions that are only activated when
required

c. Reduction of restrictions allows for more direct flight routes resulting in less fuel
consumption and lower environmental impact

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated sections:

◦ AirTrafficManagementService

◦ FlightRestriction

◦ FlightConditionElement

◦ FlightRestrictionActivation

◦ FlightRestrictionActivationCondition

Edition: 27.0 6 30
Document Title: NM 27.0 - NM B2B Reference Manual

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain FlightRestriction features.

2. All AirspaceStructure requests/replies/messages that contain AirTrafficManagementService

features.

FB-1191 / CR-052012 - Dynamic RAD Restriction Activation

Context

1. NM B2B now supports dynamic activation of RAD Restrictions for limited time periods.

2. It allows an AMC or an FMP to dynamically activate RAD Restrictions in the context of an

AUP/UUP.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated section
AirTrafficManagementService Feature.

2. New S-R/R’s

RADRestrictionActivationListRequest/Reply , RADRestrictionActivationsUpdateRequest/Reply ,
EAUPRADRestrictionActivationRequest/Reply , EAUPRADRestrictionActivationCompareRequest/Reply ,
DraftEAUPRADRestrictionActivationRequest/Reply

3. New class attributes

AUPManualEntries.radRestrictionActivations

4. New classes

RADRestrictionActivationListRequest , RADRestrictionActivationListReply ,
RADRestrictionActivationListReplyData , RADRestrictionActivationsUpdateRequest ,
RADRestrictionActivationsUpdateReply , RADRestrictionActivationsUpdateReplyData ,
EAUPRADRestrictionActivationRequest , EAUPRADRestrictionActivationReply ,
EAUPRADRestrictionActivationReplyData , EAUPRADRestrictionActivationCompareRequest ,
EAUPRADRestrictionActivationCompareReply , EAUPRADRestrictionActivationCompareReplyData ,
DraftEAUPRADRestrictionActivationRequest , DraftEAUPRADRestrictionActivationReply ,
DraftEAUPRADRestrictionActivationReplyData

Change Impacts

1. Impacted requests

AUPCreationRequest, AUPUpdateRequest , AUPValidationRequest

2. Impacted replies

AUPRetrievalReply, AUPCreationReply , AUPUpdateReply

3. Impacted messages

Edition: 27.0 6 31
Document Title: NM 27.0 - NM B2B Reference Manual

NONE.

FB-1191 / CR-052020 - Single CDR Category

Context

1. The NM system now supports the conversion and re-classification of all conditional routes into
CDR_1 category:

a. CDR_1 remains unchanged

b. CDR_2 is being decommissioned - completed by the end of 2023

c. CDR_3 becomes ATC_DISCRETION

2. From the deployment of the NM 27.0 release, the NM system rejects the opening of a CDR_2 via
AUP.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see the following updated
sections:

◦ RouteAvailability Object

◦ AUP CDRs Message

◦ EAUP CDRs Message

Trying to send a CDR_2 opening via AUP will result in a

NOTE
AUP_CDR_UPDATE_OPENING_CDR_TYPE error with message CDR_2 opening is disabled.

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain RouteSegment features.

2. All AirspaceAvailability requests/replies/messages that use AUP CDRs Message or EAUP CDRs
Message.

FB-1193 / CR-052312 - FLOS (Flight Level Orientation Scheme) Type in PointUsage

Context

1. NM stakeholders have raised questions about the cruising levels in FRA points.

2. NM extends the point usage model for FRA points with the flight level orientation scheme.

3. The extra data are provided for informational purposes. IFPS does not check the flight level
orientation scheme of the point usage with the flight plan.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated section:

◦ PointUsage Object

Edition: 27.0 6 32
Document Title: NM 27.0 - NM B2B Reference Manual

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain DesignatedPoint/Navaid features.

FB-1202 / CR-52415 - Export NM descriptor as part of Navaid/DesignatedPoint

Context

1. Identifiers of designated points and navaids are not unique.

2. Homonym points are points with the same identifiers.

3. NM asssigns an internal unique identifier to a point and refers to that identifier as the old DBE
point id.

4. NM flight services use the old DBE point id.

5. An ADR model change on the DesignatedPoint and Navaid features exports the old DBE point id
as nmDesignator.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated sections:

◦ DesignatedPoint Feature

◦ Navaid Feature

◦ CodeFlightStatusType

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain FlightRestriction/DesignatedPoint

/Navaid features.

TB-445 / CR-050607 - Adding the Group name in the AIXM output

Context

1. The NM B2B Airspace Structure Service exports the feature AirportHeliportSet.

2. RAD restrictions are published on the Network Operations Portal

https://www.nm.eurocontrol.int/RAD/index.html

3. Annex 1: Area definitions contains the definitions of areas. These areas correspond to the
feature AirportHeliportSet.

4. Some extra information is needed in order to correlate an area definition with an

AirportHeliportSet feature. Here is a concrete example of a correlation.

The area definition PARIS_GROUP corresponds to the AirportHeliportSet feature which has
the attribute airportHeliportSetId set to LFPTMA.

Edition: 27.0 6 33
Document Title: NM 27.0 - NM B2B Reference Manual

Change Details

1. The extra attribute name of the AirportHeliportSet feature enables the user to correlate an area
definition with a AirportHeliportSet feature.

<adrext:AirportHeliportSetTimeSlice gml:id="ID_12_..._8003">
<!-- some elements where left out -->
<!-- e.g. validTime, interpretation, featureLifetime ...-->
<adrext:airportHeliport xlink:href="urn:uuid:...-d27a69f2aec7"/>
<!-- some more references were left out for conciseness -->
<adrext:airportHeliportSetId>LFPTMA</adrext:airportHeliportSetId>①
<adrext:name>PARIS_GROUP</adrext:name>②
</adrext:AirportHeliportSetTimeSlice>

① LFPTMA is the identifier of the AirportHeliportSet (Set of Aerodromes) in CACD.

② PARIS_GROUP is the name of the area definition in the RAD Annex 1 publication.

TB-445 / CR-052207 - Expose ATS Units

Context

1. NM B2B allows the client application to provide some ANU identifiers in various services, e.g.
provide the ANU ids of interest in a FLIGHT_DATA P/S subscription.

2. This CR aims at exposing the NM ANU identifiers.

3. NM B2B now exports units of types FMP, DPIO, ACC, APP, OAC, TWR and UAC.

4. The designator of the exported unit contains the ANU identifier.

5. The service (AirTrafficControlService, AirTrafficManagementService or InformationService)

provided by the unit is also exported. It informs the user about the airports and/or airspaces on
which the unit provides its service.

Change Details

1. For details about the AIXM / ADR Extension Coverage impact, see updated sections:

◦ AirTrafficControlService Feature

◦ AirTrafficManagementService Feature

◦ InformationService Feature

◦ Unit Feature

2. New enum values

AIXMFeatureType.AirTrafficControlService , AIXMFeatureType.InformationService

Fixes and Corrections

Edition: 27.0 6 34
Document Title: NM 27.0 - NM B2B Reference Manual

I2-128110 - Dependent applicability offsets

Context

The RAD allows for the checking of one constraint, depending on the status of a non-associated
entity. For example, the IFPS will raise an error if a flight is planned via airspace ABC (constraint) if
route XYZ (entity) is open. Because of the non-associated entities, the IFPS will not always have the
exact entry time of the dependant entity. For example, the IFPS will know the entry time into
airspace ABC, but will not know the entry time into the dependant route XYZ if the flight route was
to be changed. The IFPS uses the time over the reference location of the RAD unit for checking the
availability of the dependant entity.

To solve this system limitation, the FlightConditionCircumstance now exposes two new attributes:

• startOffset - the duration (positive or negative) to add to the airspace entry time to get the
estimation of the dependent entity entry time.

• endOffset - the duration (positive or negative) to add to the airspace exit time to get the
estimation of the dependent entity exit time.

Change Details

For details about the AIXM / ADR Extension Coverage impact, see updated section:

• FlightConditionCircumstance Object

Change Impacts

1. All AirspaceStructure requests/replies/messages that contain FlightRestriction features with a

deferred applicability.

Known Issues and Limitations

NONE.

Flight Services
1. This section describes the changes introduced to the B2B Flight service group.

Enhancements & New Features

FB-1125 / CR-049109 - A-CDM Alerts

Context

1. The A-CDM alerts are used in the A-CDM process. They are system-generated messages, which
alert the Airport CDM Partners of an irregularity and which normally require one or more
partners to make a manual intervention to resolve the irregularity. They are related to a single
flight.

2. Most of them are sent to the AO/GH in order to take action either locally or remotely.

Edition: 27.0 6 35
Document Title: NM 27.0 - NM B2B Reference Manual

3. Alerting is an important result of information sharing and information processing. The progress
of the flight is monitored automatically and as the flight progresses through each of the
milestones, more information is added and modified as it becomes available (i.e. flight plan,
ATFM measures, actual progress etc.), and the downstream milestones are updated accordingly
and A-CDM alerts are raised, if required.

4. The alerts are triggered based on information entered into the local Airport CDM platform,
including flight plan and ATFM message updates received from NM. Once new information is
derived out of parameters that have entered the Airport CDM platform, it must be validated
whether the value of the new information is compliant with tolerances and limits.

5. The alert messages are recommended and can be sent any time but they are generally linked to
the A-CDM process, subject to local implementation decisions.

6. The A-CDM alerts are displayed in the HMI of the Airport CDM platform and normally allow
filtering according to the user profiles.

7. Sometimes, remote users, such as airline flight dispatchers, need to take an action in response to
an alert. They can also access the Airport CDM platform to check the alerts for their specific
flights. It is impractical however for them to log into several local applications for monitoring
the A-CDM alerts, especially considering the high number of A-CDM airports, which is expected
to grow further in the future.

8. Some airports offer remote users the possibility to subscribe to receiving the alerts via e-mail or
SITA. As not all alerts are of interest to the airline OCC, they need to set up filtering rules in the
email in order to capture only the relevant ones.

9. To overcome these shortcomings, the airline community, via their IATA representation, have
requested NM to investigate the possibility to collect the A-CDM alerts centrally from airports
and to disseminate them to interested users. This subject was discussed in several meetings of
the A-CDM Coordination and Harmonization WG and of the DPI WG. The conclusions were:

a. NM to implement a B2B service for the collection of A-CDM alerts from airports

b. Airports to share their A-CDM alerts with NM via B2B

c. NM to share these alerts with interested operational stakeholders via B2C/B2B.

10. Other relevant considerations made during the investigation:

a. The email is not an accepted exchange protocol for receiving/sending operational ATM
information. As a result, for NM, the email is not an option for exchanging A-CDM alerts.

b. NM is promoting a policy to make use of B2B Web Services as a standard interface for any
future services.

11. A questionnaire was sent to airlines in 2018 to investigate their usage of A-CDM alerts. 26
airlines, 4 ground handlers and 2 CFSPs expressed interest in NM centralizing them and
receiving them via B2B/B2C, while 7 said that the current solution for receiving alerts was
sufficient.

12. A number of airports expressed interest in sharing their alerts with NM should such a service
become available: EHAM, EKCH, LFPG, LFPO, Spanish airports.

13. This change enables the reception and dissemination of A-CDM alerts via NM B2B.

Edition: 27.0 6 36
Document Title: NM 27.0 - NM B2B Reference Manual

Change Details

1. New S-R/R’s

ACDMAlertRequest/Reply

2. New class attributes

Flight.activeACDMAlerts

3. New classes

ACDMAlertData , ACDMAlertRequest , ACDMAlertReply , ACDMAlertReplyData

4. New enum values

FlightField.activeACDMAlerts , FlightEventType.UAA , FlightEventType.UFC ,

PSFlightField.activeACDMAlerts

5. New enums

ACDMAlertSeverity

6. New typedefs

ACDMAlertCode

7. Altered class constraints

FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

Change Impacts

1. Impacted requests

FlightListByKeysRequest, FlightListByAircraftOperatorRequest , FlightListByAerodromeRequest ,

FlightListByAerodromeSetRequest , FlightListByAirspaceRequest , FlightListByPointRequest ,
FlightListByTrafficVolumeRequest , FlightListByMeasureRequest , FlightListByHotspotRequest ,
FlightListByAircraftRegistrationMarkRequest , FlightRetrievalRequest ,
FlightDataSubscriptionCreationRequest , FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply ,
FlightDataSubscriptionCreationReply , FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

3. Impacted messages

FlightDataMessage

Edition: 27.0 6 37
Document Title: NM 27.0 - NM B2B Reference Manual

FB-1158 / CR-050215 - Turn / Yoyo enhancements

Context

1. New TurnFlightForLocationKind enumerators.

Change Details

1. New enum values

TurnFlightForLocationKind.INTERESTING_SHARP_TURN ,
TurnFlightForLocationKind.UNINTERESTING_SHARP_TURN ,
TurnFlightForLocationKind.INTERESTING_ELSEWHERE ,
TurnFlightForLocationKind.UNINTERESTING_ELSEWHERE ,
TurnFlightForLocationKind.INTERESTING_INSIDE , TurnFlightForLocationKind.UNINTERESTING_INSIDE

2. Removed enum values

TurnFlightForLocationKind.NON_CRITICAL_SHARP_TURN ,
TurnFlightForLocationKind.NON_CRITICAL_ELSEWHERE ,
TurnFlightForLocationKind.NON_CRITICAL_INSIDE

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply

3. Impacted messages

NONE.

FB-1186 / CR-050218 - Rerouting feedback submission

Context

1. New S-R/R to allow the user, typically an aircraft operator, to provide feedback about a flight
rerouting proposed by the GRRT. A route that is disliked will not be shown again.

The provision of a rerouting feedback will trigger the publication of a flight event of
NOTE
type RRF (Rerouting Feedback from AO).

Edition: 27.0 6 38
Document Title: NM 27.0 - NM B2B Reference Manual

Change Details

1. New S-R/R’s

ReroutingFeedbackRequest/Reply

2. New class attributes

Flight.aoReroutingFeedbacks

3. New classes

ReroutingFeedback , ReroutingFeedbackRequest , ReroutingFeedbackReply ,

ReroutingFeedbackReplyData

4. New enum values

FlightField.aoReroutingFeedbacks , FlightEventType.RRF

5. New enums

ReroutingFeedbackKind , ReroutingFeedbackReason , ReroutingFeedbackAction

Change Impacts

1. Impacted requests

FlightListByKeysRequest, FlightListByAircraftOperatorRequest , FlightListByAerodromeRequest ,

FlightListByAerodromeSetRequest , FlightListByAirspaceRequest , FlightListByPointRequest ,
FlightListByTrafficVolumeRequest , FlightListByMeasureRequest , FlightListByHotspotRequest ,
FlightListByAircraftRegistrationMarkRequest , FlightRetrievalRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply

3. Impacted messages

FlightDataMessage

FB-1186 / CR-050218 - Mixer route source

Context

1. The NM system is enriched with a new "mixer" rerouting source.

2. This new source dynamically generates alternative routes for a flight from ADEP to ADES by
mixing "city pair" routes departing from ADEP with city pair routes arriving at ADES. To be
mixable, the departure city pair route and arrival city pair route must have a common crossing

Edition: 27.0 6 39
Document Title: NM 27.0 - NM B2B Reference Manual

point.

3. The resulting routes pass IFPS validation checks.

4. The routes are identified by ETFMS in the rerouting result by a route name following the
standard naming format, an aerodrome pair and sequence number.

Change Details

1. New class attributes

ReroutingSourcesAndConstraints.horizontalReroutingSourcesAndConstraints ,
ReroutingSourcesAndConstraints.reroutingConstraintSets

2. New class constraints

ReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

3. New classes

HorizontalReroutingSourcesAndConstraints , ReroutingLengthLimit , ReroutingConstraintSet

4. New enums

ReferenceRequestedFlightLevel

5. Removed class attributes

ReroutingSourcesAndConstraints.reroutingHorizontalConstraints ,
ReroutingSourcesAndConstraints.oredReroutingConstraints

6. Removed class constraints

ReroutingSourcesAndConstraints.AT_LEAST_ONE_CONSTRAINT_TYPE_MUST_BE_SET

7. Removed classes

ReroutingHorizontalConstraints , ANDedReroutingConstraints

Change Impacts

1. Impacted requests

RoutingAssistanceRequest, ReroutingCreationRequest , ReroutingUpdateRequest

2. Impacted replies

ReroutingListReply, ReroutingCreationReply , ReroutingUpdateReply , ReroutingCancelReply ,

ScenarioReroutingRetrievalReply

3. Impacted messages

ReroutingMessage

Edition: 27.0 6 40
Document Title: NM 27.0 - NM B2B Reference Manual

FB-1192 / CR-052317 - SELCAL32 evolution leftover

Context

1. For backward compatibility reason, NM 26.0 / CR-049722 SELCAL32 evolution set a temporary
(UALPHA|DIGIT){4,5} pattern to the SelectiveCallingCode typedef.

2. This change sets the definitive (UALPHA|DIGIT){4} pattern to the SelectiveCallingCode typedef.

Change Details

1. Altered class attributes

OtherInformation.selCalCode

2. Altered typedefs

SelectiveCallingCode

3. Removed class constraints

OtherInformation.INVALID_SELCALCODE_FORMAT

Change Impacts

1. None.

FB-1197 / CR-049012 - Expose highest model fuel consumption and route charges

Context

1. The fuel consumption and route charges of a flight were only exposed by S-R/R.

2. This change ensures that fuel consumption and route charges of the highest model (CTFM if it
exists, otherwise the RTFM if it exists otherwise the FTFM) are also exposed by the FLIGHT_DATA
P/S topic.

Change Details

1. New enum values

PSFlightField.routeChargeIndicator , PSFlightField.fuelConsumptionIndicator

Change Impacts

1. Impacted requests

FlightDataSubscriptionCreationRequest, FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightDataSubscriptionCreationReply, FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

Edition: 27.0 6 41
Document Title: NM 27.0 - NM B2B Reference Manual

3. Impacted messages

NONE.

FB-1202 / CR-049216 - Alternate Aerodrome Role

Context

1. This change enables the querying / subscription of / to flights by alternate aerodrome.

2. More precisely:

a. A new aerodrome role ALTERNATE is introduced.

b. This new role can be used in flight list requests as well as in FLIGHT_PLANS and FLIGHT_DATA
P/S subscriptions.

For clarification purpose, the aerodrome role BOTH is renamed to GLOBAL with
IMPORTANT
same meaning: DEPARTURE or ARRIVAL.

Change Details

1. New class attributes

FlightSetDefinitionElement.alternateAerodromes

2. New class constraints

FlightListByAerodromeRequest.INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERODROME ,
FlightListByAerodromeSetRequest.INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERODROME ,
TrafficCountsByAerodromeRequest.ALTERNATE_ROLE_NOT_ALLOWED ,
TrafficCountsByAerodromeSetRequest.ALTERNATE_ROLE_NOT_ALLOWED

3. New enum values

AerodromeRole.GLOBAL , AerodromeRole.ALTERNATE , PSFlightField.alternateAerodromes

4. Altered class constraints

FlightDataMessageFilter.VALID_FLIGHT_SET ,
FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET ,
FlightPlanMessageFilter.VALID_FLIGHT_SET

5. Removed enum values

AerodromeRole.BOTH

Change Impacts

1. Impacted requests

FlightListByAerodromeRequest, FlightListByAerodromeSetRequest ,
FlightDataSubscriptionCreationRequest , FlightDataSubscriptionUpdateRequest ,

Edition: 27.0 6 42
Document Title: NM 27.0 - NM B2B Reference Manual

FlightPlanSubscriptionCreationRequest , FlightPlanSubscriptionUpdateRequest ,
TrafficCountsByAerodromeRequest , TrafficCountsByAerodromeSetRequest

2. Impacted replies

FlightDataSubscriptionCreationReply, FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply , FlightPlanSubscriptionCreationReply ,
FlightPlanSubscriptionUpdateReply , FlightPlanSubscriptionRetrievalReply

3. Impacted messages

NONE.

FB-1202 / CR-049908 - Expose IATA flight designator

Context

1. Expose the IATA flight designator (and its source) in flights via S-R/R (flight list requests) and via
P/S (FLIGHT_DATA topic).

Change Details

1. New class attributes

CDMInfo.iataFlightDesignator , CDMInfo.iataFlightDesignatorDiscrepancy ,
Flight.iataFlightDesignator

2. New classes

AircraftIATAIdFromDataSource

3. New enum values

FlightField.iataFlightDesignator , PSFlightField.iataFlightDesignator

4. New enums

AircraftIdDataSource

Change Impacts

1. Impacted requests

FlightListByKeysRequest, FlightListByAircraftOperatorRequest , FlightListByAerodromeRequest ,

FlightListByAerodromeSetRequest , FlightListByAirspaceRequest , FlightListByPointRequest ,
FlightListByTrafficVolumeRequest , FlightListByMeasureRequest , FlightListByHotspotRequest ,
FlightListByAircraftRegistrationMarkRequest , FlightRetrievalRequest ,
FlightDataSubscriptionCreationRequest , FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

Edition: 27.0 6 43
Document Title: NM 27.0 - NM B2B Reference Manual

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,

FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply ,
FlightDataSubscriptionCreationReply , FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

3. Impacted messages

FlightDataMessage

FB-1202 / CR-052208 - Flight Retrieval by IATA flight designator

Context

1. Support flight retrieval by IATA flight designator.

Change Details

1. New class constraints

FlightRetrievalRequest.FLIGHT_PLAN_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS ,
FlightRetrievalRequest.FLIGHT_PLAN_HISTORY_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS

2. New classes

IATAFlightKeys

3. New union choices

FlightIdentificationInput.iataKeys

4. Altered class constraints

FlightRetrievalRequest.KEYS_OR_IATA_KEYS_MUST_BE_PRESENT_IF_FLIGHT_IS_SPECIFIED_AS_REQUESTE
D_DATASET

Change Impacts

1. Impacted requests

FlightRetrievalRequest

2. Impacted replies

NONE.

3. Impacted messages

NONE.

FB-1203 / CR-051019 - Expose cdmEstimatedOffBlockTime in P/S

Edition: 27.0 6 44
Document Title: NM 27.0 - NM B2B Reference Manual

Context

1. Expose the cdmEstimatedOffBlockTime Flight field via the FLIGHT_DATA P/S topic.

Change Details

1. New enum values

PSFlightField.cdmEstimatedOffBlockTime

Change Impacts

1. Impacted requests

FlightDataSubscriptionCreationRequest, FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightDataSubscriptionCreationReply, FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

3. Impacted messages

NONE.

FB-1208 / CR-051818 - Slot Swap Candidate List field on Flight List

Context

1. Expose the slot swap candidates on flight list by location.

2. The requestedFields.slotSwapCandidateList field can be requested on

FlightListByAircraftOperatorRequest and on any other FlightListByLocationRequest at the
condition that the aircraftOperators list is provided.

3. The requestedFields.slotSwapCandidateList cannot be requested for other types of

FlightListRequest (i.e., FlightListByKeysRequest and
FlightListByAircraftRegistrationMarkRequest).

Change Details

1. New class constraints

FlightListByLocationRequest.SLOT_SWAP_CANDIDATE_LIST_REQUIRES_AIRCRAFT_OPERATOR_PROVISION

Change Impacts

1. Impacted requests

FlightListByAircraftOperatorRequest, FlightListByAerodromeRequest ,
FlightListByAerodromeSetRequest , FlightListByAirspaceRequest , FlightListByPointRequest ,
FlightListByTrafficVolumeRequest , FlightListByMeasureRequest , FlightListByHotspotRequest

Edition: 27.0 6 45
Document Title: NM 27.0 - NM B2B Reference Manual

2. Impacted replies

NONE.

3. Impacted messages

NONE.

TB-445 / CR-051614 - Expose flight plan originators in P/S FlightPlanMessage history

Context

1. Before this change, only the last (latest) message originator was exposed in the P/S flight plan
messages, so the P/S flight plan subscriptions by flight plan originator only matched with that
single latest message originator.

2. Consequently, a CFSP having subscribed to flight plans originated by himself, and having
submitted a flight plan, was not receiving flight plan messages anymore about this submitted
flight plan, after an ARO or an Aircraft Operator had updated it.

3. This change exposes now the full list of originators that "participated" to the flight plan in the
event history of the flight plan message.

4. The P/S flight plan subscriptions by flight plan originator now matches with that full list of
originators.

Change Details

1. New class attributes

FlightPlanEvent.originator , FlightPlanEvent.originator

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

NONE.

3. Impacted messages

FlightPlanMessage , FficePublicationMessage

CR-052512 - RoutingAssistanceRequest: Expose current routes in system

Context

1. The client application can now demand the routes currently used by the NM system via the S-
R/R RoutingAssistanceRequest/Reply.

Edition: 27.0 6 46
Document Title: NM 27.0 - NM B2B Reference Manual

2. The RoutingAssistanceRequest.SOURCES_AND_CONSTRAINTS constraint was relaxed so that the client

application can set
sourcesAndConstraints.horizontalReroutingSourcesAndConstraints.useFlightsCurrentlyInSystem
to true.

Change Details

1. Altered class constraints

RoutingAssistanceRequest.SOURCES_AND_CONSTRAINTS

Change Impacts

1. Impacted requests

RoutingAssistanceRequest

2. Impacted replies

NONE.

3. Impacted messages

NONE.

CR-052806 - Ready pre-sequenced flights

Context

1. New TRE flight event type (Pre-sequenced flights become ready at TOBT/EOBT - 5 minutes).

Change Details

1. New enum values

FlightEventType.TRE

Change Impacts

1. Impacted requests

FlightDataSubscriptionCreationRequest, FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply ,
FlightDataSubscriptionCreationReply , FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

Edition: 27.0 6 47
Document Title: NM 27.0 - NM B2B Reference Manual

3. Impacted messages

FlightDataMessage

CR-053206 - ATC Coordinated Route

Context

1. NM received a safety concern raised by FMPs about the abuse of the Flight Plan remark
RTECOORATC. The NM B2B API now allows to demand whether a flight route is coordinated by ATC
via a new Flight.atcCoordinatedRoute dedicated field.

Change Details

1. New class attributes

Flight.atcCoordinatedRoute

2. New enum values

FlightField.atcCoordinatedRoute

Change Impacts

1. Impacted requests

FlightListByKeysRequest, FlightListByAircraftOperatorRequest , FlightListByAerodromeRequest ,

FlightListByAerodromeSetRequest , FlightListByAirspaceRequest , FlightListByPointRequest ,
FlightListByTrafficVolumeRequest , FlightListByMeasureRequest , FlightListByHotspotRequest ,
FlightListByAircraftRegistrationMarkRequest , FlightRetrievalRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply

3. Impacted messages

NONE.

CR-053506 - Rerouting Opportunities

Context

1. Expose rerouting opportunities in flight retrieval.

Change Details

1. New class attributes

Edition: 27.0 6 48
Document Title: NM 27.0 - NM B2B Reference Manual

Flight.reroutingOpportunities

2. New classes

ReroutingOpportunities , AlternativeRouteInfo

3. New enum values

FlightField.reroutingOpportunities

4. New typedefs

SignedDurationHourMinute , SignedDistanceNM , SignedWeightKg

Change Impacts

1. Impacted requests

FlightRetrievalRequest

2. Impacted replies

FlightRetrievalReply

3. Impacted messages

NONE.

Fixes and Corrections

I2-126750 - Colour_DataType incorrect naming / packaging

Context

1. The flight.Colour_DataType typedef is used by the flight.Dinghies type only. In practice, it

expresses a colour or set of colours in a non structured manner: TEXT{1,51}. However its
'Colour' name and 'flight' packaging are incorrect.

◦ remove typedef flight.Colour_DataType

◦ new typedef common.Colours

◦ update class flight.Dinghies:

▪ remove attribute colour

▪ new attribute common.Colours colours

Change Details

1. New class attributes

Dinghies.colours

2. New typedefs

Edition: 27.0 6 49
Document Title: NM 27.0 - NM B2B Reference Manual

Colours

3. Removed class attributes

Dinghies.colour

4. Removed typedefs

Colour_DataType

Change Impacts

1. Impacted requests

FlightPlanCreationRequest, FlightPlanUpdateRequest , FlightPlanValidationRequest ,

RoutingAssistanceRequest , EvaluateFlowImpactRequest , ReroutingApplyRequest

2. Impacted replies

FlightPlanCreationReply, FlightPlanUpdateReply , FlightDelayReply , FlightRetrievalReply

3. Impacted messages

FlightPlanMessage

I2-127464 - Point DAL

Context

1. In PointDAL structure, the point shall be a published point.

Change Details

1. New class constraints

PointDAL.MUST_BE_PUBLISHED_POINT

Change Impacts

1. Impacted requests

FlightPlanCreationRequest, FlightPlanUpdateRequest , FlightPlanValidationRequest ,

RoutingAssistanceRequest , EvaluateFlowImpactRequest , ReroutingApplyRequest

2. Impacted replies

FlightPlanCreationReply, FlightPlanUpdateReply , FlightRetrievalReply

3. Impacted messages

NONE.

Edition: 27.0 6 50
Document Title: NM 27.0 - NM B2B Reference Manual

I2-127491 - Rename CDM AirportType attribute

Context

1. In CDM structure, the attribute AirportType was renamed to airportType to comply with the NM
B2B attribute naming convention.

Change Details

1. New class attributes

CDM.airportType

2. Removed class attributes

CDM.AirportType

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply

3. Impacted messages

FlightDataMessage

I2-127792 - Flight Information Update ATFM Comments

Context

1. Improve the warning / error reporting of the S-R/R FlightInformationUpdateRequest/Reply.

2. In the previous version, ATFM comments were mapped to a dedicated

FlightInformationUpdateReplyData.atfmComments attribute, leading to some self-contradicting
replies, e.g. status=OK but atfmComments[0].code=NOT_AUTHORISED.

3. Each ATFM comment is now mapped to one Error either in warnings or in inputValidationErrors
attribute of Reply:

a. category is set to ATFM (see ErrorCategory.ATFM)

b. type is set to one of the ATFMError values

Edition: 27.0 6 51
Document Title: NM 27.0 - NM B2B Reference Manual

Change Details

1. Removed class attributes

FlightInformationUpdateReplyData.atfmComments

2. Removed classes

ATFMComment

3. Removed enums

ATFMCommentType

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

EarlyDPIReply, TargetDPITargetReply , TargetDPISequencedReply , ATCDPIReply , CancelDPIReply ,

PredictedDPIReply , FlightUpdateReply , GeneralAPIReply , TargetTakeOffAPIReply ,
TargetTimeOverAPIReply , FlightConfirmationReply , SlotMissedReply , ReadyToDepartReply ,
SlotImprovementModeReply , ReroutingProposalRejectedReply , SlotProposalFeedbackReply

3. Impacted messages

NONE.

I2-128108 - Remove unused types

Context

1. Remove unused types from the B2B Flight service group.

Change Details

1. Unused types removed.

Change Impacts

NONE.

I2-128134 - Rename TrafficVolumeFilter to TrafficVolumeSelection

Context

1. The name TrafficVolumeFilter type (and attribute) is very misleading and is causing confusion
because one may think it is a way of filtering the messages, whereas in fact it is only a way of
defining the content of the traffic volume profile in the FlightDataMessage.

Edition: 27.0 6 52
Document Title: NM 27.0 - NM B2B Reference Manual

2. Therefore, the type TrafficVolumeFilter has been renamed as TrafficVolumeSelection, so that

the word filter is only used for filtering the messages.

Change Details

1. New class attributes

FlightDataPayloadConfiguration.trafficVolumeSelection

2. New classes

TrafficVolumeSelection

Change Impacts

1. Impacted requests

FlightDataSubscriptionCreationRequest, FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightDataSubscriptionCreationReply, FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply

3. Impacted messages

NONE.

I2-127447 - New constraint on FlightPlanUpdate

Context

1. A new constraint FlightPlanUpdate.UPDATE_ALTERNATE_AERODROME_ONLY_NOT_SUPPORTED has been

added: enrouteAlternateAerodromes and/or takeoffAlternateAerodromes cannot be the only
updated attributes.

Change Details

1. New class constraints

FlightPlanUpdate.UPDATE_ALTERNATE_AERODROME_ONLY_NOT_SUPPORTED

Change Impacts

1. Impacted requests

FlightPlanUpdateRequest

2. Impacted replies

NONE.

Edition: 27.0 6 53
Document Title: NM 27.0 - NM B2B Reference Manual

3. Impacted messages

NONE.

Known Issues and Limitations

I2-130446 - Functional missing data items from the FLIGHT_PLAN P/S topic

Actual Time of Arrival, (actual) Arrival Aerodrome, Actual Time of Departure are missing from the
published FLIGHT_PLANS P/S messages.

Flow Services
1. This section describes the changes introduced to the B2B Flow service group.

Enhancements & New Features

FB-996 / CR-050322 - Occupancy Regulations

Context

1. Support occupancy regulations via B2B: create, query, retrieve, update and cancel.

2. An occupancy regulation works like a standard regulation, but the delays of flights are not
calculated based on entries (or slots), but based on occupancy counts.

3. An occupancy regulation has the same attributes as a standard regulation, with the following
differences:

a. An occupancy regulation can never be cherry-picked.

b. The flight selection kind has a special value indicating that it is an occupancy regulation.

c. An occupancy regulation has no "window width", but instead, it has an occupancy duration.
The semantic of occupancy duration is the same as for counts, but it is implemented
differently in CASA. In CASA, the occupancy duration is added to the elapsed time of the
flight inside the regulation. The resulting effect is that CASA smooths the occupancy counts
corresponding to the same duration.

d. An occupancy regulation has no normal / pending / equipment / supplementary rates.

Instead, it is defined with a list of sub-periods, each one containing a sustained capacity, a
peak capacity, and a pending capacity. The pending capacity is not an integer, it is expressed
in percentage of the sustained capacity.

In this release, CASA calculates delays based on sustained and pending

NOTE
capacities only. The peak capacity is used only to update the OTMV values.

e. An occupancy regulation does not support XCD (FCM, RVR, Shift are not supported).

4. Finally, the effective capacities, when available, are now returned together with the entry and
occupancy counts. See TrafficCountsReplyData.effectiveCapacities and

Edition: 27.0 6 54
Document Title: NM 27.0 - NM B2B Reference Manual

TrafficCountsReplyData.effectiveOTMVs.

Change Details

1. New class attributes

RegulationOrMCDMOnly.calculationType , RegulationOrMCDMOnly.occupancyConstraints ,
RegulationOrMCDMOnly.occupancyDuration , TrafficCountsReplyData.effectiveCapacities ,
TrafficCountsReplyData.effectiveOTMVs

2. New class constraints

RegulationOrMCDMOnly.INVALID_CALCULATION_TYPE ,
RegulationOrMCDMOnly.INVALID_INITIAL_CONSTRAINTS ,
RegulationOrMCDMOnly.INVALID_SUPPLEMENTARY_CONSTRAINTS ,
RegulationOrMCDMOnly.INVALID_OCCUPANCY_CONSTRAINTS ,
RegulationOrMCDMOnly.OCCUPANCY_DURATION_MUST_BE_NULL ,
RegulationOrMCDMOnly.INVALID_OCCUPANCY_DURATION

3. New classes

RegulationOccupancyConstraint , OTMVThresholds

4. New enum values

RegulationField.calculationType , RegulationField.occupancyConstraints ,
RegulationField.occupancyDuration , RegulationProposalField.calculationType ,
RegulationProposalField.occupancyConstraints , RegulationProposalField.occupancyDuration

5. Altered class constraints

RegulationOrMCDMOnly.NO_DELAY_WINDOW_MUST_BE_NULL ,
RegulationOrMCDMOnly.UPDATE_CAPACITY_REQUIRED_MUST_BE_FALSE

6. Removed class constraints

RegulationOrMCDMOnly.INCONSISTENT_CHERRY_PICKED_CONSTRAINTS

Change Impacts

1. Impacted requests

RegulationListRequest, RegulationCreationRequest , RegulationUpdateRequest ,

RegulationProposalListRequest , RegulationProposalFilingRequest ,
RegulationProposalUpdateRequest , RegulationSubscriptionCreationRequest ,
RegulationSubscriptionUpdateRequest , ScenarioRegulationRetrievalRequest

2. Impacted replies

RegulationListReply, RegulationCreationReply , RegulationUpdateReply , RegulationCancelReply ,

RegulationProposalListReply , RegulationProposalFilingReply , RegulationProposalUpdateReply ,
RegulationProposalRevocationReply , RegulationSubscriptionCreationReply ,

Edition: 27.0 6 55
Document Title: NM 27.0 - NM B2B Reference Manual

RegulationSubscriptionUpdateReply , RegulationSubscriptionRetrievalReply ,
ScenarioRegulationRetrievalReply , TrafficCountsByAircraftOperatorReply ,
TrafficCountsByAerodromeReply , TrafficCountsByAerodromeSetReply ,
TrafficCountsByAirspaceReply , TrafficCountsByPointReply , TrafficCountsByTrafficVolumeReply ,
TrafficCountsByMeasureReply

3. Impacted messages

RegulationMessage

FB-1172 / CR-052021 - ATFCM Situation Improvements

Context

1. The purpose of this change is to add to the ATFCM Situation the minimal information needed to
compare simulations.

2. To serve this purpose, the delayedFlightCount and forecastFlightCount attributes are added to
ATFCMSituationCounts.

3. Moreover, in order to improve the naming consistency, several attributes of

ATFCMSituationCounts, ScenarioImpact and DeltaATFCMSituationCounts are renamed:

◦ ATFCMSituationCounts and ScenarioImpact flight count attributes are consistently named

xxxFlightCount, e.g. delayedFlightCount

◦ DeltaATFCMSituationCounts flight delta count attributes are consistently named

xxxFlightDeltaCount, e.g. delayedFlightDeltaCount

Change Details

1. New class attributes

ScenarioImpact.totalCommonFlightCount , ScenarioImpact.totalOtherFlightCount ,
ATFCMSituationCounts.landedFlightCount , ATFCMSituationCounts.airborneFlightCount ,
ATFCMSituationCounts.expectedFlightCount ,
ATFCMSituationCounts.undefinedSlotComplianceFlightCount ,
ATFCMSituationCounts.beforeSlotDepartureFlightCount ,
ATFCMSituationCounts.slotCompliantFlightCount ,
ATFCMSituationCounts.afterSlotDepartureFlightCount ,
ATFCMSituationCounts.atfmMeasureSuspendedFlightCount ,
ATFCMSituationCounts.famSuspendedFlightCount , ATFCMSituationCounts.delayedFlightCount ,
ATFCMSituationCounts.significantlyDelayedFlightCount ,
ATFCMSituationCounts.forecastFlightCount , ATFCMSituationRegulation.impactedFlightCount ,
DeltaATFCMSituationCounts.landedFlightDeltaCount ,
DeltaATFCMSituationCounts.airborneFlightDeltaCount ,
DeltaATFCMSituationCounts.expectedFlightDeltaCount ,
DeltaATFCMSituationCounts.undefinedSlotComplianceFlightDeltaCount ,
DeltaATFCMSituationCounts.beforeSlotDepartureFlightDeltaCount ,
DeltaATFCMSituationCounts.slotCompliantFlightDeltaCount ,
DeltaATFCMSituationCounts.afterSlotDepartureFlightDeltaCount ,

Edition: 27.0 6 56
Document Title: NM 27.0 - NM B2B Reference Manual

DeltaATFCMSituationCounts.atfmMeasureSuspendedFlightDeltaCount ,
DeltaATFCMSituationCounts.famSuspendedFlightDeltaCount ,
DeltaATFCMSituationCounts.delayedFlightDeltaCount ,
DeltaATFCMSituationCounts.significantlyDelayedFlightDeltaCount ,
DeltaATFCMSituationCounts.forecastFlightDeltaCount ,
DeltaATFCMSituationRegulation.beforeDelay ,
DeltaATFCMSituationRegulation.beforeImpactedFlightCount

2. Removed class attributes

ScenarioImpact.totalCommonFlights , ScenarioImpact.totalOtherFlights ,
ATFCMSituationCounts.nrLandedTraffic , ATFCMSituationCounts.nrAirborneTraffic ,
ATFCMSituationCounts.nrExpectedTraffic ,
ATFCMSituationCounts.nrFlightsUndefinedSlotCompliance ,
ATFCMSituationCounts.nrFlightsDepBeforeSlot , ATFCMSituationCounts.nrFlightsCompliedWithSlot ,
ATFCMSituationCounts.nrFlightsDepAfterSlot ,
ATFCMSituationCounts.suspendedFlightsDueToATFMMeasure ,
ATFCMSituationCounts.suspendedFlightsDueToFAM ,
ATFCMSituationCounts.flightsDelayedByMoreThan30Min ,
ATFCMSituationRegulation.nrImpactedFlights , DeltaATFCMSituationCounts.nrLandedTraffic ,
DeltaATFCMSituationCounts.nrAirborneTraffic , DeltaATFCMSituationCounts.nrExpectedTraffic ,
DeltaATFCMSituationCounts.nrFlightsUndefinedSlotCompliance ,
DeltaATFCMSituationCounts.nrFlightsDepBeforeSlot ,
DeltaATFCMSituationCounts.nrFlightsCompliedWithSlot ,
DeltaATFCMSituationCounts.nrFlightsDepAfterSlot ,
DeltaATFCMSituationCounts.suspendedFlightsDueToATFMMeasure ,
DeltaATFCMSituationCounts.suspendedFlightsDueToFAM ,
DeltaATFCMSituationCounts.flightsDelayedByMoreThan30Min ,
DeltaATFCMSituationRegulation.delayBefore ,
DeltaATFCMSituationRegulation.numberOfImpactedFlightsBefore

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply , ATFCMSituationReply ,
NetworkImpactAssessmentRetrievalReply , TrafficCountsByAircraftOperatorReply ,
TrafficCountsByAerodromeReply , TrafficCountsByAerodromeSetReply ,
TrafficCountsByAirspaceReply , TrafficCountsByPointReply , TrafficCountsByTrafficVolumeReply ,
TrafficCountsByMeasureReply

3. Impacted messages

Edition: 27.0 6 57
Document Title: NM 27.0 - NM B2B Reference Manual

FlightDataMessage

FB-1186 / CR-051215 - Rerouting Id in Group Rerouting Summary and Proposal Information

Context

1. Add rerouting identifier to Group Rerouting Summary and Proposal Information.

Change Details

1. New class attributes

ProposalInformation.reroutingId , GroupReroutingSummary.reroutingId

Change Impacts

1. Impacted requests

NONE.

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply

3. Impacted messages

FlightDataMessage

FB-1198 / CR-050314 - STAM RRP process improvement

Context

1. To facilitate their role within the STAM RRP process, this change brings new functionalities to
aircraft operators:

a. New REROUTINGS P/S topic

b. Exposure of the traffic volume and reference location of the ATFCM measures that impact a
flight, see FlightAtfcmMeasureLocation.trafficVolumeLocationInfo

c. Exposure of additional information in the FlightAtfcmReroutingLocation, see

FlightAtfcmReroutingLocation.aoAcknowledgedRRP and
FlightAtfcmReroutingLocation.originator
d. Exposure of the proposal flights via the FLIGHT_DATA P/S topic, see
FlightDataMessageFilter.includeProposalFlights

Change Details

1. New S-R/R’s

Edition: 27.0 6 58
Document Title: NM 27.0 - NM B2B Reference Manual

ReroutingSubscriptionCreationRequest/Reply , ReroutingSubscriptionUpdateRequest/Reply ,
ReroutingSubscriptionRetrievalRequest/Reply

2. New P/S messages

ReroutingMessage

3. New class attributes

FlightAtfcmMeasureLocation.trafficVolumeLocationInfo ,
FlightAtfcmReroutingLocation.aoAcknowledgedRRP , FlightAtfcmReroutingLocation.originator ,
FlightDataMessageFilter.includeProposalFlights

4. New classes

TrafficVolumeLocationInfo , ReroutingSubscriptionCreationRequest , ReroutingMessageFilter ,

ReroutingPayloadConfiguration , ReroutingSubscriptionCreationReply ,
ReroutingSubscriptionCreationReplyData , ReroutingSubscription ,
ReroutingSubscriptionUpdateRequest , ReroutingSubscriptionUpdateReply ,
ReroutingSubscriptionUpdateReplyData , ReroutingSubscriptionRetrievalRequest ,
ReroutingSubscriptionRetrievalReply , ReroutingSubscriptionRetrievalReplyData ,
ReroutingMessage

5. New enum values

PSFlightField.isProposalFlight , SubscriptionTopic.REROUTINGS

6. Removed class attributes

FlightAtfcmMeasureLocation.referenceLocation

Change Impacts

1. Impacted requests

FlightDataSubscriptionCreationRequest, FlightDataSubscriptionUpdateRequest

2. Impacted replies

FlightListByKeysReply, FlightListByAircraftOperatorReply , FlightListByAerodromeReply ,

FlightListByAerodromeSetReply , FlightListByAirspaceReply , FlightListByPointReply ,
FlightListByTrafficVolumeReply , FlightListByMeasureReply , FlightListByHotspotReply ,
FlightListByAircraftRegistrationMarkReply , FlightRetrievalReply ,
FlightDataSubscriptionCreationReply , FlightDataSubscriptionUpdateReply ,
FlightDataSubscriptionRetrievalReply , SubscriptionListReply

3. Impacted messages

FlightDataMessage, HeartbeatTechnicalMessage , SubscriptionTechnicalMessage

Edition: 27.0 6 59
Document Title: NM 27.0 - NM B2B Reference Manual

CR-053430 - Delete Draft CP Regulation

Context

1. NM received the demand from some ANSPs to have the possibility to reuse the identifiers of
draft regulations that were never applied.

2. To support this use case, the NM B2B API now offers the possibility to force the deletion of a
draft regulation via the new RegulationProposalRevocationRequest.forceDelete attribute.

3. Note that the deletion of the draft regulation will also trigger the deletion of the associated
MCDM.

Change Details

1. New class attributes

RegulationProposalRevocationRequest.forceDelete

Change Impacts

1. Impacted requests

RegulationProposalRevocationRequest

2. Impacted replies

NONE.

3. Impacted messages

NONE.

Fixes and Corrections

I2-127575 - Fix OTMVSustained crossingOccurences range

Context

1. Fix the range of OTMVSustained crossingOccurences.

Old range: [1,9999[

New range: [1,9999]

Change Details

1. Altered class attributes

OTMVSustained.crossingOccurrences

Edition: 27.0 6 60
Document Title: NM 27.0 - NM B2B Reference Manual

Change Impacts

1. Impacted requests

OTMVPlanUpdateRequest

2. Impacted replies - WARNING: IMPACT PREVIOUS VERSIONS

OTMVPlanRetrievalReply, OTMVPlanUpdateReply

3. Impacted messages

NONE.

I2-128109 - Remove unused types

Change Details

1. Unused types removed.

Change Impacts

NONE.

I2-130481 - Fix ATFCM Situation Request INCONSISTENT_DAY_AND_DATASET_TYPE constraint

Context

The INCONSISTENT_DAY_AND_DATASET_TYPE constraint was incorrectly restricting, on the OPERATIONAL

dataset, the request of ATFCM Situations to current day and next day (D-1). The constraint was
relaxed to support requests for any day value in [D-1, D+3].

Change Details

NONE.

Change Impacts

NONE.

Known Issues and Limitations

NONE.

Ffice Services
1. This section describes the changes introduced to the B2B FFICE service group.

Enhancements & New Features

Edition: 27.0 6 61
Document Title: NM 27.0 - NM B2B Reference Manual

FB-1192 / CR-052317 - FFICE Service Group Improvements / Upgrade to FIXM 4.3

Context

1. The initial purpose of this change was the upgrade of the FFICE service group to FIXM 4.3 / FF-
ICE 1.1.0.

2. However, considering that the upgrade to FIXM 4.3 / FF-ICE 1.1.0 would require a re-work of the
client applications, NM took this opportunity to improve the FFICE API.

3. Therefore, additionally to the FIXM 4.3 / FF-ICE 1.1.0 upgrade, the change revisit the FFICE
services:

a. FilingService port type:

The former S-R/R FilingRequest/Reply, previously supporting the submission of

FiledFlightPlan, FlightPlanUpdate and FlightPlanCancellation FF-ICE requests, is replaced by:

▪ S-R/R FiledFlightPlanRequest/Reply - submits a FiledFlightPlan FF-ICE request

▪ S-R/R FlightPlanUpdateRequest/Reply - submits a FlightPlanUpdate FF-ICE request

▪ S-R/R FlightPlanCancellationRequest/Reply - submits a FlightPlanCancellation FF-ICE

request

b. NotificationService port type:

The former S-R/R NotificationRequest/Reply, previously supporting the submission of

FlightDeparture and FlightArrival FF-ICE requests, is replaced by:

▪ S-R/R FlightDepartureRequest/Reply - submits a FlightDeparture FF-ICE request

▪ S-R/R FlightArrivalRequest/Reply - submits a FlightArrival FF-ICE request

c. FlightDataRequestService port type:

The S-R/R FlightDataRequest/Reply, previously supporting the submission of

FlightDataRetrieval FF-ICE requests and SubmissionStatusRetrieval NM B2B requests, is split:

▪ S-R/R FlightDataRequest/Reply is preserved - submits a FlightDataRequest FF-ICE request

▪ S-R/R SubmissionStatusRetrieval/Reply is created - submits a SubmissionStatusRetrieval

NM B2B request

Change Details

1. New S-R/R’s

FiledFlightPlanRequest/Reply , FlightPlanUpdateRequest/Reply ,
FlightPlanCancellationRequest/Reply , SubmissionStatusRetrievalRequest/Reply ,
FlightDepartureRequest/Reply , FlightArrivalRequest/Reply

2. New class attributes

Edition: 27.0 6 62
Document Title: NM 27.0 - NM B2B Reference Manual

FlightDataRequest.flightDataRequest_v1_1 , FlightDataReplyData.filingStatus_v1_1 ,
FlightDataReplyData.submissionResponse_v1_1 , FlightDataReplyData.flightDataResponse_v1_1 ,
TrialRequest.trialRequest_v1_1 , TrialReplyData.trialResponse_v1_1 ,
TrialReplyData.submissionResponse_v1_1

3. New classes

FiledFlightPlanRequest , FiledFlightPlanReply , FiledFlightPlanReplyData ,

FlightPlanUpdateRequest , FlightPlanUpdateReply , FlightPlanUpdateReplyData ,
FlightPlanCancellationRequest , FlightPlanCancellationReply , FlightPlanCancellationReplyData ,
SubmissionStatusRetrievalRequest , SubmissionStatusRetrievalReply ,
SubmissionStatusRetrievalReplyData , FlightDepartureRequest , FlightDepartureReply ,
FlightDepartureReplyData , FlightArrivalRequest , FlightArrivalReply , FlightArrivalReplyData

4. New typedefs

FiledFlightPlan_v1_1 , FilingStatus_v1_1 , SubmissionResponse_v1_1 , FlightPlanUpdate_v1_1 ,

FlightPlanCancellation_v1_1 , FlightDataRequest_v1_1 , FlightDataResponse_v1_1 ,
FlightDeparture_v1_1 , FlightArrival_v1_1 , TrialRequest_v1_1 , TrialResponse_v1_1 ,
FIXMFlight_v4_3

5. Removed S-R/R’s

S-R/R FilingRequest/Reply , S-R/R NotificationRequest/Reply

6. Removed class attributes

FlightDataRequest.choice , FlightDataReplyData.nmFilingStatus_v1_0 ,
FlightDataReplyData.nmSubmissionResponse_v1_0 , FlightDataReplyData.nmFlightDataResponse_v1_0
, TrialRequest.nmTrialRequest_v1_0 , TrialReplyData.nmTrialResponse_v1_0 ,
TrialReplyData.nmSubmissionResponse_v1_0

7. Removed classes

FilingRequest , FilingReply , FilingReplyData , NotificationRequest , NotificationReply ,

NotificationReplyData

8. Removed typedefs

NmFiledFlightPlan_v1_0 , NmFlightPlanCancellation_v1_0 , NmFlightPlanUpdate_v1_0 ,

NmFilingStatus_v1_0 , NmSubmissionResponse_v1_0 , NmFlightDataRequest_v1_0 ,
NmFlightDataResponse_v1_0 , FIXMFlight_v4_2 , NmFlightDeparture_v1_0 , NmFlightArrival_v1_0 ,
NmTrialRequest_v1_0 , NmTrialResponse_v1_0

9. Removed unions

FilingRequestChoice , FlightDataRequestChoice , NotificationRequestChoice

Change Impacts

1. Impacted requests

Edition: 27.0 6 63
Document Title: NM 27.0 - NM B2B Reference Manual

FlightDataRequest, FlightPlanCreationRequest , FlightPlanValidationRequest ,

RoutingAssistanceRequest , EvaluateFlowImpactRequest , ReroutingApplyRequest , TrialRequest

2. Impacted replies

FlightDataReply, TrialReply

3. Impacted messages

FficeFlightFilingMessage, FficePublicationMessage

Change Impacts

None.

CR-053508 - Functional identified PTR causing level off not shown in agreed trajectory

Context

NM B2B reflects Profile Tuning Restrictions (PTR) from the desired trajectory within the agreed
trajectory available in responses to requests or published on the FFICE_PUBLICATION P/S topic. PTRs
are shown as level-offs. NM B2B now adds the FIXM Trajectory Point Property CONSTRAINT_POINT,
where the level-off starts and where it ends. The business identifiers of the PTR are available within
the Route Trajectory Constraint description.

Change Details

None.

Fixes and Corrections

CR-053507 - Functional missing data items from the FFICE_PUBLICATION P/S topic

Context

The arrival aerodrome, actual time of arrival, and the actual time of departure were missing from
the FFICE_PUBLICATION P/S messages. This data is now published.

Change Details

None.

Known Issues and Limitations

None.

Edition: 27.0 6 64
Document Title: NM 27.0 - NM B2B Reference Manual

Part II: Essentials

Edition: 27.0 6 65
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 1. Introduction
1.1. Organisation
1. The NM B2B Reference Manual is organised in 4 parts.

2. The Part I - Release Notes provides the following information:

◦ The revisions notes of the NM B2B Documentation(see Revisions Notes)

◦ The newly supported and decommissioned NM B2B versions (see NM B2B Versions)

◦ The possible impact of the NM Release deployment on the former but still supported NM
B2B versions (see Impact on previous version)

◦ Migration guide for the users fo the previous NM B2B version (see Migration Guidelines)

◦ The detailed new NM B2B version notes (see New Version - Notes)

3. Essential, transversal information not related to specific service groups is provided via the Part
II - Essentials

4. Services details are documented by the Part III - Service Groups. The documentation of each
service group is organised as follows:

Context
The service group high level documentation.

PREOPS Testing
PREOPS testing aspects specific to the service group.

{ Port-Type } Port Type

One chapter per port type.

Data Types
The documentation of the data types defined by the service group.

Appendixes
The service group appendixes.

In conformance with EUROCONTROL Specification for SWIM Information Definition, each

service group contains an AIRM Semantic Correspondence appendix that documents the
semantic correspondence of class attributes, union choices and enum values, by associating
them to their equivalent concept in the ATM Information Reference Model.

5. Each '{ Port-Type } Port Type' chapter is itself organised as:

Overview
The port type overview.

Edition: 27.0 6 66
Document Title: NM 27.0 - NM B2B Reference Manual

Concepts
An optional section that introduces the main concepts of the port types.

Publish/Subscribe Topics
The documentation of the port type P/S services.

Requests/Replies
The documentation of the port type R/R services.

6. The Part IV - Appendixes contains:

◦ The references (bibliography)

◦ The abbreviation and acronyms

1.2. Intended Readers

1. The intended readers of this document are customer-side governance specialists, business
analysts, architects, designers and developers, involved in the development of client
applications using NM B2B services.

1.3. Terms
Client application an application that authenticates with a certificate and
consumes/uses the NM B2B services

Customer an organisation that has an agreement with NM for the use

of the NM B2B services

Client certificate or certificate used by a client application to authenticate its access to the
NM B2B services

User a physical person who uses a client application

Edition: 27.0 6 67
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 2. Context
2.1. General
1. NM provides three web-based channels for accessing its services:

a. The NOP Portal - introduced in NM-12.2;

b. The NM Portal (NMP) - introduced in NM-25.0;

c. The NM B2B Services - introduced in NM-13.0.

2. The NOP and NMP provide a consolidated view of the different aspects of the Network to
support the planning process. The main goal of the NOP and NMP is the wide dissemination of
Network information and collaboration between the Network partners.

3. The NM B2B Services provide access to both data and services via system-to-system interfaces,
allowing NM customers to exploit and use the information in their own systems, according to
their business needs.

The specific goal of the NM B2B Services is to support the interoperability required in the future
ATM systems, which is obtained SWIM compliance.

2.2. SWIM Compliance

1. After being a pioneer in the implementation of SWIM, with SWIM services in operations since
2009, EUROCONTROL NM has now completed the formal processes of assessing the
conformance of the NM B2B Services against the EUROCONTROL Specifications for SWIM. The
operational NM B2B Services are now available in the European SWIM Registry as SWIM
Compliant Services, in compliance with the CP1 implementing regulation.

2. More information at: https://www.eurocontrol.int/news/early-compliance-eurocontrol-nm-b2b-

services-cp1swim-offers-major-benefit-operational

Edition: 27.0 6 68
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 3. Service Contract Organisation &

Conventions
3.1. Overview
1. As explained in Essentials - Introduction/Organisation , NM B2B services are organised in
service groups. The service group is logical: it groups logically the related services (port types)
and the underlying exchange model (Request/Reply types and data types).

2. For each service group NM provides:

a. One chapter in the NM B2B reference manual: {ServiceGroup}

b. One operational WSDL: {ServiceGroup}_OPS_{releaseMajorMinorIncrement} .wsdl

c. One pre-operational WSDL: {ServiceGroup}_PREOPS_{releaseMajorMinorIncrement} .wsdl

d. One XML schema (XSD): {ServiceGroup}_{releaseMajorMinorIncrement} .xsd

where {ServiceGroup} stands for the name of the service group following the CamelCase
convention, e.g. CommonServices

3.2. Namespaces
1. NM defines one namespace per service group. The service group namespace is defined as

eurocontrol/cfmu/b2b/{ServiceGroup}

2. The target namespace of the operational WSDL, the pre-operational WSDL and the XML schema
(XSD) is the service group namespace.

3. Each time an NM namespace is indicated, it is meant to be relative to that root namespace. For
example, when the CommonServices namespace is mentioned, the reader must understand
eurocontrol/cfmu/b2b/CommonServices .

3.3. Naming Conventions

1. By convention, all type names follow the CamelCase convention, including the service group
name. It is sometimes necessary to derive a namespace name from a CamelCase type name: in
order to do so, the CamelCase notation is kept in the namespace name, e.g. the CommonServices
service group defines the CommonServices namespace name.

2. Service request types are suffixed by "Request".

3. Service reply types are suffixed by "Reply".

Edition: 27.0 6 69
Document Title: NM 27.0 - NM B2B Reference Manual

3.4. Service Group Reference Manual

1. Each service group reference manual has:

a. A "Port Types" chapter

b. A "Data Types" chapter

2. The "Port Types" chapter defines the services (port types) of the group. It is organised per
service, then per service request.

3. Each service request section provides:

a. The SOAP operation name

b. The request definition

c. The reply definition

4. The "Data Types" chapter defines all the types (classes, unions, enumerations and typedefs) that
logically belong to the service group.

3.5. WSDL and XSDs

1. In order to keep the XSD organisation as straightforward as possible, the following simplifying
assumptions are followed:

a. All port types have a unique name in the scope of a B2B version

b. All request and reply types have a unique name in the scope of a B2B version

c. All data types have a unique name in the scope of a B2B version

2. NM provides one XSD file per service group: it contains all requests, replies and data types
defined in the scope of the service group. The XSD files are named:

<service_group_name>_{releaseMajorMinorIncrement} .xsd

The XSD namespace is <service_group_name> , e.g. FlightServices for the FlightServices service
group.

It is important to note that NM may change the output XML as long as it verifies
the technical contract described above. For example, with the NM-25.0 release,
NM has changed the way the namespaces were declared in the output XML,
while respecting the XSD, which is a valid change. However, some customers
were impacted because of the assumption that NM would not change this - the
NOTE NM team insists that the technical contract is the one explained here (XSD,
WSDL, Reference Manuals), and strongly recommends customers to avoid
basing their client applications on additional, undocumented assumptions. In
particular, the present technical contract does not impose to the client
application to parse the NM B2B XML using a tool based on the contractual
XSD/WSDL, but does recommend customers to do so.

3. Clearly enough, the WSDL of a service group refers to the required XSD files consistently:

Edition: 27.0 6 70
Document Title: NM 27.0 - NM B2B Reference Manual

a. It always refers to the CommonServices XSD file

b. And to the XSD file associated to the service group requests, replies and data types

4. Regarding SOAP message definitions, each request/reply pair is always supported via two
messages:

a. The request message is named as the request type, e.g. if the request type name is
FlightPlanValidationRequest , the request message definition in WSDL is:

<message name="FlightPlanValidationRequest">
<part name="parameters" element="ns:FlightPlanValidationRequest"/>
</message>

b. The response message is named as the reply type, e.g. if the reply type name is
FlightPlanValidationReply , the response message definition in WSDL is:

<message name="FlightPlanValidationReply">
<part name="parameters" element="ns:FlightPlanValidationReply"/>
</message>

Edition: 27.0 6 71
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 4. Service Lifecycle

4.1. Introduction
1. The chosen approach is based on the following facts:

a. The service contracts must be released some months before the service becomes operational
(i.e. officially released on the NM operational platform).

b. B2B service customers do not release their client applications at the same time as NM
releases these services in operations: customers need some time to adapt. Therefore, NM
must support multiple versions of the NM B2B at all times.

c. It is convenient for the B2B customers to have access to the NM B2B services on a test
platform to test client applications before accessing the NM operational services (OPS). NM
calls this platform the "pre-operational" (PREOPS) platform and the services deployed on it
are called the "pre-operational" services.

The pre-operational services must remain available a "long" time after they become
operational, to allow customers to work on their client applications with the actual NM B2B
services without affecting the operational platform.

It is convenient for the B2B service customers to have early access to draft implementations
of the NM B2B services, therefore NM will releases them as is on the pre-operational
platform some time before the services becomes operational.

2. This chapter describes how NM responds to these constraints.

3. At the end of the chapter, a specific section is dedicated to the lifecycle of the NM B2B
documentation.

4.2. NM Releases and NM B2B Versions

1. Each year, NM deploys a major release of its software. The number of a major NM release ends
with ".0": NM-26.0, NM-27.0, etc.

In a major release, NM deploys its entire software, not only the NM B2B: the backend core
systems are deployed together with their B2C and B2B interfaces.

Minor NM releases can also take place, between major releases, but are limited to B2C. The
minor releases are numbered in their deployment order: 25.1, 25.2, 26.1, etc.

In particular, the NM B2B API does NOT change in a minor release.

2. A major NM release deploys the NM B2B version corresponding to that NM release, but also the
NM B2B versions that were deployed in the two last calendar years. In normal circumstances,
this means that within a single major NM release, two NM B2B versions are deployed:

a. The B2B version corresponding to the major NM release being deployed

b. The B2B version corresponding to the previous major NM release

Edition: 27.0 6 72
Document Title: NM 27.0 - NM B2B Reference Manual

3. It is crucial to understand the difference between a major NM release and an NM B2B version:
although the deployment of a new NM B2B version coincides with the deployment of a major
NM release, a major NM release supports more than one B2B versions.

Hence, according to the scheme explained above, the major NM-25.0 release should support the
24.0 and the 25.0 NM B2B versions. But:

a. Due to the COVID-19 crisis, the NM B2B version 23.0, which should have been
decommissioned with the NM-25.0 release, will be decommissioned with NM-26.0 instead, so
that NM B2B customers have more time to adapt

b. The decision to limit the deployment of NM B2B within major releases is recent (valid since
NM-25.0 only), i.e. there exists an NM B2B version 23.5, which, consistently with the rule of
maintaining NM B2B versions during (at least) two calendar years, remains supported in the
NM-25.0 release

4. With NM-26.0, the lifecycle explained above should be fully respected, namely:

a. The NM B2B versions 25.0 and 26.0 will be supported

b. The NM B2B versions 23.0, 23.5 and 24.0 (there was no NM-24.5) will be decommissioned
with the deployment of the NM-26.0 release

4.3. Backward Compatibility

1. It is also of crucial importance that there exists no "backward compatibility" constraint between
two successive NM B2B versions, i.e. the API of the new NM B2B version can be incompatible
with the previous one - it is generally the case. This is counterbalanced by the support of
previous NM B2B versions, as explained above.

2. In very exceptional circumstances, NM may have to modify the API of a previous NM B2B
version, in which case NM will inform impacted customers in due time and coordinate with
them as to reduce as much as possible service disruptions on the client applications.

Edition: 27.0 6 73
Document Title: NM 27.0 - NM B2B Reference Manual

4.4. NM B2B Documentation Lifecycle

1. PREOPS and OPS publications of the NM B2B always come with their technical contract, made of
the XSD, WSDL and Reference Manuals, as well as the NM B2B Release Notes and possibly other
release-specific documents.

2. The NM B2B technical contract specifies that it remains valid for the whole lifetime of a B2B
version. However, the NM B2B documentation may evolve in terms of editorial quality outside
of the B2B service lifecycle, the purpose being to improve the NM B2B documentation
continuously, and not only at service release times.

3. For these reasons, NM defines monthly slots to publish new documentation editions, of the
same service versions. These successive editions are published in the same way as their initial
release editions.

Clearly publication slots are not used if no change is to be published in that slot.

4. Each edition of the NM B2B documentation comes with a proper, detailed edition history, so that
readers can easily find the changes of interest for them.

5. A new B2B documentation edition applies to the currently operated NM B2B version, and, when
deployed on PREOPS, to the next B2B version.

6. A new edition of the B2B documentation typically contains:

a. B2B Reference Manuals textual enhancements, ranging from simple typo corrections to
deeper concept clarifications/corrections

b. B2B Release Notes corrections

c. B2B XSD/WSDL bug fixes

d. New or improved B2B examples

7. Although it is not possible to provide an exhaustive definition of what a "XSD/WSDL bug fix" is,
the idea is:

a. An XSD/WSDL bug consists of an error in the XSD/WSDL delivered to the customers. For
example, in the schema of B2B version 24.0, the RegulationInitialConstraint attributes
normalRate, pendingRate and equipmentRate were specified as integers with no additional
constraints, whereas they should have been specified as positive integers. Any client
application of the 24.0 version that would send a (valid, according to XSD) negative rate
value would receive an error.

b. Fixing that bug consists in adding the missing constraint.

More generally, an XSD/WSDL bug fix is designed to reduce the risk of client applications
sending and NM rejecting XSD/WSDL-wise valid requests, but semantically invalid.

c. However, the XSD/WSDL bug fixes are also (carefully) designed to avoid any regression in
the client applications. When a doubt exists, the modification is kept for the next release
(and not edition), yet documented via documentation edition.

Edition: 27.0 6 74
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 5. Message Exchange Patterns

1. The NM B2B Services use the following Message Exchange Patterns, detailed below:

◦ Synchronous Request/Reply (S-R/R);

◦ Asynchronous Request/Reply (A-R/R);

◦ Publish/Subscribe (P/S);

◦ File Download.

5.1. Messaging Essentials

1. Prior to the discussion of the NM B2B message exchange patterns, this section aims at clarifying
the messaging essentials.

5.1.1. Requests and Replies

1. A request is an XML document, embedded in a SOAP envelope (SOAP request) or not (plain
XML request), sent by the client application to the NM B2B via a POST HTTPS request.

2. A reply is an XML document, embedded in a SOAP envelope (SOAP reply) or not (plain XML
reply), returned by the NM B2B to a client application, in response to a received request.

The NM B2B always returns SOAP replies to SOAP requests and respectively
NOTE
plain XML replies to plain XML requests.

3. Requests and replies are used by the S-R/R and A-R/R message exchange patterns.

5.1.2. File Download

1. A file download request is an HTTPS GET request, sent by the client application to the NM B2B
whose URL identifies the file to download.

2. A file download reply is the payload of a file, returned by the NM B2B to a client application, in
response to a received file download request.

3. File download requests and replies are used by the File Download message exchange pattern.

5.1.3. Messages

1. A message is an XML document, embedded in an AMQP 1.0 message, published by NM B2B to

the NM B2B Broker and consumed by one client application.

2. Messages are sent by NM via by the A-R/R and P/S message exchange patterns.

5.1.3.1. Message Time-To-Live

1. A TTL (Time-To-Live) is set on all published messages.

2. Different messages may have different TTL values depending on the subscription topic (for P/S

Edition: 27.0 6 75
Document Title: NM 27.0 - NM B2B Reference Manual

messages) or on the request type (for A-R/R messages).

3. A default TTL value is defined per P/S subscription topic and per asynchronous request type.
These default values may be changed by NM without prior notification to reduce the number of
pending messages on queues.

4. The default TTL value is documented in the Default Settings appendix of the corresponding
service group. See for example Airspace A-R/R Message Settings or Airspace P/S Message
Settings.

5.1.3.2. Message Properties

1. All messages published by the NM B2B have some properties set (in accordance with the AMQP
1.0 protocol). Properties are extremely useful because they allow the consumer to take actions
without having to parse the message payload.

2. The AMQP 1.0 protocol defines three types of properties: header properties, message properties
and application properties. NM makes use of all three. The following tables show the properties
and their values.

Table 1. AMQP header properties

AMQP Header property Value

delivery-count Automatically set by the messaging layer used by NM

durable True

first-acquirer Automatically set by the messaging layer used by NM

priority Not used by NM

ttl Specific to each A-R/R or P/S topic

Table 2. AMQP message properties

AMQP Message property Value

absolute-expiry-time Set according to the TTL

content-encoding IMPORTANT: This is set to "gzip" when the message is

compressed and is empty when the message is not compressed
(see section Compression)

content-type application/xml

correlation-id The correlation identifier of an asynchronous request as

provided by the client application - used by the A-R/R message
exchange pattern.

creation-time The timestamp of when the message was created and published
to the queue

group-id Not used by NM

group-sequence Not used by NM

Edition: 27.0 6 76
Document Title: NM 27.0 - NM B2B Reference Manual

AMQP Message property Value

message-id Automatically set by the messaging layer used by NM. This id has
no value for NM. The only message id known and set by NM is
the application property NM_MESSAGE_ID. (see below).

reply-to Not used by NM

reply-to-group-id Not used by NM

subject Not used by NM

to The queue name

user-id Not used by NM

Table 3. Application properties

Application property Value

NM_BUSINESS_ID This is a more humanly readable identifier that provides

information about the nature of the message. For example, for a
FlightDataMessage it can look like "ifplId:AA00311500
acId:AFR1144 adep:LFPG ades:UUEE divertedAdes:null eobt:2017-
09-11 17:05 evt:CNC". It was introduced for NM’s internal use.
However, it may be useful for logging purposes but the client
application should not parse it because the format may change at
NM’s discretion.

NM_CONTENT_ENCODING This application property is equivalent to the message property

content-encoding (see above) and it contains the same value. It
has been added for Java client applications because at the time of
this writing the QPid JMS library offers no way of retrieving the
content-encoding message property.

NM_LAST_UPDATED_BY For internal use by NM

NM_MESSAGE_ID The message unique identifier set by NM. It is a UUID. It uniquely

identifies each message and is the only unique identifier used by
NM for published messages.

NM_PARENT_MESSAGE_ID For internal use by NM

NM_PARENT_MESSAGE_TIMES For internal use by NM

TAMP

NM_REQUEST_ID The request identifier - used by the A-R/R message exchange

pattern.

NM_REQUEST_RECEPTION_TIM The request reception time - used by the A-R/R message exchange
E pattern.

NM_STATE For internal use by NM

NM_TASK_ID For internal use by NM

NM_TYPE The message type, e.g. FlightDataMessage

Edition: 27.0 6 77
Document Title: NM 27.0 - NM B2B Reference Manual

Application property Value

NM_VERSION The NM B2B version, e.g. 27.0.0

5.1.3.3. Pattern Specific Details

1. Pattern specific details are documented in their respective sections: A-R/R Messages and P/S
Messages.

5.2. Synchronous Request / Reply (S-R/R)

5.2.1. Overview

Figure 1. NM B2B Synchronous Request/Reply Overview

1. S-R/R is the default exchange pattern for Request/Reply (R/R) exchanges.

2. The pattern is:

a. The client application sends a request.

b. The NM B2B returns a synchronous reply.

5.3. Asynchronous Request / Reply (A-R/R)

5.3.1. Overview

Edition: 27.0 6 78
Document Title: NM 27.0 - NM B2B Reference Manual

Figure 2. NM B2B Asynchronous Request/Reply Overview

1. The NM B2B Services typically use the A-R/R message exchange pattern to expose
Requests/Replies that demand a long processing time.

2. The pattern is composed of two parts:

a. Synchronous part:

i. The client application sends a request.

ii. The NM B2B returns an information reply (see AsyncReply data type).

If the status of the information reply is OK, the client application extracts the
information on how to consume the asynchronous reply message, the pattern
continues with the asynchronous part.

In any other cases, the client application handles the reported error(s) and the pattern
terminates.

b. Asynchronous part:

i. The NM B2B publishes the asynchronous reply message (see ARMessage data type) to the
broker.

ii. The client application connects (if not already connected) to the broker and consumes
the asynchronous reply message.

5.3.2. Correlation Identifier

1. The client application must provide a correlation identifier when sending an asynchronous
request.

2. In turn, the NM B2B assigns the provided correlation identifier to:

Edition: 27.0 6 79
Document Title: NM 27.0 - NM B2B Reference Manual

◦ the correlationId attribute of the information reply (see AsyncReply data type);

◦ the correlation-id AMQP 1.0 Message property (see NM B2B message properties) of the
published reply message.

3. The client application uses the correlation identifier to associate a reply message to the
request that triggered its publication.

4. In case the client application, for an unexpected reason, loses the correlation identifier that it
provided:

◦ either the client application consumes a message of which correlation identifier is

meaningless, then drops it;

◦ or the message reaches its TTL and is automatically cleaned-up.

In both cases, the client application should consider the request as lost and may re-send it.

5.3.3. Request Processing Timeout

1. It might happen that some unexpected problem prevents the NM B2B to publish the reply
message, while it already returned the information reply.

2. To avoid the client application to wait forever for a lost reply message, the NM B2B includes in
the information reply a request processing timeout (see requestProcessingTimeout attribute).

3. The request processing timeout is the maximum duration, in seconds, that the client
application should wait to get a reply message.

4. In case of timeout, the client application shall consider the request as lost and may re-send it.

5.3.4. Queue Name

1. The NM B2B allocates one queue per client application (certificate) and per version, e.g. '27.0',
dedicated to the publication of asynchronous reply messages.

This queue does not affect the count of the P/S queues / subscriptions.

2. The NM B2B includes the queue name in the information reply (see
replyMessagePublicationQueueName attribute).

The client application shall be capable to process, on the same queue, all
IMPORTANT
types of reply message for which it submitted asynchronous requests.

5.3.5. Asynchronous Reply Messages

This section documents the asynchronous reply message specific aspects.

IMPORTANT The aspects that are common to all messages are documented in the
Messaging section.

1. The detailed asynchronous reply message model is available at ARMessage.

Edition: 27.0 6 80
Document Title: NM 27.0 - NM B2B Reference Manual

5.3.5.1. Compression

1. NM may make use of compression for any asynchronous reply message.

2. It is important to note that not all messages will be compressed. The decision of whether or not
to compress a message is based on the type of Request/Reply and the message size. It can be
summarized as follows:

◦ Messages are only compressed if above a given threshold size defined per type of
asynchronous reply.

◦ Message compression can be enabled/disabled by NM for each type of asynchronous reply

and it cannot be controlled by the client application.

5.4. Publish / Subscribe (P/S)

5.4.1. Overview

Figure 3. NM B2B Publish/Subscribe Overview

1. In a few words, the Publish/Subscribe (P/S) paradigm allows a client application to subscribe to
a topic and receive asynchronous messages published on that topic.

2. In the P/S paradigm there are therefore two distinct aspects: the subscription management and
the message consumption.

3. NM implements these two aspects by providing:

a. a Subscription Management API via Synchronous Request/Reply;

b. the Message Consumption via a Message Broker (aka B2B Broker) over AMQP 1.0.

4. A client application wanting to use the NM P/S shall create a new subscription via the

Edition: 27.0 6 81
Document Title: NM 27.0 - NM B2B Reference Manual

Subscription Management API and then consume the messages from the B2B Broker.

5. In general, when a new subscription is requested on a subscription topic by a client application,

a corresponding queue is allocated on the B2B Broker that will collect messages related to the
selected subscription topic.

5.4.2. Subscription Management

Last updated: 27.0 - Edition 1

1. The SubscriptionManagement Port Type section of the Common service group provides a
detailed documentation of the subscription management principles and API.

2. The Available Subscriptions section of the Common service group documents the available
subscriptions.

5.4.3. P/S Messages

This section documents the P/S message specific aspects. The aspects that are
IMPORTANT
common, to all messages are documented in the Messaging section.

5.4.3.1. Technical Messages vs Business Messages

1. When a client application subscribes to a given subscription topic, it will receive messages
which are pertinent to the subscribed topic. These are called Business Messages.

2. In addition to these business messages, NM will also publish Technical Messages on the same
queue, which are not related to the subscription topic but are implicit notifications of technical
nature. Examples of technical messages may be to notify about a degradation of the service or
the suspension of a subscription.

3. The P/S Messages are therefore split into two main categories:

◦ Technical Messages

Notifications of technical nature

◦ Business Messages

Messages related to the subscribed topic

All NM subscriptions make use of Technical Messages, therefore a P/S client

IMPORTANT
application must be capable of dealing with both types of messages.

1. Business Messages are then sub-categorised into more specific types to match the subscription
topics, so that a 1-to-1 correspondence exists between a message type and the subscription topic.

2. Similarly, Technical Messages are also sub-categorised into more specific types according to the
technical purpose they serve.

3. To see the specific Business and Technical Messages available please see the type PSMessage.

Edition: 27.0 6 82
Document Title: NM 27.0 - NM B2B Reference Manual

4. The following paragraphs describe the different types of Technical Messages currently used.

5.4.3.1.1. Subscription Technical Message

1. The message type is SubscriptionTechnicalMessage

2. The Subscription Technical Message is published whenever there is a change to a subscription

(e.g. a change of state) and it always conveys the latest state, the timestamp when the
subscription was last updated and by whom.

5.4.3.1.2. Heartbeat Technical Message

1. The Heartbeat Technical Message (or Heartbeat Message in short) is represented via the
HeartbeatTechnicalMessage type.

2. Heartbeat Messages are published on every subscription at regular intervals.

3. The objective of the Heartbeat Message is to serve the following use cases:

◦ Use case 1: Subscription yielding very few messages

For such subscriptions, when very few Business Messages are published, the client
application will experience long periods of time without receiving any message and
therefore may wonder whether the subscription is still working or not (e.g. whether it is still
active or has been paused).

The following diagrams depict such use case with and without Heartbeat Messages

Figure 4. Subscription with very few Business Messages

Figure 5. Subscription with very few Business Messages enriched with Heartbeat Messages

◦ Use case 2: Consumer unaware of inactive subscription

This use case is depicted below (with and without Heartbeat Messages). The diagrams
should be read from left to right with each event happening in order along the time axis.

Edition: 27.0 6 83
Document Title: NM 27.0 - NM B2B Reference Manual

Figure 6. No Heartbeat Messages - Consumer unaware of inactive subscription

The above diagram shows the case when the AMQP 1.0 consumer disconnects for some time.
During the time the consumer is disconnected, the messages remain on the queue until they
expire. When messages expire on a queue, the associated subscription is automatically
paused by NM. If the SubscriptionTechnicalMessage that informs about the change of state
to PAUSED also expires, then the AMQP 1.0 consumer will not know about the state of the
subscription when it finally reconnects.

Figure 7. Heartbeat Messages - AMQP 1.0 Consumer becomes aware of inactive subscription

The publication of Heartbeat Messages continue even while the subscription is PAUSED
(unless specifically disabled by the client application - see below). These Heartbeat messages
inform the AMQP 1.0 consumer about the state of the subscription without the need for
regularly polling the listSubscriptions or retrieveSubscription operations.

4. The frequency of the Heartbeat Message publication is controlled by NM and is not

configurable by the client application.

It is currently set to 1 minute, regardless of the subscription topic to which the client application
queue is associated.

5. The TTL (Time-To-Live) of Heartbeat Messages is also controlled by NM and is not configurable
by the client application.

In order to maintain a consistent behaviour between the expiration of a business message and
that of a heartbeat message on the same queue, the TTL of the heartbeat messages is set to the
same value of the Subscription Topic on which it is published (i.e. a heartbeat message
published on a FLIGHT_DATA topic will have the same TTL as a FlightDataMessage, whereas a

Edition: 27.0 6 84
Document Title: NM 27.0 - NM B2B Reference Manual

Heartbeat published on a REGULATIONS topic will have the same TTL as a RegulationMessage).

As a consequence of the above, when a client application remains disconnected (or is not
consuming) for a long time from a queue with large TTL, the queue may be accumulating many
heartbeat messages (maximum 360 on a 6-hour TTL topic).

6. The client application may disable the publication of Heartbeat Messages only in one specific
case: when deliberately pausing the subscription. In such case, i.e. when the client application
deliberately pauses the subscription through the pauseSubscription operation, it may decide to
turn off the publication of Heartbeat Messages while the subscription remains PAUSED. The
rationale is that, in this specific case, the client application is conscious that the subscription
will be paused and may desire to stop any message on the queue. Please note that as soon as the
subscription is resumed (via the resumeSubscription operation) the publication of Heartbeat
Messages is resumed.

5.4.3.2. Delta vs Self-Contained Messages

1. In the context of Publish/Subscribe where messages represent notifications about events that
modify the state of an object, the publisher must make a choice between publishing so called
"deltas" or fully self-contained messages.

◦ A delta message only contains the actual changes to the object and does not contain those
fields or properties that remained unchanged by the triggering event.

On the client application side (the consumer), a delta message needs to be applied to the full
state of the object (which must be stored on the client application). The loss of a delta
message leads to an incorrect and potentially inconsistent object state because it creates a
hole in the chain of updates. The subsequent messages may be updating other
fields/properties and the actual (correct) object state could potentially never be obtained.

◦ On the contrary, a fully self-contained message always carries the full object state. In this
case, the loss of a message only leads to a temporarily out-of-date (but consistent) object
state until the reception of the next message. The new message, which carries the full object
state, will immediately refresh the object to its up-to-date state on the client application.

NM does not publish "deltas", i.e. all messages published by NM are fully self-
contained and independent from other messages.

For example, if a FlightDataMessage is lost (e.g. because it expired before

being consumed), the next FlightDataMessage related to the same flight will
IMPORTANT
again contain the full flight state (i.e. all the fields specified by the client
application in the subscription’s payload configuration at the time the
subscription was created) and will therefore be sufficient to consistently
"refresh" the client application’s view on that flight. This is applicable to all
NM messages, regardless of the subscription topic.

5.4.3.3. Message Timeliness

1. One important aspect of the Publish/Subscribe paradigm is the fact that the information is

Edition: 27.0 6 85
Document Title: NM 27.0 - NM B2B Reference Manual

published as soon as it becomes available, or at least with no significant delay.

2. All P/S messages published by NM have a very short delay that varies depending on the
subscription topic.

3. This delay is due to technical constraints (such as CPU usage) and it may be changed by NM
without notifications to cope with resources limitations.

4. The value of the delay may vary from a few seconds for FLIGHT_DATA and FLIGHT_PLAN
messages up to a few minutes for REGULATIONS, REROUTINGS and AIMs (see below).

5. The default delay values for each subscription topic are provided in the PS Settings paragraph
(parameter MAX_PUBLICATION_DELAY).

5.4.3.4. Message Compression

1. NM may make use of compression for any P/S message.

2. It is important to note that not all messages will be compressed. The decision of whether or not
to compress a message is based on several aspects such as the message category (Technical vs
Business), the subscription topic and the message size, and it can be summarized as follows:

◦ Only Business messages may be compressed. Technical messages are never compressed.

◦ Messages are only compressed if above a given threshold size. See paragraph PS Settings to
see the topic-specific compression thresholds. A small message is not compressed because
the gain in size would not compensate the time and CPU usage spent to compress it and then
uncompress it on the client application side.

◦ Message compression can be enabled/disabled by NM for each subscription topic and it

cannot be controlled by the client application.

3. P/S messages that meet the above criteria are compressed as described in the Compression
section.

Edition: 27.0 6 86
Document Title: NM 27.0 - NM B2B Reference Manual

It is therefore paramount that a client application (the AMQP 1.0 consumer)

is capable of processing both uncompressed and compressed messages.

When receiving a message, the client application must check for the
presence and the value of the content encoding property (either the
standard AMQP 1.0 property content-encoding or the application property
NM_CONTENT_ENCODING) ; if its value is gzip, the message content (i.e. the actual
payload) needs to be uncompressed (i.e. g-unzipped).

The following snippet illustrates how to do this in Python:

if message.content_encoding == 'gzip':
payload = gunzip(message.body())

IMPORTANT
And the next snippet shows how to do it in Java:

if ("gzip".equals(message.getStringProperty(
"NM_CONTENT_ENCODING")))
BytesMessage binaryMsg = (BytesMessage) message;
size = (int)binaryMsg.getBodyLength();
byte[] binaryContent = new byte[size];
binaryMsg.readBytes(binaryContent, size);
payload = gunzip(binaryContent);

The above code snippets are provided as an indication only and are
deliberately kept simple. Their only purpose is to illustrate how to access and
evaluate the correct property.

5.4.3.5. Message Ordering

1. NM strives to publish the messages in chronological order based on the events that trigger
them.

2. However, a strict ordering may sometimes not be guaranteed. This is due to the fact that NM
may use multiple components or threads to spread the load and cope with the high level of
events (and therefore messages). Hence, it can happen that in some rare cases the order of the
messages may not be respected when many events happen in a very short time span.

3. In those rare occurrences when the order of two (or more) messages is shuffled, the following
may happen:

a. the messages are on different topics (e.g. one on REGULATIONS and one on FLIGHT_DATA).
This is not a problem because the order is only meaningful within the same topic.

b. the messages are on the same topic, but concern different items (for example same
FLIGHT_DATA topic, but different flights). This is also not a problem, because flights are to
be treated independently from one another and therefore updating first flight A and then
flight B or viceversa does not change anything on the client.

Edition: 27.0 6 87
Document Title: NM 27.0 - NM B2B Reference Manual

c. the messages are on the same topic and concern the same item (for example same
FLIGHT_DATA topic, and same flight). In this case, the order is important because one of the
two messages carries more up-to-date information than the other. For this reason, all P/S
messages provide a way of sorting them from the least to the most up-to-date. The sorting
strategy depends on the topic and the type of message.

4. Based on the above explanation, each subscription topic provides an ordering-policy that
explains how messages on that topic should be ordered in case of multiple messages referring
to the same item (e.g. same flight).

5.4.4. Building a Client Application

1. When developing a client application for the B2B P/S there are a few special attention points.

2. Regardless of the programming language chosen and the AMQP 1.0 library used, the client
application will have to deal with the following:

a. Subscription creation

b. Client application connection (and disconnection)

c. Message consumption

3. This paragraph provides some tips related to these aspects.

5.4.4.1. Subscription Creation

1. The first thing that a client application must do is to create a PS subscription.

2. You can create a subscription by invoking the B2B operation createXXXSubscription (e.g.,see
FlightDataSubscriptionCreationRequest).

3. A client application shall never create two (or more) overlapping subscriptions (i.e.
subscriptions that would generate the same messages) that are active at the same time.

The only exception to this rule is when a client application needs to modify its subscription. In
such case, since there is no operation that allows updating an existing subscription, the client
application can create a new subscription while still maintaining the old one active. But when
the new subscription is activated, the old subscription shall immediately be paused or deleted.

4. When creating a subscription, a client application shall narrow down the scope of the data
by making use of the message filtering capabilities offered by each subscription topic.

For example, when creating a subscription on FLIGHT_DATA, the client application shall reduce
the flight dataset to capture only those flights of interest. The rationale is to keep the number of
messages to a minimum so that both NM and the client application can benefit from a reduced
resource consumption (memory, network, cpu, storage).

5. It is important to restate that creating a subscription should be a one-off operation. Please

refer to paragraph Subscription Lifecycle for more details.

6. When a PS subscription is created, it is always associated to a message queue, to which the

client application can now connect.

Edition: 27.0 6 88
Document Title: NM 27.0 - NM B2B Reference Manual

5.4.4.2. Client Connection

1. See Client Connection (and Disconnection) to the NM B2B Broker.

5.4.4.3. Message Consumption

1. When a client application is ready to receive messages, it must make sure that the subscription
associated to the queue is in state ACTIVE (see Subscription States for more details about
subscription states and their transitions). If the subscription is in state PAUSED, it must be
resumed (see SubscriptionResumeRequest).

2. When it comes to message consumption, there are other important aspects to be analised to
avoid some adverse effects on both the client application and the NM B2B Broker itself. It is
therefore important that customers pay attention to the following:

a. Server timeout

The B2B Broker imposes a timeout of 60 seconds on the AMQP 1.0 link. This means that if no
AMQP 1.0 frames are exchanged through the link for at least 60 seconds the B2B Broker will
automatically drop the connection. To avoid this the client application must send keepalive
frames to the broker when no other frames are exchanged. This is usually done
automatically by the AMQP 1.0 library, so it should theoretically be of no concern to the
customer. However, should the customer experience such disconnections, it is the
customer’s responsibility to make sure that keepalive frames are exchanged.

b. Client timeout

Similarly to the server timeout, the client application could potentially impose a timeout on
the server. However, a small client timeout value (possibly set erroneously) may have a
significant impact on the B2B Broker.

It is therefore recommended not to set any timeout on the client application (or at least set it
to a reasonable value, e.g. 1 minute or more).

c. Link credit

The link credit, sometimes called prefetch buffer size, determines how many messages can
still be pushed to the client application at any given time. This parameter is set by the AMQP
1.0 receiver (the client application). The AMQP 1.0 sender (the B2B Broker) will honour it. If
the value is too small, the transmission will be slow because once the receiver’s prefetch
buffer is filled the sender must wait for more credit. On the other hand, if the value is too
large it may choke the client application (e.g. due to memory usage) and also have negative
effects on the server because it requires more memory. Also, a large value may lead to
consumer starvation when using multiple consumers. Therefore NM recommends to either
not set this value and use NM’s default or set a value between 10 and 50.

d. Message acknowledgement

All PS messages published by NM are non-settled, i.e. they require the client application to
settle (acknowledge) them explicitly. This is done in the disposition AMQP 1.0 performative.
Higher-level AMQP 1.0 libraries abstract the use of performatives and provide a simpler API

Edition: 27.0 6 89
Document Title: NM 27.0 - NM B2B Reference Manual

for acknowledging a message.

However, even when using such libraries, the client application may choose how and when
the acknowledgement shall be sent. For example the client application may choose to
acknowledge immediately upon reception, or after having processed the message, or even
batch several messages into the same transaction and acknowledge them all at the same
time.

Although NM cannot impose an acknowledgement strategy on the client application, it is

imperative to follow these rules:

i. Always acknowledge! Never leave a message unacknowledged;

ii. Acknowledge messages as early as possible;

iii. Avoid batching several messages into the same transaction: all NM messages are self-
contained and independent from one another and therefore there is no logical reason to
group them in the same transaction. Although this may result in improved performance,
it has a very negative effect on the server. It is important to understand that even if a
message has been delivered to the client application, that message will remain in the
B2B Broker’s store until it is finally settled (acknowledged).

e. Slow consumer

One of the most common problems that can occur when developing a PS client application is
to end up with a "slow consumer". As explained above, NM assigns a time-to-live (TTL) to
each message when it is published. If a message expires before it is consumed by the client
application, it may mean that either the client application was disconnected for some time
or that it cannot keep up with the message throughput of the server. This requires
immediate attention and needs to be fixed. There are several ways to improve the
consumer’s performance, but unfortunately many have negative side-effects. Provided that
the network infrastructure is sufficiently sized, the recommended way to improve the
consumer’s performance is to apply the following best practices:

i. Attach more than one consumer to the queue and have them consume the messages in
parallel;

the number of consumers must not exceed the limit set by NM (see
NOTE
paragraph Client Connection )

ii. Delegate the actual processing of the message to a separate thread and have the
consumer move on to the next message;

iii. Consider reducing the number of messages by acting on the subscription filtering
capabilities. In other words, keep your subscription as small as possible by only taking
what you need. Note that message compression has been introduced to reduce the
transfer time of the messages (see Message Compression for more details).

f. Queue visibility

A client authenticated with a given NM B2B certificate can only consume from its own

Edition: 27.0 6 90
Document Title: NM 27.0 - NM B2B Reference Manual

queues. As a consequence, two NM B2B certificates belonging to the same Air Navigation
Unit do not have visibility on each other’s queues: each NM B2B certificate can only see and
act upon its own subscriptions.

5.4.4.4. Publish/Subscribe Example Scenario

1. The following picture shows the simplest recommended usage scenario of the NM B2B
Publish/Subscribe.

Figure 8. P/S Recommended Usage Scenario

2. The diagram shows the following steps:

a. The client application first creates a subscription on some subscription topic by sending a
FlightDataSubscriptionCreationRequest SOAP request to the NM B2B. This triggers the
creation of a client application queue on the NM B2B broker. The newly created subscription
is in status PAUSED.

b. As a consequence of the previous request, a Technical Message is published on the queue

informing about the status (PAUSED) of the subscription.

c. The client application can now connect to the queue via AMQP 1.0. Note that although the
subscription is paused, the queue is always available.

d. The client application can consume the technical message. This is the only message present
on the queue at this moment. This gives the chance to the client application to verify that the
message consumption works as expected. Beware that technical messages related to a
subscription have the same expiration time as the business messages associated to the
subscription topic (see above) and therefore, if the consumption of the message is delayed
for longer than the time-to-live, the message will expire and will disappear from the queue.

e. Now the client application is ready to consume Business Messages. To do so, it is necessary
to resume the subscription (to set its status to ACTIVE) by sending a

Edition: 27.0 6 91
Document Title: NM 27.0 - NM B2B Reference Manual

SubscriptionResumeRequest.

f. The previous request also triggers the publication of a technical message that informs about
the change of state of the subscription (from PAUSED to ACTIVE).

g. From that point on, the NM system will publish business messages on the client application
queue (according to the subscription topic and filtering parameters) and the client
application can consume them.

5.5. File Download

5.5.1. Overview

Figure 9. NM B2B File Download Overview

1. Some NM B2B services expose data via the download of files.

2. The services that use the FIle Download pattern typically expose large size data and/or non XML
data.

3. The pattern starts when the client application has computed the file URL on the basis of a
received File.

a. The client application sends a GET HTTP request.

b. The NM B2B returns the file.

The client application typically extracts a File from a reply payload, e.g. from an
NOTE
IncrementalAIXMDatasetReply.data.datasetSummaries.files.

Edition: 27.0 6 92
Document Title: NM 27.0 - NM B2B Reference Manual

5.5.2. Computing the File Path

1. See section File Download Services.

Edition: 27.0 6 93
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 6. Protocols
6.1. Exchange Protocols
1. The NM B2B uses two different exchange protocols:

a. Requests and replies are exchanged via HTTPS (i.e. HTTP over TLS) transfer protocol

b. Message publication is implemented via AMQP 1.0 over TLS

2. For convenience, the NM B2B supports two flavours of request/reply exchanges:

a. XML requests and replies directly embedded into HTTP requests and responses (no SOAP
envelope)

b. The same XML requests and replies embedded into SOAP messages, themselves embedded
into HTTP requests and responses

3. The SOAP services make use of WSDL 1.1 and SOAP 1.1.

4. The NM B2B message exchange patterns, which all make use of these exchange protocols, are
documented in the Message Exchange Patterns chapter.

5. The details of the exchanged messages are defined according to the service contract.

6.2. Security Protocols

6.2.1. Data Encryption and Authentication

1. All NM B2B platforms (see NM B2B Platforms) support the following security protocols:

a. HTTP exchanges (S-R/R and File download): TLS 1.3 and TLS 1.2

b. AMQP 1.0 exchanges (A-R/R and P/S message publication): TLS 1.2

2. All Eurocontrol public services are signed by the Globalsign. It is recommended that the server
certificate received be verified by the customer for: valid signature and trust chain, certificate
expiration, mismatch with server certificate name (common name or alternative name).

3. Any change in this approach will be communicated by Eurocontrol in advance.

4. We do not recommend the implementation of certificate pinning (such as at certificate level or

public key level pinning). While this significantly increases security it adds strong operational
constraints.

6.2.2. Cryptographic Algorithms

1. The NM B2B supports the following cipher suites on all platforms:

a. HTTP exchanges:

i. TLS 1.3 (suites in server-preferred order)

Edition: 27.0 6 94
Document Title: NM 27.0 - NM B2B Reference Manual

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

ii. TLS 1.2 (suites in server-preferred order)

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

b. AMQP 1.0 exchanges:

i. TLS 1.2 (suites in server-preferred order)

ECDHE-RSA-AES256-GCM-SHA384
ECDHE-RSA-AES256-SHA384
ECDHE-RSA-AES256-SHA
ECDHE-RSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-SHA256
ECDHE-RSA-AES128-SHA

AES256-GCM-SHA384
AES256-SHA256
AES256-SHA
AES128-GCM-SHA256
AES128-SHA256

6.3. Compression
1. The NM B2B supports the compression of exchanged messages.

6.3.1. Requests

1. The client application decides to compress or not the request that it sends.

2. The client application must declare the request compression by setting a Content-Encoding HTTP
header to the B2B request (see '3.1.2.2 Content-Encoding' in IETF RFC 7231 ).

3. The only supported compression algorithm is gzip.

4. The NM B2B does not support more than one compression. Said in other words, NM B2B accepts

Edition: 27.0 6 95
Document Title: NM 27.0 - NM B2B Reference Manual

Content-Encoding: gzip but rejects Content-Encoding: gzip, gzip (two gzip compressions applied
consecutively).

5. Upon reception of such HTTP header the NM B2B de-compresses the received request.

6. The processing time with or without request compression is similar.

7. On reception of an unsupported Content-Encoding HTTP header, the NM B2B returns an error

415 Unsupported Media Type with headers Accept-Encoding: gzip, deflate (see IETF RFC 7694
HTTP Client-Initiated Content-Encoding ).

6.3.2. Replies

1. The reply compression is performed only if explicitly requested by the client application.

2. The client application must declare that it accepts compression by setting a Accept-Encoding
HTTP header to the B2B Request (see '5.3.4 Accept-Encoding' in IETF RFC 7231 ).

3. The only supported compression algorithm is gzip.

4. Upon reception of such HTTP header the NM B2B compresses the reply, if larger than the
REPLY_COMPRESSION_THRESHOLD value, and set the Content-Encoding HTTP header of the reply (e.g.
Content-Encoding: gzip).

5. The processing time with or without compression is similar.

6. The compression ratio is around 10-20%.

6.3.3. Messages

1. The NM B2B decides, based on some internal algorithm, to compress or not the messages that it
publishes.

2. For more information about message compression criteria, see asynchronous reply message
compression and P/S message compression sections.

3. When NM B2B publishes a compressed message:

a. It sets the AMQP 1.0 message property content-encoding="gzip"

b. It sets the application property NM_CONTENT_ENCODING="gzip"

c. It compresses the message using the gzip algorithm.

6.4. Protocol Errors

1. See Protocol Errors.

Edition: 27.0 6 96
Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 7. Platforms, Service Locations and

Client Connections
1. To cope with contingency situations, the current deployment architecture
of the NM B2B services includes two distinct sites. The NM B2B services
are always served by a single site: the primary site in normal conditions,
and the contingency site in contingency situations.
IMPORTANT
2. The contingency procedure is activated in case of major catastrophe at
the primary site and is announced by different means, including AIMs,
contingency web site, press, etc. The access to the contingency site must
only be attempted in case the NM contingency has been announced.

7.1. Platforms
1. NM deploys the NM B2B services on distinct platforms with distinct purposes, enabled services,
data and access.

7.1.1. Pre-operational (PREOPS)

1. Purpose: The main purpose is to support the development and testing of B2B client
applications. This platform is also used to validate the correct behaviour of client applications
and to assess their readiness to be connected to the Operational platform (see below).

2. Deployed services: All services. See possible limitations in 'PREOPS Testing' sections of the
various specific service group reference manuals.

3. Data: All Operational data is replayed on the PREOPS platform (with some delays depending on
the type of data), with some exceptions. See 'PREOPS Testing' sections of the various specific
service group reference manuals. Note that the PREOPS platform may also contain test data
entered by other client applications as part of their own testing.

4. Access: Any valid PREOPS certificate.

5. Support: Normal office hours.

Edition: 27.0 6 97
Document Title: NM 27.0 - NM B2B Reference Manual

1. The NM B2B versions supported in the new NM release are deployed on the
PREOPS platform a couple of months before they become operational, so that
customers can start working on client application adaptations. During the time
between the PREOPS deployment and the OPS deployment, the PREOPS services
may undergo several updates due to final correction and tuning. The services
deployed on PREOPS remain available throughout the entire lifecycle of the
NOTE release, until the next release becomes available.

2. During development and testing, all client applications access the same PREOPS
services (deployed on the same PREOPS servers and using the same PREOPS
data). Consequently, specific testing policies are described in the "PREOPS
Testing" section of the various specific service group reference manuals, as
these policies are not necessarily the same for testing e.g. airspace availability
and flight filing services.

7.1.2. Operational (OPS)

1. Purpose: Expose the operational services in normal conditions (not in contingency situations).

2. Enabled services: All services.

3. Data: Airspace, flight and flow operational data.

4. Access: Any valid OPS certificate.

5. Support: 24/7 in normal conditions.

7.1.3. ENVPREVAL.NEXT

1. Purpose: Expose non-final next AIRAC airspace data. The final next AIRAC airspace data is
available in the Operational platform 6 days before the AIRAC switch. This platform has been
explicitly created to expose the next AIRAC data earlier than that, even if not yet final, to enable
flight plan validation against next AIRAC airspace data and detect possible issues at an earlier
stage.

2. Deployed services: Airspace data download and flight plan validation.

3. Data: Airspace Structure of the next AIRAC. In nominal situation the data is made available
between D-16 and D-14 depending on the complexity of the AIRAC changes. However, in
exceptional situations the publication may be slightly delayed. Note that the data is still subject
to changes until the AIRAC becomes operationnaly available, at D-6. No flight / flow data.

4. Access: Any valid OPS certificate.

5. Support: 24/7 in normal conditions.

In order to upload the new AIRAC data in the ENVPREVAL.NEXT platform, so that it
becomes available for download to client applications, the platform needs to be put
NOTE offline for few hours. Such intervention is preceded by an announcement on One
Sky Team with a rather short notice (few hours). The reason for such short notice is
to publish the data the same day, rather than waiting for the next day.

Edition: 27.0 6 98
Document Title: NM 27.0 - NM B2B Reference Manual

7.1.4. ENVPREVAL.ADHOC and ENVPREVAL.ADHOC5

1. Purpose: Expose future (under work) significant Airspace changes. Enable flight plan validation
against these changes.

2. Deployed services: Airspace data download and flight plan validation.

3. Data: Airspace Structure resulting from significant Airspace changes - for which NM has agreed
to support pre-validation to client applications - a number of days, weeks or months before the
corresponding AIRAC switch(es). The data is still subject to changes until the corresponding
AIRAC goes into force. No flight / flow data.

4. Access: Any valid OPS certificate.

5. Support: 24/7 in normal conditions.

In order to upload the Airspace changes to one of the ENVPREVAL.ADHOC platform,

so that they becomes available for download to client applications, the platform
NOTE needs to be put offline for few hours. Such intervention is preceded by an
announcement on One Sky Team. The announcement indicates the future change(s)
and the ENVPREVAL.ADHOC platform on which they will be exposed.

7.1.5. Contingency

1. Purpose: Expose the operational services in contingency situations.

2. Deployed services: All services.

3. Data: Airspace, flight and flow operational data.

4. Access: Any valid OPS certificate.

5. Support: 24/7 in contingency situations.

In case of site contingency, NM will update the DNS so that the contingency
IMPORTANT platform will be reachable with the Operational platform URLs. The DNS
propagation should take about 4 hours.

7.2. Service Locations

7.2.1. Request / Reply Services

1. The URL of a Request/Reply service conveys both the platform and the NM B2B version.

2. Besides, since a request type defines entirely the port type that handles it and the request type is
part of the message, the location of the port type is actually independent of the port type: for a
given NM B2B version on a given platform, NM exposes all its services via a single URL.

3. The service location for a given platform/version is:

Edition: 27.0 6 99
Document Title: NM 27.0 - NM B2B Reference Manual

https://<platform_domain>:<platform_port>/<platform_name>/gateway/spec/<b2b_version
>.0

where:

a. <platform_domain> is:

i. www.b2b.preops.nm.eurocontrol.int for the pre-operational platform

ii. www.b2b.nm.eurocontrol.int for the following platforms: operational,

ENVPREVAL.NEXT, ENVPREVAL.ADHOC and contingency

b. <platform_port> is 443

c. <platform_name> is:

i. B2B_PREOPS for the pre-operational platform

ii. B2B_OPS for the operational and contingency platforms

iii. B2B_ENVPREVAL_NEXT for the ENVPREVAL.NEXT platform

iv. B2B_ENVPREVAL_ADHOC for the ENVPREVAL.ADHOC platform

v. B2B_ENVPREVAL_ADHOC5 for the ENVPREVAL.ADHOC5 platform

d. <b2b_version> is the requested B2B version (e.g. "26.0" or "27.0")

e. .0 is simply the literal ".0" (dot zero) - due to historical reasons

4. To reach the NM B2B version 27.0, the supported URLs are:

a. Pre-operational (PREOPS):

https://www.b2b.preops.nm.eurocontrol.int:443/B2B_PREOPS/gateway/spec/27.0.0

b. Operational (OPS) and contingency:

https://www.b2b.nm.eurocontrol.int:443/B2B_OPS/gateway/spec/27.0.0

c. ENVPREVAL.NEXT:

https://www.b2b.nm.eurocontrol.int:443/B2B_ENVPREVAL_NEXT/gateway/spec/27.0.0

For backward compatibility reason, and until the deployment of NM-27.0, the
ENVPREVAL.NEXT platform is also reachable at

https://www.b2b.nm.eurocontrol.int/B2B_EP1/gateway/spec/27.0.0

d. ENVPREVAL.ADHOC:

https://www.b2b.nm.eurocontrol.int:443/B2B_ENVPREVAL_ADHOC/gateway/spec/27.0.0

For backward compatibility reason, and until the deployment of NM-27.0, the
ENVPREVAL.ADHOC platform is also reachable at

https://www.b2b.nm.eurocontrol.int/B2B_EP3/gateway/spec/27.0.0

Edition: 27.0 6 100

Document Title: NM 27.0 - NM B2B Reference Manual

e. ENVPREVAL.ADHOC5:

https://www.b2b.nm.eurocontrol.int:443/B2B_ENVPREVAL_ADHOC5/gateway/spec/27.0.0

For backward compatibility reason, and until the deployment of NM-27.0, the
ENVPREVAL.ADHOC5 platform is also reachable at

https://www.b2b.nm.eurocontrol.int/B2B_EP5/gateway/spec/27.0.0

7.2.2. File Download Services

1. The file download service location for a given platform is:

https://<platform_domain>:<platform_port>/FILE_<platform_name>/gateway/spec/<file-
id>

where:

a. <platform_domain>, <platform_port> and <platform_name> are the same as the ones defined in
the Request / Reply Services section;

b. <file-id> is the id of the File to download, e.g.

AIXMFile/20220603/CDS/27.0.0/AirportHeliport.BASELINE.zip.

7.2.3. Message Services

1. Here are the parameters for connecting to the B2B Broker and consuming the messages over
AMQP 1.0.

2. URL: one of the following:

◦ for operational use in normal circumstances and for contingency in case of contingency

amqps://pubsub.nm.eurocontrol.int:5671 (for queues over Internet)

amqps://pubsub.nm.eurocontrol.int:15671 (for queues over PENS)

◦ for pre-operational use (not available in contingency situations)

amqps://pubsub.preops.nm.eurocontrol.int:5671 (for queues over Internet)

amqps://pubsub.preops.nm.eurocontrol.int:15671 (for queues over PENS)

3. Destination:

◦ queue://<queue_name>

(or simply <queue_name> depending on the client library)

where the <queue_name> is specified in the SubscriptionCreationReply object returned upon a

SubscriptionCreationRequest.

Edition: 27.0 6 101

Document Title: NM 27.0 - NM B2B Reference Manual

4. NOTE on TLS:

Like in the NM B2B SOAP Request/Reply paradigm, the AMQP 1.0 connection to the NM B2B
Broker must be done over TLS. The NM B2B Broker requires certificate-based client application
authentication, so the client application must provide its full certificate chain. The client
certificate required for the NM B2B Broker Message Consumption is the same as for the
NM B2B Request/Reply.

5. NOTE on AMQP 1.0 Connections:

Once an AMQP 1.0 connection is established with the NM B2B Broker, it may be kept open for an
indefinite period of time. This is a requirement for the PUSH methodology. However, NM may
drop the client connection at any time, and will certainly do so at each maintenance window. It
is therefore paramount that the client application which is managing the AMQP 1.0
connection with the NM B2B Broker is able to automatically re-connect when the
connection goes down. The client application should allow a few seconds before trying to re-
connect.

7.3. Client Connection

7.3.1. Source IP Addresses

1. NM B2B clients may connect to the NM B2B from static or dynamic IP addresses.

2. NM does not enforce any rule on these IP addresses. However, NM recommends the users to
communicate their static source IP addresses for the following reasons:

a. In case of DoS or similar attacks coming from multiple IP addresses simultaneously, NM may
decide to deny all connection attempts except for those coming from white-listed IP
addresses. If the NM B2B clients' source IP addresses are not known to NM, they cannot be
white-listed and therefore in such cases the B2B client will experience a service
unavailability.

b. NM keeps track of all source IP addresses and builds statistics. It is the intention of NM to
implement a service to inform the B2B users about the IP addresses that were used to
establish connections for each client certificate and/or to highlight/alert when new
unknown IP addresses are detected.

3. NM B2B Users that deploy their NM B2B client systems in the cloud, should consider using static
outbound IP addresses (via the cloud provider’s NAT services) and communicate such addresses
to NM.

7.3.2. Client Connection (and Disconnection) to the NM B2B Broker

1. In order to start consuming messages, the client application needs to establish a connection
with the NM B2B Broker.

2. To do so, the customer needs to know the B2B Broker’s URL and the name of the queue (also
known as destination), and to setup their TLS credentials correctly. Please refer to section
Message Services.

Edition: 27.0 6 102

Document Title: NM 27.0 - NM B2B Reference Manual

In AMQP 1.0 terms the connection is established via the open performative.

3. Once a connection is established, the client application needs to begin a session (via the begin
performative), and attach a receiver link, i.e. a consumer (via the attach performative).

4. IMPORTANT: While it is allowed, and in some cases even recommended (see paragraph
Message consumption), to connect more than one consumer to the same destination, NM sets
limits to both the number of connections and consumers a client application can attach to the
NM B2B broker. The following limits are set on the NM B2B broker:

◦ Max global number of connections:

This is the maximum number of simultaneous connections the NM B2B broker can accept.

This limit has been put in place to protect the NM B2B broker’s resources.

◦ Max number of connections from same IP address:

This is the maximum number of simultaneous connections the NM B2B broker can accept
coming from the same IP address.

This limit has been put in place in order to prevent that a single client application
accidentally creates a large number of connections on the B2B broker causing the global
connection limit to be reached and hence leaving no available connections to other client
applications.

The limit is currently set to 20.

Please note that this parameter does not limit the number of consumers and that the same
connection may contain several consumers.

◦ Max number of consumers attached to a queue:

This is the maximum number of simultaneous consumers that each queue can accept
(regardless of the connections the consumers are embedded into).

So for example if we consider the two following cases:

▪ Case 1: 1 connection with 10 consumers attached to queue A

▪ Case 2: 10 connections, each with 1 consumer attached to queue B

then both Case 1 and Case 2 equally account for having 10 consumers simultaneusly
attached to a queue and therefore both queue A and B have reached the consumers limit.

The limit is currently set to 10.

5. The client application is now ready to receive messages. This is done via the other three
performatives transfer , flow and disposition

6. Many client applications will use libraries that abstract the use of AMQP 1.0 performatives and
provide a simpler or already known API such as JMS. But the above concepts remain valid
regardless of the library used.

Edition: 27.0 6 103

Document Title: NM 27.0 - NM B2B Reference Manual

7. IMPORTANT: It is important to notice that these operations shall be done once and the
connection/session/link should always be kept open. Do not re-create a connection/session/link
unless it goes down. This channel is supposed to remain open (possibly forever) to allow a
continous flow of messages.

8. However, a client application must be able to cope with sudden disconnections that may be due
to network outages, NM maintenance interventions, etc.

Edition: 27.0 6 104

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 8. Access to Services

8.1. Authentication
8.1.1. Client

Last updated: 27.0 - Edition 2

1. In order to gain access to the NM B2B services, customers need to request access and sign an
agreement with NM. The form for requesting access to NM B2B services can be found here:
https://www.eurocontrol.int/network-operations/access-service-request-form.

2. The customer must request access to specific B2B services on the pre-operational
(testing/validation) and/or the operational platform.

3. These access requests are distinct and trigger slightly different processes. On success, the
requester receives the technical details on how to access the accepted services and the
authentication credentials (if the customer is new).

4. Authentication of the access to the NM B2B services is achieved through client certificates (see
Public Key Infrastructure (PKI). The certificates provided by NM are "Enterprise PKI Lite For
Personal Digital ID" created for EUROCONTROL by GlobalSign Certificate Authority (CA). For
information on the Certificate Practices Statement (CPS) and the Certificate Policy (CP) of these
certificates see Certificate Practices Statement.

5. NM creates different accounts and issues distinct certificates to access the pre-operational and
operational platforms. The certificates for accessing the pre-operational platform are called
"test certificates". Access is denied if a client application attempts to use a test certificate to
access operational services.

6. As a result of the successful access request process, the customer receives from NM an
encrypted PKCS#12 file that contains; the client’s public key certificate, the client’s private key,
and the public key certificate of the issuing Certificate Authority. A PIN is needed in order to
activate the certificate; the customer obtains this PIN by calling the NM CSO Helpdesk.

7. The customer accounts and the corresponding certificates are independent from the NM
release. As long as it is not revoked, an account created for NM release X can also be used for
releases X+1, X+2, etc. However, a certificate has a validity period of three years. The customer
must submit a request for a new certificate via the NM Services Request form at least two
months before the end of this period.

8. Customers need to configure the certificates on their client application platform. The details on
how to do so depend on the platform. Additionally, the details on how to write/run the client
application to authenticate using the certificate depends on the technologies used by the
customer.

9. The certificate is used during the establishment of the TLS connection between the client
application and the NM access infrastructure. The data in the certificate must not be corrupted
and the certificate itself must not have been revoked via a certificate revocation list.

Edition: 27.0 6 105

Document Title: NM 27.0 - NM B2B Reference Manual

8.1.2. Server

Last updated: 27.0 - Edition 2

1. To establish the TLS connection, the operational and pre-operational B2B servers use a TLS
server certificate (sometimes called SSL certificate), issued by the Certificate Authority. The TLS
server certificate corresponds to the domain host name of the server.

2. B2B client applications may want to store the public key certificate of the Certificate Authority
in their local certificate store and use it for authenticating the B2B servers at TLS session
establishment time, this ensures their client applications can perform server authentication
against the Certificate Authority.

3. The TLS server certificates used by NM typically have a lifetime of one year and are then
replaced by a new certificate. B2B client applications that perform server authentication against
the Certificate Authority stored in their local certificate store are not impacted by these updates.

4. Nevertheless, to avoid connection problems due to a failing server authentication in the client
application, NM will announce installation of a new TLS server certificate a few days in advance
to the customers. The announcement will specify the date and time of the new certificate’s
installation and will include a copy of the new certificate. This should allow customers who are
performing server authentication directly against the NM B2B TLS certificate, instead of relying
on the Certificate Authority, to update their configurations.

8.2. Access Control

8.2.1. Overview

Last updated: 27.0 - Edition 2

1. NM B2B exposes services, e.g. the S-R/R FlightListByAerodromeRequest/Reply.

2. Each NM B2B service reads / writes resources, e.g. the the S-R/R
FlightListByAerodromeRequest/Reply reads flights.

3. NM B2B implements service and resource access control:

a. Service access control consists in checking the access to a service, e.g. verifying the access
to the S-R/R FlightListByAerodromeRequest/Reply.

b. Resource access control consists in checking the access to a resource, e.g. verifying the read
access to the flight proposals in the OPERATIONAL dataset.

4. On both services and resources, NM B2B implements a two steps access control:

a. Service / resource access enablement control consists in checking that the access to a
service or a resource is enabled, independently of the client application / certificate, e.g.
verifying that the S-R/R RegulationCreationRequest/Reply is enabled on the OPERATIONAL
dataset.

b. Service / resource access authorisation control consists in checking that the access to a
service or a resource is granted to the client application / certificate / acting air navigation
unit, e.g. verifying that the certificate has the right to execute a S-R/R

Edition: 27.0 6 106

Document Title: NM 27.0 - NM B2B Reference Manual

RegulationCreationRequest/Reply and to write a regulation on the OPERATIONAL dataset.

1. Any attempt to access a disabled service/resource is reported to the client

application as a Reply with status SERVICE_UNAVAILABLE.

The disabled service/resource accesses are reported in the reason

attribute.
IMPORTANT
2. Any attempt to access a not authorised service/resource is reported to the
client application as a Reply with status NOT_AUTHORISED.

The not authorised service/resource accesses are reported in the reason

attribute.

8.2.2. Resources

8.2.2.1. Resource Model

Last updated: 27.0 - Edition 2

1. The resource access control requires a resource model that identifies the accessed resources.

◦ The resource model is a conceptual model that aims at

enabling/facilitating discussions between NM business experts, NM
technical experts, NM customer support and customers.

It describes resources in a logical/business manner, without entering

the technical implementation details.

IMPORTANT The resource model should not be confused with the exchange model.

◦ The purpose of the resource model is to support the resource access

control (enablement and authorisation).

It does not aim at describing the NM B2B resources in an exhaustive

manner.

2. The resource model is organised as:

◦ a set of resource types

◦ three dataset resource trees: OPERATIONAL, FORECAST and SIMULATION

3. A resource type identifies a type of resource, e.g. Flight.

A resource type might declare attributes. The purpose of attributes is twofold:

a. enable the access control on resources according to some attribute value, e.g. control the
access on the Flights such that proposal attribute is true

b. enable the access control on resource fragment, e.g. control the access on the ccams_ssr_code

Edition: 27.0 6 107

Document Title: NM 27.0 - NM B2B Reference Manual

attribute of any Flight

4. The three dataset resource trees share the same organisation.

5. The complete resource model is presented here.

Example 1. Resource model (fragment)

• Resource types

◦ Flight - a flight as it exists in NM systems

Attributes

▪ sensitive - indicate whether the flight is sensitive or not

▪ proposal - indicate whether the flight is a proposal or not

▪ avoided_regulations - the identifiers of the regulations that have been avoided by

the different flight plan changes

▪ ccams_ssr_code - the CCAMS SSR codes associated to the flight

▪ …

◦ TrafficCount - a traffic count

◦ …

• Dataset resource tree

◦ /flights - the Flight resources in the dataset

◦ /counts - the TrafficCount resources in the dataset

◦ …

8.2.2.2. Identifying Resources

Last updated: 27.0 - Edition 2

1. A resource or a collection of resources is identified by a <path>?<query>#<fragment> expression:

where

a. <path> is a mandatory path in the resource tree, e.g. /flights

b. <query> is an optional attribute based query, e.g. proposal=true

c. <fragment> is an optional resource attribute, e.g. ccams_ssr_code

For example:

◦ /flights identifies the flights in the dataset

◦ /flights?proposal=true identifies the flight proposals in the dataset

◦ /flights#ccams_ssr_code identifies ccams_ssr_code attribute values of the flights in the

Edition: 27.0 6 108

Document Title: NM 27.0 - NM B2B Reference Manual

dataset

◦ /flights?proposal=true#ccams_ssr_code identifies the ccams_ssr_code attribute values of the

flight proposals in the dataset

8.2.3. Air Navigation Unit (ANU)

Last updated: 27.0 - Edition 2

1. An Air Navigation Unit, an ANU in short, represents a business actor interacting with the
Network Manager.

8.2.3.1. ANU Exposure

Last updated: 27.0 - Edition 2

1. Since NM 27.0, the AirspaceStructure port type exposes some types of ANU.

2. Each ANU is exposed as:

a. a Unit feature that represents the ANU

b. one of an AirTrafficControlService feature, an AirTrafficManagementService feature or an

InformationService feature that describes the service delivered by the ANU as well as its area
of responsibility (airports and/or airspaces)

3. The designator attribute of an exposed Unit feature is the ANU identifier.

8.2.3.2. Acting ANU

Last updated: 27.0 - Edition 2

1. NM associates to each certificate an ANU (more precisely an ANU identifier).

2. Since NM 27.0, the user has the possibility to ask NM the authorisation to send requests in name
of one or more distinct ANUs. The purpose of such a feature is, for example, to allow an ANSP to
send requests in name of distinct FMP’s and/or distinct DPIO’s. Once the demand is approved by
NM, the client application can file the onBehalfOfUnit request attribute.

3. NM B2B considers as acting ANU:

◦ the onBehalfOfUnit value if provided

◦ otherwise, the ANU associated to the certificate

Any attempt to send a request with an onBehalfOfUnit value that was not
IMPORTANT previously approved by NM is reported to the client application as a Reply
with status NOT_AUTHORISED.

8.2.4. Access Rights

Edition: 27.0 6 109

Document Title: NM 27.0 - NM B2B Reference Manual

8.2.4.1. Certificate Access Rights

Last updated: 27.0 - Edition 2

1. NM B2B Support assigns, in agreement with the user, access rights to the user certificate(s).

2. These access rights are expressed in terms of:

◦ Execute service access rights, e.g.

--x FlightManagement FlightListByAerodromeRequest/Reply

The certificate is authorised to execute FlightManagement

FlightListByAerodromeRequest/Reply.

◦ Read or read/write resource access rights e.g.

rw- /flights#departure_info

The certificate is authorised to read and write the departure information of flights.

3. The user can at any time consult its access rights by downloading a User Information Report
thanks to the GeneralInformation.NMB2BInfo S-R/R UserInformationRequest/Reply.

8.2.4.2. ANU Access Rights

Last updated: 27.0 - Edition 4

1. In addition to the certificate access rights, NM B2B also grants to some ANUs that satisfy some
criteria some specific resource access rights.

2. The table below summarises these ANU specific access rights.

Table 4. Acting ANU Granted Resource Access Rights

ANU Criteria Granted Access Rights

ANU is APR rw- /flights#aircraft_position_report

enabled (1)
rw- /flights#landing_info

An APR enabled ANU has write access to the aircraft position reports and the
landing information of the flights.

ANU type is AMC rw- /aups

rw- /restriction#activation_time_table?aup_activatable=true

An AMC ANU has write access to the AUPs. and the activation time table of the
AUP manageable restrictions (see AUP/UUP Manageable Restrictions).

Edition: 27.0 6 110

Document Title: NM 27.0 - NM B2B Reference Manual

ANU Criteria Granted Access Rights

ANU type is ARO (2) rw- /flights#departure_info

rw- /flights/messages/rea

An ARO ANU has write access to the departure information of the flights.

It can send REA messages.

ANU type is DPIO rw- /flights#departure_info?aerodromeOfDeparture={..}

rw- /flights#landing_info?aerodromeOfArrival={..}

A DPIO ANU has write access to the departure/landing information of the

flights departing from/arriving to an aerodrome for which it is responsible
(see InformationService clientAirport), e.g. LFPGDPIO has write access to the
departure information of the flights departing from LFPG.

ANU type is FMP rw- /restriction#activation_time_table?aup_activatable=true

rw- /flights#departure_info

rw- /flights/messages/rea

A FMP ANU has write access to the activation time table of the AUP manageable
restrictions (see AUP/UUP Manageable Restrictions) and to the departure
information of the flights.

It can send REA messages.

ANU type is one of rw- /flights#departure_info

ACC, APP or UAC (FSA
A FSA enabled ANU has write access to the departure information of the
enabled ANU)
flights.

ANU type is TWR rw- /flights#departure_info

rw- /flights/messages/rea

A TWR ANU has write access to the departure information of the flights.

It can send REA messages.

(1) The current version of the AirspaceStructure port type does not expose the APR enabled types of
ANU.

(2) The current version of the AirspaceStructure port type does not expose the ARO type of ANU.

Edition: 27.0 6 111

Document Title: NM 27.0 - NM B2B Reference Manual

8.2.5. Checking Resource Access Rights

Last updated: 27.0 - Edition 2

1. NM B2B implements two kinds of resource access checks.

2. An assertion defines a condition which, if not true, results in a resource access error.

For example, on the reception of a FlightListAerodromeRequest with

includeProposalFlights=true, NM B2B asserts that the certificate has access to the
/flights?proposal=true resource. If this is not the case, it returns a reply with status
NOT_AUTHORISED

3. A verification defines a condition which, if true, results in the return or publication of some
protected information.

For example, on the reception of a FlightListAerodromeRequest, NM B2B verifies whether the

certificate has access to the /flights?sensitive=true resource or not. If the certificate has access,
it includes the sensitive flights in the reply. Otherwise, the sensitive flights are not included in
the reply.

8.2.6. Documentation

8.2.6.1. Services

Last updated: 27.0 - Edition 2

1. The documentation of each service includes an access control paragraph organised as follows:

a. The global access mode of the service: READ or WRITE.

b. The accessed dataset: the dataset against which NM B2B implements the access controls.

c. The access check list: the list of access checks that NM B2B implements.

2. Each access check is documented as follows:

a. The assert or verify keyword

b. The checked access rights: certificate, anu or certificate, anu

c. The access mode: read access or write access

d. The accessed resource identifier, e.g. /flights?proposal=true

e. Some optional access criteria following an if keyword

A resource access can be conditioned by some additional criterion. For example, the
/flights?proposal=true is read by a S-R/R FlightListByAerodromeRequest/Reply only if
explicitly demanded in the payload of the request, i.e. if
request.includeProposalFlights=true.

f. If the check is a verification (verify keyword), the then keyword followed by the protected
information possibly returned by the replies or the P/S messages

Edition: 27.0 6 112

Document Title: NM 27.0 - NM B2B Reference Manual

3. See below some access control paragraph examples.

a. S-R/R FlightListByAerodromeRequest/Reply

Access control

▪ Access mode: READ

▪ Accessed dataset: the value of request.dataset.type

▪ Access check list:

▪ assert certificate read access to /flights

▪ assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

▪ verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

▪ assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

▪ assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

▪ assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

The above access check list should be interpreted as:

▪ NM B2B asserts the certificate read access to the flights.

▪ NM B2B asserts the certificate read access the dataset flight proposals if explicitly
demanded in the request payload, i.e. if request.includeProposalFlights=true.

▪ NM B2B verifies the certificate read access to sensitive flights, then if verified, includes
sensitive flights in the reply payload.

▪ NM B2B asserts the certificate read access to the avoided_regulations attribute of the
flights if explicitly demanded in the request payload, i.e. if
FlightField.avoidedRegulations is requested.

▪ NM B2B asserts the certificate read to the ccams_ssr_code attribute of the flights if
explicitly demanded in the request payload.

▪ NM B2B asserts the certificate read access to the traffic counts if

FlightField.worstLoadStateAtReferenceLocation is explicitly demanded (the read access
to the traffic counts is required to compute the worst monitored load state in which each
flight is involved).

Edition: 27.0 6 113

Document Title: NM 27.0 - NM B2B Reference Manual

b. S-R/R EarlyDPIRequest/Reply

Access control

▪ Access mode: WRITE

▪ Accessed dataset: OPERATIONAL

▪ Access check list:

▪ assert anu write access to

/flights#departure_info?aerodromeOfDeparture={request.aerodromeOfDeparture}

The above access check list should be interpreted as:

▪ NM B2B asserts the anu write access to the departure information of the flights
departing from the request’s aerodrome of departure.

8.2.6.2. Binding the Exchange Model to the Resource Model

Last updated: 27.0 - Edition 2

1. The resource model is expressed by means of business terms. It does not refer to the exchange
model data types, attributes, choices or enumeration values.

2. The binding of the exchange model to the resource model aims at specifying if the GET/SET of an
attribute, choice or enumeration value requires some read/write resource access.

3. The binding, when relevant, is documented in an Access control paragraph of the

documentation of the bound attribute, choice or enumeration value.

4. See below some attribute documentation examples:

a. Flight.ccamsSSRCode attribute

SSR code as assigned by CCAMS.

1. Access control

GET ccamsSSRCode requires read access to /flights#ccams_ssr_code

b. FlightListRequest.includeProposalFlights attribute

Determines if the selected traffic must include the proposal flights…

1. Access control

SET includeProposalFlights=true requires read access to /flights?proposal=true

Edition: 27.0 6 114

Document Title: NM 27.0 - NM B2B Reference Manual

8.2.7. User Information Report

Last updated: 27.0 - Edition 6

1. NM informs the user about service / resource enablement and authorisation via the S-R/R
UserInformationRequest/Reply.

2. In this version, NM chose to publish the report in a textual - humanly readable - format only.
Such a report is not aimed to be parsed or handled in an automated manner. In future versions,
NM might decide to enrich the report with other kind of information. NM might also decide to
publish the report in a more structured and machine-readable format.

3. The user information report is organised as follows:

◦ the service accesses

◦ the resource accesses

◦ the combined service - resource accesses

4. Each service / resource access is reported via two columns:

◦ the first column provides information about the service / resource enablement

◦ the second column provides information about the service / resource client application /
certificate authorisation

5. Each column is made of 3 flags:

◦ r or -: read access or not

◦ w or -: write access or not

◦ x or -: execute access or not

6. For example:

◦ Measures RegulationCreationRequest/Reply --- ---

Measures RegulationCreationRequest/Reply is not enabled and the client application is not

authorised to execute it.

◦ Measures RegulationCreationRequest/Reply --x ---

Measures RegulationCreationRequest/Reply is enabled but the client application is not

authorised to execute it.

◦ Measures RegulationCreationRequest/Reply --x --x

Measures RegulationCreationRequest/Reply is enabled and the client application is

authorised to execute it.

◦ operational/regulations?cherry_pick=true r-- ---

Read access to OPERATIONAL cherry pick regulations is enabled but the client application is
not authorised to read them.

◦ operational/regulations?cherry_pick=true r-- r--

Edition: 27.0 6 115

Document Title: NM 27.0 - NM B2B Reference Manual

Read access to OPERATIONAL cherry pick regulations is enabled and the client application
is authorised to read them.

◦ simulation/regulations?cherry_pick=true rw- ---

Read / write access to SIMULATION cherry pick regulations is enabled but the client
application is not authorised to read / write them.

◦ simulation/regulations?cherry_pick=true rw- r--

Read / write access to SIMULATION cherry pick regulations is enabled but the client
application is only authorised to read them.

◦ simulation/regulations?cherry_pick=true rw- rw-

Read / write access to SIMULATION cherry pick regulations is enabled and the client
application is authorised to read / write them.

Example 2. OPS ANSP user information report (fragment)

1. Service Accesses
Service Access
...
AIMs AIMListRequest/Reply --x --x
...
FlightManagement FlightListByAerodromeRequest/Reply --x --x
...
Measures RegulationListRequest/Reply --x ---
...

2. Resource Accesses
Resource Operational Forecast Simulation
...
/counts r-- --- r-- --- r-- ---
...
/flights r-- r-- r-- --- rw- ---
/flights#ccams_ssr_code r-- --- --- --- --- ---
/flights?proposal=true rw- --- r-- --- r-- ---
...
/regulations r-- r-- r-- --- rw- ---
...

3 Combined Service - Resource Accesses

...

Edition: 27.0 6 116

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 9. Quality of Service

Last updated: 27.0 - Edition 3

9.1. Throughput
1. The NM B2B enforces usage quotas to prevent the situation where a single user could exhaust
all available resources. The quotas established effectively enforce a maximum throughput per
user.

2. The quotas are explained in Service Usage.

9.2. Response Time

1. NM B2B provides for each service the measured response time at the 50%, 95% and 99%
percentiles, e.g.:

Response time: 20 / 460 / 1200 (ms)

2. The values provided represent the elapsed time measured in milliseconds (ms) between a
request being received at the NM B2B and a reply being delivered. In particular, they do not
include the network latency.

3. These measures are provided as a reference and are indicative of the empirical values observed
during operations.

For some recently deployed requests/replies, it might happen that NM could not
NOTE measure significant values during operations. In such cases, response time is
indicated as not available.

9.3. Availability
1. NM B2B publishes planned maintenance windows and unplanned outages in the NM B2B
OneSky Teams: https://ost.eurocontrol.int/sites/B2BWS/Lists/Announcements/AllItems.aspx .

Edition: 27.0 6 117

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 10. Service Usage

10.1. Usage Control Principles
Last updated: 27.0 - Edition 3

1. On the one hand, NM does not wish to impose limitations on the number of requests that a
given client application can submit: NM B2B will process requests as long as its resources are
not exhausted.

2. On the other hand, NM implements a mechanism that precludes the situation where the heavy
demand from a client application would prevent another client application to access the NM
B2B services.

3. The NM B2B decision to accept or reject a request depends on:

a. The load on the NM system resources

b. The client application activity

c. The quotas allocated to the certificate

4. The load on the NM system resources is categorised as follows:

a. Normal load: resources are not overloaded, i.e. the number of requests under processing is
in normal range, there is no risk of overload.

b. High load: resources are not overloaded, however, the number of requests under
processing is high, there is a risk of overload.

c. Overload: some resource is overloaded, it cannot handle new requests.

5. The client application activity is evaluated on the basis of the following metrics:

a. Parallel S-R/R count: the number of S-R/R (all types included), submitted by the client
application, being currently processed (the processing terminates when the synchronous
reply is returned).

b. Parallel A-R/R count: the number of A-R/R (all types included), submitted by the client
application, being currently processed (the processing terminates when the asynchronous
reply message is published).

c. Time window R/R counts: the number of Requests/Replies (S-R/R or A-R/R), per R/R type,
submitted by the client application, that have been processed during the last x minutes, x
being defined per R/R type.

d. Peak bandwidth consumption: the cumulative size of the replies (of any type) returned by
NM B2B in the last minute (short time window) to the client application.

e. Bandwidth consumption: the cumulative size of the replies (of any type) returned by NM
B2B in the last hour (large time window) to the client application.

f. P/S topic subscription counts: the number of P/S (non deleted) subscriptions, per P/S topic,
created by a client application.

6. By default, NM allocates the same quotas to all certificates.

Edition: 27.0 6 118

Document Title: NM 27.0 - NM B2B Reference Manual

a. The default global thresholds (thresholds that apply independently of the R/R type or P/S
topic) are:

▪ MAX PARALLEL S-R/R COUNT: 20

▪ MAX PARALLEL A-R/R COUNT: 10

▪ MAX PEAK BANDWIDTH: 100MB per minute

▪ MAX BANDWIDTH: 400MB per hour

b. The default time windows and time window R/R count thresholds are documented, per R/R
type, in the Request / Reply Count Quotas section of their service group Default Settings
appendix, e.g. Flight - Request / Reply Count Quotas.

c. The default P/S topic subscription count thresholds are documented, per P/S topic, in the P/S
Message Settings section of their service group Default Settings appendix, e.g. FLIGHT_DATA
- P/S Message Settings.

On explicit user demand, NM can allocate specific time window

IMPORTANT counts and bandwidth quotas. Such a demand shall be duly
motivated.

7. In conclusion, NM implements a self-regulating mechanism such that:

a. Client applications may consume the NM resources according to their usage quotas.

b. When a high load condition is met, priority is given to calls issued by client applications who
are consuming fewer resources at that given time.

c. In case of overload, all client applications are equally impacted.

This mechanism also makes the NM services less sensitive to denial of service attacks.

NM is however aware that some client applications serve more users than others, and therefore
might increase the time window counts and bandwidth quotas on a duly motivated user
demand.

10.2. Parallel Request Count Quotas

Last updated: 27.0 - Edition 3

NM recommends the client application to make its best effort to sequence the
CAUTION submission of the requests and avoid as much as possible the simultaneous
submission of multiple requests.

1. NM B2B asserts on each received request (S-R/R or A-R/R) that the client application complies
with its parallel request count quotas (see MAX PARALLEL S-R/R COUNT and MAX PARALLEL A-R/R
COUNT default values).

2. If NM B2B detects that the client application exceeds its parallel count quotas, it returns a Reply
with status PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED.

Edition: 27.0 6 119

Document Title: NM 27.0 - NM B2B Reference Manual

3. Parallel request count quotas are common to all client applications. They cannot be modified
for the specific needs of a user.

10.3. Time Window Request Count Quotas

Last updated: 27.0 - Edition 2

1. NM B2B measures the request counts per request type and per time window.

The time window duration is specific to the R/R type. See for example Flight -
NOTE
Request / Reply Count Quotas.

2. NM B2B categorises the time window counts as follows:

a. By default, a request is categorised as normal usage.

b. Above the overbooking threshold, a request is categorised as overbooking.

c. Above the max threshold, a request is categorised as quota exceeded.

3. NM B2B maintains metrics for each certificate and for each request type. Thus, a client
application can make a normal usage for the type A request, while overbooking the type B
request and exceeding its quota for the type C request.

4. The table below summarises the reply status returned by NM B2B according to the recent
customer activity and the load on the NM system resources.

Table 5. Time Window R/R Count Quotas - Returned Reply Status

Normal load High Load

Normal usage OK OK

count < overbooking

Overbooking OK REQUEST_OVERBOOKING_REJECTED

overbooking < count < max

Quotas exceeded REQUEST_COUNT_QUOTA_EXCEEDED REQUEST_COUNT_QUOTA_EXCEEDED

max < count

In case of normal load overbooking, NM B2B adds the following warning to the
reply:

NOTE
group: COMMON
category: GEN
type: REQUEST_OVERBOOKING_ACCEPTED

Edition: 27.0 6 120

Document Title: NM 27.0 - NM B2B Reference Manual

10.4. Bandwidth Quotas

Last updated: 27.0 - Edition 2

1. The bandwidth quotas aims at protecting the NM B2B services by preventing a client application
to consume an excessive bandwidth.

2. For a given client application, the bandwidth quotas encompasses the traffic generated by all
types of R/R.

3. NM B2B assesses the compliance to the bandwidth quotas against two time windows:

a. Peak bandwidth quotas compliance: NM B2B assesses that the bandwidth consumed by
the client application (the cumulated size of the replies returned by NM B2B to this client
application) during the elapsed minute is below the MAX_PEAK_BANDWIDTH).

b. Bandwidth quotas compliance: NM B2B assesses that the bandwidth consumed by the
client application (the cumulated size of the replies returned by NM B2B to this client
application) during the elapsed hour is below the MAX_BANDWIDTH).

4. When the measured client application bandwidth exceeds either the MAX_PEAK_BANDWIDTH or the
MAX_BANDWIDTH, NM B2B returns a reply with status BANDWIDTH_QUOTAS_EXCEEDED.

10.5. Resource Overload

Last updated: 27.0 - Edition 2

1. If NM B2B detects a system resource overload during the processing of a request (synchronous
or asynchronous), it returns a Reply with status RESOURCE_OVERLOAD.

10.6. Overall View

Last updated: 27.0 - Edition 2

1. The table below summarises the reply status values returned by NM B2B in case of excessive
usage and/or resource overload.

Table 6. Returned reply status

Reply status Condition

PARALLEL_REQUEST_COUNT The client application exceeds its parallel request count quota
_QUOTA_EXCEEDED
REQUEST_OVERBOOKING_RE The client application exceeds for this type of request its normal usage
JECTED quota (tries to overbook) while some resource is highly loaded
REQUEST_COUNT_QUOTA_EX The client application exceeds its time window request count quota for
CEEDED this type of request
BANDWIDTH_QUOTAS_EXCEE The client application exceeds its bandwidth or peak bandwidth quota
DED
RESOURCE_OVERLOAD Some NM B2B resource is overloaded

Edition: 27.0 6 121

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 11. Exchange Model

11.1. Introduction
1. Each service group defines its own exchange model: the set of requests, replies and data types
that logically belong to the service group.

2. Requests, replies and data types are defined and documented as classes, unions, enumerations
and typedefs.

3. Classes, unions and typedefs depend themselves on constrained strings and numbers.

4. This chapter describes how these exchange models are defined and how they are mapped to
XML schemas (XSD).

11.2. Strings
11.2.1. Overview

1. An NM exchange model expresses string constraints in a formal manner.

2. This section presents:

a. The grammar that is used to describe string patterns

b. The mapping rules that are applied to translate this formal patterns into XSD patterns

11.2.2. Grammar

1. A formal string validation language is defined: the EBNF (Extended Backus-Naur Form) of the
grammar is defined below.

a. Spaces are not permitted as delimiters anywhere, the grammar considers them always as
part of the rule.

b. As courtesy to the developer and not being part of the grammar, the multiplicity {1} can be
omitted and the parser will automatically apply {1} if it cannot find a multiplicity of a
textItem.

Edition: 27.0 6 122

Document Title: NM 27.0 - NM B2B Reference Manual

start = '' | listOrItems

listOrItems = orItem, { '|', orItem }
orItem = textItem, { textItem }
textItem = (groupOfTextDescriptors | textDescriptor),
multiplicity
groupOfTextDescriptors = '(', listOrItems, ')'
textDescriptor = ( charClass | charSequence | charLiteral )
charClass = 'ALPHA' | 'UALPHA' | 'LALPHA' | 'DIGIT' | 'HEXA'
| 'TEXT' |
'MULTILINE_TEXT'| 'WHITESPACE' | 'ANY'
charSequence = '"', charSequenceLiterals, { charSequenceLiterals
}, '"'
charLiteral = charLiteralWithoutEscapees | allEscapedCharacters
multiplicity = '{', digit, [ ',', digit ], '}'
charSequenceLiterals = charLiteralWoDoubleQuotesEscape |
escapedDoubleQuote |
escapedEscape
charLiteralWoDoubleQuotesEscape = charLiteralWithoutEscapees | '(' | ')' | '{' |
'}' |
'[' | ']' | '|'
charLiteralWithoutEscapees = a-zA-Z0-9_ -+/*<>=,.;:?!'~@#$%^&
allEscapedCharacters = escapedEscape | escapedDoubleQuote | '\(' | '\)'
| '\{' |
'\}' | '\[' | '])' | '\|'
escapedEscape = '\\'
escapedDoubleQuote = '\"'
digit = '0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'

2. charClass represents a class of characters in the value to be validated. In the grammar, the
charClass name is a terminal symbol.

Table 7. Available character classes

Class Definition

ALPHA all lower and upper case letters a to Z

LALPHA all lower case letters a to z

UALPHA all upper case letters A to Z

DIGIT all digits 0 to 9

HEXA all hexadecimal 0 to 9 A to F

TEXT the following characters: a-zA-Z0-9_ -+/*<>=,.;:?!'`"~@#$%^&(){}[]\

Edition: 27.0 6 123

Document Title: NM 27.0 - NM B2B Reference Manual

Class Definition

MULTILINE_TEXT the following characters: a-zA-Z0-9_ -+/*<>=,.;:?!'`"~@#$%^&(){}[]\ or

any of new_line carriage_return

WHITESPACE any of tab new_line carriage_return

SPECIAL_CHARACTER the following characters: _ -+/*<>=,.;:?!'`"~@#$%^&(){}[]\

ANY any character but new_line and carriage_return

11.2.3. XSD Mapping

1. A string is mapped to:

<xs:simpleType name="typedef-name" >

<xs:restriction base="xs:string"/>
<xs:pattern value="{pattern}"/>
</xs:restriction>
</xs:simpleType>

The {pattern} is evaluated according to the following character class mapping rules.

Table 8. Character class mapping

Class Definition
ALPHA [a-zA-Z]

LALPHA [a-z]

UALPHA [A-Z]

DIGIT [0-9]

HEXA [A-F0-9]

TEXT [a-zA-Z0-9_\-\+\(/)\*(<)(>)=,.;:?!'`(")(~)@#$%^(&)\(\)\{\}\[\]]

MULTILINE_TEXT [a-zA-Z0-9_\r\n\-\+\(/)\*(<)(>)=,.;:?!'`(")(~)@#$%^(&)\(\)\{\}\[\]]

WHITESPACE [ \t\r\n]

SPECIAL_CHARACTER [_\-\+\(/)\*(<)(>)=,.;:?!'`(")(~)@#$%^(&)\(\)\{\}\[\]]

ANY .

Edition: 27.0 6 124

Document Title: NM 27.0 - NM B2B Reference Manual

11.2.4. Examples

1. The UALPHA{4} pattern is mapped to the <xs:pattern value="[A-Z]{4}"/> XSD pattern.

2. The (DIGIT|UALPHA|.|_){1,500} pattern is mapped to the <xs:pattern value=""([a-zA-Z]|[0-

9])|(.|(_)){1,500}""/> XSD pattern.

11.3. Numbers
11.3.1. Overview

1. An NM exchange model makews use of the following concrete numbers: byte, double, float,
int, long, short.

2. Each number can be constrained to belong to a range [min, max[. By default, ranges are defined
as right end open intervals. Each interval bound can however be included or excluded.

11.3.2. XSD Mapping

1. A {number} is mapped to:

<xs:simpleType>
<xs:restriction base="xs:{number}>">
{number constraints}
</xs:restriction>
</xs:simpleType>

2. The {number constraints} are the usual XSD number bound constraints

<xs:minInclusive="{inclusive min}"/>
<xs:minExclusive="{exclusive min}"/>
<xs:maxInclusive="{inclusive max}"/>
<xs:maxExclusive="{exclusive max}"/>

11.4. Classes
11.4.1. Definition

1. A class definition includes:

a. The name

b. The abstract property and/or inheritance relation

c. A textual description

d. The attribute definitions

e. Additional constraints

Edition: 27.0 6 125

Document Title: NM 27.0 - NM B2B Reference Manual

2. An attribute definition includes:

a. The type

b. The name

c. The presence constraint (mandatory, optional or contextual)

d. A textual description

e. Additional type related constraints

11.4.2. XSD Mapping

1. A class is mapped to a global XML schema complex type according to the following rules:

a. The schema type name is equal to the class name

b. If the class is abstract, the schema type is defined abstract

c. If the class extends a base class, the schema type extends the schema type that represents
the base class

d. The list of attributes is mapped to a sequence of XML schema local elements which are
defined according to the following rules:

i. The element name is equal to the attribute name

ii. The element multiplicity reflects the combination of the attribute presence and
multiplicity:

A. 1..1 if the mapped attribute is mandatory and its type is not an array

B. 0..1 if the mapped attribute can be optional and its type is not a array

C. min..max if the mapped attribute is mandatory and its type is an array

D. 0..max if the mapped attribute can be optional and its type is an array

iii. The element type is evaluated according to the type of the mapped attribute

11.4.3. Examples

11.4.3.1. Common Services <<class>> LastUpdate

1. The LastUpdate class is defined as follows:

a. Describes when and by whom an object has been last updated

b. Attributes:

i. DateTimeSecond timestamp (Mandatory)

Time at which the object was created or last updated.

ii. UserId userId (Mandatory)

Id of the NOP user who created or last updated the object.

iii. AirNavigationUnitId airNavigationUnitId (Optional)

Edition: 27.0 6 126

Document Title: NM 27.0 - NM B2B Reference Manual

The ANU id associated to userId , if known by NM.

2. The LastUpdate XSD Representation is:

<xs:complexType name="LastUpdate" abstract="false">

<xs:sequence>
<xs:element name="timestamp" type="common:DateTimeSecond" minOccurs="1"
maxOccurs="1"/>
<xs:element name="userId" type="common:UserId" minOccurs="1" maxOccurs="1"/>
<xs:element name="airNavigationUnitId" type="common:AirNavigationUnitId"
minOccurs="0"

maxOccurs="1"/>
</xs:sequence>
</xs:complexType>

11.4.3.2. Airspace Services <<class>> ReferenceLocationAerodrome

1. The ReferenceLocationAerodrome class is defined as follows:

a. Reference to an aerodrome.

b. Inherits from: ReferenceLocation .

c. Attributes:

i. AerodromeICAOId id (Mandatory)

ICAO id of the referenced aerodrome.

2. The ReferenceLocationAerodrome XSD Representation is:

<xs:complexType name="ReferenceLocationAerodrome" abstract="false">

<xs:complexContent>
<xs:extension base="airspace:ReferenceLocation">
<xs:sequence>
<xs:element name="id" type="airspace:AerodromeICAOId" minOccurs="1"
maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

11.4.3.3. Flight Services <<class>> FlightOperationalLogEntry

1. The FlightOperationalLogEntry class is defined as follows:

a. Describes an entry in a flight operational log.

b. Attributes:

Edition: 27.0 6 127

Document Title: NM 27.0 - NM B2B Reference Manual

i. DateTimeSecond timestamp (Optional)

The date/time when the entry was recorded.

ii. FlightOperationalLogEntryType type (Optional)

The type of the operational log entry.

iii. int etfmsId (Optional)

The ETFMS unique id of the flight.

Constraint: Range: ]-∞,+∞[ .

iv. IFPLId ifplId (Optional)

The IFPL id of the flight, if any in ETFMS.

v. string issuer (Optional)

The identification of the issuer of the message, if any.

vi. string message (Optional)

The detailed text of the message (if the entry is a detailed entry).

vii. string[] summaryFields (Optional)

The summary fields (if the entry is a summary entry).

Constraint: Size must be comprised between 0 and 2147483646.

2. The FlightOperationalLogEntry XSD Representation is:

Edition: 27.0 6 128

Document Title: NM 27.0 - NM B2B Reference Manual

<xs:complexType name="FlightOperationalLogEntry" abstract="false">

<xs:sequence>
<xs:element name="timestamp" type="common:DateTimeSecond" minOccurs="0"
maxOccurs="1"/>
<xs:element name="type" type="flight:FlightOperationalLogEntryType" minOccurs="0"
maxOccurs=
"1"/>
<xs:element name="etfmsId" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:int"/>
</xs:simpleType>
</xs:element>
<xs:element name="ifplId" type="flight:IFPLId" minOccurs="0" maxOccurs="1"/>
<xs:element name="issuer" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="message" minOccurs="0" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="summaryFields" minOccurs="0" maxOccurs="unbounded">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>

11.4.4. Special remark on the mapping of Classes to XSD Types

1. A class is mapped to an XSD Complex Type Definition. Two aspects are considered to define the
mapping strategy:

a. Inheritance relationship

b. Attributes

2. The inheritance mapping has an equivalent in XSD: the complex type extension. An XSD
complex type extends another XSD complex type, e.g.:

Edition: 27.0 6 129

Document Title: NM 27.0 - NM B2B Reference Manual

<xs:complexType name="SpecialisedClass" abstract="false">

<xs:complexContent>
<xs:extension base="BaseClass">
...
</xs:extension>
</xs:complexContent>
</xs:complexType>

3. To map the set of a class attributes, two options were considered:

a. Mapping to an XSD "sequence" model group:

i. Enforces the child element order

ii. Is compatible with XSD complex type extension

b. Mapping to an XSD "all" model group:

i. Does not enforce child element order

ii. Is not compatible with XSD complex type extension

4. NM considered that losing the extension capability was of higher cost than the ordering
constraint, and therefore adopted the XSD "sequence" mapping approach.

11.5. Unions
11.5.1. Definition

1. A union is a polymorphic stereotype used in NM exchange models to model choices between

different representation of the same concept, e.g. a flight plan can be defined as a structure or
as a string that respects the ICAO format.

2. A union definition includes:

a. The name

b. A textual description

c. The choice definitions

d. Additional constraints

3. A choice definition includes:

a. The type

b. The name

c. The presence constraints (mandatory, optional or contextual)

d. A textual description

e. Additional type related constraints

Edition: 27.0 6 130

Document Title: NM 27.0 - NM B2B Reference Manual

11.5.2. XSD Mapping

1. A union is mapped to a global XML schema complex type according to the following rules:

a. The schema type name is equal to the union name

b. The list of choices is mapped to a choice of XML schema local elements which are defined
according to the following rules:

i. The element name is equal to the choice name

ii. The element multiplicity is 1..1

iii. The element type is evaluated according to the type of the mapped choice

11.5.3. Examples

11.5.3.1. Flight Services <<union>> FlightPlanInput

1. The FlightPlanInput union is defined as follows:

a. Flight plan information expressed in either a structural or a textual format.

b. Choices:

i. FlightPlan structural

Object used when the flight plan data is input in a structured manner.

ii. string textual

FPL message text used when the flight plan data is input via a string.

Two message formats are accepted: ICAO and ADEXP.

2. The FlightPlanInput XSD Representation is:

<xs:complexType name="FlightPlanInput">
<xs:choice>
<xs:element name="structural" type="flight:FlightPlan" minOccurs="1"
maxOccurs="1"/>
<xs:element name="textual" minOccurs="1" maxOccurs="1">
<xs:simpleType>
<xs:restriction base="xs:string" />
</xs:simpleType>
</xs:element>
</xs:choice>
</xs:complexType>

11.6. Enumerations

Edition: 27.0 6 131

Document Title: NM 27.0 - NM B2B Reference Manual

11.6.1. Definition

1. An enumeration definition includes

a. The name

b. The loose / strict property

c. The list of possible values

2. NM distinguishes loose and strict enumerations. Loose enumerations accept values that are not
strictly defined whereas strict enumerations do not. The purpose of loose enumerations is to
support enumeration values that might appear in further NM releases without requiring an
adaptation of the client applications.

3. Enumerations are loose by default: the << enumeration >> stereotype qualifies loose
enumerations. If an enumeration is strict, it is qualified by the << strict enumeration >>
stereotype.

11.6.2. XSD Mapping

1. An enumeration is mapped to a global XML schema simple type.

2. The simple type definition depends on the nature of the enumeration: loose or strict.

3. A strict StrictEnum { SE1, SE2, SE3 } enumeration is mapped to:

<xs:simpleType name="StrictEnum" >

<xs:restriction base="xs:string">
<xs:enumeration value="SE1"/>
<xs:enumeration value="SE2"/>
<xs:enumeration value="SE3"/>
</xs:restriction>
</xs:simpleType>

4. A loose LooseEnum { LE1, LE2, LE3 } enumeration is mapped to:

Edition: 27.0 6 132

Document Title: NM 27.0 - NM B2B Reference Manual

<xs:simpleType name="LooseEnum" >

<xs:union>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LE1"/>
<xs:enumeration value="LE2"/>
<xs:enumeration value="LE3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="OTHER:[a-zA-Z][a-zA-Z0-9_]*"/>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>

11.7. Typedefs
11.7.1. Definition

1. A typedef definition includes

a. A name

b. The underlying type (string or number)

11.7.2. XSD Mapping

1. A typedef is mapped to a global XML schema simple type.

2. The simple type definition depends on the nature of the typedef target type (boolean , byte ,
double , float , int , long , short or string ).

3. A typedef[boolean] is mapped to:

<xs:simpleType name="typedef-name" >

<xs:restriction base="xs:boolean"/>
</xs:simpleType>

4. A typedef[{number}] is mapped to:

<xs:simpleType name="typedef-name" >

<xs:restriction base="xs:{number}>">
{number constraints}
</xs:restriction>
</xs:simpleType>

Edition: 27.0 6 133

Document Title: NM 27.0 - NM B2B Reference Manual

5. A typedef[string] is mapped to:

<xs:simpleType name="typedef-name" >

<xs:restriction base="xs:string"/>
<xs:pattern value="{string pattern}"/>
</xs:restriction>
</xs:simpleType>

11.7.3. Examples

11.7.3.1. Airspace Services <<typedef[string]>> AerodromeICAOId

1. The AerodromeICAOId typedef is defined as follows:

a. ICAO id of an Aerodrome.

b. Pattern: UALPHA{4} .

2. The AerodromeICAOId XSD Representation is:

<xs:simpleType name="AerodromeICAOId">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z]{4}"/>
</xs:restriction>
</xs:simpleType>

11.8. Service Requests / Replies

11.8.1. Definition

1. Requests / replies are defined as classes.

2. A service request type is a concrete class that extends the abstract Request class.

3. A service reply type is a concrete class that extends the abstract Reply class.

4. By convention:

a. A request type name always ends with "Request"

b. The corresponding reply type name is always equal to the requested type name where
"Request" is replaced with "Reply"

11.8.2. XSD Mapping

1. Requests are mapped to the following pattern:

a. One XSD element

b. One complex type obtained according to the usual class XSD mapping

Edition: 27.0 6 134

Document Title: NM 27.0 - NM B2B Reference Manual

2. Replies are mapped to the following pattern:

a. One XSD element

b. One reply complex type that:

i. Extends the CommonServices Reply type

ii. Wraps a reply data element that contains the reply specific data

c. One reply data complex type that is obtained by applying the usual class XSD mapping

11.8.3. Examples

11.8.3.1. Flight Services <<request>> FlightPlanValidationRequest

1. The FlightPlanValidationRequest class is defined as follows:

a. Request to query the validation of an FPL according to the NM/IFPS validation rules.

b. The request provides the input flight plan information via a choice: either in string format
or via a FlightPlan structure.

c. Inherits from: Request

d. Attributes:

i. FlightPlanInput flightPlan (Mandatory)

Flight plan to be validated.

2. The FlightPlanValidationRequest XSD Representation is:

<!-- request element -->

<xs:element name="FlightPlanValidationRequest"
type="flight:FlightPlanValidationRequest"/>

<!-- request complex type -->

<xs:complexType name="FlightPlanValidationRequest" abstract="false">
<xs:complexContent>
<xs:extension base="common:Request">
<xs:sequence>
<xs:element name="flightPlan" type="flight:FlightPlanInput" minOccurs="1"
maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

11.8.3.2. Flight Services <<reply>> FlightPlanValidationReply

1. The FlightPlanValidationReply class is defined as follows:

a. Reply returned in response to FlightPlanValidationRequest.

Edition: 27.0 6 135

Document Title: NM 27.0 - NM B2B Reference Manual

b. Inherits from: Reply

c. Attributes:

i. IFPSError[] ifpsErrors (Mandatory)

Array of NM/IFPS errors in response to the flight plan validation.

Mandatory: the array is empty if there is no such error.

2. The FlightPlanValidationReply XSD Representation is:

<!-- reply element -->

<xs:element name="FlightPlanValidationReply"
type="flight:FlightPlanValidationReply"/>

<!-- reply complex type -->

<xs:complexType name="FlightPlanValidationReply" abstract="false">
<xs:complexContent>
<xs:extension base="common:Reply">
<xs:sequence>
<xs:element name="data" type="flight:FlightPlanValidationReplyData"
minOccurs="0"

maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<!-- reply data complex type -->

<xs:complexType name="FlightPlanValidationReplyData" abstract="false">
<xs:sequence>
<xs:element name="ifpsErrors" type="flight:IFPSError" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>

Edition: 27.0 6 136

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 12. Error and Warning Reporting

12.1. Principles
1. All NM B2B services report errors in the same way. Some services report warnings, also in the
same way.

The difference between an error and a warning is that an error prevents the transaction (read
and write) from being realised, whereas a warning does not.

2. The very existence of one or more errors resulting from a Request is expressed via the return
ReplyStatus reply.status: if reply.status is ReplyStatus.OK , the Request was processed without
error (but possibly with warnings).

3. If the reply.status value is not ReplyStatus.OK:

a. The reply does not return any other data than the error data

b. Unless the reply.status value is ReplyStatus.OBJECT_OUTDATED, in which case the latest

version of the object to be updated is typically returned (see concrete Reply types)

4. If the reply.status value is neither ReplyStatus.OK nor ReplyStatus.INVALID_INPUT, the

reply.status value is self-explanatory and the returned reply has a null inputValidationErrors
value; the reply.iputValidationErrors value is not null if and only if the reply.status value is
ReplyStatus.INVALID_INPUT.

5. Errors are typed using a three-dimensional path:

a. Service group: error first-level scope, namely the service group to which this error type
belongs

b. Error category: within a service group, errors are further logically organised into categories

c. Error type: the final concrete error, within a service group and an error category

This way of expressing error types has been preferred to a simple error type id because it is
in the customer’s interest to take advantage of the service group/error category
classification.

6. The error type identification follows these conventions:

a. The Error.group attribute is of type ServiceGroup, where ServiceGroup enumerates (in the
Common scope) the existing service groups

b. The Error.category value is a string<ErrorCategory> where ErrorCategory belongs to the

service group pointed out by Error.group. Each service group reference manual defines zero
or one ErrorCategory enumeration that lists the error categories for that service group. It is
because a port type in a service group may use an error category of another service group
that the Error.category type is string<ErrorCategory>, being conventionally understood that
the ErrorCategory refers to the ErrorCategory enumeration of the Error.group service group.

c. The Error.type value is a string<ErrorType> where ErrorType is an enumeration defined in

each service group that declares error types. Although the ErrorType is a real enumeration

Edition: 27.0 6 137

Document Title: NM 27.0 - NM B2B Reference Manual

from the XSD perspective, the ServiceGroup / ErrorCategory / ErrorType enumerations define
together an "enumeration tree", where ErrorType enumerates can only be used within the
context of a given ErrorCategory. The belonging of ErrorType enumerators to an
ErrorCategory is expressed within the reference manuals (ErrorType), not in the XSD.

The Common ErrorType includes some general error types that can be used in many port
types of potentially all service groups, like MISSING_MANDATORY_ATTRIBUTE.

7. Warnings are represented using Error objects but are expressed within the Reply.warnings
attribute.

12.2. Attribute Locations

1. The Error class lists the attributes involved in the error via the Set<string> Error.attributes . If
the error does not involve any attribute (e.g. for SLA errors), the Error.attributes set is left
empty.

2. The strings used in Error.attributes are either "attribute locations" or "attribute identifiers".

3. "Attribute locations" are structured strings:

a. The attribute location is relative to the root Request object

b. It uses attribute names separated by a “:” (colon) character

For example the FlightLevelRange flightLevelRange of an AbstractEAUPCDRRequest (see

Airspace Reference Manual ) is indicated as flightLevelRange.

The flightLevelRange min and max attributes are indicated as flightLevelRange:min and
flightLevelRange:max respectively.

c. In order to locate an item in a collection/array attribute, the item in the collection is

indicated with the attribute name, followed by the “#” (sharp) character, followed by the
index of the object in the collection (the first collection item has index 0)

For example the 8th UUID in UUID[] rsaUUIDs of an AbstractEAUPRSARequest is indicated as

rsaUUIDs#7; would the UUID class have an attribute called someAttr, this attribute would be
located with rsaUUIDs#7:someAttr.

4. "Attribute identifiers" are also structured strings:

a. It is prefixed by the four characters @ID=

b. The value following the prefix is that of the XML ID of the entry producing the error as
provided in the received message

For example, within a received AIXM message, being the mandatory gml:id an attribute type
XML ID, the timeslice with gml:id=ID_1 would be identified with an Error.attribute @ID=ID_1.

Edition: 27.0 6 138

Document Title: NM 27.0 - NM B2B Reference Manual

12.3. Protocol Errors

12.3.1. HTTP 400 - Bad Request

Last updated: 27.0 - Edition 3

1. The NM B2B services make use of the standard HTTP 400 error [Bad Request] if one of the
following conditions is met:

◦ The version in the URL is incorrect, e.g. https://www.b2b.nm.eurocontrol.int:443/B2B_OPS/

gateway/spec/24.0.0
◦ The request is not a well-formed XML and the request type cannot be read

◦ The request type is not supported by the B2B version

2. To facilitate the B2B developer’s work, in addition to the generic HTTP 400 error [Bad Request],
a free text is returned indicating the cause of the error. Below are some examples for the
conditions listed above.

Example 3. Invalid version

HTTP Response:

STATUS[400]: Version in root path 24.0.0 is not supported - must be one of

{26.0.0,27.0.0}

Edition: 27.0 6 139

Document Title: NM 27.0 - NM B2B Reference Manual

Example 4. Invalid XML declaration

Request payload:

<?xml version="1.0>
<ffice:FlightArrivalRequest
xmlns:ffice="eurocontrol/cfmu/b2b/FficeServices"
xmlns:fixm_base="http://www.fixm.aero/base/4.3"
xmlns:fixm_flight="http://www.fixm.aero/flight/4.3"
xmlns:fixm_nm="http://www.eurocontrol.int/nm/fixm/ext/1.5"
xmlns:fixm_ffice="http://www.eurocontrol.int/nm/fixm/app/ffice/1.1"
xmlns:common="eurocontrol/cfmu/b2b/CommonServices"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<endUserId>tstxb2b7</endUserId>
<sendTime>2022-09-30 07:20:00</sendTime>
<dayOfOperation>2022-09-30</dayOfOperation>
...
</ffice:FlightArrivalRequest>

HTTP Response:

STATUS[400]: Unable to createXMLStreamReader

Edition: 27.0 6 140

Document Title: NM 27.0 - NM B2B Reference Manual

Example 5. Malformed SOAP envelope

Request payload:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
</soap:Envelope>
<ffice:FlightArrivalRequest xmlns:ffice="eurocontrol/cfmu/b2b/FficeServices"
xmlns:fixm_base="http://www.fixm.aero/base/4.3"
xmlns:fixm_flight="http://www.fixm.aero/flight/4.3"
xmlns:fixm_nm="http://www.eurocontrol.int/nm/fixm/ext/1.5"
xmlns:fixm_ffice="http://www.eurocontrol.int/nm/fixm/app/ffice/1.1"
xmlns:common="eurocontrol/cfmu/b2b/CommonServices"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<endUserId>tstxb2b7</endUserId>
<sendTime>2022-09-30 07:20:00</sendTime>
<dayOfOperation>2022-09-30</dayOfOperation>
...
</ffice:FlightArrivalRequest>

HTTP Response:

STATUS[400]: NM 27.0.0 - invalid/malformed request:

com.ctc.wstx.exc.WstxParsingException: Unexpected close tag </soap:Envelope>;
expected </soap:Body>.
at [row,col {unknown-source}]: [4,15]

Edition: 27.0 6 141

Document Title: NM 27.0 - NM B2B Reference Manual

Example 6. NotificationRequest not supported in NM B2B 27.0

Request payload:

<ffice:NotificationRequest
xmlns:ffice="eurocontrol/cfmu/b2b/FficeServices"
xmlns:fixm_base="http://www.fixm.aero/base/4.3"
xmlns:fixm_flight="http://www.fixm.aero/flight/4.3"
xmlns:fixm_nm="http://www.eurocontrol.int/nm/fixm/ext/1.5"
xmlns:fixm_ffice="http://www.eurocontrol.int/nm/fixm/app/ffice/1.1"
xmlns:common="eurocontrol/cfmu/b2b/CommonServices"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<endUserId>tstxb2b7</endUserId>
<sendTime>2022-09-30 07:20:00</sendTime>
<dayOfOperation>2022-09-30</dayOfOperation>
...
</ffice:NotificationRequest>

HTTP Response:

STATUS[400]: NM 27.0.0 - Unexpected query:

namespace='eurocontrol/cfmu/b2b/FficeServices' localname='NotificationRequest'

The client application should not use the B2B’s reply to validate their
requests. The textual error message is provided as a help for quickly
IMPORTANT
identifying a problem. The client application shall validate the requests
against the provided XSD before sending them to the NM B2B.

12.3.2. HTTP 404 - Not Found

Last updated: 27.0 - Edition 3

1. The NM B2B services make use of the standard HTTP 404 error [Not Found] if the following
condition is met:

◦ The URL path is incorrect, e.g. https://www.b2b.nm.eurocontrol.int:443/B2B/gate/spectacular

12.3.3. HTTP 413 error - Request Entity Too Large

1. If the NM system receives an XML message that is too large (500 KB, where all input messages
should be considerably smaller), the HTTP status 413 is returned.

Edition: 27.0 6 142

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 13. Examples

1. The NM B2B documentation includes one plain XML and one SOAP Request / Reply example per
Request / Reply type.

2. The examples can be downloaded:

◦ from the One Sky Team website, or

◦ using the NM B2B S-R/R NMB2BScenariosRequest/Reply.

In this case, the download is two steps:

NOTE i. post a NMB2BScenariosRequest

ii. download the file returned by the NMB2BScenariosReply (see File

Download)

3. The request examples are valid with respect to the XSD and with respect to the constraints
defined in the NM B2B Reference Manual.

4. However, the request examples might not be semantically valid with respect to:

◦ the PREOPS data - this is typically true for all volatile data such as dates, flights, regulations,
etc.

◦ the business rules implemented by the NM system

The request examples are generated at build time using a third party library. Some
NOTE formatting aspects like the namespace declaration order or the generated
namespace aliases might change from one edition to another.

Edition: 27.0 6 143

Document Title: NM 27.0 - NM B2B Reference Manual

Part III: Service Groups

Edition: 27.0 6 144

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 14. Resource Model

14.1. Overview
1. The main purpose of the NM B2B resource model is to support the resource access control. As
such, the resource model does not cover all resources but only those that are explicitly
submitted to access control.

2. The resource model is organised as:

a. a set of resource types

b. three dataset resource trees: OPERATIONAL, FORECAST and SIMULATION

3. A resource type identifies a type of resource, e.g. Flight.

4. A resource type might declare attributes. The purpose of attributes is twofold:

a. enable the access control on resources according to some attribute value, e.g. control the
access on the Flight resources of which attribute proposal is true

b. enable the access control on resource fragments, e.g. control the access on the
ccams_ssr_code attribute of the Flight resources

5. The three dataset resource trees share the same organisation.

6. See also Access Control.

14.2. Resource Types

1. ATFCMSituation - an ATFCM situation

2. AUP - an Airspace Use Plan

◦ attribute owner - the owner of this AUP, typically an AMC

3. EHelpdeskTicket - a e-helpdesk ticket

◦ attribute kind - the kind of ticket, one of FORCE_FLIGHTS_IN_REGULATION,

UNFORCE_FLIGHTS_IN_REGULATION, EXCLUDE_FLIGHT_FROM_REGULATION,
REINCLUDE_FLIGHT_IN_REGULATION, IMPROVE_SLOT_IN_REGULATION, EXTEND_SLOT_IN_REGULATION,
SWAP_SLOTS_IN_REGULATION, ADD_FLIGHTS_IN_FMP_STAM_REROUTING,
REMOVE_FLIGHTS_FROM_FMP_STAM_REGULATION, INFORMATION or OTHER

4. Flight - a flight as it exists in the NM system

◦ attribute aerodrome_of_arrival - the flight aerodrome of arrival

◦ attribute aerodrome_of_departure - the flight aerodrome of departure

◦ attribute aircraft_position_report - a flight aircraft position report

◦ attribute avoided_regulations - the regulations that have been avoided by the different flight
plan changes

◦ attribute ccams_ssr_code - the CCAMS SSR code assigned to the flight

◦ attribute criticality - the flight criticality indicator

Edition: 27.0 6 145

Document Title: NM 27.0 - NM B2B Reference Manual

◦ attribute ctot - the calculated take-off time of a regulated flight

◦ attribute departure_info - the flight departure information

◦ attribute en_route_info - the flight en route information

◦ attribute fnm_oceanic_info - the flight oceanic information from FNM source

◦ attribute landing_info - the flight landing information

◦ attribute mfs_oceanic_info - the flight oceanic information from MFS source

◦ attribute proposal - a proposal=true flight is a proposition of flight from NM/ANSP to an

airspace user or another ANSP

◦ attribute sensitive - a sensitive=true flight is a flight whose access is restricted

◦ attribute target_time_over_fix - the target time over the relevant flight profile point for the
most penalizing regulation of the flight

◦ attribute traffic_volume_profile - the traffic volume profile (FTFM, RTFM or CTFM) of the
flight

◦ attribute performance_data - the performance data

◦ attribute take_off_weight - the take off weight

5. FlightMessage - a flight message

6. Hotspot - a hotspot

◦ attribute kind - the kind of hotspot: LOCATION_OF_INTEREST or PROBLEM

7. MCDMOnly - an MCDM only measure

◦ attribute cherry_pick - indicates whether the MCDM only measure is cherry pick or not

8. MCDMTopic - an MCDM topic

◦ attribute deadlines - the topic deadlines

◦ attribute actors - the actors of the topic

9. NetworkImpactAssessment - the network impact assessment of a regulation or a rerouting

creation/modification/cancellation or of a set of EHelpdesk tickets

10. Restriction - a restriction

◦ attribute activation_time_table - the restiction activation time table

◦ attribute aup_activatable - indicates whether the restriction can be activated via AUP

11. Regulation - a regulation measure

◦ attribute cherry_pick - indicates whether the regulation is cherry pick or not

◦ attribute excluded_flights - the list of flights excluded from this regulation

12. RegulationProposal - a proposal to NM for the creation/modification/cancellation of a regulation

◦ attribute cherry_pick - indicates whether the proposal is for a cherry pick regulation or not

13. Rerouting - a rerouting measure

◦ attribute cherry_pick - indicates whether the rerouting is cherry pick or not

Edition: 27.0 6 146

Document Title: NM 27.0 - NM B2B Reference Manual

◦ attribute captured_flights - the list of flights captured by this (cherry pick) rerouting

14. Scenario - a scenario

15. TacticalConfigurationPlan - a tactical configuration plan

16. Subscription - a subscription

◦ attribute filter - subscription filter

17. TrafficCount - a count

14.3. Resource Tree

• /atfcmSituations (ATFCMSituation)

the ATFCM situations

• /aups (AUP)

the Airspace Use Plans

• /counts (TrafficCount)

the traffic counts

• /ehelpdeskTickets (EHelpdeskTicket)

the e-helpdesk tickets

• /flights (Flight)

the flights

• /flights/messages/rea (FlightMessage)

the flight ready (REA) messages

• /flights/messages/rrn (FlightMessage)

the flight rerouting notification messages

• /flights/messages/rrp (FlightMessage)

the flight rerouting proposal messages

• /hotspots (Hotspot)

the hotspots

• /mcdmTopics (MCDMTopic)

the MCDM topics

Edition: 27.0 6 147

Document Title: NM 27.0 - NM B2B Reference Manual

• /networkImpactAssessments (NetworkImpactAssessment)

the network impact assessments

• /plans/capacity (TacticalConfigurationPlan)

the capacity plans

• /plans/otmv (TacticalConfigurationPlan)

the OTMV plans

• /plans/restrictionActivation (TacticalConfigurationPlan)

the restriction activation plans

• /plans/runwayConfiguration (TacticalConfigurationPlan)

the runway configuration plans

• /plans/sectorConfiguration (TacticalConfigurationPlan)

the sector configuration plans

• /plans/trafficVolumeActivation (TacticalConfigurationPlan)

the traffic volume activation plans

• /restrictions (Restriction)

the restrictions

• /regulations (Regulation)

the regulations

• /regulationProposals (RegulationProposal)

the regulation proposals

• /reroutings (Rerouting)

the reroutings

• /scenarios (Scenario)

the scenarios

• /subscriptions/flightData (Subscription)

the FLIGHT_DATA P/S subscriptions

• /subscriptions/mcdm (Subscription)

Edition: 27.0 6 148

Document Title: NM 27.0 - NM B2B Reference Manual

the MCDM P/S subscriptions

Edition: 27.0 6 149

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 15. Common

15.1. Context
Last updated: 27.0 - Edition 1

1. The Common service group defines and exposes services and data types that are used by all
business specific service groups.

2. It exposes the Requests/Replies that support the Publish/Subscribe message exchange pattern:

a. The SubscriptionManagement port type allows the client to manage its P/S subscriptions.

b. The Messaging port type allows the client to pull its messages from the queues by means of
SOAP Request/Reply, instead of connecting to the queues directly via AMQP.

B2B users are encouraged to access their queues by connecting

directly to the B2B Broker via AMQP 1.0.

The Messaging port type is provided to assist the user during an early
phase of the development.
IMPORTANT
It is intended for those B2B clients that do not have yet the
infrastructure to connect to the Broker via AMQP but would like to
validate some features offered by the subscriptions, such as message
filtering and payload configuration.

3. This service group defines data types for:

a. Temporal concepts

b. Kinematic concepts

c. Abstract Request, Reply or Message classes with their generic report status mechanism

d. Miscellaneous basic types

15.2. PREOPS Testing

1. There is no known limitation regarding the PREOPS behaviour of the Common services.

15.3. SubscriptionManagement Port Type

15.3.1. Overview

1. SubscriptionManagementService exposes the generic subscription management

Requests/Replies (that do not depend on a specific P/S topic):

a. S-R/R SubscriptionPauseRequest/Reply (new 27.0)

b. S-R/R SubscriptionResumeRequest/Reply (new 27.0)

Edition: 27.0 6 150

Document Title: NM 27.0 - NM B2B Reference Manual

c. S-R/R SubscriptionDeletionRequest/Reply (new 27.0)

d. S-R/R SubscriptionListRequest/Reply (new 27.0)

e. S-R/R SubscriptionHistoryRequest/Reply (new 27.0)

f. S-R/R SubscriptionSynchronisationRequest/Reply (new 27.0)

g. S-R/R SubscriptionSynchronisationAbortRequest/Reply (new 27.0)

1. The subscription management Requests/Replies, used to create, update or retrieve a

subscription, are exposed by the business port type to which the P/S topic belongs.

2. For example, the AIMs port type exposes AIMSubscriptionCreationRequest/Reply,

AIMSubscriptionUpdateRequest/Reply and AIMSubscriptionRetrievalRequest/Reply to respectively
create, update and retrieve a subscription to the ATM_INFORMATION topic.

3. See also Available Subscriptions.

15.3.2. Concepts

1. The Subscription Management API allows:

a. creating, updating, pausing, resuming and deleting subscriptions (see below)

b. listing and retrieving subscriptions

c. synchronizing a subscription (see below)

d. requesting the history of a subscription - the history of a subscription shows all the state
changes the subscription went through (see below)

2. When a new subscription is created, it is linked to a specific NM B2B version (see section
Subscriptions and NM B2B Versions below).

3. When a client requests to delete a subscription, the subscription is flagged by NM as deleted so

it will no longer collect messages, but it is kept in the NM system for auditing purposes. The
corresponding queue is later physically removed from the B2B Broker.

4. A subscription is always associated to exactly one queue. On the other hand, a queue can be
associated to more than one subscription. When creating a new subscription, it is the client’s
choice to indicate whether an existing queue should be reused or a new queue should be
allocated. When the client requests to reuse an existing queue, the NM system checks that all
subscriptions previously associated to the same queue belong to the same NM release and are
related to the same NM subscription topic. It is not possible to combine subscriptions on
different topics into the same queue.

5. A subscription can be suspended by NM (temporarily or indefinitely) for technical or

contractual reasons. In such a case the client is notified via a Technical Message (see below).

15.3.2.1. Subscription States

1. A subscription is always in one of the following states:

a. ACTIVE

It means the subscription is collecting messages on a queue and a client can consume them.

Edition: 27.0 6 151

Document Title: NM 27.0 - NM B2B Reference Manual

b. PAUSED

The subscription has been paused: the subscription is still valid but it is inactive, i.e. it does
not collect messages. A subscription can be paused either by the client or by NM. A client can
pause a subscription at any time by sending a specific request (see below). IMPORTANT: NM
can also pause a subscription and will do so as soon as published messages related to
that subscription expire (see section Message Time-To-Live). A paused subscription can be
resumed by the client by sending a specific request (see below).

c. SUSPENDED_ACTIVE

The subscription has been suspended by NM while it was ACTIVE. A suspended subscription
behaves like a PAUSED one in the sense that it does not collect messages, but in contrast with
pausing, only NM can suspend a subscription. Once a subscription is suspended, only NM
can un-suspend it. Un-suspending a SUSPENDED_ACTIVE subscription will set it back to
ACTIVE.

d. SUSPENDED_PAUSED

The subscription has been suspended by NM while it was PAUSED. The behaviour of a
subscription in state SUSPENDED_PAUSED is the same as for SUSPENDED_ACTIVE: it does
not collect messages. Un-suspending a SUSPENDED_PAUSED subscription will set it back to
PAUSED. Again, once a subscription is suspended, only NM can un-suspend it. The two
different SUSPENDED states (SUSPENDED_ACTIVE and SUSPENDED_PAUSED) are needed to
be able to go back to the original state before the suspension.

e. DELETED

The subscription has been deleted, either by the client or by NM. A DELETED subscription is
no longer available for further operations.

2. Note that a client can connect to the queue associated to a subscription even when the
subscription is paused or suspended. The states listed above are the states of the subscription,
not of the queue. When a subscription is deleted, the associated queue will be deleted only if it
has no other non-deleted subscriptions associated (a queue may be associated to more than one
subscription).

3. The following figure illustrates the possible state transitions:

Edition: 27.0 6 152

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 10. Subscription State Diagram

4. It is important to notice that when a subscription is created, it is initially in state PAUSED, and
therefore it does not collect messages on the queue. This is done so that a client can create a
subscription, test the connection and attach a listener to the connection, without being flooded
with messages right away. Then, when the client application is ready to receive the messages, it
can resume the subscription.

5. A subscription can be paused and resumed many times.

6. A subscription can be suspended and un-suspended many times.

7. When faced with a suspended subscription, a user shall not take any further actions on such
subscription. If the subscription was temporarily suspended because of maintenance, it will be
automatically un-suspended at the end of the maintenance. If it was suspended for another
reason, for example because the client is deemed to be inadequate to keeping up with the flow
of messages, this will be communicated (see SubscriptionUpdateReason below).

8. Once a subscription is deleted, it is no longer available for any other operation, i.e. DELETED is a
final state.

15.3.2.2. Subscription Lifecycle

1. Subscriptions are intended to be long-lived objects. Ideally, a subscription should be created

once and used for as long as the client application needs it. Only then a subscription should be
deleted.

2. As explained above, a subscription can be paused and resumed many times during its life.

3. A subscription should be deleted only when the client application no longer needs the data;

◦ Since NM 26.0, the Subscription Management API allows updating an existing subscription,
so there is no longer need to delete and recreate a subscription to modify its parameters
(message filtering and payload configuration).

Edition: 27.0 6 153

Document Title: NM 27.0 - NM B2B Reference Manual

1. A user should never delete a subscription to recreate an identical one.

IMPORTANT 2. If the subscription is automatically paused by NM due to the expiration

of a message, the client should resume the subscription rather than
delete and recreate it.

15.3.2.3. Subscription Synchronisation

Last updated: 27.0 - Edition 2

1. Since NM 27.0, the Subscription Management port type provides new S-R/R
SubscriptionSynchronisationRequest/Reply to "synchronise" an existing subscription (note that
for the moment the functionality is only available to the FLIGHT_DATA topic). The S-R/R takes as
input a time interval [wef, til] which represents the time period during which the
subscription was out-of-sync (more details below).

2. Upon synchronisation request, NM will republish the latest message of each flight matching the
subscription that was published (but potentially not consumed by the client) during the given
time interval, allowing the client application to quickly rebuild the most up-to-date view of the
flights.

3. This operation fulfills the following two use cases:

Case 1 - Initialising a newly created (or newly activated) subscription

When a subscription is created, it starts yealding messages as soon as it is activated, but it
may take some time until the client can build a complete flight view. This is because
messages are published only when some events cause significant changes in the flight. The
subscription synchronisation provides a convenient way to build-up a comprehensive up-to-
date flight view very quickly (more details below).

Case 2 - Re-synchronising a subscription on which the client went "out-of-sync"

When the client application loses some messages (e.g. due to a network problem, a
temporary pause, etc.), it goes "out-of-sync", i.e. some flights will not be up-to-date. This
situation will normally recover naturally after some time, due to the publication of new
messages on the same flights (when new events trigger changes to those flights). Note that
for cancelled or terminated flights, there will not be new events. The subscription
synchronisation functionality provides a convenient way to "resynchronise" a client that
went "out-of-sync" (more details below).

The NM B2B keeps a republication window of 6 hours (this parameter

is configurable by NM only), meaning that messages older than 6
IMPORTANT
hours will not be republished in response to a synchronisation
request.

Note that the republished messages are similar to any other message and that the
republication and normal publication are done in parallel, so republished messages (shown
in blue in the diagrams below) are mixed with the normal publication flow (shown in black).

When a synchronisation request is accepted, the following happens:

Edition: 27.0 6 154

Document Title: NM 27.0 - NM B2B Reference Manual

a. A new technical message ('SubscriptionSynchronisationTechnicalMessage') is published

to inform the client about the start of the republication. This technical message contains a
correlation Id that identifies the request.

b. All republished messages contain the correlation-id message property set to the above
correlation id (to indicate that the message was republished as a result of the
synchronisation request).

c. At the end of the republication, another 'SubscriptionSynchronisationTechnicalMessage'

is published informing about the end and the status of the republication.

The subscription synchronisation is a heavy operation and must be

IMPORTANT
used with care, i.e. only when really needed.

4. The following paragraphs detail the two cases described above.

15.3.2.3.1. Case 1 - Initialise a new subscription

Last updated: 27.0 - Edition 2

1. The following figure illustrates the use case:

Figure 11. Synchronisation of a new subscription

(1) Client creates a subscription (newly created subscriptions are in state PAUSED)

(2) At time TA, the client activates the subscription via the SubscriptionResumeRequest/Reply S-R/R
(the subscription becomes ACTIVE). From this moment (TA), new messages start being published
on the queue (depicted in black). The client can slowly build a full flight list as messages arrive,
but this may take some time (depending on the flights and the events).

(3) The client sends a synchronisation request with wef=null and til=TA. NM will republish on
the subscription queue the last message that was generated for each flight matching the
subscription (depicted in blue), giving the client the full situation at time TA.

15.3.2.3.2. Case 2 - Synchronise an out-of-sync subscription

Last updated: 27.0 - Edition 2

1. A subscription may go out-of-sync when it gets paused (or suspended), because during the time
the subscription is paused (or suspended), it yealds no messages.

Edition: 27.0 6 155

Document Title: NM 27.0 - NM B2B Reference Manual

2. Note that if an AMQP client disconnects only for a brief period of time (shorter than the
message’s TTL), the subscription is still in sync. This is very important, and it is depicted in
the following diagram.

Figure 12. Short client disconnection, subscription still ACTIVE

(1) Client is connected to the queue and consuming messages. Then, at time T1 it disconnects
from the queue. Note that the subscription remains ACTIVE (as long as messages do not expire
in the queue).

(2) At time T2, the client reconnects to the queue and resumes message consumption.

(3) Note that if the subcription is still ACTIVE, it means that all published messages are still in
the queue and no messages were lost. The consumption automatically resumes from where it
left.

When the client reconnects to the queue it MUST check the status of
IMPORTANT the subscription and if the status is ACTIVE it must not submit any
synchronisation request.

3. The use case of synchronising an out-of-sync subscription can be further subdivided in the
following two sub-cases:

Case 2a - The subscription was paused by the client

In this case, the client application knows the exact time the subscription was paused.

Case 2b - The subscription was paused (or suspended) by NM

In this case, the subscription was likely paused because some messages expired. The
subscription is paused as soon as the message expiration is detected by NM, which happens
after some time from the actual expiration (e.g. 1 minute later). The
SubscriptionTechnicalMessage that is published as a consequence of pausing the
subscription contains the time the subscription was paused but not the time of the first
message expiration. Hence the client does not know the exact time when it started losing
messages.

4. These two sub-cases are depicted below.

Edition: 27.0 6 156

Document Title: NM 27.0 - NM B2B Reference Manual

Case 2a - Synchronise a subscription paused by the client

1. This use case is depicted in the following diagram:

Figure 13. Subscription paused by client

(1) At time T1, the client application pauses the subscription. This pauses the message
publication.

(2) At a later time T2, the client resumes the subscription and hence resumes the nominal
message publication.

Note that at this point, the client is likely to be out-of-sync (if any message was supposed to be
published during the time the subscription was paused).

(3) The client may ask for a subscription synchronisation from time T1 to T2, which is the time
window during which the client was "blind".

2. NM will then republish messages that were created between T1 and T2.

If for a given flight, several messages were created (due to several events) between
NOTE
T1 and T2, only the latest, i.e. the most up-to-date, of these messages is republished.

Case 2b - Synchronise a subscription paused by NM

1. This use case is depicted in the following diagram:

Edition: 27.0 6 157

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 14. Subscription paused by NM

(1) At time TE, a message expires on the queue.

Note that, at this moment:

◦ there may be other messages in the queue, and the client may continue to consume those
messages

◦ the subscription is still ACTIVE

(2) At time TP, NM detects the expiration and pauses the subscription.

(3) At time TR, the client resumes the subscription, hence resuming the nominal message
publication.

Note that the client is out-of-sync from the moment the first message expired (TE), but the client
does not know TE.

(4) The user may request a subscription synchronisation up to TR, which is the time the client
resumed nominal message consumption. However, what would be the appropriate value for T1?
The appropriate value would obviously be TE, but as already stated above, this is not known.
The recommendation is to compute T1 as follows:

T1 = TP - TTL - 10min

where:

◦ TTL is the Message Time-To-Live

◦ 10min is just a margin to cover the elapsed time from TE to TP.

If the subscription is paused by NM due to slow message consumption, the

IMPORTANT user SHALL NOT submit synchronisation requests, but shall instead improve
the message consumption performance.

Edition: 27.0 6 158

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.2.4. Subscription’s last update

1. Every time a subscription state is modified the following attributes are updated:

◦ lastUpdatedBy

The user that performed the update: it is either the username associated with the user’s NM
B2B certificate or NM_ADMIN for NM.

◦ lastUpdatedOn

The timestamp of the update.

◦ lastUpdateReason

The reason for the update. This is an enumeration on which the user can rely to react
accordingly. IMPORTANT: See SubscriptionUpdateReason for more details about update
reasons and on how to react.

◦ lastUpdateComment

An optional comment that can in some cases provide more details about the update.

2. Every time a subscription update is performed (via SubscriptionUpdateRequest), the following

attributes are updated:

◦ versionNumber

The new version number of the subscription.

◦ description

The new description of the subscription.

◦ messageFilter

The new message filter of the subscription.

◦ payloadConfiguration

The new payload configuration of the subscription.

◦ lastUpdatedBy

The user that performed the update: it is either the username associated with the user’s NM
B2B certificate or NM_ADMIN for NM.

◦ lastUpdatedOn

The timestamp of the update.

◦ lastUpdateReason

Edition: 27.0 6 159

Document Title: NM 27.0 - NM B2B Reference Manual

The reason for the update.

◦ lastUpdateComment

An optional comment that can in some cases provide more details about the update.

15.3.2.5. Subscription Topics

1. For a complete list of subscription topics offered by NM refer to section Available Subscriptions.

15.3.2.6. Message Filtering

1. For some types of subscriptions, it makes sense to filter the messages before they are published
to the client queues, to avoid unnecessary processing of irrelevant messages on the client side.

2. In order to do so, some subscriptions may offer a filtering functionality in which a message-
specific filter can be set by the user when creating the subscription (see also Subscription
Model).

The AMQP 1.0 protocol provides a built-in support for message filtering.
However, this shall not be used because it would cause the filtered-out
messages to remain in the client queues on the B2B broker until they expire.
Then, when these messages will finally expire, they will cause the
IMPORTANT
subscription to be paused (see section Subscription States). The filtering
must be specified exclusively as part of the subscription creation using the
appropriate message filter classes provided by the SubscriptionManagament
interface.

15.3.2.7. Message Customisation (payload configuration)

1. Some types of messages may generate a very large payload because they can potentially contain
many large fields.

2. For these types of messages it may be desirable to choose which fields should be included in the
message payload.

3. NM will therefore create a custom P/S Message for each subscription according to the payload
configuration provided.

4. NOTE: Please note that reducing the message payload may result in delivering multiple identical
messages, e.g. in the following scenario:

a. A client creates a new subscription configuring the message payload to be composed solely
of fields F1, F2, and F3

b. The client receives a first message with F1, F2 and F3 set

c. The NM system generates a new message in which the only changes apply to fields F4 and
F5

d. According to the client subscription, NM would publish a new P/S message and set only
fields F1, F2 and F3, resulting in the same message previously delivered (because the NM
system does not check if a message is identical to the last message published on each queue)

Edition: 27.0 6 160

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.2.8. Subscriptions and NM B2B Versions

1. A subscription is created for a specific NM B2B version (as any NM B2B request must be issued
with an explicit NM B2B version number).

2. A subscription remains linked to the same NM B2B version throughout its whole lifecycle,
regardless to the NM release that exposes that NM B2B version.

3. This means that the P/S messages published on the associated queue will always be compatible
with the NM B2B version associated to the subscription.

4. It is the NM’s responsibility to make sure that the published P/S messages are adapted to the
correct NM B2B version for each subscription.

5. When an NM B2B version is no longer supported, all queues associated to that version can no
longer be re-used in new subscriptions and are therefore removed from the B2B Broker.

15.3.2.9. Maximum Number of Subscriptions

1. The number of subscriptions that a user can create is limited.

2. The maximum number of subscriptions allowed by NM is set per NM B2B certificate and per
subscription topic.

3. When the maximum number of subscriptions is reached, the user is not allowed to create new
subscriptions and must delete some existing ones.

4. Deleted subscriptions are ignored and not counted. All non-deleted subscriptions, whether they
are active, paused, etc, are counted against the maximum number.

5. The default values for the maximum number of subscriptions for each subscription topic can be
found in the Default Settings appendix of the corresponding service group. See for example
Airspace P/S Message Settings.

15.3.2.10. Subscription Model

1. The Subscription is the root class of the NM B2B subscription model.

2. The SubscriptionTopic is an enumeration of all the NM subscription topics to which a P/S client
can subscribe (see below).

3. Each subscription may define subscription filter and/or subscription payload configuration (see
below).

15.3.2.11. Error Handling

1. Following the NM B2B Error Handling pattern, all the errors related to
SubscriptionManagement have the following categorisation:

a. Group = ServiceGroup.COMMON

b. Category = ErrorCategory.SUBSCRIPTION_MANAGEMENT

c. Type = one of the enumeration values in type SubscriptionManagementErrorType (see below).

Edition: 27.0 6 161

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.2.12. Available Subscriptions

1. The NM B2B exposes the following subscriptions:

◦ AIRSPACE_DATA

◦ ATM_INFORMATION

◦ EAUP

◦ FFICE_PUBLICATION

◦ FFICE_FLIGHT_FILING

◦ FLIGHT_DATA

◦ FLIGHT_PLANS

◦ FLIGHT_FILING_RESULT

◦ REGULATIONS

◦ REROUTINGS

◦ MCDM

15.3.3. Requests/Replies

15.3.3.1. SubscriptionPauseRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionPauseRequest

Reply: SubscriptionPauseReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionPauseReply pauseSubscription(SubscriptionPauseRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Pauses an existing subscription.

Edition: 27.0 6 162

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.3.1.1. SubscriptionPauseRequest (new 27.0)

<<class>>

Request to pause a subscription.

A subscription can be paused and resumed many times.

This request works across NM releases, i.e.: the request is invoked on a specific NM release but it
can be used to pause a subscription created in a different NM release.

1. Inherits from: Request

2. Attributes:

a. UUID uuid (Mandatory)

The UUID of the subscription to pause.

b. boolean heartbeatEnabled (Optional)

This parameter allows disabling the publication of Heartbeat Messages (

HeartbeatTechnicalMessage ) on the associated queue while the subscription remains PAUSED .

Nothe that when the subscription is resumed (via the resumeSubscription operation) the
publication of Heartbeat Messages is automatically restored.

Default value is true .

15.3.3.1.2. SubscriptionPauseReply (new 27.0)

<<class>>

Returned in response to SubscriptionPauseRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionPauseReplyData data (Optional)

The reply payload.

Edition: 27.0 6 163

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.3.2. SubscriptionResumeRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionResumeRequest

Reply: SubscriptionResumeReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionResumeReply resumeSubscription(SubscriptionResumeRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Resumes anexisting subscription.

15.3.3.2.1. SubscriptionResumeRequest (new 27.0)

<<class>>

Request to resume a paused subscription.

This request works across NM releases, i.e., the request is invoked on a specific NM release but it
can be used to resume a subscription created in a different NM release.

1. Inherits from: Request

2. Attributes:

a. UUID uuid (Mandatory)

The UUID of the subscription to resume.

Edition: 27.0 6 164

Document Title: NM 27.0 - NM B2B Reference Manual

15.3.3.2.2. SubscriptionResumeReply (new 27.0)

<<class>>

Returned in response to SubscriptionResumeRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionResumeReplyData data (Optional)

The reply payload.

15.3.3.3. SubscriptionDeletionRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionDeletionRequest

Reply: SubscriptionDeletionReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionDeletionReply deleteSubscription(SubscriptionDeletionRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Deletes an existing subscription.

15.3.3.3.1. SubscriptionDeletionRequest (new 27.0)

<<class>>

Edition: 27.0 6 165

Document Title: NM 27.0 - NM B2B Reference Manual

Subscription deletion request.

Once a subscription is deleted it is no longer available for any other operation, i.e. the state DELETED
is a final state.

This request works across NM releases, i.e., the request is invoked on a specific NM release but it
can be used to delete a subscription created in a different NM release.

1. Inherits from: Request

2. Attributes:

a. UUID uuid (Mandatory)

The UUID of the subscription to delete.

15.3.3.3.2. SubscriptionDeletionReply (new 27.0)

<<class>>

Returned in response to SubscriptionDeletionRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionDeletionReplyData data (Optional)

The reply payload.

15.3.3.4. SubscriptionListRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionListRequest

Reply: SubscriptionListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionListReply listSubscriptions(SubscriptionListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 166

Document Title: NM 27.0 - NM B2B Reference Manual

Queries subscription.

15.3.3.4.1. SubscriptionListRequest (new 27.0)

<<class>>

List all subscriptions owned by an ANU.

This method always returns all the subscriptions owned by the calling ANU, no matter which NM
release they were created in.

1. Inherits from: Request

2. Attributes:

a. set< SubscriptionState > states (Optional)

Selects the subscriptions with a state that matches an entry in this set.

By default, when no state is given, only non-deleted subscriptions are selected.

i. Constraints:

▪ set size range : [1, unbounded[

15.3.3.4.2. SubscriptionListReply (new 27.0)

<<class>>

Returned in response to SubscriptionListRequest.

1. Inherits from: Reply

2. Attributes:

Edition: 27.0 6 167

Document Title: NM 27.0 - NM B2B Reference Manual

a. SubscriptionListReplyData data (Optional)

The reply payload.

15.3.3.5. SubscriptionHistoryRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionHistoryRequest

Reply: SubscriptionHistoryReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionHistoryReply subscriptionHistory(SubscriptionHistoryRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the history of a subscription.

To limit the size of the replies, in the current version, the maximum number of
NOTE
returned history items is set to 100.

15.3.3.5.1. SubscriptionHistoryRequest (new 27.0)

<<class>>

Operation to request the history of a subscription, i.e. all the changes of states performed on the
subscription.

Edition: 27.0 6 168

Document Title: NM 27.0 - NM B2B Reference Manual

Returns a list of SubscriptionHistoryItem, which contains the state, the actor and the timestamp of
the change.

1. Inherits from: Request

2. Attributes:

a. UUID uuid (Mandatory)

The UUID of the subscription for which the history has to be returned.

b. DateTimeSecond referenceTime (Optional)

Documentation last updated: 27.0 - Edition 2

The reference time from which the last SubscriptionHistoryItem are returned. If not
provided, the reception time of the request is used as reference time.

15.3.3.5.2. SubscriptionHistoryReply (new 27.0)

<<class>>

Returned in response to SubscriptionHistoryRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionHistoryReplyData data (Optional)

The reply payload.

15.3.3.6. SubscriptionSynchronisationRequest/Reply (new 27.0)

Edition: 27.0 6 169

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SubscriptionSynchronisationRequest

Reply: SubscriptionSynchronisationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionSynchronisationReply
synchroniseSubscription(SubscriptionSynchronisationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Synchronise an existing ACTIVE subscription.

15.3.3.6.1. SubscriptionSynchronisationRequest (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 2

This request can be used to:

• Initialise a new subscription

• Resynchronise an existing subscription that went out-of-sync

A subscription can be synchronised only if its state is ACTIVE.

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 170

Document Title: NM 27.0 - NM B2B Reference Manual

a. UUID subscriptionUuid (Mandatory)

The subscription’s unique identifier.

i. Constraints:

▪ SubscriptionSynchronisationRequest.INVALID_SUBSCRIPTION_STATE

▪ SubscriptionSynchronisationRequest.SUBSCRIPTION_SYNCHRONISATION_NOT_SUPPORTED

b. DateTimeMinute wef (Optional)

The cut-off time for filtering out old messages. Only messages newer than wef will be
processed for republication. To initialise a new subscription this can be left null. To
resynchronize an existing subscription it should correspond to the time when the client
went out-of-sync (i.e. the time from which to resync).

i. Constraints:

▪ SubscriptionSynchronisationRequest.INVALID_WEF_TIL

c. DateTimeMinute til (Optional)

Documentation last updated: 27.0 - Edition 2

The cut-off time for filtering out new messages. Only messages older than til will be
processed for republication. It should correspond to the time when the client resumed the
message consumption. When left null, it indicates "now" and the NM B2B will use the
current time (i.e. the time when the synchronisation request was received).

i. Constraints:

▪ SubscriptionSynchronisationRequest.INVALID_TIL

▪ SubscriptionSynchronisationRequest.INVALID_WEF_TIL

3. Constraints:

a. SUBSCRIPTION_SYNCHRONISATION_NOT_SUPPORTED

Subscription synchronisation is supported only for topic FLIGHT_DATA.

Constrained attributes: subscriptionUuid

Constrained requests: any using request

b. INVALID_SUBSCRIPTION_STATE

The subscription state must be ACTIVE.

Constrained attributes: subscriptionUuid

Constrained requests: any using request

c. INVALID_TIL

Edition: 27.0 6 171

Document Title: NM 27.0 - NM B2B Reference Manual

The til datetime attribute shall be less or equals than the current datetime.

Constrained attributes: til

Constrained requests: any using request

d. INVALID_WEF_TIL

If present, wef datetime shall be less than til datetime.

Constrained attributes: wef, til

Constrained requests: any using request

15.3.3.6.2. SubscriptionSynchronisationReply (new 27.0)

<<class>>

Returned in response to SubscriptionSynchronisationRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionSynchronisationReplyData data (Optional)

The reply payload.

15.3.3.7. SubscriptionSynchronisationAbortRequest/Reply (new 27.0)

MEP: S-R/R

Request: SubscriptionSynchronisationAbortRequest

Reply: SubscriptionSynchronisationAbortReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubscriptionSynchronisationAbortReply
abortSubscriptionSynchronisation(SubscriptionSynchronisationAbortRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Edition: 27.0 6 172

Document Title: NM 27.0 - NM B2B Reference Manual

This operation shall interrupt any existing republication for the specified subscription.

15.3.3.7.1. SubscriptionSynchronisationAbortRequest (new 27.0)

<<class>>

This request will interrupt any ongoing synchronisation for the specified subscription. Note that
only the synchronisation messages will be stopped; the subscription will continue to publish the
nominal flow of messages as usual. Note that pausing a subscription will also automatically abort
any ongoing synchronisation on that subscription.

IMPORTANT: The B2B client is required to abort any ongoing synchronisation request that is no
longer needed to avoid wasteful use of valuable resources.

1. Inherits from: Request

2. Attributes:

a. UUID subscriptionUuid (Mandatory)

The subscription’s unique identifier.

15.3.3.7.2. SubscriptionSynchronisationAbortReply (new 27.0)

<<class>>

Returned in response to SubscriptionSynchronisationAbortRequest.

1. Inherits from: Reply

2. Attributes:

a. SubscriptionSynchronisationAbortReplyData data (Optional)

The reply payload.

15.4. Messaging Port Type

15.4.1. Overview

1. MessagingService provides requests aimed at browsing or retrieving messages from queues.

Edition: 27.0 6 173

Document Title: NM 27.0 - NM B2B Reference Manual

Note that this is not the recommended way to consume the P/S Messages. The recommended
way is to directly connect to the queue on the B2B Message Broker via AMQP 1.0, as explained
above.

However, this API is provided in case the client does not yet have the technological set-up
needed to consume messages via AMQP 1.0.

a. S-R/R MessagePullRequest/Reply (new 27.0)

15.4.2. Requests/Replies

15.4.2.1. MessagePullRequest/Reply (new 27.0)

MEP: S-R/R

Request: MessagePullRequest

Reply: MessagePullReply

Response time: not available

Default settings: request count quotas

SOAP operation:

MessagePullReply pullMessages(MessagePullRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Pulls the P/S messages from a given queue.

15.4.2.1.1. MessagePullRequest (new 27.0)

<<class>>

Edition: 27.0 6 174

Document Title: NM 27.0 - NM B2B Reference Manual

Request to pull messages from a client queue.

This is not the recommended way to consume messages from a queue. The
recommended way is to connect directly to the queue via the AMQP 1.0 protocol.
NOTE This method is provided for convenience, for example to check if a queue has
messages without actually consuming them (non-destructive read). It can also be
used to consume messages for those clients who are not yet ready to use AMQP 1.0.

1. Inherits from: Request

2. Attributes:

a. QueueName queueName (Mandatory)

The queue from which to pull messages.

b. int maxSize (Mandatory)

The maximum number of messages to pull.

i. Constraints:

▪ range : [1, 1000]

c. boolean destructive (Mandatory)

Indicates if it should be a destructive read or not. In a destructive read, the messages are
removed from the queue. In a non-destructive read, the messages are kept in the queue and
will be returned again to subsequent calls to this method. Setting this parameter to False
allows to browse the queue rather than consume.

15.4.2.1.2. MessagePullReply (new 27.0)

<<class>>

Returned in response to MessagePullRequest.

1. Inherits from: Reply

2. Attributes:

a. MessagePullReplyData data (Optional)

The reply payload.

15.5. Data Types

15.5.1. AirNavigationUnitId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 2

Edition: 27.0 6 175

Document Title: NM 27.0 - NM B2B Reference Manual

Unique id of an air navigation unit, defined by NM.

See Air Navigation Unit (ANU) and ANU Access Rights.

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,12}

2. Used by: FlightSetDefinitionElement, AUPSummary, UserManagedSimulation, MCDMUserAndRole,

FficePublicationMessage, FlightPlanEvent, FlightDataMessage, MCDMTopicListRequestSelector,
MCDMUserRoleAndApprovalState, ASMScenarioListRequest, FlightAtfcmReroutingLocation,
FlightFilingResultMessageFilter, MCDMMessageFilter, AUPGetManageableRoutesForAMCRequest,
FlightSetDefinitionElement, AUPChainRetrievalRequest, AirspaceDataFilter, AUPChain,
SubscriptionSummary, MessageOriginator, AUPGetManageableRouteSegmentsForAMCAndRouteRequest,
LastUpdate, Request, FlightPlanMessage, ScenarioListRequest, ScenarioAttributes,
MCDMStatefulTopic

15.5.2. ARMessage

<<abstract class>>

The ARMessage is the base class of all asynchronous reply messages.

NOTE Any ARMessage has its messageExchangePattern attribute set to REQUEST_REPLY.

1. Inherits from: Message

2. Attributes:

a. DateTimeSecond requestReceptionTime (Optional)

UTC time at which the request was received at NM.

b. string requestId (Optional)

The identifier of the request.

c. CorrelationId correlationId (Mandatory)

The correlation identifier provided by the B2B client.

Edition: 27.0 6 176

Document Title: NM 27.0 - NM B2B Reference Manual

d. ReplyStatus status (Mandatory)

The status of the reply.

e. Error[] inputValidationErrors (Optional)

The input validation errors, if any.

i. Constraints:

▪ array size range : [0, 100]

f. Error[] outputValidationErrors (Optional)

The output validation errors, if any.

i. Constraints:

▪ array size range : [0, 100]

g. Error[] warnings (Optional)

The warnings, if any.

i. Constraints:

▪ array size range : [0, 100]

h. Error slaError (Optional)

An error caused by a violation of the SLA.

i. string reason (Optional)

A detailed explanation about the returned reply status when other than ReplyStatus.OK.

15.5.3. AsyncReply

<<abstract class>>

Edition: 27.0 6 177

Document Title: NM 27.0 - NM B2B Reference Manual

Reply returned in response to AsyncRequest

1. Inherits from: Reply

2. Attributes:

a. AsyncReplyInformation information (Optional)

Information on how to consume the reply message(s).

15.5.4. AsyncReplyInformation
<<class>>

Encapsulates the information needed by B2B client to receive and consume the reply message(s)
that NM B2B publishes.

1. Attributes:

a. CorrelationId correlationId (Mandatory)

The asynchronous R/R correlation identifier set by the B2B client. In turn, NM B2B inserts
the provided correlationId in the returned reply and reply message.

b. QueueName replyMessagePublicationQueueName (Mandatory)

The name of the queue to which NM B2B publishes the asynchronous reply message.

c. Duration requestProcessingTimeout (Mandatory)

The maximum duration, in seconds, that B2B client should wait to get a complete reply.

2. Used by: AsyncReply

15.5.5. AsyncRequest
<<abstract class>>

Base class of all asynchronous requests.

1. Inherits from: Request

2. Attributes:

a. CorrelationId correlationId (Mandatory)

The correlation id that NM will include in the request reception reply and in the
asynchronous reply message(s).

15.5.6. Base64Encoded
<<typedef[string]>>

Edition: 27.0 6 178

Document Title: NM 27.0 - NM B2B Reference Manual

Base 64 encoded byte array.

1. Used by: AirspaceDataRetrievalReplyData, AirspaceDataIncrementRetrievalReplyData

15.5.7. Bearing
<<typedef[int]>>

Bearing angle expressed as an integer amount of degrees.

1. range : [0, 360]

2. Used by: ReferencePoint

15.5.8. BusinessPSMessage (new 27.0)

<<abstract class>>

When a B2B client subscribes to a given subscription topic he is in fact subscribing to a specific type
of P/S message and will then receive messages of that type on the corresponding client queue.

1. Inherits from: PSMessage

2. Attributes:

a. SubscriptionTopic topic (Mandatory)

The topic of the subscription. This defines the subtype of message. For example for topic
SubscriptionTopic.REGULATIONS the message subtype will be RegulationMessage, which will
inherit from BusinessPSMessage.

b. UUID subscriptionUuid (Mandatory)

The UUID of the subscription for which this message was published.

c. VersionNumber subscriptionVersion (Mandatory)

The subscription version.

d. string parentMessageId (Mandatory)

The id of the original internal NM message, from which this message was created (for
auditing purposes only).

Edition: 27.0 6 179

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.9. Colours (new 27.0)

<<typedef[string]>>

A human readable colour or a set of colours.

1. Pattern: TEXT{1,51}

2. Used by: Dinghies

15.5.10. CorrelationId
<<typedef[string]>>

Asynchronous R/R correlation identifier

1. Pattern: TEXT{1,256}

2. Used by: SubscriptionSynchronisationSummary, AsyncRequest,

SubscriptionSynchronisationReplyData, AsyncReplyInformation, ARMessage

15.5.11. Cost
<<typedef[int]>>

A positive or negative cost expressed in EUR.

1. Used by: AlternativeRouteInfo, RouteInfo, ProposalInformation, GroupReroutingSummary

15.5.12. Dataset
<<class>>

The type of this dataset. See Forecast and Operational Datasets, Proposal Flights, and Simulation
DataSets.

1. Attributes:

a. DatasetType type (Mandatory)

The type of this dataset.

b. SimulationIdentifier simulationIdentifier (Optional)

In case the dataset type is SIMULATION, the identifier of the simulation.

i. Constraints:

▪ Dataset.INVALID_SIMULATION_IDENTIFIER

▪ Dataset.INVALID_SIMULATION_STATE

c. SimulationState simulationState (Optional)

Documentation last updated: 27.0 - Edition 1

Edition: 27.0 6 180

Document Title: NM 27.0 - NM B2B Reference Manual

In case the dataset type is SIMULATION, the simulationState specifies if the request has to be
performed on either the initial or current state of the simulation. The initial state of a
simulation is the state of the simulation when it started (without any modifications).

Querying e.g. counts/flightlist for the initial state and the current state of the simulation,
allows the user to evaluate what has changed in the simulation (i.e. what is the impact of the
changes in the simulation). As an alternative, the B2B client could compare the current
simulation state with the operational/forecast siuation, but in such a comparison it is not
clear if differences are due to the simulation changes or are due to the server changes (e.g.
on the server new regulations have been created in parallel).

In addition the current simulation state can be reset to it’s initial simulation state to allow
e.g. evaluating and comparing different alternative solutions/rates for e.g. a regulation. The
client application should eveluate the diferent solutions, one after the other (using
resetSimulation in between to each time revert to the INITIAL state) and in the end show the
results/comparison of the different solutions evaluated. The client application should not
start multiple simulations in parallel.

If simulationState is not present, then the request is performed on the current state of the
simulation.

In the case of a Request/Reply of which access mode is documented as

IMPORTANT WRITE, simulationState shall be set to null or CURRENT. Otherwise the
system returns a reply with status INVALID_INPUT.

2. Constraints:

a. INVALID_SIMULATION_IDENTIFIER

The simulationIdentifier must be set to null if the datasetType is set to FORECAST or

OPERATIONAL, and cannot be null if the datasetType is set to SIMULATION.

Constrained attributes: simulationIdentifier

Constrained requests: any using request

b. INVALID_SIMULATION_STATE

The simulationState must be set to null if the datasetType is set to FORECAST or OPERATIONAL.

Constrained attributes: simulationIdentifier

Constrained requests: any using request

3. Used by: SimulationResetRequest, FlightRetrievalRequest, EhelpDeskTicketUpdateRequest,

FlightListRequest, EhelpDeskTicketRevocationRequest, MCDMTopicUpdateRequest,
MCDMStateUpdateRequest, MCDMTopicListRequest, RegulationUpdateRequest, ReroutingCancelRequest,
SimulationStopRequest, RegulationCreationRequest, TacticalConfigurationPlan,
TacticalConfigurationRetrievalRequest, HotspotPlans, MeasureOpLogRetrievalRequest, Simulation,
SimulationMeasureRevertRequest, UpdateFlightsInMeasureRequest, HotspotListRequest,

Edition: 27.0 6 181

Document Title: NM 27.0 - NM B2B Reference Manual

MeasureListReplyData, ScenarioMeasureRetrievalRequest, TrafficCountsRequest,

RegulationProposalFilingRequest, RegulationProposalUpdateRequest, MeasureListRequest,
RegulationCancelRequest, NetworkImpactAssessmentRetrievalRequest, ReroutingUpdateRequest,
ATFCMSituationRequest, ReroutingCreationRequest, EhelpDeskTicketCreationRequest,
ScenarioListRequest, RegulationProposalRevocationRequest

15.5.13. DatasetType
<<strict enumeration>>

Possible dataset types.

1. Values:

a. FORECAST

The pre-tactical traffic prediction for the period [D-6, D-1] built on all available information
such as airport slots, airline schedules, past traffic, etc. The FORECAST dataset contains all
predicted flights, i.e. of type CFMUFlightType.PREDICTED_FLIGHT.

b. OPERATIONAL

The tactical traffic situation of the day, available from [D-1, D] built from the actual traffic
demand.

c. SIMULATION

Refers to a specific traffic simulation.

2. Used by: Dataset

15.5.14. DateTimeMinute
<<typedef[string]>>

String representation of a date and time in the day (Gregorian Calendar - UTC).

Its format is " YYYY-MM-DD hh:mm ". Example: " 2013-12-01 11:37 ".

Possible values of YYYY , MM and DD in " YYYY-MM-DD " are defined in DateYearMonthDay.

Possible values of hh and mm in " hh:mm " are defined in TimeHourMinute.

1. Pattern: DIGIT{4}-DIGIT{2}-DIGIT{2} DIGIT{2}:DIGIT{2}

2. Used by: ACDMAlertData, ArrivalInformation, EarlyDPIRequest, ConcernedRegulationTimeOver,

RoutingAssistanceReplyDataResult, AUPSummary, SubscriptionSynchronisationRequest,
FlightFilingResultMessage, MCDMDeadlines, ProposalInformation, EAUPSummary,
EhelpDeskForceFlightInRegulation, NetworkImpactFlightData, DepartureInformation, ATCDPIRequest,
FlightPlan, SlotSwapCandidate, DateTimeMinutePeriod, APISubmissionRules,
DateTimeMinutePeriodWithUFN, ReroutingApplyReplyDataResult, AUPServiceConfigurationReplyData,
EhelpDeskImproveSlotInRegulation, RouteInfo, FlightPlanUpdate, GeneralAPIRequest,

Edition: 27.0 6 182

Document Title: NM 27.0 - NM B2B Reference Manual

FlightArrivalRequest, LandingInformation, IATAFlightKeys, TargetTakeOffAPIRequest,

TargetTimeOverAPIRequest, FourDFlightPoint, Simulation, TargetDPIRequest, CDMInfo, FlightKeys,
ActualTimeAtTarget, UpdateDPIRequest, ProfileValidity, PredictedDPIRequest,
FlightDepartureRequest, FlightEvent, ACDMAlertRequest, AIMSummary, DraftEAUPSummary,
FlightInformationUpdateRequest, EhelpDeskTicketFlightInfo, ForceFlightInRegulation,
FlightDelayRequest, Flight, SlotMissedRequest

15.5.15. DateTimeMinutePeriod
<<class>>

Left-closed, right-opened period of UTC times, up to the minute precision.

1. Attributes:

a. DateTimeMinute wef (Mandatory)

Start time of the period.

i. Constraints:

▪ DateTimeMinutePeriod.INVALID_PERIOD

b. DateTimeMinute unt (Mandatory)

End time of the period.

i. Constraints:

▪ DateTimeMinutePeriod.INVALID_PERIOD

2. Constraints:

a. INVALID_PERIOD

wef must be less or equal to unt .

Constrained attributes: wef, unt

Constrained requests: any using request

3. Used by: RegulationOccupancyConstraint, AUPSummary, FlightListRequest,

RegulationInitialConstraint, PlannedRunwayConfigurations, AUPRSAAllocationExpansionRequest,
FlightListByLocationReplyData, ASMScenarioActivationListRequest, AbstractEAUPCDRRequest,
Simulation, ASMScenarioListRequest, ASMScenarioActivation, PlannedTrafficVolumeActivation,
AUPGetManageableRoutesForAMCRequest, EAUPSummary, HotspotId, ScenarioMeasureRetrievalRequest,
FlightPlanListRequest, PlannedOTMV, AbstractEAUPRSARequest, ReroutingOpportunities,
TrafficCountsRequest, ScenarioImpact, AUPGetManageableRouteSegmentsForAMCAndRouteRequest,
PlannedSectorConfigurationActivation, ATFCMSituationRegulation, DraftEAUPSummary,
MeasureListRequest, RegulationSupplementaryConstraint, PlannedRestrictionActivation,
SimulationAvailability, Measure, PlannedCapacity, TrafficCountsReplyData, OtmvAlert

Edition: 27.0 6 183

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.16. DateTimeMinutePeriodWithUFN

<<class>>

wef can be equal to unt

1. Attributes:

a. DateTimeMinute wef (Optional)

The start-time.

b. DateTimeMinute unt (Optional)

The end-time.

2. Used by: WeeklyScheduleItem, NetworkImpactAssessmentRetrievalReplyData, ScenarioAttributes

15.5.17. DateTimeSecond
<<typedef[string]>>

String representation of a date and time in the day (Gregorian Calendar - UTC).

Its format is " YYYY-MM-DD hh:mm:ss ". Example: "2013-12-01 11:37:25".

Possible values of YYYY , MM and DD in " YYYY-MM-DD hh:mm:ss " are defined in DateYearMonthDay.

1. Pattern: DIGIT{4}-DIGIT{2}-DIGIT{2} DIGIT{2}:DIGIT{2}:DIGIT{2}

2. Used by: AirFiledData, FlightPoint, HeartbeatTechnicalMessage, FourDPosition, InvalidFiling,

Reply, FlightAirspace, FlightOperationalLogEntry, FlightPlanEvent,
SubscriptionSynchronisationSummary, FlightPlanEvent, LifeCycleEvent,
NetworkImpactAssessmentRetrievalReplyData, FlightPlanHistoryInfo, FlightEvent,
ReroutingOpportunities, SubscriptionSummary, EhelpDeskTicketRequestDetails,
SubscriptionHistoryRequest, File, ARMessage, LastUpdate, Request, FlightTrafficVolume,
ScenarioListRequest, TargetTime, FlightRestriction, ATFCMSituationReplyData, ScenarioAttributes,
TimeAndModel

15.5.18. DateYearMonthDay
<<typedef[string]>>

String representation of a date (Gregorian Calendar - UTC).

Its format is " YYYY-MM-DD ". Example: " 2013-12-01 ".

Possible values of YYYY are 4-digit numeric in [0001, …, 9998].

Edition: 27.0 6 184

Document Title: NM 27.0 - NM B2B Reference Manual

Possible values of MM are 2-digit numeric in [01, …, 12].

Possible values of DD are 2-digit numeric in [01, …, 31] (depending on the month).

1. Pattern: DIGIT{4}-DIGIT{2}-DIGIT{2}

2. Used by: AUPSummary, MCDMTopicUpdateRequest, AIMListRequest, MCDMTopicListRequest,

ReroutingCancelRequest, TacticalConfigurationPlan, TacticalConfigurationRetrievalRequest,
HotspotPlans, DraftEAUPRADRestrictionActivationRequest, CompleteDatasetQueryCriteria,
DateYearMonthDayPeriod, DraftEAUPsRetrievalRequest, DraftEAUPRSARequest, DraftEAUPCDRRequest,
AirspaceDataIncrementSummary, EAUPChainRetrievalRequest, HotspotListRequest,
AUPChainRetrievalRequest, AUPChain, IncrementalDatasetSummary, AirspaceDataRetrievalReplyData,
CompleteDatasetSummary, EAUPChain, EAUPIdentification, IncrementalDatasetQueryCriteria,
RegulationCancelRequest, ATFCMSituationRequest, RegulationProposalRevocationRequest

15.5.19. DateYearMonthDayPeriod
<<class>>

Left-closed, right-opened period of days.

1. Attributes:

a. DateYearMonthDay wef (Optional)

Start day of the period.

If left to null, set to the current date.

i. Constraints:

▪ DateYearMonthDayPeriod.INVALID_PERIOD

b. DateYearMonthDay unt (Optional)

End day of the period.

If left to null, set to infinity.

Note that if wef is equal to unt , the period is empty.

i. Constraints:

▪ DateYearMonthDayPeriod.INVALID_PERIOD

2. Constraints:

a. INVALID_PERIOD

wef must be less or equal to unt .

Constrained attributes: wef, unt

Constrained requests: any using request

Edition: 27.0 6 185

Document Title: NM 27.0 - NM B2B Reference Manual

3. Used by: CompleteDatasetQueryCriteria, AIMSummary, IncrementalDatasetQueryCriteria

15.5.20. DistanceM
<<typedef[int]>>

Measure of the distance between two points expressed as an integer amount of meters.

1. range : [0, unbounded[

2. Used by: OtherInformation, AerodromeDAL, PointDAL, Flight, Relative4DPoint,

RegulationExceptionalConstraint, FlightConfirmationRequest

15.5.21. DistanceNM
<<typedef[int]>>

Measure of the distance between two points expressed as an integer amount of nautical miles.

1. range : [0, unbounded[

2. Used by: AlternativeRouteInfo, ReferencePoint, FlightPoint, RouteInfo, DeltaEntry, Flight,

TargetTime, FlightRestriction, FlightAirspace

15.5.22. Duration
<<typedef[long]>>

Time duration in seconds.

1. range : [0, unbounded[

2. Used by: Relative4DPoint, AsyncReplyInformation

15.5.23. DurationHourMinute
<<typedef[string]>>

String representation of a duration (with minute precision).

Its format is " hhmm " (note the absence of " : " (colon) character - as this is not a time in day).
Example: " 0850 " (duration of 8 hours 50 minutes).

Possible values of hh are 2-digit numeric in [00, …, 99].

Possible values of mm are 2-digit numeric in [00, …, 59].

1. Pattern: DIGIT{4}

2. Used by: AlternativeRouteInfo, GeneralAPIRequest, ArrivalInformation, ShiftHourMinute,

OTMVPlan, TaxiTimeAndProcedure, HotspotPlans, OTMVThresholds, EnrouteDelay, CountsInterval,
OTMVWithDuration, HotspotId, ReroutingApplyRequest, FlightPlan, UpdateDPIRequest,
HotspotListRequest, OTMVSustained, RevisionTimes, CountsCalculationTypeAndInterval, OTMVPlans,

Edition: 27.0 6 186

Document Title: NM 27.0 - NM B2B Reference Manual

RunwayConfiguration, OTMV, ReadyStatus, EstimatedElapsedTimeAtLocation, RegulationOrMCDMOnly,

FlightListByHotspotRequest, RouteInfo, Flight, FlightPlanUpdate, SupplementaryInformation

15.5.24. DurationHourMinuteSecond
<<typedef[string]>>

String representation of a duration with second precision.

Its format is " hhmmss " (note the absence of " : " (colon) character - as this is not a time in day).
Example: " 085032 " (duration of 8 hours 50 minutes 32 seconds).

Possible values of hh are 2-digit numeric in [00, .., 99].

Possible values of mm are 2-digit numeric in [00, …, 59].

Possible values of ss are 2-digit numeric in [00, …, 59].

1. Pattern: DIGIT{6}

2. Used by: CDMInfo, FlightAirspace

15.5.25. DurationMinute
<<typedef[long]>>

Time duration in minutes

1. range : [0, unbounded[

2. Used by: ReadyToDepartRequest, DepartureData, SlotZone

15.5.26. Error

<<class>>

Edition: 27.0 6 187

Document Title: NM 27.0 - NM B2B Reference Manual

Description of a NOP/B2B error - see Error And Warning Reporting.

1. Attributes:

a. set< string > attributes (Optional)

Set of attributes to which this Error applies.

Can be empty for errors that do not apply to attributes, like SLA errors.

b. ServiceGroup group (Mandatory)

Identifies the Service Group (e.g. FLIGHT corresponds to the FlightServices Service Group).

c. string category (Mandatory)

Corresponds to a category of errors defined within a Service group (e.g. FUA within the
AirspaceServices).

i. Constraints:

▪ Pattern: (ALPHA|_){1,100}

d. string type (Mandatory)

The specific type of error as defined by the specific enumeration type (e.g.
AUP_CDR_UPDATE_AMC_NOT_RESPONSIBLE).

i. Constraints:

▪ Pattern: (ALPHA|DIGIT|_){1,100}

e. map< string, string > parameters (Optional)

Name/value pairs providing contextual information on the error.

Each key and value in the map can contain maximum 1000 printable characters.

Empty if the ErrorType of type does not define parameters, otherwise contains all keys
defined for the ErrorType of type .

i. Constraints:

▪ Item max length: 1000

▪ Item max length inclusive: true

▪ Item max length: 1000

▪ Item max length inclusive: true

f. string message (Optional) (altered 27.0)

Documentation last updated: 27.0 - Edition 4

Error message if any - the error message is not part of the B2B contract, i.e. the error
message may or may not be provided, and its content may change at any time.

Edition: 27.0 6 188

Document Title: NM 27.0 - NM B2B Reference Manual

The message may contain substitution variables if the ErrorType of type has parameters.
Such a substitution variable is indicated as “{{<parameter_key>}}”, e.g. if a parameter
START_POINT is defined for the ErrorType of type and if a message contains it, it is indicated in
message as “{{START_POINT}}”. Note that an Error may contain parameters that are not used
in message.

i. Constraints:

▪ Max length: 2000

▪ Max length inclusive: true

2. Used by: Reply, ARMessage

15.5.27. ErrorCategory
<<strict enumeration>>

Lists the possible error categories for this service group - see Error And Warning Reporting.

1. Values:

a. GEN

single, general category for Common error types

b. SUBSCRIPTION_MANAGEMENT (new 27.0)

for all validation errors related to subscription management

c. MESSAGING (new 27.0)

for all validation errors related to messaging

15.5.28. ErrorType
<<strict enumeration>>

Lists the possible error types for this service group - see Essentials - Error And Warning Reporting.

1. Values:

a. UNSUPPORTED_VERSION

This error is sent when an element in the request is not supported by the current version -
no parameter

b. ATTRIBUTE_CANNOT_BE_NULL

Specifies that the given attribute cannot be null and must therefore have a non-null value.

c. ATTRIBUTE_MUST_BE_NULL

Specifies that the given attribute must be null.

Edition: 27.0 6 189

Document Title: NM 27.0 - NM B2B Reference Manual

d. INVALID_COLLECTION_SIZE

Specifies a size constraint violation for the given collection.

e. INVALID_ATTRIBUTE_VALUE

The value of the given attribute violates the associated acceptance pattern.

f. MISSING_CHOICE_VALUE

A choice is a constraint such that one attribute among a list of attributes must be set to a
non-null value - this error is returned when no attribute involved in the choice has been set
- no parameter

g. CHOICE_OVERFLOW

This error is sent when more than one attribute involved in the choice have been set - no
parameter

h. REQUESTED_ATTRIBUTE_NOT_ALLOWED

This error is sent in replies to some requests where the client application can define itself
the attributes to be returned; in some exceptional circumstances, a request may be able to
specify an attribute that is actually not allowed in these specific circumstances.

Parameters:

1. " ATTRIBUTE ": unsupported requested attribute, expressed as a string (up to the client to
cast it to the concerned enumeration)

i. REPLY_ATTRIBUTE_NOT_SET

This error/warning is returned when one or more attributes in the reply have not been set.
The location of such attributes is specified in the Error.attributes field of the Reply.

j. REQUEST_COUNT_QUOTA_EXCEEDED

This error is sent in replies to some requests where usage (count) exceeds "normal" request
count quotas (max-count value/period) in normal load conditions - Overbooking in low
service load is tolerated up to (overbooking-max-count value/period).

k. REQUEST_OVERBOOKING_ACCEPTED

This error is sent in replies to some requests where usage (count) exceeds "normal" request
count quotas (max-count value/period) in normal load conditions - Overbooking in low
service load is tolerated up to (overbooking-max-count value/period).

l. UNKNOWN

An unknown error type.

Edition: 27.0 6 190

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.29. EstimateQualifier
<<strict enumeration>>

This type is used to qualify a value in terms of it being either an estimated value or an actual value.

It can be used to qualify any value, such as a time, a position, a flight level, weight, etc.

1. Values:

a. ESTIMATED

Specifies that the associated value is an estimate.

b. ACTUAL

Specifies that the associated value is an actual value, i.e. it has been measured or confirmed.

2. Used by: LandingInformation, DepartureInformation, EnRouteInformation

15.5.30. ExecutionEnvironment
<<strict enumeration>>

Defines the execution environment where the NM B2B provider agent is running.

1. Values:

a. OPS

Operational platform.

b. OPT

Operational test platform.

c. PRE_RELEASE

Test platform.

d. DEV

Development platform.

2. Used by: NMPlatform

15.5.31. File
<<class>>

A file descriptor provides information about a file.

The file id identifies uniquely the file on the platform (see Platforms).

Edition: 27.0 6 191

Document Title: NM 27.0 - NM B2B Reference Manual

The file id can be used to build a URL and download the file content (see File Download Service).

The NM system updates the releaseTime and fileLength attributes on file content change.

Hence, if some service returns twice a File with same id and same releaseTime, the consumer
should consider the file as unchanged.

1. Attributes:

a. FileId id (Mandatory)

The unique id of the file.

b. FileType type (Mandatory)

Final type of the file - see specific reference manuals where file port types are defined.

c. DateTimeSecond releaseTime (Mandatory)

Production time of the file.

The NM system updates the releaseTime on file change.

d. int fileLength (Mandatory)

The length of the file in bytes.

The NM system updates fileLength on file change.

i. Constraints:

▪ range : [0, unbounded[

2. Used by: ScenarioAttributes

15.5.32. FileId
<<typedef[string]>>

Unique id of a file.

1. Pattern: (ALPHA|DIGIT|.|_|-|/){1,200}

2. Used by: File

15.5.33. FileType
<<typedef[string]>>

Type of a file - not an enumeration because concrete file types are defined in specific service
groups.

1. Pattern: ALPHA{1,50}

2. Used by: File

Edition: 27.0 6 192

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.34. FlightLevelM
<<typedef[int]>>

Measure of the flight level expressed as an integer amount of meters.

1. Used by: Relative4DPoint

15.5.35. HeartbeatTechnicalMessage (new 27.0)

<<class>>

The heartbeat technical message ( TechnicalTopic.HEARTBEAT ) which is sent at regular frequency to

the queue of a subscription.

1. Inherits from: TechnicalPSMessage

2. Attributes:

a. SubscriptionState currentSubscriptionState (Mandatory)

The current state of the subscription.

b. DateTimeSecond timeToNextPulse (Mandatory)

The time when the next HeartbeatTechnicalMessage will be sent for this subscription.

15.5.36. LastUpdate
<<class>>

Describes when and by whom an object has been last updated.

1. Attributes:

a. DateTimeSecond timestamp (Mandatory)

Time at which the object was created or last updated.

b. UserId userId (Mandatory)

Id of the NOP user who created or last updated the object.

c. AirNavigationUnitId airNavigationUnitId (Optional)

The ANU id associated to userId , if known by NM.

2. Used by: AUPDeletionRequest, AUPSummary

15.5.37. Latitude
<<class>>

Represents a latitude.

Edition: 27.0 6 193

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. string angle (Mandatory)

Expressed in degrees, minutes and seconds. Note the absence of " : " (colon) separator.

i. Constraints:

▪ Pattern: DIGIT{6}

b. LatitudeSide side (Mandatory)

Indicates the latitude side: NORTH or SOUTH .

2. Used by: EstimatedElapsedTimeAtLocation, Position

15.5.38. LatitudeSide
<<enumeration>>

The side of the latitude.

1. Values:

a. NORTH

North.

b. SOUTH

South.

2. Used by: Latitude

15.5.39. LogicalOperator
<<enumeration>>

Represents a logical operator, limited at the moment to AND and OR.

1. Values:

a. AND

The logical operator AND.

b. OR

The logical operator OR.

2. Used by: IRDesignatorFilter, IRUUIDFilter

Edition: 27.0 6 194

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.40. LongDurationHourMinute
<<typedef[string]>>

String representation of a long duration with minute precision.

Its format is "hhhhhhhhmm" . Example: "73828" (duration of 738 hours 28 minutes).

Possible values of hhhhhhhh are 8-digit numeric in [00000000, …, 99999999].

Possible values of mm are 2-digit numeric in [00, …, 59].

1. Pattern: DIGIT{4,10}

2. Used by: ATFCMSituationDelays, DeltaATFCMSituationRegulation, SignificantDeltaDuration,

ATFCMSituationRegulation

15.5.41. Longitude
<<class>>

Represents a longitude.

1. Attributes:

a. string angle (Mandatory)

Expressed in degrees, minutes and seconds. Note the absence of " : " (colon) separator.

i. Constraints:

▪ Pattern: DIGIT{6,7}

b. LongitudeSide side (Mandatory)

Indicates the longitude side: EAST or WEST .

2. Used by: EstimatedElapsedTimeAtLocation, Position

15.5.42. LongitudeSide
<<enumeration>>

The side of a longitude.

1. Values:

a. EAST

East.

b. WEST

West.

Edition: 27.0 6 195

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: Longitude

15.5.43. Message

<<abstract class>>

The Message is the base class for both P/S and A/R messages.

1. Attributes:

a. UUID uuid (Mandatory)

The message unique id.

b. Timestamp timestamp (Mandatory)

The message timestamp.

c. MessageExchangePattern messageExchangePattern (Mandatory)

The message exchange pattern.

15.5.44. MessageExchangePattern
<<enumeration>>

Enumerates the NM B2B supported message exchange patterns.

1. Values:

Edition: 27.0 6 196

Document Title: NM 27.0 - NM B2B Reference Manual

a. PUBLISH_SUBSCRIBE

Identifies the Publish/Subscribe Message Exchange Pattern.

b. REQUEST_REPLY

Identifies the Request/Reply Message Exchange Pattern.

2. Used by: Message

15.5.45. MessagePullReplyData (new 27.0)

<<class>>

The MessagePullReply payload.

1. Attributes:

a. list< PSMessageElement > marshalledMessages (Optional)

The list of P/S messages retrieved from the queue.

b. boolean hasMoreMessages (Mandatory)

Indicates if the queue contains more messages than the ones returned.

2. Used by: MessagePullReply

15.5.46. MessagingErrorType (new 27.0)

<<enumeration>>

Error types for messaging.

1. Values:

a. INVALID_QUEUENAME

No queue can be found with a given queue name.

15.5.47. NMB2BProviderVersion
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

The unique identifier of the software running the NM B2B provider agent.

Example
19.5.0.4.76 or FB599_19_5_0.34

Edition: 27.0 6 197

Document Title: NM 27.0 - NM B2B Reference Manual

When the value of NMB2BProviderVersion has a prefix alphanumeric (FB599 or NMVP,

NOTE …), it means that the NMB2BProvider is hosting an NM release corresponding to an
exercise. This is typically the case when using the NMVP platform.

1. Used by: NMReleaseInformationReplyData

15.5.48. NMB2BVersion
<<typedef[string]>>

It corresponds to the version of the Web Services supported by the NM B2B provider agent.

The NM B2B provider agent can support several NM B2B versions. The NM B2B version is
supported during two years after its deployment.

The NM B2B version identifier of any service artefact is the version identifier of its NM release,
namely 19.0.0, 19.5.0, and so forth.

1. Pattern: DIGIT{2}.DIGIT{1}.DIGIT{1}

2. Used by: NMB2BAddendaErrataRequest, NMB2BWSDLsRequest, NMB2BReferenceManualsRequest,

NMB2BScenariosRequest, NMReleaseInformationReplyData

15.5.49. NMPlatform
<<class>>

NM B2B consumer can be connected to different types of platform depending on the end point
used. The NM platform is reflected in the URL used to access the NM B2B provider agent.

1. Attributes:

a. ExecutionEnvironment executionEnvironment (Mandatory)

Defines the execution environment where the NM B2B provider agent is running.

Example
OPS

b. string applicationInstance (Mandatory)

Unique name of the system running the NM B2B provider agent.

Examples
CUA_OPA

i. Constraints:

▪ Pattern: UALPHA{3}_UALPHA{2}(UALPHA|DIGIT){1}

2. Used by: NMReleaseInformationReplyData

Edition: 27.0 6 198

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.50. NMRelease
<<typedef[string]>>

NM Release.

Example: 26.0.0.

1. Pattern: DIGIT{2}.DIGIT{1}.DIGIT{1}

2. Used by: SubscriptionSummary, NMReleaseInformationReplyData

15.5.51. PlanDataId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 5

An identifier that represents the version of a plan (a plan can be for example a
TrafficVolumeActivationPlan, OTMVPlan, etc.).

The identifier is a string (see pattern below) and, by applying alphanumerical sorting, it can be used
to chronologically order different versions of a plan or different versions of an item, e.g. a specific
regulation or a specific rerouting.

In general, it should be treated as an opaque string on which to simply apply an alphanumerical

sorting. However, the meaning of the field is as follows:

• One of O|F|S character.

◦ O = Operational Dataset

◦ F = Forecast Dataset

◦ S = Simulation Dataset

• Four characters for AIRAC cycle identifier, e.g. 2306.

• Additional characters for the baseline identifier.

1. Pattern: (O|F|S)(DIGIT){14}(UALPHA|DIGIT){0,40}

2. Used by: HotspotPlans, RegulationCancelRequest, Measure, MCDMTopic, MCDMStateUpdateRequest,

RegulationProposalFilingRequest, ReroutingCancelRequest, RegulationProposalRevocationRequest,
TacticalConfigurationPlan

15.5.52. Position
<<class>>

Represents a position, i.e. a latitude and a longitude.

1. Attributes:

a. Latitude latitude (Mandatory)

Edition: 27.0 6 199

Document Title: NM 27.0 - NM B2B Reference Manual

The latitude.

b. Longitude longitude (Mandatory)

The longitude.

2. Used by: FlightRestriction, GeoPoint

15.5.53. PSMessage (new 27.0)

<<abstract class>>

The PSMessage is the abstract base class for any message that is going to be published via the B2B
P/S.

Note: any PSMessage has its messageExchangePattern attribute set to PUBLISH_SUBSCRIBE.

1. Inherits from: Message

2. Attributes:

a. PSMessageType type (Mandatory)

The type of the message.

15.5.54. PSMessageElement (new 27.0)

<<typedef[string]>>

A marshalled PSMessage.

It is used to encapsulate a PSMessage into a web service XML Reply.

1. Used by: MessagePullReplyData

Edition: 27.0 6 200

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.55. PSMessageType (new 27.0)

<<enumeration>>

The PSMessageType defines if a message is a Business Message or a Technical Message.

1. Values:

a. TECHNICAL_MESSAGE

Notifications of technical nature like changes to the subscriptions.

b. BUSINESS_MESSAGE

Message related to the subscribed topic, which have business value.

2. Used by: PSMessage

15.5.56. QueueName
<<typedef[string]>>

QueueName

1. Pattern: TEXT{1,200}

2. Used by: MessagePullRequest, SubscriptionSummary, SubscriptionCreationRequest,

AsyncReplyInformation

15.5.57. ReceivedOrSent
<<enumeration>>

Convenience type used in situations where NM needs to express whether an object (typically a
message) was received or sent by the NM.

1. Values:

a. RECEIVED

Received by NM.

b. SENT

Sent by NM.

c. UNKNOWN

The nature of the transmission is either unknown or not applicable.

2. Used by: Flight

Edition: 27.0 6 201

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.58. Reply

<<abstract class>>

Abstract ancestor of all NOP/B2B replies.

No XML reply is sent if the request is such that the system returned an HTTP error instead - see
Error And Warning Reporting.

Otherwise, the corresponding concrete reply type message is returned.

1. Attributes:

a. DateTimeSecond requestReceptionTime (Optional)

UTC time at which the request was received at NM.

Always set when an XML reply is returned, regardless of the possible exceptions that
occurred within the request processing.

b. string requestId (Optional)

Identification of the request. This id is not unique across time: the request is uniquely
identified via two attributes: requestReceptionTime and requestId .

Always set when an XML reply is returned, regardless of the possible exceptions that
occurred within the request processing.

Edition: 27.0 6 202

Document Title: NM 27.0 - NM B2B Reference Manual

c. DateTimeSecond sendTime (Optional)

UTC time at which NM has sent the reply.

Always set when an XML reply is returned, regardless of the possible exceptions that
occurred within the request processing.

d. ReplyStatus status (Mandatory)

Documentation last updated: 27.0 - Edition 4

Specifies if the request was successfully processed (value is ReplyStatus.OK) or not (value is
not ReplyStatus.OK).

Always set when an XML reply is returned, regardless of the possible exceptions that
occurred within the request processing.

e. Error[] inputValidationErrors (Optional)

Documentation last updated: 27.0 - Edition 4

Contains the input validation errors, if any.

Set to null if the request successfully passed input validations (i.e. status is not set to
ReplyStatus.INVALID_INPUT).

Input validation error types are described in Error And Warning Reporting.

i. Constraints:

▪ array size range : [0, 100]

f. Error[] outputValidationErrors (Optional)

Contains the output validation errors, if any.

Set to null if the request successfully passed output validations (i.e. status is not set to
ReplyStatus.INVALID_OUTPUT ).

This is only used in test context.

i. Constraints:

▪ array size range : [0, 100]

g. Error[] warnings (Optional)

See Error And Warning Reporting.

Left null if there is no returned warning.

i. Constraints:

▪ array size range : [0, 100]

Edition: 27.0 6 203

Document Title: NM 27.0 - NM B2B Reference Manual

h. Error slaError (Optional)

Describes an error caused by a SLA violation.

Unused in current release: always null.

i. string reason (Optional)

This attribute is used to provide a detailed explanation about the returned reply status when
other than ReplyStatus.OK .

Optionally set when an XML reply is returned with reply status different than
ReplyStatus.OK .

15.5.59. ReplyStatus
<<strict enumeration>>

Describes if a request was successfully processed, and if not, gives an overview of why.

1. Values:

a. OK

The request was successfully processed.

b. INVALID_INPUT

Documentation last updated: 27.0 - Edition 6

The request processing failed due to the detection of an invalid input.

The client application shall correct the request before re-submitting.

Edition: 27.0 6 204

Document Title: NM 27.0 - NM B2B Reference Manual

For any received request, NM B2B implements at least two levels of

input validation:

XML validation
This validation is executed while parsing the XML request.

Data validation
This validation is executed on the parsed data.

CAUTION Ideally, NM B2B would always report the INVALID_INPUT error details in
the inputValidationErrors of the reply.

However, this is not always possible. In particular, NM B2B is not

capable to map some XML parsing errors (generated by the XML parser
library) into structured errors that can be reported in the
inputValidationErrors. In such a situation, e.g. the violation of the
maximum size of a collection, NM B2B reports the error details
(generated by the XML parser library) in the plain text reason of the
reply.

c. INVALID_OUTPUT

Documentation last updated: 27.0 - Edition 6

The request processing failed due to the detection of an invalid output, i.e. of a NM B2B
internal error.

The client application should not re-submit the same request until NM communicates about
the correction of the problem.

IMPORTANT INVALID_OUTPUT is never returned on the OPS platform.

d. INTERNAL_ERROR

Documentation last updated: 27.0 - Edition 6

The request processing failed due to an internal error.

The client application should not re-submit the same request until NM communicates about
the correction of the problem.

e. SERVICE_UNAVAILABLE

Documentation last updated: 27.0 - Edition 6

Unfortunately, this status covers two distinct errors:

▪ Service temporarily unavailable

The request processing failed due to the temporary unavailability of some component on

Edition: 27.0 6 205

Document Title: NM 27.0 - NM B2B Reference Manual

the request processing path.

The client application can re-submit the request.

▪ Disabled service/resource access

The service access (or some resource access) is currently disabled by NM.

The client application should not re-submit the same request until NM communicates a
change in the enabled accesses.

Clearly, the NM B2B shall report a distinct status for these two errors.

To determine what is the exact nature of the error, the user can
IMPORTANT obtain the enablement status of a service / resource access via the S-
R/R UserInformationRequest/Reply.

See also sections Access Control and User Information Report.

f. RESOURCE_OVERLOAD

Documentation last updated: 27.0 - Edition 6

The request processing failed due to some temporary overload of the system.

The client application can re-submit the request.

g. REQUEST_COUNT_QUOTA_EXCEEDED

Documentation last updated: 27.0 - Edition 6

The client application exceeded its "overbooking" request count quotas (value/period) in
normal load conditions. More information is available here.

The client application shall wait until its recent usage is back to normal before re-
submitting.

h. PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED

Documentation last updated: 27.0 - Edition 6

The client application sent too many requests simultaneously. More information is available
here.

The client application shall wait until some submitted requests return before re-submitting.

i. REQUEST_OVERBOOKING_REJECTED

Documentation last updated: 27.0 - Edition 6

The client application exceeded its request count quotas (value/period) in high load

Edition: 27.0 6 206

Document Title: NM 27.0 - NM B2B Reference Manual

conditions. More information is available here.

The client application shall wait until its recent usage is back to normal before re-
submitting.

j. BANDWIDTH_QUOTAS_EXCEEDED

Documentation last updated: 27.0 - Edition 6

The client application exceeded its bandwidth consumption quotas (value/period). More
information is available here.

The client application shall wait until its recent usage is back to normal before re-
submitting.

k. NOT_AUTHORISED

Documentation last updated: 27.0 - Edition 6

The service/resource access is not authorised to the client application. More information is
available here.

The client application shall not re-submit the same request until NM informs him about a
change in its access rights.

l. OBJECT_NOT_FOUND

Documentation last updated: 27.0 - Edition 6

The client application sent a request referring to an object that does not exist in the NM
system.

The client application shall correct the request before re-submitting.

m. TOO_MANY_RESULTS

Documentation last updated: 27.0 - Edition 6

The client application sent a request producing too many results.

The client application shall refine the request arguments before re-submitting.

n. OBJECT_EXISTS

Documentation last updated: 27.0 - Edition 6

The client application attempted to create an object that already exists in the NM system.

The client application shall correct the request before re-submitting.

o. OBJECT_OUTDATED

Edition: 27.0 6 207

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 6

The client application attempted to update an object of which it does not have the latest
version. The object might have been updated concurrently, see also LastUpdate data type).

The client application shall correct the request before re-submitting.

p. CONFLICTING_UPDATE

Documentation last updated: 27.0 - Edition 6

The client application attempted to update an object which conflicts with parallel changes.

The client application shall correct the request before re-submitting.

q. INVALID_DATASET

Documentation last updated: 27.0 - Edition 6

The client application attempted to update an object on an invalid dataset.

This error occurs either when the plan has not been transferred (for OPERATIONAL dataset)
or when the cut-off time has been reached (for FORECAST dataset) or when the simulation
has been stopped.

The client application shall correct the request before re-submitting.

2. Used by: Reply, ARMessage

15.5.60. Request

<<abstract class>>

Abstract ancestor of all NOP/B2B requests.

1. Attributes:

a. string endUserId (Optional)

The id of the end user of the client application, hence typically not the id of the certificate
owner. Subsequently used to build usage statistics.

It is recommended to pass it.

Length must be in [0,30]. Alphabetic, numeric and underscore characters only.

i. Constraints:

Edition: 27.0 6 208

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Pattern: (ALPHA|DIGIT|_){0,30}

b. AirNavigationUnitId onBehalfOfUnit (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 2

The ANU ID of the user on behalf of which the request is sent.

See Acting Air Navigation Unit.

c. DateTimeSecond sendTime (Mandatory)

UTC time at which the client application has sent the request.

15.5.61. ServiceGroup
<<strict enumeration>>

Lists the possible NOP/B2B service groups.

1. Values:

a. COMMON

The Common Services Service Group.

b. GENERAL_INFORMATION

The General Information Services Service Group.

c. AIRSPACE

The Airspace Services Service Group.

d. FLOW

The Flow Services Service Group.

e. FLIGHT

The Flight Services Service Group.

f. FFICE

The FF-ICE Services Service Group.

2. Used by: Error

15.5.62. ShiftHourMinute
<<class>>

Representation of a signed duration (with minute precision). A negative shift represents a shift in

Edition: 27.0 6 209

Document Title: NM 27.0 - NM B2B Reference Manual

the past.

1. Attributes:

a. Sign sign (Mandatory)

The mathematical sign (+ or -).

b. DurationHourMinute value (Mandatory)

The numerical value.

2. Used by: Flight

15.5.63. Sign
<<enumeration>>

Convenience type used to express a sign in a signed type.

1. Values:

a. PLUS

The mathematical '+' sign.

b. MINUS

The mathematical '-' sign.

2. Used by: ShiftHourMinute

15.5.64. SignedDistanceNM (new 27.0)

<<typedef[int]>>

Measure of the delta distance between two points expressed as a positive or negative integer
amount of nautical miles.

1. Used by: AlternativeRouteInfo

15.5.65. SignedDurationHourMinute (new 27.0)

<<typedef[string]>>

String representation of a signed duration with minute precision.

Its format is " +hhmm " for positive or 0 duration, " -hhmm " for strictly negative duration.

Examples:

• " +0850 ": positive duration of 8 hours 50 minutes

• " -0850 ": negative duration of 8 hours 50 minutes

Edition: 27.0 6 210

Document Title: NM 27.0 - NM B2B Reference Manual

Possible values of hh are 2-digit numeric in [00, .., 99].

Possible values of mm are 2-digit numeric in [00, …, 59].

1. Pattern: (+|-)DIGIT{4}

2. Used by: AlternativeRouteInfo

15.5.66. SignedDurationHourMinuteSecond
<<typedef[string]>>

String representation of a signed duration with second precision.

Its format is " +hhmmss " for positive or 0 duration, " -hhmmss " for strictly negative duration.

Examples:

• " +085032 ": positive duration of 8 hours 50 minutes 32 seconds

• " -085032 ": negative duration of 8 hours 50 minutes 32 seconds

Possible values of hh are 2-digit numeric in [00, .., 99].

Possible values of mm are 2-digit numeric in [00, …, 59].

Possible values of ss are 2-digit numeric in [00, …, 59].

1. Pattern: (+|-)DIGIT{6}

2. Used by: ProposalInformation, GroupReroutingSummary

15.5.67. SignedWeightKg (new 27.0)

<<typedef[int]>>

A positive or negative weight in kilograms.

1. range : [-999999, 999999]

2. Used by: AlternativeRouteInfo

15.5.68. SimulationId
<<typedef[string]>>

Unique id of an NM simulation.

1. Pattern: ANY{1,200}

2. Used by: SimulationListRequest, DatasetReference, SimulationIdentifier

Edition: 27.0 6 211

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.69. SimulationIdentifier
<<class>>

The identifier of a simulation. See Forecast, Operational and Simulation DataSets.

1. Attributes:

a. SimulationType simulationType (Mandatory)

Describes the different types of simulations.

b. SimulationId simulationId (Mandatory)

The id of the simulation.

i. Constraints:

▪ SimulationIdentifier.INVALID_SIMULATION_ID

2. Constraints:

a. INVALID_SIMULATION_ID

Invalid Simulation Id.

Constrained attributes: simulationId

Constrained requests: any using request

3. Used by: Dataset

15.5.70. SimulationState
<<enumeration>>

1. Values:

a. INITIAL

Identifies the initial state of a simulation, i.e. the state of the simulation as it was when it
was created.

b. CURRENT

Identifies the current state of a simulation, i.e. including all the changes performed until the
current moment.

2. Used by: Dataset

15.5.71. SimulationType
<<strict enumeration>>

Describes the different types of simulations.

Edition: 27.0 6 212

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. STANDALONE_SIMEX

The simulation is a standalone SIMulation Experiment (SIMEX).

Special future events are typically prepared and simulated on SIMEX with specially
modified environment (CACD) data and forecasted traffic.

It can be used as a reference for other simulations to evaluate different alternatives and
compare with the STANDALONE_SIMEX as reference.

The simulation is managed (start/stop) and prepared by NMOC for the other users (B2B &
B2C) to have a look at the results.

Optionally the users can create or modify the measures and tactical updates.

b. NMOC_MANAGED_SIMULATION

The simulation is managed (start/stop) and prepared by NMOC for the other users (B2B &
B2C) to have a look at the results.

Optionally the users can create or modify the measures and tactical updates to evaluate the
what-if effects.

c. USER_MANAGED_SIMULATION

The simulation is managed (start/stop) and prepared by the users (via B2B & B2C) to
simulate some measures and evaluate their effect.

In addition the user can request other users or NMOC to have a look at proposed solution or
to contribute to the simulation

2. Used by: SimulationIdentifier

15.5.72. Subscription (new 27.0)

<<abstract class>>

Base class for concrete subscriptions.

1. Attributes:

a. SubscriptionSummary summary (Mandatory)

The subscription summary.

15.5.73. SubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 213

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Common ancestor of all subscription creation requests.

A newly created subscription is in state PAUSED and therefore it does not

IMPORTANT collect messages. To activate the subscription the user must explicitly call the
SubscriptionResumeRequest method.

1. Inherits from: Request

2. Attributes:

a. string description (Optional)

The textual description of the subscription.

i. Constraints:

▪ Pattern: ANY{1,500}

b. QueueName queueName (Optional)

If set, it instructs NM to re-use an existing client queue for this subscription. If not set, it
requires NM to create a new client queue for this subscription on the B2B Broker (this is the
default behaviour). Note that it is not possible to re-use a queue associated exclusively to
DELETED subscriptions or to subscriptions created in a different NM release.

When re-using the same queue for more than one subscription NM will check that all
subscriptions are related to the same subscription topic and were created with the same NM
release and will return an error otherwise.

15.5.74. SubscriptionDeletionReplyData (new 27.0)

<<class>>

The SubscriptionDeletionReply payload.

1. Used by: SubscriptionDeletionReply

Edition: 27.0 6 214

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.75. SubscriptionField (new 27.0)

<<enumeration>>

Enumerates the subscription fields that can be updated.

Each enumeration value corresponds to a homonym attribute in the Subscription type. Please refer
to such type for a full description of each attribute.

The state field can only be updated via pause/resume/delete operations.

The other fields can be updated via SubscriptionUpdateRequest.

1. Values:

a. state

The state field.

b. description

The description field.

c. messageFilter

The messageFilter field.

d. payloadConfiguration

The payloadConfiguration field.

2. Used by: SubscriptionTechnicalMessage

15.5.76. SubscriptionHistoryItem (new 27.0)

<<class>>

Subscription history item.

1. Attributes:

a. UUID uuid (Mandatory)

The unique identifier of the subscription.

b. VersionNumber version (Mandatory)

The subscription version. See Subscription last update.

c. SubscriptionState state (Mandatory)

The state of the subscription.

d. string description (Optional)

Edition: 27.0 6 215

Document Title: NM 27.0 - NM B2B Reference Manual

The textual description of the subscription provided by the user.

i. Constraints:

▪ Pattern: ANY{1,500}

e. string updatedBy (Mandatory)

The userId of the user who has updated the subscription.

i. Constraints:

▪ Pattern: ANY{1,100}

f. Timestamp updatedOn (Mandatory)

The timestamp when the subscription was updated.

g. SubscriptionUpdateReason updatedReason (Mandatory)

The reason why the latest subscription status has changed (for example, from ACTIVE to
PAUSED ).

h. string updatedComment (Optional)

A free text comment of the reason why the latest subscription status has changed.

i. Constraints:

▪ Max length: 256

▪ Max length inclusive: true

i. boolean heartbeatEnabled (Mandatory)

Indicates if HeartbeatTechnicalMessage 's must be sent or not on the subscription queue.

2. Used by: SubscriptionHistoryReplyData

15.5.77. SubscriptionHistoryReplyData (new 27.0)

<<class>>

The SubscriptionHistoryReply payload.

1. Attributes:

a. list< SubscriptionHistoryItem > history (Optional)

The list of subscription history items.

b. boolean hasMoreItems (Mandatory)

Flag indicating whether there exists more subscription history items than the ones in the
returned list. See Subscription history reply size limit.

Edition: 27.0 6 216

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: SubscriptionHistoryReply

15.5.78. SubscriptionListReplyData (new 27.0)

<<class>>

The SubscriptionListReply payload.

1. Attributes:

a. list< SubscriptionSummary > subscriptions (Optional)

Set of subscription summaries.

2. Used by: SubscriptionListReply

15.5.79. SubscriptionManagementErrorType (new 27.0)

<<enumeration>>

Error types for subscription management.

1. Values:

a. DUPLICATE_SUBSCRIPTION

The subscription already exists.

b. INVALID_QUEUENAME

No compatible subscription could be found with a given queue name.

c. UNKNOWN_SUBSCRIPTION

The subscription does not exist.

d. OPERATION_NOT_ALLOWED

The management operation is not allowed because of the subscription state.

e. TOO_MANY_SUBSCRIPTIONS

The subscription cannot be created because the maximum number of non-deleted

subscriptions on the same topic has been reached.

15.5.80. SubscriptionPauseReplyData (new 27.0)

<<class>>

The SubscriptionPauseReply payload.

1. Used by: SubscriptionPauseReply

Edition: 27.0 6 217

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.81. SubscriptionResumeReplyData (new 27.0)

<<class>>

The SubscriptionResumeReply payload.

1. Used by: SubscriptionResumeReply

15.5.82. SubscriptionRetrievalRequest (new 27.0)

<<abstract class>>

Common ancestor of all subscription retrieval requests.

1. Inherits from: Request

2. Attributes:

a. UUID uuid (Mandatory)

The UUID of the subscription to retrieve.

b. VersionNumber version (Optional)

The version of the subscription to retrieve. If not provided the latest (current) version is
returned.

The values of SubscriptionSummary attributes state, description, lastUpdatedBy, lastUpdatedOn,

lastUpdateReason, lastUpdateComment and heartbeatEnabled are the latest ones linked to that
version (see Subscription last update).

The available versions can be obtained thanks to a SubscriptionHistoryRequest /

SubscriptionHistoryReply.

If the provided version does not exist, a reply with status OBJECT_NOT_FOUND is returned.

15.5.83. SubscriptionState (new 27.0)

<<enumeration>>

Enumerates all the states in which a Subscription can be.

Edition: 27.0 6 218

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. ACTIVE

It means the subscription is collecting messages on the associated queue.

b. PAUSED

The subscription has been paused by the client: the subscription is still valid but it is
inactive, i.e. it does not collect messages until it will be resumed by the client.

c. SUSPENDED_ACTIVE

The subscription has been suspended by NM while it was ACTIVE . A suspended subscription
behaves like a PAUSED one in the sense that it does not collect messages, but only NM can
suspend a subscription. Once a subscription is suspended, only NM can un-suspend it. Un-
suspending a SUSPENDED_ACTIVE subscription will set it back to ACTIVE .

d. SUSPENDED_PAUSED

The subscription has been suspended by NM while it was PAUSED . The behaviour of a
subscription in state SUSPENDED_PAUSED is the same as for SUSPENDED_ACTIVE . Un-suspending a
SUSPENDED_PAUSED subscription will set it back to PAUSED . The two different states are needed
to be able to go back to the original state before the suspension.

e. DELETED

The subscription has been deleted, either by the client or by NM. A DELETED subscription is no
longer available for further operations.

2. Used by: SubscriptionHistoryItem, SubscriptionSummary, HeartbeatTechnicalMessage,

SubscriptionTechnicalMessage, SubscriptionListRequest

15.5.84. SubscriptionSummary (new 27.0)

<<class>>

A P/S subscription summary.

1. Attributes:

a. UUID uuid (Mandatory)

The unique identifier of the subscription, generated by NM.

b. VersionNumber version (Mandatory)

The subscription version number.

▪ The version number initial value is 1

▪ The version number is incremented on each subscription update request (but not on
subscription state update)

Edition: 27.0 6 219

Document Title: NM 27.0 - NM B2B Reference Manual

c. NMRelease release (Mandatory)

The NM release in which the subscription was created. It is assigned by NM.

d. AirNavigationUnitId anuId (Mandatory)

The ANU id who is the owner of the subscription. It is derived from the userId when the
subscription is created.

e. QueueName queueName (Mandatory)

The name of the queue on the B2B Broker associated to the subscription.

f. SubscriptionTopic topic (Mandatory)

The topic of the subscription.

g. SubscriptionState state (Mandatory)

The state of the subscription.

h. string description (Optional)

The textual description of the subscription provided by the user.

i. Constraints:

▪ Pattern: ANY{1,500}

i. DateTimeSecond creationDate (Mandatory)

The timestamp in which the subscription was created.

j. string lastUpdatedBy (Mandatory)

The userId of the user who has last updated the subscription.

i. Constraints:

▪ Pattern: ANY{1,100}

k. Timestamp lastUpdatedOn (Mandatory)

The timestamp when the subscription was last updated.

l. SubscriptionUpdateReason lastUpdateReason (Mandatory)

The reason why the latest subscription status has changed (for example, from ACTIVE to
PAUSED ).

m. string lastUpdateComment (Optional)

A free text comment of the reason why the latest subscription status has changed.

Edition: 27.0 6 220

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ Max length: 256

▪ Max length inclusive: true

n. boolean heartbeatEnabled (Mandatory)

Indicates if HeartbeatTechnicalMessage 's must be sent or not on the subscription queue.

2. Used by: Subscription, SubscriptionListReplyData

15.5.85. SubscriptionSynchronisationAbortReason (new 27.0)

<<enumeration>>

This enumeration lists the reasons why a subscription synchronisation has been aborted.

1. Values:

a. USER_REQUEST

User requests to abort the subscription synchronisation (via

SubscriptionSynchronisationAbortRequest).

b. MAINTENANCE

NM aborts the subscription synchronisation.

c. SUBSCRIPTION_NOT_ACTIVE

Subscription synchronisation has been aborted because the subscription state is no more
ACTIVE.

2. Used by: SubscriptionSynchronisationSummary

15.5.86. SubscriptionSynchronisationAbortReplyData (new 27.0)

<<class>>

The SubscriptionSynchronisationAbortReply payload.

1. Attributes:

a. SubscriptionSynchronisationSummary synchronisationSummary (Mandatory)

Summary information about the requested synchronisation.

2. Used by: SubscriptionSynchronisationAbortReply

15.5.87. SubscriptionSynchronisationReplyData (new 27.0)

<<class>>

Edition: 27.0 6 221

Document Title: NM 27.0 - NM B2B Reference Manual

The SubscriptionSynchronisationReply payload.

1. Attributes:

a. CorrelationId correlationId (Mandatory)

The correlation identifier set by NM on every synchronisation message sent to the B2B
queue subscription.

b. int messagesCount (Mandatory)

The number of messages sent to the B2B queue subscription. Every message is associated
with the correlation identifier set by NM.

i. Constraints:

▪ range : [0, unbounded[

2. Used by: SubscriptionSynchronisationReply

15.5.88. SubscriptionSynchronisationStatus (new 27.0)

<<enumeration>>

This enumeration lists the subscription synchronisation statuses.

1. Values:

a. STARTED

Subscription synchronisation has started.

b. COMPLETED

Subscription synchronisation has completed.

c. ABORTED

Subscription synchronisation has aborted.

2. Used by: SubscriptionSynchronisationSummary

15.5.89. SubscriptionSynchronisationSummary (new 27.0)

<<class>>

Summary information about a subscription synchronisation.

1. Attributes:

a. UUID subscriptionUuid (Mandatory)

The UUID of the subscription.

b. CorrelationId correlationId (Mandatory)

Edition: 27.0 6 222

Document Title: NM 27.0 - NM B2B Reference Manual

The unique identifier of the synchronisation request. All PS messages published as a result
of this synchronisation request will contain this correlationId.

c. int size (Optional)

The expected number of messages that will be published as a result of the synchronisation
request.

i. Constraints:

▪ range : [0, unbounded[

d. DateTimeSecond startTime (Mandatory)

The time when the B2B server started processing the synchronisation request.

e. DateTimeSecond endTime (Optional)

The time when the B2B server finished processing the synchronisation request or null if the
synchronisation is still ongoing.

f. SubscriptionSynchronisationStatus status (Mandatory)

The status of this subscription synchronisation request.

g. SubscriptionSynchronisationAbortReason abortReason (Optional)

The reason why this synchronisation was aborted. Null if the synchronisation is still ongoing
or if it completed.

2. Used by: SubscriptionSynchronisationAbortReplyData,

FficePublicationSubscriptionRetrievalReplyData, FlightDataSubscriptionRetrievalReplyData,
FlightPlanSubscriptionRetrievalReplyData, SubscriptionSynchronisationTechnicalMessage

15.5.90. SubscriptionSynchronisationTechnicalMessage (new 27.0)

<<class>>

The technical message ( TechnicalTopic.SYNCHRONISATION ) which is sent when a subscription

synchronisation starts, ends or aborts.

1. Inherits from: TechnicalPSMessage

2. Attributes:

a. SubscriptionSynchronisationSummary synchronisationSummary (Mandatory)

Summary information about the requested synchronisation.

Edition: 27.0 6 223

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.91. SubscriptionTechnicalMessage (new 27.0)

<<class>>

The technical P/S message for technical topic TechnicalTopic.SUBSCRIPTION .

1. Inherits from: TechnicalPSMessage

2. Attributes:

a. string subscriptionDescription (Optional)

The textual description of the subscription provided by the user at the time of creation.

i. Constraints:

▪ Pattern: ANY{1,500}

b. SubscriptionState subscriptionState (Mandatory)

The state of the subscription.

c. string lastUpdatedBy (Mandatory)

The userId of the user who has last updated the subscription.

i. Constraints:

▪ Pattern: ANY{1,100}

d. Timestamp lastUpdatedOn (Mandatory)

The timestamp when the subscription was last updated.

e. SubscriptionUpdateReason lastUpdateReason (Mandatory)

The reason why the subscription status has changed (for example, from ACTIVE to PAUSED ).

f. string lastUpdateComment (Optional)

A free text comment of the reason why the subscription status has changed.

i. Constraints:

▪ Max length: 256

▪ Max length inclusive: true

g. set< SubscriptionField > updatedFields (Optional)

Updated subscription fields.

15.5.92. SubscriptionTopic (new 27.0)

<<enumeration>>

Edition: 27.0 6 224

Document Title: NM 27.0 - NM B2B Reference Manual

This enumeration lists the topics currently available on the NM Publish/Subscribe.

1. Values:

a. ATM_INFORMATION

See ATM_INFORMATION.

b. AIRSPACE_DATA

See AIRSPACE_DATA.

c. REGULATIONS

See REGULATIONS.

d. REROUTINGS (new 27.0)

See REROUTINGS.

e. EAUP

See EAUP.

f. FLIGHT_PLANS

See FLIGHT_PLANS.

g. FLIGHT_DATA

See FLIGHT_DATA.

h. FLIGHT_FILING_RESULT

See FLIGHT_FILING_RESULT.

i. FFICE_PUBLICATION (new 27.0)

See FFICE_PUBLICATION.

j. FFICE_FLIGHT_FILING

See FFICE_FLIGHT_FILING.

k. MCDM

See MCDM.

2. Used by: BusinessPSMessage, SubscriptionSummary, TechnicalPSMessage

Edition: 27.0 6 225

Document Title: NM 27.0 - NM B2B Reference Manual

15.5.93. SubscriptionUpdateReason (new 27.0)

<<enumeration>>

Provides a reason for a change of state of a subscription.

1. Values:

a. USER_REQUEST

The change of state is the result of a B2B request sent by the user (e.g.,
SubscriptionPauseRequest).

b. MSG_EXPIRED

This is set if and only if the subscription is paused by NM due to a message expiring on the
queue.

Because at least one message has not been consumed by the user the subscription is paused
and therefore it is no longer collecting messages. This is done for two reasons: to avoid
wasting resources in publishing further messages that may also not be consumed (e.g. in
case of a prolonged user disconnection) and to prevent the user from continuing processing
messages unaware of the fact that some messages have been lost, leading to an inconsistent
view of the data.

When the subscription will be resumed by the user, a resynchronization is then needed to
re-obtain an up-to-date view of the data (for example via a new flight list if the subscription
was on FLIGHT_DATA) from which to restart processing messages.

If this reason happens on a regular basis it means that the client

application is consistently slow in consuming messages and therefore
the user is discouraged from continously resuming the subscription.
IMPORTANT This would in fact result in a loop in which NM pauses the
subscription and the client resumes it. Instead the user must solve the
issue of the slow consumer, e.g. by either connecting more consumers
on the same queue or improve the processing of messages on its side.

c. MAINTENANCE

This is a general value set when a subscription is paused, suspended, deleted or reactivated
by NM for any reason not covered by other enumeration values. When this happens, a
textual comment is usually associated providing more details about the change.

d. NM_UPDATE

This is set when a predefined NM-managed subscription is updated.

e. QUEUE_OVERFLOW

This is set when messages queue quota exceeded.

Edition: 27.0 6 226

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: SubscriptionHistoryItem, SubscriptionSummary, SubscriptionTechnicalMessage

15.5.94. SubscriptionUpdateRequest (new 27.0)

<<abstract class>>

Common ancestor of all subscription update requests.

A subscription can be updated only if its state is either PAUSED or ACTIVE.

Only the following fields can be updated (note that the state can only be updated via pause/resume
operations):

• description

• messageFilter

• payloadConfiguration

1. Inherits from: Request

2. Attributes:

a. UUID subscriptionUuid (Mandatory)

The unique identifier of the subscription to be updated.

i. Constraints:

▪ SubscriptionUpdateRequest.INVALID_SUBSCRIPTION_STATE

b. string description (Optional)

The textual description of the subscription.

i. Constraints:

▪ Pattern: ANY{1,500}

3. Constraints:

a. INVALID_SUBSCRIPTION_STATE

The subscription state must be ACTIVE or PAUSED .

Constrained attributes: subscriptionUuid

Edition: 27.0 6 227

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

15.5.95. TechnicalPSMessage (new 27.0)

<<abstract class>>

A TechnicalPSMessage is a PSMessage that conveys information of technical nature, such as the

suspension of a subscription, changes to the service, etc. Technical messages are published by NM
on the client queues alongside business messages (see BusinessPSMessage), therefore the user must
be able to process both types of messages.

For instance technical messages will be published by NM every time a subscription is modified, i.e.
created, paused, resumed, suspended, un-suspended, deleted.

1. Inherits from: PSMessage

2. Attributes:

a. TechnicalTopic topic (Mandatory)

The technical message’s topic.

b. UUID subscriptionUuid (Mandatory)

The UUID of the subscription for which this message was published.

c. VersionNumber subscriptionVersion (Mandatory)

The subscription version.

d. SubscriptionTopic subscriptionTopic (Mandatory)

The topic of the subscription.

15.5.96. TechnicalTopic (new 27.0)

<<enumeration>>

Topics for Technical Messages.

Technical Topics cannot be subscribed to, but they are implicitly associated to all client
subscriptions.

Technical Topics are used by NM to publish Technical Messages. These Technical Messages convey
information of technical nature that is of interest to the client.

1. Values:

a. SUBSCRIPTION

This topic is to notify a client about changes to his subscriptions (e.g. to notify that a
subscription has been suspended by NM).

Edition: 27.0 6 228

Document Title: NM 27.0 - NM B2B Reference Manual

The message type associated with this Technical Topic is the SubscriptionTechnicalMessage.

b. HEARTBEAT

This topic is associated to the publication of Heartbeat Messages. These are special technical
messages published on every subscription queue at frequent regular intervals (like a
heartbeat) to constantly inform the consumer about the current health (state) of the
subscription.

The message type associated with this Technical Topic is the HeartbeatTechnicalMessage.

c. SYNCHRONISATION (new 27.0)

This topic is associated to the start / end / abortion of a subscription synchronisation.

The message type associated with this Technical Topic is the

SubscriptionSynchronisationTechnicalMessage.

2. Used by: TechnicalPSMessage

15.5.97. TextReport
<<typedef[string]>>

A multiline textual report.

1. Pattern: MULTILINE_TEXT{0,1000000}

2. Used by: UserInformationReplyData

15.5.98. TimeHourMinute
<<typedef[string]>>

String representation of a UTC time in a day, limited to the minute precision.

Its format is " hh:mm ".

Possible values of hh are 2-digit numeric in [00, …, 23].

Possible values of mm are 2-digit numeric in [00, …, 59].

1. Pattern: DIGIT{2}:DIGIT{2}

2. Used by: SlotProposalFeedbackRequest, TimeHourMinutePeriod

15.5.99. TimeHourMinutePeriod
<<class>>

Left-closed, right-opened period of a time in a day.

1. Attributes:

Edition: 27.0 6 229

Document Title: NM 27.0 - NM B2B Reference Manual

a. TimeHourMinute wef (Optional)

Start time of the period.

If left to null, set to "00:00".

b. TimeHourMinute unt (Optional)

End time of the period.

If left to null, set to "24:00".

2. Used by: WeeklyScheduleItem, DepartureTolerance

15.5.100. Timestamp
<<typedef[string]>>

String representation of a timestamp (Gregorian Calendar - UTC).

Its format is " YYYY-MM-DD hh:mm:ss SSS ". Example: "2013-12-01 11:37:25 245".

Possible values of YYYY , MM and DD in " YYYY-MM-DD hh:mm:ss " are defined in DateYearMonthDay. SSS
represents milliseconds.

1. Pattern: DIGIT{4}-DIGIT{2}-DIGIT{2} DIGIT{2}:DIGIT{2}:DIGIT{2} DIGIT{3}

2. Used by: Message, SubscriptionHistoryItem, SubscriptionSummary, SubscriptionTechnicalMessage

15.5.101. UserId
<<typedef[string]>>

Id of a NOP user, e.g. a certificate owner id.

1. Pattern: ANY{1,11}

2. Used by: LastUpdate, LifeCycleEvent, UserManagedSimulation

15.5.102. UUID
<<typedef[string]>>

UUID in its canonical form: see UUID

Examples
" 550e8400-e29b-41d4-a716-446655440000 ".

1. Pattern: TEXT{36}

2. Used by: ASMScenarioActivationDeletionRequest, ASMScenarioActivationSummary,

SubscriptionHistoryItem, AbstractEAUPRSARequest, SubscriptionRetrievalRequest,
SubscriptionSummary, SubscriptionHistoryRequest,

Edition: 27.0 6 230

Document Title: NM 27.0 - NM B2B Reference Manual

AUPGetManageableRouteSegmentsForAMCAndRouteRequest, RevalidationInformation,
SubscriptionResumeRequest, TechnicalPSMessage, SubscriptionSynchronisationAbortRequest,
Message, SubscriptionSynchronisationRequest, SubscriptionSynchronisationSummary,
AbstractEAUPCDRRequest, BusinessPSMessage, ASMScenarioListReplyData, RevalidationInformation,
SubscriptionUpdateRequest, SubscriptionDeletionRequest, IRUUIDFilter, SubscriptionPauseRequest,
AUPGetManageableRoutesForAMCReplyData

15.5.103. VersionNumber
<<typedef[int]>>

A version number.

1. range : [0, unbounded[

2. Used by: BusinessPSMessage, SubscriptionHistoryItem, SubscriptionRetrievalRequest,

SubscriptionSummary, TechnicalPSMessage

15.5.104. WeekDay
<<strict enumeration>>

WeekDay

1. Values:

a. SUNDAY

Sunday.

b. MONDAY

Monday.

c. TUESDAY

Tuesday.

d. WEDNESDAY

Wednesday.

e. THURSDAY

Thursday.

f. FRIDAY

Friday.

g. SATURDAY

Saturday.

Edition: 27.0 6 231

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: WeeklyScheduleItem

15.5.105. WeeklySchedule

<<class>>

Represents a schedule that is repeated weekly.

1. Attributes:

a. set< WeeklyScheduleItem > weeklyScheduleItems (Mandatory)

The individual schedules that are to be repeated weekly.

2. Used by: ScenarioAttributes

15.5.106. WeeklyScheduleItem

<<class>>

Represents a schedule that can be repeated at the same time for several days of the week.

1. Attributes:

a. DateTimeMinutePeriodWithUFN globalPeriod (Mandatory)

The period of time during which the weekly schedule is to be applied (the given schedule is
applied within the period and not outside of it).

b. set< WeekDay > weekDaySet (Mandatory)

The days of the week to which this particular schedule applies.

c. TimeHourMinutePeriod dailyPeriod (Mandatory)

Edition: 27.0 6 232

Document Title: NM 27.0 - NM B2B Reference Manual

The time interval in the day during which this particular schedule applies.

2. Used by: WeeklySchedule

15.5.107. WeightKg
<<typedef[int]>>

Weight in kilograms.

1. range : [0, 999999]

2. Used by: AlternativeRouteInfo, BasicTrajectoryData, RouteInfo

Appendix A: AIRM Semantic Correspondence

• DateTimeMinutePeriod.wef

urn:aero:airm:1.0.0:LogicalModel:Abstract:Timesheet@startTime

• DateTimeMinutePeriod.unt

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomTimeType

• DateTimeMinutePeriodWithUFN.wef

urn:aero:airm:1.0.0:LogicalModel:Abstract:Timesheet@startTime

• DateTimeMinutePeriodWithUFN.unt

urn:aero:airm:1.0.0:LogicalModel:Abstract:Timesheet@endTime

• DateYearMonthDayPeriod.wef

urn:aero:airm:1.0.0:LogicalModel:Abstract:Timesheet@startTime

• DateYearMonthDayPeriod.unt

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomTimeType

• EstimateQualifier.ESTIMATED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodePlanningStatusType@ESTIM
ATED

• EstimateQualifier.ACTUAL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodePlanningStatusType@ACTUA
L

• File.id

Edition: 27.0 6 233

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• LastUpdate.airNavigationUnitId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@name (additional)

• Latitude.angle

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:AngleIndication (additional)

• SubscriptionSummary.uuid

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• SubscriptionUpdateRequest.subscriptionUuid

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• TimeHourMinutePeriod.wef

urn:aero:airm:1.0.0:LogicalModel:Abstract:Timesheet@startTime

• TimeHourMinutePeriod.unt

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomTimeType

• WeekDay.SUNDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@SUNDAY

• WeekDay.MONDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@SUNDAY

• WeekDay.TUESDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@TUESDAY

• WeekDay.WEDNESDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@WEDNESDAY

• WeekDay.THURSDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@THURSDAY

• WeekDay.FRIDAY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@FRIDAY

• WeekDay.SATURDAY

Edition: 27.0 6 234

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeDayType@SATURDAY

Appendix B: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

15.B.1. Request / Reply Settings

Table 9. Compression settings

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

15.B.2. Time Window Request / Reply Count Quotas

Table 10. SubscriptionManagement Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

SubscriptionPauseReque 30 36 60
st/Reply

SubscriptionResumeRequ 30 36 60
est/Reply

SubscriptionDeletionRe 30 36 60
quest/Reply

SubscriptionListReques 30 36 60
t/Reply

SubscriptionHistoryReq 30 36 60
uest/Reply

SubscriptionSynchronis 3 4 3600
ationRequest/Reply

SubscriptionSynchronis 30 36 60
ationAbortRequest/Repl
y

Edition: 27.0 6 235

Document Title: NM 27.0 - NM B2B Reference Manual

Table 11. Messaging Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

MessagePullRequest/Rep 30 36 60
ly

15.B.3. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Edition: 27.0 6 236

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 16. General Information

16.1. Context
1. This service group is aimed at giving access to information of a general nature, e.g. AIM,
Headline News, etc.

2. The GeneralInformationServices B2B service group exposes the following services:

a. AIMsService - Serving ATFCM Information Messages (AIMs)

b. NMB2BInfoService - General information about the NM B2B service provision

16.2. PREOPS Testing

1. The data available on the PREOPS platform for the current AIMsService is fed daily from the
OPS systems.

16.2.1. AIM P/S Messages

1. AIM Messages may be of two kinds: manually written or automatically generated.

2. In general the AIMs are imported from the OPS platform to the PREOPS only once a day. The
publication of AIM Messages via P/S on PREOPS is dependent on this data alignment: a new AIM
message is published only when a new AIM is detected. So in PREOPS this will result in the
publication of several AIMs (all the once imported from OPS) in a very short time (the time
when the data alignment is performed).

3. However, some AIMs are "special". These are the ones which are automatically generated for
each taxi-time update. Since taxi-time updates are imported in PREOPS more frequently (every
5 minutes) the publication of these types of AIMs in PREOPS is more frequent.

16.3. AIMs Port Type

16.3.1. Overview

1. The AIMsService allows for querying and retrieving ATFCM Information Messages (AIMs):

a. P/S ATM_INFORMATION

b. S-R/R AIMListRequest/Reply

c. S-R/R AIMRetrievalRequest/Reply

16.3.2. Publish/Subscribe Topics

16.3.2.1. ATM_INFORMATION

Edition: 27.0 6 237

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: AIMMessage

Ordering policy:

Not Applicable: NM does not publish multiple messages for the same AIM.

Subscription management (topic specific):

• S-R/R AIMSubscriptionCreationRequest/Reply

• S-R/R AIMSubscriptionUpdateRequest/Reply

• S-R/R AIMSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Notification about newly published AIMs (ATM Information Messages).

16.3.2.1.1. AIMMessage (new 27.0)

<<class>>

The business P/S message for topic ATM_INFORMATION.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. AIM payload (Mandatory)

The payload of this AIMMessage .

16.3.2.1.2. AIMSubscriptionCreationRequest/Reply (new 27.0)

Edition: 27.0 6 238

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AIMSubscriptionCreationRequest

Reply: AIMSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AIMSubscriptionCreationReply createAIMSubscription(AIMSubscriptionCreationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic ATM_INFORMATION.

AIMSubscriptionCreationRequest (new 27.0)

<<class>>

It allows creating a new subscription for topic ATM_INFORMATION.

1. Inherits from: SubscriptionCreationRequest

AIMSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to AIMSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. AIMSubscriptionCreationReplyData data (Optional)

Edition: 27.0 6 239

Document Title: NM 27.0 - NM B2B Reference Manual

The reply payload.

16.3.2.1.3. AIMSubscriptionUpdateRequest/Reply (new 27.0)

MEP: S-R/R

Request: AIMSubscriptionUpdateRequest

Reply: AIMSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AIMSubscriptionUpdateReply updateAIMSubscription(AIMSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic ATM_INFORMATION.

AIMSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic ATM_INFORMATION.

1. Inherits from: SubscriptionUpdateRequest

AIMSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to AIMSubscriptionUpdateRequest.

Edition: 27.0 6 240

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. AIMSubscriptionUpdateReplyData data (Optional)

The reply payload.

16.3.2.1.4. AIMSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: AIMSubscriptionRetrievalRequest

Reply: AIMSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AIMSubscriptionRetrievalReply
retrieveAIMSubscription(AIMSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic ATM_INFORMATION.

AIMSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic ATM_INFORMATION.

1. Inherits from: SubscriptionRetrievalRequest

Edition: 27.0 6 241

Document Title: NM 27.0 - NM B2B Reference Manual

AIMSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to AIMSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. AIMSubscriptionRetrievalReplyData data (Optional)

The reply payload.

16.3.3. Requests/Replies

16.3.3.1. AIMListRequest/Reply

MEP: S-R/R

Request: AIMListRequest

Reply: AIMListReply

Response time: 5 / 15 / 64 (ms)

Default settings: request count quotas

SOAP operation:

AIMListReply queryAIMs(AIMListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the AIM summaries of which the validity period overlaps the given day of operation.

16.3.3.1.1. AIMListRequest

Edition: 27.0 6 242

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the AIM summaries of which the validity period overlaps the given day of
operation.

1. Inherits from: Request

2. Attributes:

a. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the AIM summaries are requested.

i. Constraints:

▪ AIMListRequest.DAY_OF_OPERATION_LESS_THAN_14_MONTHS

3. Constraints:

a. DAY_OF_OPERATION_LESS_THAN_14_MONTHS

The dayOfOperation must be less than 14 months in the past up to any time in the future.

Constrained attributes: dayOfOperation

Constrained requests: any using request

16.3.3.1.2. AIMListReply

<<class>>

Returned in response to AIMListRequest.

1. Inherits from: Reply

2. Attributes:

a. AIMListReplyData data (Optional)

16.3.3.2. AIMRetrievalRequest/Reply

Edition: 27.0 6 243

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AIMRetrievalRequest

Reply: AIMRetrievalReply

Response time: 5 / 13 / 350 (ms)

Default settings: request count quotas

SOAP operation:

AIMRetrievalReply retrieveAIMs(AIMRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the AIM of given id.

16.3.3.2.1. AIMRetrievalRequest

<<class>>

Request to retrieve an AIM based on its unique id (extracted from an AIMSummary).

1. Inherits from: Request

2. Attributes:

a. AimId_DataType aimId (Mandatory)

AIM unique id.

16.3.3.2.2. AIMRetrievalReply

<<class>>

Edition: 27.0 6 244

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to AIMRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. AIMRetrievalReplyData data (Optional)

The reply payload.

16.4. NMB2BInfo Port Type

16.4.1. Overview

1. The NMB2BInfo port type exposes the following services:

a. S-R/R NMB2BReferenceManualsRequest/Reply

b. S-R/R NMB2BWSDLsRequest/Reply

c. S-R/R NMB2BScenariosRequest/Reply

d. S-R/R NMB2BAddendaErrataRequest/Reply

e. S-R/R NMReleaseInformationRequest/Reply

f. S-R/R UserInformationRequest/Reply

16.4.2. Requests/Replies

16.4.2.1. NMB2BReferenceManualsRequest/Reply

MEP: S-R/R

Request: NMB2BReferenceManualsRequest

Reply: NMB2BReferenceManualsReply

Response time: 430 / 880 / 920 (ms)

Default settings: request count quotas

SOAP operation:

NMB2BReferenceManualsReply queryNMB2BReferenceManuals(NMB2BReferenceManualsRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 245

Document Title: NM 27.0 - NM B2B Reference Manual

Queries the NM B2B reference manuals and the NM B2B release notes for the given version.

16.4.2.1.1. NMB2BReferenceManualsRequest

<<class>>

NM B2B reference manuals query request.

1. Inherits from: Request

2. Attributes:

a. NMB2BVersion version (Mandatory)

One of the supported NM B2B versions.

16.4.2.1.2. NMB2BReferenceManualsReply

<<class>>

Returned in response to NMB2BReferenceManualsRequest.

1. Inherits from: Reply

2. Attributes:

a. NMB2BReferenceManualsReplyData data (Optional)

The reply payload.

16.4.2.2. NMB2BWSDLsRequest/Reply

Edition: 27.0 6 246

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: NMB2BWSDLsRequest

Reply: NMB2BWSDLsReply

Response time: 110 / 150 / 180 (ms)

Default settings: request count quotas

SOAP operation:

NMB2BWSDLsReply queryNMB2BWSDLs(NMB2BWSDLsRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the NM B2B WDSLs and the NM B2B XSDs for the given version.

16.4.2.2.1. NMB2BWSDLsRequest

<<class>>

NM B2B WDSLs and XSDs request.

1. Inherits from: Request

2. Attributes:

a. NMB2BVersion version (Mandatory)

One of the supported NM B2B versions.

16.4.2.2.2. NMB2BWSDLsReply

<<class>>

Edition: 27.0 6 247

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to NMB2BWSDLsRequest.

1. Inherits from: Reply

2. Attributes:

a. NMB2BWSDLsReplyData data (Optional)

The reply payload.

16.4.2.3. NMB2BScenariosRequest/Reply

MEP: S-R/R

Request: NMB2BScenariosRequest

Reply: NMB2BScenariosReply

Response time: 120 / 120 / 120 (ms)

Default settings: request count quotas

SOAP operation:

NMB2BScenariosReply queryNMB2BScenarios(NMB2BScenariosRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the NM B2B sample scenarios, i.e. one plain XML and one SOAP Request / Reply sample
per Request / Reply type.

16.4.2.3.1. NMB2BScenariosRequest

<<class>>

Edition: 27.0 6 248

Document Title: NM 27.0 - NM B2B Reference Manual

NM B2B scenarios request.

1. Inherits from: Request

2. Attributes:

a. NMB2BVersion version (Mandatory)

One of the supported NM B2B versions.

16.4.2.3.2. NMB2BScenariosReply

<<class>>

Returned in response to NMB2BScenariosRequest.

1. Inherits from: Reply

2. Attributes:

a. NMB2BScenariosReplyData data (Optional)

The reply payload.

16.4.2.4. NMB2BAddendaErrataRequest/Reply

MEP: S-R/R

Request: NMB2BAddendaErrataRequest

Reply: NMB2BAddendaErrataReply

Response time: not available

Default settings: request count quotas

SOAP operation:

NMB2BAddendaErrataReply queryNMB2BAddendaErrata(NMB2BAddendaErrataRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

This service allows querying for a document describing the late modifications or additions
(addenda) to the B2B reference manuals and errors (errata) discovered after initial
publication.

Edition: 27.0 6 249

Document Title: NM 27.0 - NM B2B Reference Manual

16.4.2.4.1. NMB2BAddendaErrataRequest

<<class>>

This service allows querying for a document describing the late modifications or additions
(addenda) to the B2B reference manuals and errors (errata) discovered after initial publication.

This document is associated to a NM B2B version.

This document may also contain patch description (it is possible that a patch is applied to one or
more NM B2B versions).

1. Inherits from: Request

2. Attributes:

a. NMB2BVersion version (Mandatory)

One of the supported NM B2B versions.

16.4.2.4.2. NMB2BAddendaErrataReply

<<class>>

Returned in response to NMB2BAddendaErrataRequest.

1. Inherits from: Reply

2. Attributes:

a. NMB2BAddendaErrataReplyData data (Optional)

The reply payload.

16.4.2.5. NMReleaseInformationRequest/Reply

Edition: 27.0 6 250

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: NMReleaseInformationRequest

Reply: NMReleaseInformationReply

Response time: 1 / 2 / 7 (ms)

Default settings: request count quotas

SOAP operation:

NMReleaseInformationReply retrieveNMReleaseInformation(NMReleaseInformationRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieve the NM Release Information that is attached to the NM B2B.

16.4.2.5.1. NMReleaseInformationRequest

<<class>>

NM Release Information request.

1. Inherits from: Request

16.4.2.5.2. NMReleaseInformationReply

<<class>>

Returned in response to NMReleaseInformationRequest.

1. Inherits from: Reply

2. Attributes:

Edition: 27.0 6 251

Document Title: NM 27.0 - NM B2B Reference Manual

a. NMReleaseInformationReplyData data (Optional)

The reply payload.

16.4.2.6. UserInformationRequest/Reply

MEP: S-R/R

Request: UserInformationRequest

Reply: UserInformationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

UserInformationReply retrieveUserInformation(UserInformationRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the information associated by NM to the user or more precisely, to the certificate.

16.4.2.6.1. UserInformationRequest

<<class>>

User or more precisely certificate information request.

1. Inherits from: Request

Edition: 27.0 6 252

Document Title: NM 27.0 - NM B2B Reference Manual

16.4.2.6.2. UserInformationReply

<<class>>

Returned in response to UserInformationRequest.

1. Inherits from: Reply

2. Attributes:

a. UserInformationReplyData data (Optional)

The reply payload.

16.5. Data Types

16.5.1. AIM
<<class>>

1. Attributes:

a. AIMSummary summary (Optional)

AIM summary.

b. string message (Optional)

AIM body.

New line characters are encoded using "\n".

2. Used by: AIMMessage, AIMRetrievalReplyData

16.5.2. AimId_DataType
<<typedef[string]>>

1. Pattern: DIGIT{8}

2. Used by: AIMRetrievalRequest

16.5.3. AIMListReplyData
<<class>>

The AIMListReply payload.

1. Attributes:

a. AIMSummary[] summaries (Mandatory)

The list of AIM summaries that match the query.

Edition: 27.0 6 253

Document Title: NM 27.0 - NM B2B Reference Manual

The order of the AIM summaries in the returned list is not significant.

The returned array is empty if no match was found.

2. Used by: AIMListReply

16.5.4. AIMRetrievalReplyData
<<class>>

The AIMRetrievalReply payload.

1. Attributes:

a. AIM aim (Mandatory)

The requested AIM.

2. Used by: AIMRetrievalReply

16.5.5. AIMSubscription (new 27.0)

<<class>>

Subscription of topic ATM_INFORMATION.

1. Inherits from: Subscription

2. Used by: AIMSubscriptionUpdateReplyData, AIMSubscriptionRetrievalReplyData,

AIMSubscriptionCreationReplyData

16.5.6. AIMSubscriptionCreationReplyData (new 27.0)

<<class>>

The AIMSubscriptionCreationReply payload.

1. Attributes:

a. AIMSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: AIMSubscriptionCreationReply

Edition: 27.0 6 254

Document Title: NM 27.0 - NM B2B Reference Manual

16.5.7. AIMSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The AIMSubscriptionRetrievalReply payload.

1. Attributes:

a. AIMSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: AIMSubscriptionRetrievalReply

16.5.8. AIMSubscriptionUpdateReplyData (new 27.0)

<<class>>

The AIMSubscriptionUpdateReply payload.

1. Attributes:

a. AIMSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: AIMSubscriptionUpdateReply

16.5.9. AIMSummary
<<class>>

1. Attributes:

a. string id (Optional)

AIM unique id.

b. DateYearMonthDayPeriod validityPeriod (Optional)

The period for which the AIM is valid.

c. DateTimeMinute releaseTime (Optional)

The time at which the AIM was released.

d. string description (Optional)

AIM short description.

2. Used by: AIM, AIMListReplyData

Edition: 27.0 6 255

Document Title: NM 27.0 - NM B2B Reference Manual

16.5.10. B2BInfoFile
<<class>>

Represents the B2B publication artefacts:

1. B2B Reference Manuals

2. B2B WSDLs and XSDs

3. B2B Scenarios

1. Inherits from: File

2. Attributes:

a. boolean hasAddendaErrata (Optional)

Indicates whether a correction has been applied to this version of documents.

3. Used by: NMB2BWSDLsReplyData, NMB2BReferenceManualsReplyData, NMB2BScenariosReplyData,

NMB2BAddendaErrataReplyData

16.5.11. NMB2BAddendaErrataReplyData
<<class>>

The NMB2BAddendaErrataReply payload.

1. Attributes:

a. B2BInfoFile file (Mandatory)

Identification of the NM B2B Addenda-Errata document corresponding to the requested NM

B2B version.

2. Used by: NMB2BAddendaErrataReply

16.5.12. NMB2BReferenceManualsReplyData
<<class>>

The NMB2BReferenceManualsReply payload.

1. Attributes:

a. B2BInfoFile file (Mandatory)

Identification of the compressed file containing the NM B2B reference manuals and the NM
B2B release notes corresponding to the requested NM B2B version.

2. Used by: NMB2BReferenceManualsReply

Edition: 27.0 6 256

Document Title: NM 27.0 - NM B2B Reference Manual

16.5.13. NMB2BScenariosReplyData
<<class>>

The NMB2BScenariosReply payload.

1. Attributes:

a. B2BInfoFile file (Mandatory)

Identification of the compressed file containing the NM B2B Scenarios corresponding to the
requested NM B2B version.

2. Used by: NMB2BScenariosReply

16.5.14. NMB2BWSDLsReplyData
<<class>>

The NMB2BWSDLsReply payload.

1. Attributes:

a. B2BInfoFile file (Mandatory)

Identification of the compressed file containing the NM B2B WSDLs and the NM B2B XSDs
corresponding to the requested NM B2B version.

2. Used by: NMB2BWSDLsReply

16.5.15. NMReleaseInformationReplyData
<<class>>

The NMReleaseInformationReply payload.

It provides relevant information about the NM B2B provider agent (or NM B2B endpoint).

1. Attributes:

a. NMRelease release (Mandatory)

The NM release number deployed on this NM B2B endpoint. Note that one NM release
exposes multiple B2B versions (see attribute 'supportedB2BVersions').

b. NMB2BProviderVersion baseline (Mandatory)

The unique identifier of the software (the baseline or build id) running by the NM B2B
provider agent.

c. NMB2BVersion[] supportedB2BVersions (Mandatory)

The list of NM B2B versions served by the NM B2B server.

Edition: 27.0 6 257

Document Title: NM 27.0 - NM B2B Reference Manual

d. NMPlatform platform (Mandatory)

The platform where the NM B2B provider agent is running. It identifies the execution
environment (e.g. OPS vs PREOPS) and the execution chain (the physical NM system).

2. Used by: NMReleaseInformationReply

16.5.16. UserInformationReplyData
<<class>>

The UserInformationReply payload.

1. Attributes:

a. TextReport textReport (Mandatory)

The user information textual report.

For more information about the report organisation and contents, see User Information
Report.

2. Used by: UserInformationReply

Appendix C: AIRM Semantic Correspondence

NOTE No AIRM semantic correspondence for this service group.

Appendix D: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

16.D.1. Request / Reply Settings

Table 12. Compression settings

Edition: 27.0 6 258

Document Title: NM 27.0 - NM B2B Reference Manual

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

16.D.2. Time Window Request / Reply Count Quotas

Table 13. AIMs Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

AIMListRequest/Reply 150 180 600

AIMRetrievalRequest/Re 555 666 600

ply

AIMSubscriptionCreatio 30 36 60
nRequest/Reply

AIMSubscriptionUpdateR 30 36 60
equest/Reply

AIMSubscriptionRetriev 30 36 60
alRequest/Reply

Table 14. NMB2BInfo Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

NMB2BReferenceManualsR 5 6 60
equest/Reply

NMB2BWSDLsRequest/Repl 5 6 60
y

NMB2BScenariosRequest/ 5 6 60
Reply

NMB2BAddendaErrataRequ 5 6 60
est/Reply

NMReleaseInformationRe 5 6 60
quest/Reply

UserInformationRequest 5 6 60
/Reply

16.D.3. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Table 15. ATM_INFORMATION

Edition: 27.0 6 259

Document Title: NM 27.0 - NM B2B Reference Manual

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 300 Delay from the AIM publication

MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B

certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Edition: 27.0 6 260

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 17. Airspace

17.1. Context
17.1.1. Introduction

1. The AirspaceServices NM B2B service group is intended to provide services related to the
management and sharing of Airspace data (e.g. airspaces, routes, aerodromes, etc.) used by the
NM system.

2. The AirspaceServices group consists of two port types:

a. AirspaceStructureService: for retrieving up-to-date airspace data from the CACD database.
The CACD database is the repository for the environment data, including airspace data, used
in the NM system to perform its flight and flow functions. This data includes AIP concepts
(such as routes, points or airports/heliports), and non-AIP concepts (such as flows, RAD
restrictions or traffic volumes).

AIP concepts such as airspaces may differ slightly from the AIP definition: for example when
the AIP in defining an airspace reads "follow the border between country X and Y", this must
be translated into a real geometry that can be interpreted efficiently by the NM system.

b. AirspaceAvailabilityService: for querying and modifying the airspace availability

information; this includes the Flexible Use of Airspace (FUA — AUP/UUP and EAUP/EUUP).

3. The Airspace services make use of AIXM/ADR-E types when possible. This does not mean that all
data types defined in this service group are AIXM or ADR-E types, as other service groups (like
Flight and Flow) use non-AIXM types, and because Airspace querying services must still use, for
example, traditional ICAO ids (not UUIDs that do not support wildcards).

4. The version of AIXM used by NM is 5.1.1.

Whenever the word AIXM is used in the NM B2B documentation, it refers to AIXM 5.1.1.

5. Documentation about AIXM can be found in AIXM .

6. The ADR Extension is based on a UML model which is published on the Eurocontrol OneSky
website (see ADR Extension Model ).

17.1.2. AIXM / ADR Extension Usage

1. This section describes how the AIXM model is used in terms of:

◦ Container message

◦ Temporality

◦ Feature/Object identification and referencing

17.1.2.1. ADR Message

1. The ADR Message is the container for exchanging AIXM Features.

Edition: 27.0 6 261

Document Title: NM 27.0 - NM B2B Reference Manual

2. An ADR Message may contain 0..n AIXM Features.

3. An ADR Message is represented in the NM Exchange Model as typedef.

typedef<String> airspace:ADRMessageType;

4. Depending on the service, the ADR Message may be embedded in the B2B reply as part of the
message or returned as a file. When returned as a file, each file contains a single ADR Message.
When embedded in the B2B reply, the reply may contain one or more ADR Messages.

5. An ADR Message contains the mandatory GML id attribute.

6. An ADR Message does not contain the GML aggregation type attribute. The implicit enumeration
value is set. There will be no duplicates in the AIXM Features.

7. An ADR Message does not contain GML elements (e.g. name, description, history, data source …).

8. An ADR Message does not contain sequence number or message metadata elements.

17.1.2.2. Temporality

1. The AIXM Temporality model defines four TimeSlice types:

a. BASELINE

b. SNAPSHOT

c. PERMDELTA

d. TEMPDELTA

2. The NM Airspace services make use of all four timeslice types as follows:

◦ The AirspaceStructure services make use of BASELINE and PERMDELTA timeslices

◦ The AirspaceAvailability services make use of SNAPSHOT and TEMPDELTA timeslices

3. The usage of these TimeSlice types conforms to the AIXM recommendations:

◦ BASELINE timeslices are used to exchange the lifetime (or part) of the Airspace data (see
AirspaceStructureService)

◦ PERMDELTA timeslices are used to exchange permanent changes to the Airspace data, i.e.
changes that may or not follow the AIRAC cycles and are effective permanently (see
AirspaceStructureService)

◦ TEMPDELTA timeslices are used to exchange temporary changes to the Airspace data, i.e.
changes that do not follow the AIRAC cycles and are effective only for a short period of time
(see AirspaceAvailabilityService)

◦ SNAPSHOT timeslices are used for Feature identification as an alternative to the UUID

4. The temporality model used in the AirspaceStructure services is explained in detail in AIXM
Temporality Model Profile.

Edition: 27.0 6 262

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.2.3. Feature / Object Identification

1. NM follows the AIXM recommendations for Feature and Object identification.

2. AIXM Features and Objects must have a valid gml:id.

3. A gml:id is unique within the scope of an XML document. The gml:id is never persisted in the
NM system and cannot be used to identify a Feature or an Object outside of the XML document
in which it is defined.

4. In the airspace data published by NM, the use of the gml:id for Feature identification is limited
to the AirspaceAvailability services — in the AirspaceStructure services the Feature
identification is done exclusively by means of the gml:identifier.

5. In addition to a gml:id, AIXM Features must have a valid gml:identifier.

6. The gml:identifier is used as a persistent identifier for a Feature. A gml:identifier will always
refer to the same Feature.

7. The UUID is normally used as gml:identifier and in such cases the codeSpace attribute is set to
"urn:uuid:". However, for some Feature types, a valid UUID could not be used. This is the case
for those feature types that do not map to entities in the CACD database but are artificially
created during the export to AIXM. Here is a list of such Feature types:

a. AirportHeliportCollocation — The collocation of two airports

b. AngleIndication — The angle attribute of a Reference Point from a Navaid

c. DistanceIndication — The distance attribute of a Reference Point from a Navaid

d. RouteSegment — When it is part of a NAT Track

e. AirTrafficManagementService — The Air Traffic Management Service associated to the

service provider defined by a Unit

f. StandardLevelColumn

g. StandardLevelTable

8. For example the AngleIndication and DistanceIndication in CACD are simple attributes of a
Reference Point. They do not map to standalone entities. However, when exporting the
Reference Point to AIXM, the angle becomes a separate AngleIndication feature, which requires
generating a new unique identifier. If afterwards the Reference Point is updated in CACD with a
new angle value, when re-exporting to AIXM, it is important not to export a new
AngleIndication without being able to stop the life of the previous one. Being able to identify a
previously exported Feature becomes paramount. Hence when a Feature does not exist as an
entity in CACD, it cannot be assigned a new random UUID but it must be given a deterministic
gml:identifier which allows referring to the same feature afterwards. Depending on the
Feature type, different algorithms are used to generate such an identifier. These algorithms are
explained below for each Feature when needed.

9. In those cases in which a valid UUID cannot be used, the codeSpace value is set to "urn:x-nmb2b:".

Note that this is in line with the IANA (Internet Assigned Numbers Authority) recommendations
on URN Namespace Identifiers (NID). In particular RFC 2611 defines three categories of URN
namespaces:

Edition: 27.0 6 263

Document Title: NM 27.0 - NM B2B Reference Manual

a. Formal

i. It requires registration at IANA through RFC review process

b. Informal

i. It requires registration at IANA via template submission

ii. It has the form urn-<number> (e.g. urn-2), where <number> is assigned by IANA

c. Experimental

i. It does not require any registration at IANA

ii. There is no provision for avoiding namespace collisions

iii. It has the form x-<name> (it starts with x-)

10. The URN namespace used by NM falls into the Experimental category.

11. All UUID values used in ADR Messages are originated and maintained by NM. In other words,
NM applications serve and consume only NM UUIDs.

12. The UUID is represented in the NM Data Model as:

typedef<string> common:UUID;

13. In few cases in the AirspaceAvailabilityService the feature identification is done through a
SNAPSHOT TimeSlice instead of the UUID. When this is the case it is explicitly documented (see
AirspaceAvailabilityService).

17.1.2.4. Feature References

1. In the ADR Message NM only makes use of Feature references and never Object references.

2. Feature references in the ADR Message conform to the AIXM recommendations.

3. The NM general principle about Feature references is that they are always expressed as "remote
references", i.e. via xlink:href to a gml:identifier (UUID), unless where explicitly stated
otherwise (see AirspaceAvailabilityService).

4. In few cases NM makes use of "local references" using xlink:href with an xpointer to a gml:id.
When this is the case it is explicitly documented (see AirspaceAvailabilityService) as this
represents a deviation from the NM general principle.

5. When Feature references are used in the NM Data Model they are of type

typedef<string> common::UUID;

17.1.3. AIXM and ADR Extension Coverage

Last updated: 27.0 - Edition 6

1. This section documents the subset of the AIXM model and ADR-E extension that is used by the

Edition: 27.0 6 264

Document Title: NM 27.0 - NM B2B Reference Manual

Airspace services.

2. For each feature, this section document:

a. The algorithm used to populate the gml:identifier when the feature has no UUID in the NM
system, e.g. AirportHeliportCollocation Feature

b. The list of exported attributes in the context of PERMDELTA or BASELINE time slices (see
Temporality)

c. The list of exported associations

3. For each object, this section document:

a. The list of exported attributes

b. The list of exported associations

4. Whenever a feature/object/data type is not part of the AIXM core but is introduced by the ADR-
E, the title of the corresponding section is suffixed by "(ADR-E)", indicating that AIXM is
extended, e.g. IntermediateSignificantPoint Object (ADR-E).

5. Whenever a feature/object type that is already part of the AIXM core is extended, the attributes
and associations added by the ADR-E are highlighted ed by an "(ADR-E)" suffix.

For example, the section that documents the Airspace feature is titled "Airspace Feature" but the
attribute level1 is documented as level1 (ADR-E) highlighting the ADR-E addition of this
attribute.

17.1.3.1. Features

17.1.3.1.1. AirportHeliport Feature

1. The exported attributes are:

a. name

b. locationIndicatorICAO

c. designatorIATA

d. controlType

e. type

f. fieldElevation

The vertical distance above Mean Sea Level (MSL) of the highest point of the landing area.

g. defaultTaxiTime (ADR-E)

2. The exported associations are:

a. servedCity

b. ARP

only the position (gml:pos) of the ElevatedPoint is exported.

Edition: 27.0 6 265

Document Title: NM 27.0 - NM B2B Reference Manual

c. availability

The IFR/VFR rules.

3. See Airport/Heliport without ICAO/IATA Designator.

17.1.3.1.2. AirportHeliportCollocation Feature

1. The gml:identifier (see Feature/Object identification) is the concatenation of the feature type
and the UUID of the dependent airport/heliport, e.g. AirportHeliportCollocation_c608da02-859e-
4c93-a228-73da81d686c9.

2. There are no exported attributes.

3. The exported associations are:

a. hostAirport

b. dependentAirport

Example 7. AirportHeliportCollocation

<aixm:AirportHeliportCollocationTimeSlice gml:id="ID_167_1385510754492_3484">
<aixm:hostAirport xlink:href="urn:uuid:35b44a15-2cb5-455d-98e0-1f2cc09b3160"/>
<aixm:dependentAirport xlink:href="urn:uuid:2fc069c4-3a18-46f2-9ea8-
a77c96701fc9"/>
</aixm:AirportHeliportCollocationTimeSlice>

17.1.3.1.3. AirportHeliportSet Feature (ADR-E)

1. RAD Appendix 2 (Area Definitions) defines collections of airports/heliports as they are referred
by RAD restrictions.

2. The composition of an AirportHeliportSet feature can be defined:

a. explicitly, listing all the members airports/heliports using the hasAiportHeliport association

b. implicitly, using a pattern match using the hasAirportHeliportSetPattern association

An example of pattern is EB, meaning all the Belgian airports/heliports.

The creation of a new airport/heliport can impact some existing, implicitly

CAUTION
defined, airport/heliport sets.

3. The exported attributes are:

a. airportHeliport

The explicitly associated airports/heliports.

b. airportHeliportSetPattern

Edition: 27.0 6 266

Document Title: NM 27.0 - NM B2B Reference Manual

To implicitly add groups of airports/heliports to an AirportHeliportSet based on a pattern in

the designator. The value is a string of alphabetical characters and represents the first
letters of the ICAO identifier. The semantic is therefore the following: "include all
airports/heliports whose ICAO identifier starts with the pattern". For example a pattern such
as EB includes all aerodromes whose ICAO designator starts with EB.

c. name

The operational name or a short description or the corresponding RAD area definition when
it exists.

4. The exported associations are:

a. airportHeliport

Example 8. AirportHeliportSet composed of four explicit aerodromes plus all aerodromes whose ICAO
identifier starts with "EGA"

<AirportHeliportSetTimeSlice id="ID_690_1423477720241_130">
<airportHeliport href="urn:uuid:b6f0ff0c-397c-4140-bf25-c47830a3ddc0"/>
<airportHeliport href="urn:uuid:ed6ffa29-2e87-439e-a899-d942791ac9cd"/>
<airportHeliport href="urn:uuid:c3c8b035-26fd-4c9d-a5c9-7dd177d14c08"/>
<airportHeliport href="urn:uuid:b4274096-7463-40ee-a6b9-008c4fa19834"/>
<airportHeliportSetPattern>
<AirportHeliportSetPattern id="ID_690_1423477720241_133">
<pattern>EGA</pattern>
</AirportHeliportSetPattern>
</airportHeliportSetPattern>
</AirportHeliportSetTimeSlice>

17.1.3.1.4. Airspace Feature

1. The exported attributes are:

a. type

b. localType

This AIXM property is published with the value CDA (Client Defined Area) when the airspace
type is SECTOR or AUA and when these airspaces have been defined with a subtype CDA.

The property value CDA is used to indicate non-published operational airspaces, mostly for
ATFCM requirements like monitoring occupancy/hourly counts, flow definitions, regulation
creation.

The property value NPZ (No Planning Zone) is used to indicate a relevant zone unavailable
for flight planning. The main purpose is to avoid short crossing of multiple ATC airspaces in
FRA.

c. designator

Edition: 27.0 6 267

Document Title: NM 27.0 - NM B2B Reference Manual

d. designatorICAO

e. name

f. flexibleUse (ADR-E)

g. level1 (ADR-E)

The airspace is manageable at the strategic level. The act of defining and reviewing as
required the national airspace policy taking into account national and international
airspace requirement.

h. level2 (ADR-E)

The airspace is manageable at the pre-tactical level. The act of conducting operational
management within the framework of pre-determined existing ATM structure and
procedures defined in level1 and of reaching specific agreement between civil and military
authorities involved.

i. level3 (ADR-E)

The airspace is manageable at the tactical level.

j. isFBZ (ADR-E)

This attribute is only exported when the Airspace.type is one of {D, R, P, TSA, TRA, RCA, CBA} or
Airspace.type is D_OTHER and Airspace.localType is one of {MRA, MTA}. These types correspond
to the RSA airspaces (see FUA (Flexible Use of Airspace)). When the attribute value is YES,
then the Airspace is an FPZ (FPL Buffer Zone).

k. fbzDefaultActive (ADR-E)

This attribute is only exported when Airspace.isFBZ is set to YES. The attribute
fbzDefaultActive is used in the FUA context (see FUA (Flexible Use of Airspace)).

i. AMA (AMC Manageable Area)

This corresponds to Airspace.level1 and Airspace.level2 set to YES. The airspace can be
activated in a flexible way for use by the military or other special users after due
coordination between military and civilian airspaces during the times defined in the
availability. When there is no allocation for this airspace in the AUP/UUP, then the
airspace is considered as available for civilian traffic during the availability.

ii. NAM (Non AMC Manageable Area)

This corresponds to Airspace.level1 set to "YES" and Airspace.level2 set to NO. The
airspace can be activated by the military or other special users without prior
coordination with the civilian users, i.e. AMC during the times defined in the availability.
When there is no allocation for this airspace in the AUP/UUP, then the airspace is
considered as closed for civilian traffic during the availability.

When an airspace managed by an AMC is not allocated, then there is an 'implicit

Edition: 27.0 6 268

Document Title: NM 27.0 - NM B2B Reference Manual

allocation' according to whether the airspace is AMA or NAM. The question arises as
whether the RSA or the surrounding FBZ should be used for that. In order to answer that
question, the FBZ airspace has an attribute fbzDefaultActive: when set to YES, the FBZ
availability is used for the implicit allocation, otherwise the RSA availability is used.

l. isAMC (ADR-E)

This flag indicates whether the RSA airspace is eligible for negotiation. The flag is purely
informative for civil-military coordination, it has no direct impact on system processing.

2. The exported associations are:

a. geometryComponent

b. activation

Refers only to airspace activations with status set to AVBL_FOR_ACTIVATION. The related
timesheet contains a time schedule (see Time Schedule).

c. nearby (ADR-E)

Refers to route portions potentially extended with a range (see AirspaceLayer Object). When
the RSA airspace is allocated, the nearby route portions are considered to be so near that
they need to be closed.

d. offload (ADR-E)

Refers to route portions potentially extended with a range (see AirspaceLayer Object). When
the RSA Airspace is allocated, the offload route portions are considered to be an alternative
so they are opened.

e. notAffected (ADR-E)

Refers to route portions. When the RSA airspace is allocated, these route portions are
considered as not affected (neither opened nor closed).

f. rsaActivation (ADR-E)

Refers to airspace activations with status set to ACTIVE. In reality they are the result of the
publication of an AUP/UUP. The related timesheet contains a time period (see Time Period).

g. ownerRSA (ADR-E)

Only set when Airspace.isFBZ is "YES". The owning RSA is indicated via a UUID.

3. See Airblocks and Airspaces and FUA (Flexible Use of Airspace).

17.1.3.1.5. AirTrafficControlService Feature

Last updated: 27.0 - Edition 3

1. The gml:identifier (see Feature/Object identification) is composed of the feature type and the

Edition: 27.0 6 269

Document Title: NM 27.0 - NM B2B Reference Manual

UUID of the unit that provides the service.

For example, AirTrafficControlService_17fcafb8-605c-1841-9cd5-4a4dafd8e254 is the

gml:identifier of the AirTrafficControlService provided by the TWR unit of UUID 17fcafb8-605c-
1841-9cd5-4a4dafd8e254.

2. The exported attributes are:

a. name

The name of the unit that provides the service, e.g. BRUSSELS TOWER.

b. type

The service type, one of:

▪ ACS - provided by an ACC unit

▪ APP - provided by an APP unit

▪ OACS - provided by an OAC unit

▪ TWR - provided by a TWR unit

▪ UAC - provided by an UAC unit

3. The exported associations are:

a. serviceProvider

A reference to the unit that provides the service.

b. clientAirspace

The list of airspace references for which the service is provided.

c. clientAirport

The list of airport references for which the service is provided.

17.1.3.1.6. AirTrafficManagementService Feature

Last updated: 27.0 - Edition 3

1. The gml:identifier (see Feature/Object identification) is composed of the feature type and the
UUID of the unit that provides the service.

For example, AirTrafficManagementService_4cfcafb8-1841-405c-9c75-454dafd8e5d4 is the

gml:identifier of the AirTrafficManagementService provided by the AMC unit of UUID 4cfcafb8-
1841-405c-9c75-454dafd8e5d4.

2. The exported attributes are:

a. name

Edition: 27.0 6 270

Document Title: NM 27.0 - NM B2B Reference Manual

The name of the unit that provides the service, e.g. BELGIUM.

b. type

The service type, one of:

▪ ATFM - provided by an ATFMU unit

▪ OTHER:__ADR__AMC - provided by an AMC unit

3. The exported associations are:

a. serviceProvider

A reference to the unit that provides the service.

b. clientAirspace

The list of airspace references for which the service is provided.

c. clientRestriction (ADR-E) (new 27.0)

The list of AUP-RAD restrictions for which the service is provided. Only the providing unit
(AMC or FMP) can dynamically activate these restrictions.

See AUP-RAD Restriction.

Example 9. AirTrafficManagementService

<aixm:AirTrafficManagementServiceTimeSlice gml:id="ID_171_1385510754499_198518">
<aixm:name>BELGIUM</aixm:name>
<aixm:type>OTHER:__ADR__AMC</aixm:type>
<aixm:serviceProvider xlink:href="urn:uuid:4cfcafb8-1841-405c-9c75-
454dafd8e5d4"/>
<aixm:clientAirspace xlink:href="urn:uuid:27b59518-f53c-4ccf-9c38-
0495935946c9"/>
<aixm:clientAirspace xlink:href="urn:uuid:11f90918-73dd-450a-832a-
ca5c2b0d061d"/>
</aixm:AirTrafficManagementServiceTimeSlice>

17.1.3.1.7. AngleIndication Feature

1. The gml:identifier (see Feature/Object identification) is composed of the feature type and the
UUID of the reference point, e.g. AngleIndication_529f213e-0568-4334-86c0-8bb1a268b9dc.

It is not necessary to include the UUID of the navaid because the reference point
NOTE
can refer to only one navaid at a time.

2. The exported attributes are:

Edition: 27.0 6 271

Document Title: NM 27.0 - NM B2B Reference Manual

a. angle

b. angleType

3. The exported associations are:

a. fix

This association refers to a DesignatedPoint of type OTHER:__ADR__REFERENCE.

b. pointChoice

The pointChoice always refers to a Navaid.

Example 10. AngleIndication

<aixm:AngleIndicationTimeSlice gml:id="ID_171_1385510754499_198518">>
<aixm:angle>10</aixm:angle>
<aixm:angleType>MAG</aixm:angleType>
<aixm:fix xlink:href="urn:uuid:c608da02-859e-4c93-a228-73da81d686c9"/>
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:529f213e-0568-4334-86c0-
8bb1a268b9dc"/>
</aixm:AngleIndicationTimeSlice>

17.1.3.1.8. ApproachLeg Feature (ADR-E)

1. The ApproachLeg is an abstract feature in the core AIXM. The purpose of this extension is to make
it a concrete feature: this extension defines no extra attributes and no extra associations.

2. The exported attributes are:

a. upperLimitAltitude (from SegmentLeg)

b. upperLimitReference (from SegmentLeg)

c. lowerLimitAltitude (from SegmentLeg)

d. lowerLimitReference (from SegmentLeg)

3. The exported associations are:

a. startPoint (from SegmentLeg)

b. endPoint (from SegmentLeg)

c. approach (from AIXM.ApproachLeg)

17.1.3.1.9. ArrivalLeg Feature

1. The exported attributes are:

a. upperLimitAltitude and upperLimitReference

b. lowerLimitAltitude and lowerLimitReference

2. The exported associations are:

Edition: 27.0 6 272

Document Title: NM 27.0 - NM B2B Reference Manual

a. startPoint

b. endPoint

c. arrival

Example 11. ArrivalLeg

<aixm:ArrivalLegTimeSlice gml:id="ID_172_1385510754499_780064">
<aixm:upperLimitAltitude uom="FL">20</aixm:upperLimitAltitude>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimitAltitude uom="FT">GND</aixm:lowerLimitAltitude>
<aixm:lowerLimitReference>MSL</aixm:lowerLimitReference>
<aixm:startPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780064">
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:69ed4c7b-d34c-457c-a780-
3baed58fe767"/>
</aixm:TerminalSegmentPoint>
</aixm:startPoint>
<aixm:endPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780065">
<aixm:pointChoice_airportReferencePoint xlink:href="urn:uuid:dd2a6f3f-bd9b-
436e-98..."/>
</aixm:TerminalSegmentPoint>
</aixm:endPoint>
<aixm:arrival xlink:href="urn:uuid:28b8122d-ca51-4cbb-aa5f-b78d859099c9"/>
</aixm:ArrivalLegTimeSlice>

17.1.3.1.10. ASMScenario Feature (ADR-E)

Last updated: 27.0 - Edition 3

1. The feature represents a pre-defined and coordinated set of temporary areas (RSA airspaces).

2. The exported attributes are:

a. category

b. defaultApplicabilityTil

c. defaultApplicabilityWef

d. defaultLowerLimit

e. defaultLowerLimitReference

f. defaultUpperLimit

g. defaultUpperLimitReference

h. name

i. note

j. scenarioId

Edition: 27.0 6 273

Document Title: NM 27.0 - NM B2B Reference Manual

3. The exported associations are:

a. scenarioRsaAllocation

An ASM scenario contains one or more scenario RSA allocations. For an ASM scenario of
category MANAGED, the scenario lead AMC must be the responsible for all the RSAs of the
scenario RSA allocations, taking delegation into account.

b. leadAmc

An ASM scenario has exactly one lead AMC. The lead AMC is responsible for the activation of
a MANAGED ASM scenario.

c. scenarioRsgActivation

This association is for future use.

d. conflictingScenario

ASM scenarios that cannot be activated simultaneously. This association is bi-directional.

17.1.3.1.11. DepartureLeg Feature

1. The exported attributes are:

a. upperLimitAltitude and upperLimitReference

b. lowerLimitAltitude and lowerLimitReference

2. The exported associations are:

a. startPoint

b. endPoint

c. departure

Edition: 27.0 6 274

Document Title: NM 27.0 - NM B2B Reference Manual

Example 12. DepartureLeg

<aixm:DepartureLegTimeSlice gml:id="ID_172_1385510754499_780098">
<aixm:upperLimitAltitude uom="FL">110</aixm:upperLimitAltitude>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimitAltitude uom="FT">GND</aixm:lowerLimitAltitude>
<aixm:lowerLimitReference>MSL</aixm:lowerLimitReference>
<aixm:startPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780099">
<aixm:pointChoice_fixDesignatedPoint xlink:href="urn:uuid:28ac6496-46bf-
4c13-8293-..."/>
</aixm:TerminalSegmentPoint>
</aixm:startPoint>
<aixm:endPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780100">
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:aca80964-9e4f-4e59-970b-
..."/>
</aixm:TerminalSegmentPoint>
</aixm:endPoint>
<aixm:departure xlink:href="urn:uuid:056b539f-40d5-455b-a3a3-41baf7ceb71d"/>
</aixm:DepartureLegTimeSlice>

17.1.3.1.12. DesignatedPoint Feature

Last updated: 27.0 - Edition 3

1. The exported attributes are:

a. designator

The designator is only defined for the types:

i. ICAO

ii. TERMINAL

iii. OTHER:__ADR__REFERENCE

b. type

c. name

d. nmDesignator (ADR-E) (new 27.0)

The content corresponds to the oldDbePointId from CACD.

2. The exported associations are:

a. location

b. pointUsage

The point usage is used to facilitate the implementation of FRA projects.

Edition: 27.0 6 275

Document Title: NM 27.0 - NM B2B Reference Manual

The AIXM features DesignatedPoint and Navaid are extended. The extended features are
associated to PointUsage Object with a multiplicity of zero or more instances.

Figure 15. Significant Point Type Usage

PointUsage is derived from PropertiesWithSchedule, meaning that a PointUsage has an

associated time table.

PointUsage has a role.

PointUsage has associated levels.

PointUsage has an associated reference location.

3. In AIXM, the possible types of a DesignatedPoint are listed in the core enumeration
CodeDesignatedPointType. NM makes use of three additional CodeDesignatedPointType values,
listed below.

Edition: 27.0 6 276

Document Title: NM 27.0 - NM B2B Reference Manual

a. OTHER:__ADR__REFERENCE

Reference points support the definitions of routes. AngleIndication and DistanceIndication

features refer to it as fix.

b. OTHER:__ADR__BOUNDARY

This type of point lays on a route at the boundary of two information regions. This type is
not yet defined by ICAO. EAD exports these points with the type COORD. EAD uses the
SignificantPointInAirspace feature to link the DesignatedPoint and the Airspace together
with a relativeLocation attribute set to BORDER.

c. OTHER:__ADR__RADAR

This type of point represents a radar located at an airport/heliport.

17.1.3.1.13. DistanceIndication Feature

1. The gml:identifier (see Feature/Object identification) is composed of the feature type and the
UUID of the reference point, e.g. DistanceIndication_529f213e-0568-4334-86c0-8bb1a268b9dc.

It is not necessary to include the UUID of the navaid because the reference point
NOTE
can refer to only one navaid at a time.

2. The exported attribute is:

a. distance

3. The exported associations are:

a. fix

This association refers to a DesignatedPoint of type OTHER:__ADR__REFERENCE.

b. pointChoice

This association always refers to a Navaid.

Example 13. DistanceIndication

<aixm:DistanceIndicationTimeSlice gml:id="ID_172_1385510754499_780099">
<aixm:distance uom="NM">14</aixm:distance>
<aixm:fix xlink:href="urn:uuid:c608da02-859e-4c93-a228-73da81d686c9"/>
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:529f213e-0568-4334-86c0-
8bb1a268b9dc"/>
</aixm:DistanceIndicationTimeSlice>

Edition: 27.0 6 277

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.1.14. FlightRestriction Feature

Last updated: 27.0 - Edition 3

1. The exported attributes are:

a. designator

b. type

i. OTHER:__ADR__FORBIDDEN_FOR_DCT

There will be exactly one regulatedRoute with one FlightRoutingElement of type Airspace.
The new value expresses that it is forbidden to fly through the airspace using DCT
segments.

ii. OTHER:__ADR__CLOSED_FOR_ENTRY_DCT

The configuration of some adjacent FRA airspaces diverges from the standard FRA
model. In the standard FRA model, the collections of entry-exit points of two adjacent
FRA DCT airspaces are identical. There seem to exist FRA exit points where entering the
adjacent FRA airspace is not allowed, i.e. from that particular exit point, one must join
an air route instead of continuing flying FRA.

iii. OTHER:__ADR__CLOSED_FOR_EXIT_DCT

Similarly, there are FRA entry points that cannot be reached from an adjacent FRA
airspace.

c. instruction

d. processingIndicator (ADR-E)

e. enabled (ADR-E)

f. usage (ADR-E)

Indicates whether the timeslice is operational or not. See Operational Usage.

g. isFUA (ADR-E)

Indicates whether the FlightRestriction is a FUA restriction or not. See FUA Restriction.

h. fuaDefaultActive (ADR-E)

Indicates that this restriction should be activated by default when its dependent RSA
airspace is allocated by an AUP/UUP. The creation/update of an AUP/UUP must indicate
which restrictions are activated or not.

i. verticalLimitReference (ADR-E)

Indicates the reference for the flight level used in profile calculation.

j. dependentVerticalLimits (ADR-E)

Edition: 27.0 6 278

Document Title: NM 27.0 - NM B2B Reference Manual

Indicates if the dependent applicability includes vertical limits.

k. isFuaRAD (ADR-E)

Indicates that the restriction is a FUA-RAD restriction. It is associated with the allocation of
an RSA airspace. Concretely this means that the RAD restriction can be activated by the
activation of the associated RSA in an AUP/UUP. See FUA-RAD Restriction.

l. isAupRAD (ADR-E) (new 27.0)

Indicates that the restriction is an AUP-RAD restriction. See AUP-RAD Restriction.

m. aupRadDefaultActive (ADR-E) (new 27.0)

Strongly suggests to a front-end user to activate this AUP-RAD restriction.

n. iOAT (ADR-E) (new 27.0)

Indicates which flights are taken into consideration. The default is NON_IOAT.

2. The exported associations are:

a. flight

b. regulatedRoute

c. annotation

Conventionally, expressed as a Note with propertyName set to instruction and purpose set to
REMARK.

d. activation (ADR-E) (new 27.0)

The list of dynamic activations of the restriction.

3. See Restrictions.

Edition: 27.0 6 279

Document Title: NM 27.0 - NM B2B Reference Manual

Example 14. FlightRestriction

<aixm:FlightRestrictionTimeSlice gml:id="ID_168_1385510754493_5">
<aixm:designator>DS2000A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>GITER NOT AVAILABLE $FOR TRAFFIC ARR ESMS</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_168_1385510754493_6">
<!-- not expanded here -->
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
<!-- not expanded here -->
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_4941_1381916120390_9">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_4941_1381916120390_10">
<aixm:note>TO SEGREGATE ARR ESMS TO DEP EKCH</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
</aixm:FlightRestrictionTimeSlice>

17.1.3.1.15. FlightRestrictionGroup Feature (ADR-E)

A FlightRestrictionGroup allows to manage a group of flight restrictions as a whole.

1. The exported attributes are:

a. designator

A value that identifies the FlightRestrictionGroup (for human reader).

b. instruction

The text that describe the operational instructions.

All the restrictions in the FlightRestrictionGroup should have the same

NOTE
instruction.

a. category

the category of the FlightRestrictionGroup

Edition: 27.0 6 280

Document Title: NM 27.0 - NM B2B Reference Manual

The following values have a specific meaning:

i. FUA: the restrictions of a FlightRestrictionGroup with this category must always be

activated/de-activated together as a whole. See FUA Restriction.

ii. FUARAD: this category is used for configurations of FUA and FUA-RAD restrictions with a
dependent applicability on the same RSA. The restrictions can be activated as a group.
See FUA-RAD Restriction.

b. enabled

c. fuaDefaultActive

When set to true, this flag informs the client application that it should suggest to its end
user(s) the activation of all the restrictions of this group when its dependent RSA airspace is
allocated by an AUP/UUP.

IMPORTANT The value of this flag has no operational impact.

d. usage

Indicates whether the timeslice is operational or not. See Operational Usage.

2. The exported associations are:

a. referenceRSA

The reference to the airspace.

b. flightRestriction

The list of restrictions that form the FlightRestrictionGroup.

17.1.3.1.16. Flow Feature (ADR-E)

1. A Flow identifies a pattern of traffic and is used inside a reference location or a traffic volume.

2. It catches flights by defining where they come from, where they are directed and what they
cross. This is done by combining flow elements.

3. A flow element (see FlowLocationElement Object) is a location used to define how the Flow is
composed. For example a Flow may be defined by the following sequence of flow elements:

a. Flights crossing point DIRBO

b. And then landing in EDDV

4. A flow element can be:

◦ An airport/heliport

◦ An airport/heliport set

◦ An airspace

◦ A significant point (a navaid or a designated point)

Edition: 27.0 6 281

Document Title: NM 27.0 - NM B2B Reference Manual

◦ A point set

5. The order of the flow elements is paramount.

6. More precisely, a Flow is defined by sequences of upstream and downstream flow elements,
where the concepts of upstream and downstream are to be intended with respect to the
reference location to which the Flow will be linked. This allows the same Flow to be linked to
several reference locations or traffic volumes without having to redefine the flow elements in
each reference location or traffic volume.

Example 15. EBBR> flow

The following snippet defines a Flow named EBBR> (note that the character '>' is escaped as
"&gt" in order to be included in an XML document) with a single upstream flow element
represented by the EBBR airport (The UUID f44fb7b2-a883-4e4d-b741-97b2d1879ae5 is the
EBBR aerodrome). The semantic of this Flow is that it captures all flights departing from EBBR.

<Flow id="ID_74_1425258197437_15290">
<identifier codeSpace="urn:uuid:">0ab1205a-0692-4798-8068-
40c15c7e1e6f</identifier>
<timeSlice>
<FlowTimeSlice id="ID_74_1425258197437_15291">
<validTime>
<TimePeriod id="ID_74_1425258197437_15292">
<beginPosition>2003-12-25T00:00:00</beginPosition>
<endPosition indeterminatePosition="unknown"/>
</TimePeriod>
</validTime>
<interpretation>BASELINE</interpretation>
<featureLifetime>
<TimePeriod id="ID_74_1425258197437_15293">
<beginPosition>2003-12-25T00:00:00</beginPosition>
<endPosition indeterminatePosition="unknown"/>
</TimePeriod>
</featureLifetime>
<flowId>EBBR&gt;</flowId>
<upstreamFlowElement>
<FlowLocationElement id="ID_74_1425258197437_15294">
<index>1</index>
<locationChoice_airportHeliport href="urn:uuid:f44fb7b2-a883-4e4d-
b741-97b2d1879ae5"/>
</FlowLocationElement>
</upstreamFlowElement>
</FlowTimeSlice>
</timeSlice>
</Flow>

7. The Flow in the above example can now be used in any reference location or traffic volume. For

Edition: 27.0 6 282

Document Title: NM 27.0 - NM B2B Reference Manual

example, it is used in the reference location LFRRZU (which represents a particular sector) to
capture flights traversing the sector LFRRZU which departed from the EBBR airport.

8. The exported attributes are:

a. flowId

9. The exported associations are:

a. downstreamFlowElement

b. upstreamFlowElement

Example 16. Showing a Flow with one downstream and two upstream flow elements

<FlowTimeSlice id="ID_101_1423664342095_20">
<flowId>18GWC&gt;SO</flowId>
<downstreamFlowElement>
<FlowLocationElement id="ID_101_1423664342095_23">
<index>3</index>
<locationChoice_airportHeliportSet href="urn:uuid:b7ed0827-57a6-489a-8fad-
6788b1616ee0"/>
</FlowLocationElement>
</downstreamFlowElement>
<upstreamFlowElement>
<FlowLocationElement id="ID_101_1423664342095_24">
<index>1</index>
<locationChoice_airspace href="urn:uuid:f61af630-fe9e-4847-9757-
9ba4d36dcd82"/>
</FlowLocationElement>
</upstreamFlowElement>
<upstreamFlowElement>
<FlowLocationElement id="ID_101_1423664342095_25">
<index>2</index>
<locationChoice_navaid href="urn:uuid:f967e31c-5b26-4c4e-8a9d-
9c85291f62ee"/>
</FlowLocationElement>
</upstreamFlowElement>
</FlowTimeSlice>

17.1.3.1.17. InformationService Feature

Last updated: 27.0 - Edition 3

1. The gml:identifier (see Feature/Object identification) is composed of the feature type and the
UUID of the Unit that provides the service, e.g. InformationService_34a2a103-18a0-b150-10a3-
7000a309c238 is the gml:identifier of the InformationService provided by the DPIO unit of UUID
34a2a103-18a0-b150-10a3-7000a309c238.

2. The exported attributes are:

Edition: 27.0 6 283

Document Title: NM 27.0 - NM B2B Reference Manual

a. name

The name of the unit that provides the service, e.g. FRANKFURT.

b. type

Always OTHER:__ADR__DPIO.

c. flightOperations

Always DEP.

3. The exported associations are:

a. serviceProvider

A reference to the unit that provides the service.

b. clientAirport

The list of airport references for which the service is provided.

17.1.3.1.18. InstrumentApproachProcedure Feature

1. The exported attributes are:

a. name

2. The exported associations are:

a. airportHeliport

17.1.3.1.19. Navaid Feature

Last updated: 27.0 - Edition 3

1. The exported attributes are:

a. type

b. designator

c. name

d. nmDesignator (ADR-E) (new 27.0)

The content corresponds to the oldDbePointId from CACD.

2. The exported associations are:

a. location

b. pointUsage

See PointUsage Object (ADR-E).

Edition: 27.0 6 284

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.1.20. OrganisationAuthority Feature

Last updated: 27.0 - Edition 3

1. The feature is used to export states and aircraft operators.

2. The exported attributes are:

a. name

b. designator

c. type

The type is either STATE or ACFT_OPR.

Example 17. BELGIUM (state)

<aixm:OrganisationAuthorityTimeSlice gml:id="ID_170_1385510754495_73755">
<aixm:name>KINGDOM OF BELGIUM</aixm:name>
<aixm:designator>BELGIUM</aixm:designator>
<aixm:type>STATE</aixm:type>
</aixm:OrganisationAuthorityTimeSlice>

Example 18. IBERIA (aircraft operator)

<aixm:OrganisationAuthorityTimeSlice gml:id="ID_11195_1626919384783_2827">
<aixm:name>IBERIA</aixm:name>
<aixm:designator>IBE</aixm:designator>
<aixm:type>ACFT_OPR</aixm:type>
</aixm:OrganisationAuthorityTimeSlice>

1. There are no exported associations.

17.1.3.1.21. PointSet Feature (ADR-E)

1. The feature represents a set of significant points.

2. The exported attributes are:

a. pointSetId

Identifier of the PointSet.

b. name

The operational name or a short description.

3. The exported association is:

Edition: 27.0 6 285

Document Title: NM 27.0 - NM B2B Reference Manual

a. point

A PointSet can contain 2 or more significant points.

17.1.3.1.22. ReferenceLocation Feature (ADR-E)

1. A ReferenceLocation can be one of the following entities:

◦ An Airspace

◦ An AirportHeliport

◦ An AirportHeliportSet

◦ A significant point: DesignatedPoint or a Navaid

2. One ReferenceLocation can be used in multiple traffic volumes.

3. If the location is a significant point, it has an association to a flight level range (see
AirspaceLayer Object).

4. A ReferenceLocation can have associated flows (see also Flow Feature (ADR-E) and
TrafficVolume Feature (ADR-E)).

This allows to consistently reuse the same reference location and the same flows in multiple
traffic volumes without having to duplicate the flows in each traffic volume.

In such a case, a TrafficVolume associated to this ReferenceLocation may have

◦ Linked Flows - flows which are directly linked to the traffic volumes

◦ Associated Flows - flows which are associated to the ReferenceLocation

5. The exported attributes are:

a. referenceLocationId

b. category

Possible values are: ARR for arrival, DEP for departure, ALL for arrival and departure.

The category is always set to ALL when the location is an Airspace, a DesignatedPoint or a
Navaid, whereas it can take any of the three values if the location is an AirportHeliport or an
AirportHeliportSet.

6. The exported associations are:

a. location

A reference to one of: Airspace, AirportHeliport, AirportHeliportSet, DesignatedPoint, Navaid

b. associatedFlow

The "reusable" associated flows.

c. airspaceLayer

Edition: 27.0 6 286

Document Title: NM 27.0 - NM B2B Reference Manual

Present only when location is a significant pint.

Example 19. ReferenceLocation to an airspace

<ReferenceLocationTimeSlice id="ID_704_1423477742163_19">
<category>ALL</category>
<referenceLocationId>ASEBTCWXG</referenceLocationId>
<locationChoice_airspace href="urn:uuid:a875ce9c-512b-40ba-9ac6-e85032350cb0"/>
</ReferenceLocationTimeSlice>

Example 20. ReferenceLocation to a designated point

<ReferenceLocationTimeSlice id="ID_193_1423620275860_25039">
<category>ALL</category>
<referenceLocationId>SPABLOMG</referenceLocationId>
<airspaceLayer>
<AirspaceLayer id="ID_193_1423620275860_25042">
<upperLimit uom="FT">UNL</upperLimit>
<upperLimitReference>MSL</upperLimitReference>
<lowerLimit uom="FT">GND</lowerLimit>
<lowerLimitReference>MSL</lowerLimitReference>
</AirspaceLayer>
</airspaceLayer>
<locationChoice_designatedPoint href="urn:uuid:aa19ebe5-485c-40f9-83a5-
2aa3e5ae88d1"/>
</ReferenceLocationTimeSlice>

17.1.3.1.23. Route Feature

1. The exported attributes are:

a. designatorPrefix

b. designatorSecondLetter

c. designatorNumber

2. There are no exported associations.

Edition: 27.0 6 287

Document Title: NM 27.0 - NM B2B Reference Manual

Example 21. Route

<aixm:RouteTimeSlice gml:id="ID_170_1385510754495_73755">
<aixm:designatorPrefix>K</aixm:designatorPrefix>
<aixm:designatorSecondLetter>H</aixm:designatorSecondLetter>
<aixm:designatorNumber>501</aixm:designatorNumber>
</aixm:RouteTimeSlice>

17.1.3.1.24. RouteSegment Feature

1. The NM system uses route segments to define ATS routes. However, it does not for NAT tracks
(see NAT Tracks Publication).

2. An ATS route segment has a UUID in CACD.

3. A NAT track route segment receives a generated gml:identifier (see Feature/Object

identification) which is the concatenation of the NAT track’s UUID with the UUIDs of the first
and last point of the segment in this order, e.g. Route_024bb6f8-3265-472a-9988-
c765f519bcef.7ae44b19-3827-4ce9-8fd1-ac20ca5e2ead.f24473c7-85f8-4329-965f-4057bfa7c60c.

4. The exported attributes are:

a. upperLimit and upperLimitReference

b. lowerLimit and lowerLimitReference

5. The exported associations are:

a. start

b. routeFormed

c. end

d. availability

The "permanent" availabilities.

e. cdrUpdate (ADR-E)

The temporary overriding availabilities related to the publication of the AUP/UUP.

f. verticalLimits (ADR-E)

Describe during which part of the day the portions of the route exist. It is possible to declare
a route as non-existing, e.g. during the night to allow DCT in the Airspace.

Edition: 27.0 6 288

Document Title: NM 27.0 - NM B2B Reference Manual

Example 22. RouteSegment

<aixm:RouteSegmentTimeSlice gml:id="ID_172_1385510754499_82">
<aixm:upperLimit uom="FL">430</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">185</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
<aixm:start>
<aixm:EnRouteSegmentPoint gml:id="ID_172_1385510754499_82">
<aixm:pointChoice_fixDesignatedPoint xlink:href="urn:uuid:f24473c7-85f8-
4329-965f-..."/>
</aixm:EnRouteSegmentPoint>
</aixm:start>
<aixm:routeFormed xlink:href="urn:uuid:024bb6f8-3265-472a-9988-
c765f519bcef"/>
<aixm:end>
<aixm:EnRouteSegmentPoint gml:id="ID_172_1385510754499_83">
<aixm:pointChoice_fixDesignatedPoint xlink:href="urn:uuid:7ae44b19-3827-
4ce9-8fd1-..."/>
</aixm:EnRouteSegmentPoint>
</aixm:end>
<aixm:availability/><!-- not expanded here -->
</aixm:RouteSegmentTimeSlice>

6. Route segments form a route. The NM system groups route segments into route portions. The
route portions can be in the down or in the up direction. Up and Down route portions do not
necessarily match. For example, a route A-B-C-D-E-F-G could be organised in portions with the
following segments:

Table 16. Partitioning of CACD Routes into portions.

Portion Constituting RouteSegments

PortionForward=1 A-B

PortionForward=2 B-C C-D D-E

PortionForward=3 E-F F-G

PortionBackward=1 F-G

PortionBackward=2 C-D D-E E-F

PortionBackward=3 A-B B-C

Edition: 27.0 6 289

Document Title: NM 27.0 - NM B2B Reference Manual

Example 23. RouteSegment with route portion annotations

<aixm:RouteSegmentTimeSlice>
<!-- start B -->
<!-- end C -->
<!-- availability -->
<aixm:annotation>
<aixm:Note gml:id="ID_NOTE_1">
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_NOTE_1_1">
<aixm:note>PortionForward=2</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:annotation>
<aixm:Note gml:id="ID_NOTE_2">
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_NOTE_2_1">
<aixm:note>PortionBackward=1</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
</aixmRouteSegmentTimeSlice>

17.1.3.1.25. SpecialDate Feature

1. The exported attributes are:

a. type

The type is either "HOL" or "BUSY_FRI"

b. dateDay

c. dateYear

d. name

2. The exported associations are:

a. authority

Edition: 27.0 6 290

Document Title: NM 27.0 - NM B2B Reference Manual

Example 24. Specific holiday

<aixm:SpecialDateTimeSlice gml:id="ID_172_1385510754499_82">
<aixm:type>HOL</aixm:type>
<aixm:dateDay>19-06</aixm:dateDay>
<aixm:dateYear>2014</aixm:dateYear>
<aixm:name>CORPUS CHRISTI DAY (M)</aixm:name>
<aixm:authority xlink:href="urn:uuid:11bf3600-dcba-4448-85d9-259b3b5e88b7"/>
</aixm:SpecialDateTimeSlice>

Example 25. Re-occurring holiday

<aixm:SpecialDateTimeSlice gml:id="ID_172_1385510754499_82">
<aixm:type>HOL</aixm:type>
<aixm:dateDay>25-12</aixm:dateDay>
<aixm:name>CHRISTMAS DAY</aixm:name>
<aixm:authority xlink:href="urn:uuid:2ada7e48-c90d-4f2c-b33e-3f75dd995566"/>
</aixm:SpecialDateTimeSlice>

Example 26. Busy Friday

<aixm:SpecialDateTimeSlice gml:id="ID_172_1385510754499_82">
<aixm:type>BUSY_FRI</aixm:type>
<aixm:dateDay>23-04</aixm:dateDay>
<aixm:dateYear>2021</aixm:dateYear>
<aixm:authority xlink:href="urn:uuid:609bcbaf-0960-45da-9e80-645ecdf499f5"/>
</aixm:SpecialDateTimeSlice>

17.1.3.1.26. StandardInstrumentArrival Feature

1. The exported attributes are:

a. designator

b. instruction

2. The exported associations are:

a. availability

b. airportHeliport

c. connectingPoint (ADR-E)

The published ICAO points (navaid or designated point) that may serve as connecting point
to the en-route network. A flight may join the STAR only at these points.

Edition: 27.0 6 291

Document Title: NM 27.0 - NM B2B Reference Manual

d. initialApproachFix (ADR-E)

A point that connects the arrival procedure to the instrument approach procedure.

e. hasSynonym (ADR-E)

Example 27. StandardInstrumentArrival

<aixm:StandardInstrumentArrivalTimeSlice gml:id="ID_172_1385510754499_784149">
<instruction>VIA UP/P7</instruction>
<availability>
<!-- not expanded here -->
</availability>
<airportHeliport href="urn:uuid:02876331-3e92-4cea-a67f-a4cf6cf9aefd"/>
<designator>ABBOT1B</designator>
<extension>
<StandardInstrumentArrivalExtension id="ID_142_1423664916078_10">
<connectingPoint>
<TerminalSegmentPoint id="ID_142_1423664916078_11">
<pointChoice_fixDesignatedPoint href="urn:uuid:260a38b8-61ec-4f0e-91d8-
d9c79270f461"/>
</TerminalSegmentPoint>
</connectingPoint>
<connectingPoint>
<TerminalSegmentPoint id="ID_142_1423664916078_12">
<pointChoice_fixDesignatedPoint href="urn:uuid:376efb12-ca41-46fb-895e-
e1a8060210d1"/>
</TerminalSegmentPoint>
</connectingPoint>
<connectingPoint>
<TerminalSegmentPoint id="ID_142_1423664916078_13">
<pointChoice_fixDesignatedPoint href="urn:uuid:fe43cb87-cd23-47ad-9a60-
60f25cfe451b"/>
</TerminalSegmentPoint>
</connectingPoint>
<connectingPoint>
<TerminalSegmentPoint id="ID_142_1423664916078_14">
<pointChoice_fixDesignatedPoint href="urn:uuid:64464f67-bb36-4d72-b664-
1acf24332780"/>
</TerminalSegmentPoint>
</connectingPoint>
</StandardInstrumentArrivalExtension>
</extension>
</StandardInstrumentArrivalTimeSlice>

Edition: 27.0 6 292

Document Title: NM 27.0 - NM B2B Reference Manual

Example 28. StandardInstrumentArrival (using synonyms)

<aixm:StandardInstrumentArrivalTimeSlice>
<aixm:designator>SARAX1A</aixm:designator>
<aixm:extension>
<adrext:ProcedureExtension gml:id="pe1320">
<adrext:hasSynonym>
<adrext:Synonym gml:id="s1321">
<adrext:synonymId>SARAX1B</adrext:synonymId>
</adrext:Synonym>
</adrext:hasSynonym>
<adrext:hasSynonym>
<adrext:Synonym gml:id="s1322">
<adrext:synonymId>SARAX2A</adrext:synonymId>
</adrext:Synonym>
</adrext:hasSynonym>
<adrext:hasSynonym>
<adrext:Synonym gml:id="s1323">
<adrext:synonymId>SARAX2B</adrext:synonymId>
</adrext:Synonym>
</adrext:hasSynonym>
</adrext:ProcedureExtension>
</aixm:extension>
</aixm:StandardInstrumentArrivalTimeSlice>

17.1.3.1.27. SunriseSunsetTable Feature (ADR-E)

1. There are no exported attributes.

2. The exported associations are:

a. airportHeliport

b. row

17.1.3.1.28. StandardInstrumentDeparture Feature

1. The exported attributes are:

a. designator

b. instruction

2. The exported associations are:

a. availability

b. airportHeliport

c. connectingPoint (ADR-E)

The published ICAO points (navaid or designated point) that may serve as connecting point
to the en-route network. A flight may leave the SID only at these points.

Edition: 27.0 6 293

Document Title: NM 27.0 - NM B2B Reference Manual

d. hasSynonym (ADR-E)

Example 29. StandardInstrumentDeparture

<aixm:StandardInstrumentDepartureTimeSlice gml:id="ID_172_1385510754499_780091">
<aixm:instruction>FL 110 MAX -----&gt; ONLY DEST LFCI/FL110
MAX</aixm:instruction>
<aixm:availability/><!-- not expanded here -->
<aixm:airportHeliport xlink:href="urn:uuid:5ba9179b-3306-486e-8970-
edce59758396"/>
<aixm:designator>AB5E</aixm:designator>
<aixm:extension>
<adr:StandardInstrumentDepartureExtension gml:id=
"ID_172_1385510754499_780092">
<adr:connectingPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780093">
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:8b359a52-bf2c-4dc6-
af1a-..."/>
</aixm:TerminalSegmentPoint>
</adr:connectingPoint>
<adr:connectingPoint>
<aixm:TerminalSegmentPoint gml:id="ID_172_1385510754499_780094">
<aixm:pointChoice_navaidSystem xlink:href="urn:uuid:aca80964-9e4f-4e59-
970b-..."/>
</aixm:TerminalSegmentPoint>
</adr:connectingPoint>
</adr:StandardInstrumentDepartureExtension>
</aixm:extension>
</aixm:StandardInstrumentDepartureTimeSlice>

17.1.3.1.29. TrafficVolume Feature (ADR-E)

1. A TrafficVolume represents a volume of air traffic.

It is used for monitoring the amount of air traffic over a given reference location, e.g. an
airspace, so that a regulation can be applied if the load is higher than the available capacity.

2. A TrafficVolume is always associated to exactly one reference location (see ReferenceLocation

Feature (ADR-E)).

3. In a simplistic approach, it would seem enough to define a capacity for the reference location
and count all the flights entering that location in a given unit of time. In reality, not all flights
crossing a location contribute to the complexity of the traffic in the same way: for example, if
the majority of the traffic is in the southern part of an airspace and only few flights cross the
northern part, it would be desirable to set a specific monitoring for the southern flights alone.

4. This is why a TrafficVolume can be refined with flows (see Flow Feature (ADR-E)).

5. A TrafficVolume is therefore the combination of one reference location and potentially multiple

Edition: 27.0 6 294

Document Title: NM 27.0 - NM B2B Reference Manual

Flows.

6. It is worth noticing here that a reference location can itself have flows.

◦ The flows defined in the reference location are called associated flows

◦ The flows defined in the traffic volume are called linked flows

7. When defining the linked flows in a TrafficVolume, these can be combined in several ways. Each
linked flow can be:

◦ Included

Flights matching the flow are included in the TrafficVolume.

If at least one included flow is defined, then the TrafficVolume is defined

solely by its linked flows. In other words if there is at least one included
IMPORTANT
flow in a TrafficVolume, then a flight must be in at least one of the
included flows in order to be counted in the TrafficVolume.

◦ Excluded

Flights matching the excluded flows are excluded from the TrafficVolume and therefore do
not contribute to the counts.

◦ Exempted

Flights matching an exempted flow are not affected by regulations. Exempted flows
participate in the counts, provided that no included flows are defined (if any included flows
were defined, only flights matching those flows would be included in the counts, as
explained above).

◦ Included Exempted

Flights matching an included exempted flow always participate in the counts but are not
affected by regulations. The flow behaves both as an included flow and an exempted flow at
the same time.

8. Traffic volumes can be active or not according to a timetable. This reflects in principle the
sector configurations, and the rationale behind is that the amount of traffic changes according
to the period of the year, the day of the week and the time of the day. So, for example, in a
timeframe when the traffic is relatively low, a single traffic volume could suffice, whereas in a
time of high load, the same volume could be split into smaller traffic volumes to allow a more
granular monitoring. So according to a timetable, the large traffic volume could be made
inactive and the smaller ones active.

9. When a TrafficVolume is not active, the counts are not computed.

10. The exported attributes are:

a. tvId

11. The exported associations are:

Edition: 27.0 6 295

Document Title: NM 27.0 - NM B2B Reference Manual

a. activation

b. linkedFlow

Example 30. TrafficVolume

<TrafficVolumeTimeSlice id="ID_705_1423477842671_179">
<tvId>EGPESTX</tvId>
<referenceLocation href="urn:uuid:00495049-ecc1-4936-a1d0-35bbbdaaf2fe"/>
<activation>
<TrafficVolumeActivation id="ID_705_1423477842671_182">
<!-- not expanded here -->
</TrafficVolumeActivation>
</activation>
<linkedFlow>
<TrafficVolumeLinkedFlow id="ID_705_1423477842671_186">
<role>EXCLUDED</role>
<theFlow href="urn:uuid:c9c75b61-4c5e-4e4f-be75-cdef7b94f258"/>
</TrafficVolumeLinkedFlow>
</linkedFlow>
</TrafficVolumeTimeSlice>

17.1.3.1.30. TrafficVolumeSet Feature (ADR-E)

1. Represents a set of traffic volumes as a single entity.

2. The exported attributes are:

a. tvSetId

3. The exported associations are:

a. trafficVolume

TrafficVolume included in this TrafficVolumeSet

Example 31. TrafficVolumeSet

<TrafficVolumeSetTimeSlice id="ID_46_1423644956269_3">
<tvSetId>AEROEDNY</tvSetId>
<trafficVolume href="urn:uuid:64b3ec4b-f673-4709-9771-4517fb70b72b"/>
<trafficVolume href="urn:uuid:ba60a7d2-11e1-4948-9c0f-566f2db6a23e"/>
<trafficVolume href="urn:uuid:4b2a81eb-f2dc-4e82-b296-00a406fc9850"/>
</TrafficVolumeSetTimeSlice>

17.1.3.1.31. Unit Feature

Last updated: 27.0 - Edition 3

Edition: 27.0 6 296

Document Title: NM 27.0 - NM B2B Reference Manual

1. The exported unit types are: AMC, FMP, DPIO, ACC, APP, OAC, UAC and TWR.

2. The export of a unit feature is always coupled to the export of a service feature that represents
the service provided by the unit. The concrete type of service depends on the exported unit
type:

a. AMC and FMP units provide Air Traffic Management Service;

b. ACC, APP, OAC, UAC and TWR units provide Air Traffic Control Service;

c. DPIO units provide Information Service.

3. The exported attributes are:

a. name

The unit name, e.g. BRUSSELS FMP.

b. type

The unit type, one of:

▪ ATFMU - FMP unit

▪ ACC - ACC unit

▪ APP - APP unit

▪ OAC - OAC unit

▪ UAC - UAC unit

▪ TWR - TWR unit

▪ OTHER:__ADR__AMC - AMC unit

▪ OTHER:__ADR__DPIO - DPIO unit

c. designator

The NM Air Navigation Unit identifier (ANU ID), e.g. FMPEBBU.

4. There are no exported associations.

Example 32. AMC Unit

<aixm:UnitTimeSlice gml:id="ID_172_1385510754499_780092">
<aixm:name>BELGIUM</aixm:name>
<aixm:type>OTHER:__ADR__AMC</aixm:type>
<aixm:designator>EBBRZAMC</aixm:designator>
</aixm:UnitTimeSlice>

17.1.3.2. Objects

Edition: 27.0 6 297

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.2.1. AirspaceHeliportAvailability Object

1. It is used to export the IFR/VFR rules of an airport/heliport.

2. There are no exported attributes.

3. The exported associations are:

a. selection

17.1.3.2.2. AirspaceActivation Object

1. It contains the Information Region in which the airspace is located and the AMC requesting the
activation. It also allows specifying which associated FUA restrictions are to be activated.

2. The exported attributes are:

a. status

b. isP3 (ADR-E)

A derived flag calculated for non-published UUPs. The flag indicates that the restriction
group was activated extra, compared to the activation in its predecessor within the AUP
chain.

c. isAMC (ADR-E)

The default value is the value of the isAMC flag from the airspace, but this value can be
overwritten by the AMC for an individual airspace allocation as part of an AUP/UUP.

d. isNotamExtension (ADR-E)

The flag indicates that the airspace is activated outside its published times and/or vertical
limits.

e. remark (ADR-E)

When the isNotamExtension element is set to "YES", the remark element must refer to the
NOTAM that extends the airspace published times and vertical limits.

f. scenario (ADR-E)

Derived flag that describes the current participation of the airspace in a scenario. The
scenario attribute is only calculated for airspace activations that belong to non-published
AUP/UUPs.

3. The exported associations are:

a. levels

b. hostAirspace (ADR-E)

The Information Region in which the (military) Airspace is located.

c. requestor (ADR-E)

Edition: 27.0 6 298

Document Title: NM 27.0 - NM B2B Reference Manual

d. fuaRestriction (ADR-E)

The activation of the associated FUA restrictions (see FUARestrictionActivation Object (ADR-
E)).

e. fuaRestrictionGroup (ADR-E)

The activation of the associated RestrictionGroup (see FUARestrictionGroupActivation Object

(ADR-E)).

f. fuaAsmScenario (ADR-E)

This relationship is calculated when retrieving an AUP/UUP. An airspace activation can be

associated to multiple ASM scenarios (see FUAAsmScenarioActivation Object (ADR-E)).

Example 33. Airspace activation by an AUP (AirspaceAvailability service)

<aixm:activation>
<aixm:AirspaceActivation gml:id="ID_4247_1381851018763_6">
<aixm:status>ACTIVE</aixm:status>
<aixm:levels>
<aixm:AirspaceLayer gml:id="ID_4247_1381851018763_7">
<aixm:upperLimit uom="FL">55</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FT">GND</aixm:lowerLimit>
<aixm:lowerLimitReference>MSL</aixm:lowerLimitReference>
</aixm:AirspaceLayer>
</aixm:levels>
<aixm:extension>
<adr:AirspaceActivationExtension
xmlns:adr="http://www.aixm.aero/schema/5.1/extensions/ADR"
gml:id="ID_4247_1381851018763_8">
<adr:hostAirspace
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:126db09b-215c-4eee-981b-27063b544b4a"/>
</adr:AirspaceActivationExtension>
</aixm:extension>
</aixm:AirspaceActivation>
</aixm:activation>

Edition: 27.0 6 299

Document Title: NM 27.0 - NM B2B Reference Manual

Example 34. Availability of a (military) airspace (AirspaceStructure service):

<aixm:activation>
<aixm:AirspaceActivation gml:id="ID_171_1385510754499_169471">
<aixm:status>AVBL_FOR_ACTIVATION</aixm:status>
<aixm:extension>
<adr:PropertiesWithScheduleExtension gml:id="ID_171_1385510754499_169472">
<adr:timeTable>
<adr:TimeTable gml:id="ID_171_1385510754499_169473">
<!-- not expanded here -->
</adr:TimeTable>
</adr:timeTable>
</adr:PropertiesWithScheduleExtension>
</aixm:extension>
</aixm:AirspaceActivation>
</aixm:activation>

17.1.3.2.3. AirspaceBorderCrossingObject Object (ADR-E)

1. Same semantic as an AirspaceBorderCrossing feature.

2. There are no exported attributes.

3. The exported associations are:

a. exitedAirspace

b. enteredAirspace

17.1.3.2.4. AirspaceLayer Object

1. It is primarily used in the RouteSegmentExtension.

2. The exported attributes are:

a. upperLimit

b. upperLimitReference

c. lowerLimit

d. lowerLimitReference

e. amcLowerLimit (ADR-E)

Element is set when the lower limit of an airspace allocation was originally specified with a
unit of measurement that differs from FL.

f. amcLowerLimitReference (ADR-E)

g. amcUpperLimit (ADR-E)

Element is set when the upper limit of an airspace allocation was originally specified with a
unit of measurement that differs from FL.

Edition: 27.0 6 300

Document Title: NM 27.0 - NM B2B Reference Manual

h. amcUpperLimitReference (ADR-E)

3. There are no exported associations.

Example 35. AirspaceLayer use in a RouteSegmentExtension

<adr:RouteSegmentExtension gml:id="ID_172_1385510754499_98">
<adr:levels gml:id="ID_172_1385510754499_99">
<aixm:upperLimit uom="FL">430</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">185</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
</adr:levels>
</adr:RouteSegmentExtension>

17.1.3.2.5. AirspaceVolume Object

1. It is used in the definition of Airspace geometry

2. The exported attributes are:

a. upperLimit

The upper limit as published in the AIP.

b. upperLimitReference

c. lowerLimit

The lower limit as published in the AIP.

d. lowerLimitReference

e. nmLowerLimit (ADR-E)

The lower limit in FL as it is used by the NM flight plan validation processing.

f. nmLowerLimitReference (ADR-E)

g. nmUpperLimit (ADR-E)

The upper limit in FL as it is used by the NM flight plan validation processing.

h. nmUpperLimit (ADR-E)

3. There are no exported associations.

17.1.3.2.6. ConditionCombination Object

1. It is used to export the IFR/VFR rules of an airport/heliport.

2. There are no exported attributes.

3. The exported associations are:

Edition: 27.0 6 301

Document Title: NM 27.0 - NM B2B Reference Manual

a. flight

17.1.3.2.7. FlightCharacteristic Object

1. It is used to export the IFR/VFR rules of an airport/heliport.

2. The exported attributes are:

a. rule

3. There are no exported associations.

17.1.3.2.8. FlightConditionCircumstance object

Last updated: 27.0 - Edition 3

The RAD allows for the checking of one constraint, depending on the status of a
non-associated entity. For example, the IFPS will raise an error if a flight is planned
via airspace ABC (constraint) if route XYZ (entity) is open. Because of the non-
associated entities, the IFPS will not always have the exact entry time of the
dependant entity. For example, the IFPS will know the entry time into airspace ABC,
but will not know the entry time into the dependant route XYZ if the flight route
was to be changed. The IFPS uses the time over the reference location of the RAD
unit for checking the availability of the dependant entity.

To solve this system limitation, the FlightConditionCircumstance exposes two offset

NOTE
attributes:

• startOffset - the duration (positive or negative) to add to the airspace entry time
to get the estimation of the dependent entity entry time.

• endOffset - the duration (positive or negative) to add to the airspace exit time to
get the estimation of the dependent entity exit time.

For more details, see section Dependent Applicability based on Route availability and
Deferred Applicability in NM Flight Planning Requirements - Guidelines and IFPS
Users Manual.

1. The exported attributes are:

a. endOffset (ADR-E) (new 27.0)

End offset: a value (in minutes) between [-90, +90]

b. referenceLocation

c. relationWithLocation

d. startOffset (ADR-E) (new 27.0)

Start offset: a value (in minutes) between [-90, +90]

Edition: 27.0 6 302

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.2.9. FlightConditionCombination Object

1. The exported attribute is:

a. logicalOperator

2. The exported associations are:

a. element

b. timeInterval

3. There are no exported associations.

Example 36. FlightConditionCombination

<aixm:FlightConditionCombination gml:id="ID_168_1385510754493_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_168_1385510754493_7">
<!-- not expanded here -->
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>ANDNOT</aixm:logicalOperator>
<aixm:element>
<!-- not expanded here -->
</aixm:element>
<aixm:element>
<!-- not expanded here -->
</aixm:element>
</aixm:FlightConditionCombination>

17.1.3.2.10. FlightConditionElement Object

Last updated: 27.0 - Edition 3

1. The exported attribute is:

a. index

2. The exported associations are:

a. flightCondition

b. operationalCondition

c. flightLevel

d. borderCrossingCondition (ADR-E)

e. airportHeliportSetCondition (ADR-E)

f. pointSetCondition (ADR-E)

This extension allows a FlightConditionElement to refer to a PointSet feature.

Edition: 27.0 6 303

Document Title: NM 27.0 - NM B2B Reference Manual

g. flightRestrictionActivationCondition (ADR-E) (new 27.0)

This condition states that the applicability is based on the dynamic activations of the
restriction itself.

Example 37. FlightConditionElement - crossing an airspace reference location between certain levels

<aixm:FlightConditionElement gml:id="ID_168_1385510754493_11">
<aixm:flightCondition_airspaceCondition xlink:href="urn:uuid:d664b2c4-8b52-4387-
b26a-..."/>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance gml:id="ID_168_1385510754493_12">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>XNG</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
<aixm:flightLevel>
<aixm:FlightRestrictionLevel gml:id="ID_168_1385510754493_13">
<aixm:upperLevel uom="FL">115</aixm:upperLevel>
<aixm:upperLevelReference>STD</aixm:upperLevelReference>
<aixm:lowerLevel uom="FT">GND</aixm:lowerLevel>
<aixm:lowerLevelReference>MSL</aixm:lowerLevelReference>
</aixm:FlightRestrictionLevel>
</aixm:flightLevel>
</aixm:FlightConditionElement>

Edition: 27.0 6 304

Document Title: NM 27.0 - NM B2B Reference Manual

Example 38. FlightConditionElement - using a border crossing condition:

<aixm:FlightConditionElement gml:id="ID_168_1385510754493_3062">
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance gml:id="ID_168_1385510754493_3063">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>XNG</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
<aixm:flightLevel>
<aixm:FlightRestrictionLevel gml:id="ID_168_1385510754493_3064">
<aixm:upperLevel uom="FL">245</aixm:upperLevel>
<aixm:upperLevelReference>STD</aixm:upperLevelReference>
<aixm:lowerLevel uom="FT">GND</aixm:lowerLevel>
<aixm:lowerLevelReference>MSL</aixm:lowerLevelReference>
</aixm:FlightRestrictionLevel>
</aixm:flightLevel>
<aixm:extension>
<adr:FlightConditionElementExtension gml:id="ID_168_1385510754493_3065">
<adr:borderCrossingCondition>
<adr:AirspaceBorderCrossingObject gml:id="ID_168_1385510754493_3066">
<adr:exitedAirspace xlink:href="urn:uuid:d664b2c4-8b52-4387-b26a-
4f993180c545"/>
<adr:enteredAirspace xlink:href="urn:uuid:6013c06c-6cba-4a83-b0dd-
b9e527c86920"/>
</adr:AirspaceBorderCrossingObject>
</adr:borderCrossingCondition>
</adr:FlightConditionElementExtension>
</aixm:extension>
</aixm:FlightConditionElement>

Edition: 27.0 6 305

Document Title: NM 27.0 - NM B2B Reference Manual

Example 39. FlightConditionElement - using an airport/heliport set condition

<aixm:FlightConditionElement gml:id="ID_168_1385510754493_3062">
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance gml:id="ID_168_1385510754493_3063">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>DEP</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
<aixm:extension>
<adr:FlightConditionElementExtension gml:id="ID_168_1385510754493_3065">
<adr:airportHeliportSetCondition xlink:href="urn:uuid:d664b2c4-8b52-4387-
b26a-4f..."/>
</adr:FlightConditionElementExtension>
</aixm:extension>
</aixm:FlightConditionElement>

17.1.3.2.11. FlightRestrictionActivation Object (ADR-E) (new 27.0)

Last updated: 27.0 - Edition 3

1. The FlightRestrictionActivation object contains the information about a dynamic activation of

a restriction.

2. The exported attributes are:

a. PropertiesWithSchedule.timeInterval: the activation period

b. isP3: this flag is for use by NM MILO, NM CADF and AMCs. It is not included in the EAUP.
This flag indicates that this AUP contains P3 (Procedure 3) flight restriction activations.

This flag is ignored in input context.

This flag is optional in output context.

a. remark: the remark that an AMC or FMP can add to a dynamic activation of a restriction.

3. The exported associations are:

a. requestor: the unit that makes the request for the FlightRestriction reservation.

Edition: 27.0 6 306

Document Title: NM 27.0 - NM B2B Reference Manual

Example 40. Restriction activation start/end times

<adrext:FlightRestrictionExtension>
<adrext:activation>
<adrext:FlightRestrictionActivation gml:id="77728">
<aixm:timeInterval>
<aixm:Timesheet gml:id="77729">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:extension>
<adrext:TimesheetExtension gml:id="77730">
<gml:validTime>
<gml:TimePeriod gml:id="77731">
<gml:beginPosition>2021-07-22T15:30:00</gml:beginPosition>
<gml:endPosition>2021-07-22T16:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<adrext:remark>Some traffic reason</adrext:remark>
</adrext:FlightRestrictionActivation>
</adrext:activation>
</adrext:FlightRestrictionExtension>

17.1.3.2.12. FlightRestrictionActivationCondition Object (ADR-E) (new 27.0)

Last updated: 27.0 - Edition 3

1. A FlightRestrictionActivationCondition enriches the flight condition with a dependent

applicability on the activation of a restriction.

2. The restriction involved is implicitly the restriction itself.

3. There are no exported attributes

4. There are no exported associations.

17.1.3.2.13. FlightRoutingElement Object

1. The exported attributes are:

a. orderNumber

2. The exported associations are:

a. flightLevel

b. airportHeliportElement

c. airspaceElement

Edition: 27.0 6 307

Document Title: NM 27.0 - NM B2B Reference Manual

d. routePortionElement

e. pointElement

f. standardInstrumentArrivalElement

g. standardInstrumentDepartureElement

h. pointSetElement (ADR-E)

This extension allows a FlightRoutingElement to refer to a PointSet Feature (ADR-E).

i. airportHeliportSetElement (ADR-E)

This extension allows a FlightRoutingElement to refer to a AirportHeliportSet Feature (ADR-

E).

j. borderCrossingElement (ADR-E)

This extension allows a FlightRoutingElement to refer to an AirspaceBorderCrossingObject

Object (ADR-E).

17.1.3.2.14. FlowLocationElement Object

1. The exported attributes are:

a. index

Defines the order of the FlowElements in the upstream or downstream sequence

2. The exported associations are:

a. location

The location that identifies this FlowElement

Example 41. Two flow location elements representing the downstream and upstream of a flow

<downstreamFlowElement>
<FlowLocationElement id="ID_699_1423477726446_12">
<index>2</index>
<locationChoice_navaid href="urn:uuid:bf538f1c-21bd-4629-a893-2a1b8292cb8a"/>
</FlowLocationElement>
</downstreamFlowElement>
<upstreamFlowElement>
<FlowLocationElement id="ID_699_1423477726446_13">
<index>1</index>
<locationChoice_designatedPoint href="urn:uuid:07765def-1d2b-4c9d-8b39-
997a61f4cb49"/>
</FlowLocationElement>
</upstreamFlowElement>

Edition: 27.0 6 308

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.2.15. FUARestrictionActivation Object (ADR-E)

1. The exported attributes are:

a. active

Indication that the FUA restriction (theFlightRestriction) is activated during the

AirspaceActivation

b. remark

A remark specific to why the FUA restriction was (or was not) activated. The remark field is
only used in the context of AirspaceAvailability Service ((E)AUP/UUP related). In the context
of Airspace.rsaActivation (ADR-E), the remark field is not exported.

2. The exported associations are:

a. theFlightRestriction

Reference to the FUA restriction (using UUID)

Example 42. FUA restriction activation

<aixm:extension>
<adr:AirspaceActivationExtension gml:id="ID_171_1385510754499_169472_1">
<adr:fuaRestriction>
<adr:FUARestrictionActivation gml:id="ID_171_1385510754499_169472_2">
<adr:active>YES</adr:active>
<!-- remark field not used in the context of Airspace.rsaActivation -->
<adr:theFlightRestriction xlink:href="urn:uuid:9f7051bf-a004-4d51-b3a4-
df4283fe11cd"/>
</adr:FUARestrictionActivation>
</adr:fuaRestriction>
<!-- potentially more fuaRestrictions -->
</adr:AirspaceActivationExtension>
</aixm:extension>

17.1.3.2.16. FUARestrictionGroupActivation Object (ADR-E)

1. The exported attributes are

a. active

This flag indicates that the FUA restriction group is activated during the AirspaceActivation

b. isP3

Derived flag calculated for non-published UUPs. The flag indicates that the restriction group
was activated extra, compared to the activation in its predecessor within the AUP chain.

c. remark

Edition: 27.0 6 309

Document Title: NM 27.0 - NM B2B Reference Manual

Remark specific to why the FUA restriction group was (or was not) activated. The remark
field is only used in the context of AirspaceAvailability Service ((E)AUP/UUP related). In the
context of Airspace.rsaActivation (ADR-E), the remark field is not exported.

2. The exported associations are:

a. fuaRestrictionGroup

Reference to the FUA restriction group

17.1.3.2.17. FUAAsmScenarioActivation Object (ADR-E)

1. The exported attributes are:

a. scenarioActivationUuid

The value is set when the referenced ASM scenario is of category MANAGED. The value is the
uuid of the ASM scenario activation.

b. state

i. When the FUAAsmScenarioActivation object references an ASM scenario of category

MONITORED, the state is calculated taking into account all the relevant AUPs/UUPs.

ii. When the FUAAsmScenarioActivation object references an ASM scenario of category

MANAGED, the state is the state of the ASM scenario activation referenced by the
scenarioActivationUuid.

2. The exported associations are:

a. fuaAsmScenario

Reference to the ASM scenario.

17.1.3.2.18. IntermediateSignificantPoint Object (ADR-E)

1. There are no exported attributes.

2. The exported associations are:

a. pointChoice

3. The IntermediateSignificantPoint (ADR-E) is only used in the context of route portion

definitions.

Example 43. IntermediateSignificantPoint

<adr:IntermediateSignificantPoint gml:id="ID_168_1385510754493_741">
<adr:pointChoice_fixDesignatedPoint xlink:href="urn:uuid:1b3950ed-6e59-4a0e-
a732-49..."/>
</adr:IntermediateSignificantPoint>

Edition: 27.0 6 310

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.3.2.19. PointUsage Object (ADR-E)

Last updated: 27.0 - Edition 3

1. The exported attributes are:

a. role

The CodePointUsage Object (ADR-E) defines the attributes relativeLocation and reportATC,
but these attributes are not exported.

2. The exported associations are:

a. timeInterval (inherited from PropertiesWithSchedule)

The associated time table information.

b. specialDateAuthority (inherited from PropertiesWithSchedule)

The associated organisation authority. This association is only provided when there is at
least one associated timesheet that contains a special day (CodeDayType), i.e. a Timesheet
where the value of the attribute day is in {"HOL", "BEF_HOL", "AFT_HOL" or "BUSY_FRI"}.

c. levels

The associated upper and lower limits between which the point usage is defined.

d. levelSeries (new 27.0)

Indicates the flight level orientation scheme. This a combination of level series (EVEN, ODD).

e. reference

The associated reference location of type PointUsageReferenceChoice (ADR-E). Which of the

choice options is applicable depends on the value of the role attribute.

Table 17. PointUsageReferenceChoice selection according to the PointUsage.role attribute

PointUsage.role value PointUsageReferenceChoice attribute

FRA_ENTRY FRA_EXIT border
FRA_INTERMEDIATE airspace
FRA_ARRIVAL FRA_DEPARTURE one of:

1. airspace

2. airportHeliport

3. airportHeliportSet

17.1.3.2.20. ProcedureAvailability Object

1. The exported attributes are:

Edition: 27.0 6 311

Document Title: NM 27.0 - NM B2B Reference Manual

a. status

The value is always set to USABLE

2. The exported associations are:

a. timeInterval

Example 44. ProcedureAvailability

<aixm:ProcedureAvailability gml:id="ID_172_1385510754499_780273">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_172_1385510754499_780273_1">
<!-- not expanded here -->
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:status>USABLE</aixm:status>
</aixm:ProcedureAvailability>

17.1.3.2.21. PropertiesWithSchedule Object

1. There are no exported attributes.

2. The exported associations are:

a. timeInterval

3. For an example, see Timesheet Object.

17.1.3.2.22. RouteAvailability Object

1. The hostAirspace is used in the AirspaceAvailability Service to express in which FIR(s) the
RouteSegments are located.

2. The exported attributes are:

a. direction

b. status

The possible values are:

▪ OPEN

▪ CLSD

▪ COND

c. conditionalRouteType (ADR-E)

Only exported when status=COND. Possible values are:

▪ CDR_1: Conditional Route Type 1, normally available for flight planning, but can be
closed.

Edition: 27.0 6 312

Document Title: NM 27.0 - NM B2B Reference Manual

▪ CDR_2: Conditional Route Type 2. CDR_2’s are being decommissioned. However, some of
them might still be present in the NM system until end of 2023. Therefore, their export
remains possible.

▪ ATC_DISCRETION: ATC Discretion

3. The exported associations are:

a. timeInterval

b. levels

c. hostAirspace (ADR-E)

This is only used in the context of an AUP, to indicate in which Information Region the
RouteSegment is located.

Example 45. Route availability defining the schedule of CDR usage

<aixm:RouteAvailability gml:id="ID_172_1385510754499_2371">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_172_1385510754499_2371">
<!-- not expanded here, see Timesheet (schedule definitions) -->
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:direction>FORWARD</aixm:direction>
<aixm:status>COND</aixm:status>
<aixm:levels>
<aixm:AirspaceLayer gml:id="ID_172_1385510754499_2372">
<aixm:upperLimit uom="FL">245</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">95</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
<aixm:discreteLevelSeries xlink:href="urn:uuid:SLC_ODD_IFR"/>
</aixm:AirspaceLayer>
</aixm:levels>
<aixm:extension>
<adr:RouteAvailabilityExtension gml:id="ID_172_1385510754499_2373">
<adr:conditionalRouteType>CDR_3</adr:conditionalRouteType>
</adr:RouteAvailabilityExtension>
</aixm:extension>
</aixm:RouteAvailability>

17.1.3.2.23. RoutePortion Object

1. There are no exported attributes.

2. The exported associations are:

a. start

Edition: 27.0 6 313

Document Title: NM 27.0 - NM B2B Reference Manual

b. referencedRoute

c. end

d. range (ADR-E)

The range allows to express some altitudes related to the route portion. This is used to
express vertical limits when defining nearBy and offLoad associations between airspaces
and route portions.

e. intermediatePoint (ADR-E)

The intermediatePoint(s) is used when defining flight conditions and flight routings where
the order (sequence) of the significant points to be traversed is important, but not Route
dependent.

f. referencedProcedure (ADR-E)

The referencedProcedure allows to define a "Procedure" route portion. Instead of having a

route portion between any two points of a route, it allows expressing a portion between any
two points of a SID/STAR.

Example 46. Route portion

<aixm:RoutePortion gml:id="ID_168_1385510754493_739">
<aixm:start_navaidSystem xlink:href="urn:uuid:682543b6-97c6-4bf7-b95c-
21a1e5b8c998"/>
<aixm:referencedRoute xlink:href="urn:uuid:77af856b-078c-484b-a20a-
3216cef1be2d"/>
<aixm:end_fixDesignatedPoint xlink:href="urn:uuid:a7b98cb4-4e28-4258-8a4e-
d8b5ab3d95d0"/>
<aixm:extension>
<adr:RoutePortionExtension gml:id="ID_168_1385510754493_740">
<adr:intermediatePoint>
<adr:IntermediateSignificantPoint gml:id="ID_168_1385510754493_741">
<adr:pointChoice_fixDesignatedPoint xlink:href="urn:uuid:1b3950ed-6e59-
4a0e-a73..."/>
</adr:IntermediateSignificantPoint>
</adr:intermediatePoint>
</adr:RoutePortionExtension>
</aixm:extension>
</aixm:RoutePortion>

17.1.3.2.24. ScenarioRsaAllocation Object (ADR-E)

1. The exported attributes are:

a. defaultApplicabilityTil

b. defaultApplicabilityWef

Edition: 27.0 6 314

Document Title: NM 27.0 - NM B2B Reference Manual

c. defaultLowerLimit

d. defaultLowerLimitReference

e. defaultUpperLimit

f. defaultUpperLimitReference

2. The exported associations are:

a. rsa

17.1.3.2.25. SunriseSunsetRow Object (ADR-E)

1. The exported attributes are:

a. sunrise

b. sunset

2. There are no exported associations.

17.1.3.2.26. Timesheet Object

1. CACD timeslices are bounded by AIRAC switch dates. This granularity is not sufficient to express
permanent changes that occur during the AIRAC, e.g. permanent changes to the CDR definitions.

2. Therefore CACD uses two kinds of temporal structures inside the timeslices:

a. A time period specifies the validity period of a property. Typically when AIXM would use a
TEMP_DELTA to express route closures/openings and airspace allocations.

b. A time schedule (or time table) specifies defintion periods of a property, e.g. during certain
time intervals of some days of the week. In CACD these timetables are expressed with a
string like 2012/10/18→2014/04/03 -----67 06:00 - 10:00. However, CACD also makes use of
concepts such as holiday, day-before-holiday, busy-Friday, etc.

Time Period

1. The core aixm:Timesheet does not allow to express a time period because the
Timesheet.startDate and Timesheet.endDate are of type aixm:DateMonthDayType.

2. The Timesheet was extended with a gml:validTime to have the possibility to express a time
period.

3. The following Timesheet properties are set with fixed values.

Table 18. Timesheet properties with fixed values when defining a time period

Property Value

timeReference UTC

day ANY

excluded NO

Edition: 27.0 6 315

Document Title: NM 27.0 - NM B2B Reference Manual

Example 47. Time period from 2013/11/05 20:30 to 2013/11/05 21:00

<aixm:Timesheet gml:id="ID_50_1352812184610_10_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_10_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_83">
<gml:beginPosition>2013-11-05T20:30:00</gml:beginPosition>
<gml:endPosition>2013-11-05T21:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>

Time Schedule

1. The Time Schedule information in CACD can be represented by a string like "2012/10/18 ->
2014/02/06 -----67 00:00 06:00". The meaning of this is: "from 2012/10/18 (midnight) to 2014/02/06
(midnight), on Saturdays(6) and Sundays(7) from 00:00 to 06:00".

2. The Time Schedule information is always part of an AIXM Object that is derived from
PropertiesWithSchedule.

3. Apart from the days of the week, holidays, the day before/after holidays and busy Fridays are
supported.

4. For each day in an expression like "2012/10/18 -> 2014/02/06 -----67 00:00 06:00", a separate
aixm:timeInterval element is needed.

5. The following Timesheet properties are set:

Table 19. Timesheet properties when defining a Time Schedule

Property Value

timeReference UTC

day 'day of the week or special day'

startTime 'start time'

endTime 'end time'

excluded NO

gml:validTime (ADR-E) 'the surrounding time period'

Edition: 27.0 6 316

Document Title: NM 27.0 - NM B2B Reference Manual

Example 48. Time schedule "2012/10/18 → 2014/02/06 -----67 00:00 06:00"

<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_8_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SAT</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>06:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_8_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_81">
<gml:beginPosition>2012-10-18T00:00:00</gml:beginPosition>
<gml:endPosition>2014-02-06T00:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_9_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SUN</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>06:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_9_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_82">
<gml:beginPosition>2012-10-18T00:00:00</gml:beginPosition>
<gml:endPosition>2014-02-06T00:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>

6. For wintertime and summertime periods, the gml:validTime (ADR-E) is not used. Instead the core
AIXM startDate and endDate are used with the values SDLST and EDLST. The daylightSavingAdjust
is explicitly set to NO.

Edition: 27.0 6 317

Document Title: NM 27.0 - NM B2B Reference Manual

Example 49. Time schedule for wintertime and summertime periods

<!-- WINTERTIME start EDLST end SDLST -->

<aixm:timeInterval>
<aixm:Timesheet gml:id="uuid.7033a5ab-b30c-4daa-82c3-68ff420e1330">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:startDate>EDLST</aixm:startDate>
<aixm:endDate>SDLST</aixm:endDate>
<aixm:day>MON</aixm:day>
<aixm:startTime>08:30</aixm:startTime>
<aixm:endTime>17:00</aixm:endTime>
<aixm:daylightSavingAdjust>NO</aixm:daylightSavingAdjust>
<aixm:excluded>NO</aixm:excluded>
</aixm:Timesheet>
</aixm:timeInterval>

<!-- SUMMERTIME start SDLST end EDLST -->

<aixm:timeInterval>
<aixm:Timesheet gml:id="uuid.7033a5ab-b30c-4daa-82c3-68ff420e1330">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:startDate>EDLST</aixm:startDate>
<aixm:endDate>SDLST</aixm:endDate>
<aixm:day>MON</aixm:day>
<aixm:startTime>07:30</aixm:startTime>
<aixm:endTime>16:00</aixm:endTime>
<aixm:daylightSavingAdjust>NO</aixm:daylightSavingAdjust>
<aixm:excluded>NO</aixm:excluded>
</aixm:Timesheet>
</aixm:timeInterval>

Default Schedules

1. Time Schedules can be very complex. E.g. in defining the CDRs, it is not allowed to have gaps in
the schedule. In order to simplify the definitions, it is possible to define a "default" schedule. The
default schedule is defined as any time, subtracting some Time Schedules from this default.

2. The default schedules is represented as a Timesheet with the following properties:

Table 20. Timesheet properties of the default schedule

Property Value

timeReference UTC

day ANY

excluded NO

gml:validTime (ADR-E) 'the surrounding time period'

Edition: 27.0 6 318

Document Title: NM 27.0 - NM B2B Reference Manual

3. From the default schedule, the other time schedules are subtracted by setting the
Timesheet.excluded property to YES.

Edition: 27.0 6 319

Document Title: NM 27.0 - NM B2B Reference Manual

Example 50. Default schedule

<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_7_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_8_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_81">
<gml:beginPosition>2012-10-18T00:00:00</gml:beginPosition>
<gml:endPosition>2014-02-06T00:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_8_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SAT</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>06:00</aixm:endTime>
<aixm:excluded>YES</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_8_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_81">
<gml:beginPosition>2012-10-18T00:00:00</gml:beginPosition>
<gml:endPosition>2014-02-06T00:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_9_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SUN</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>06:00</aixm:endTime>
<aixm:excluded>YES</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_9_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_82">

Edition: 27.0 6 320

Document Title: NM 27.0 - NM B2B Reference Manual

<gml:beginPosition>2012-10-18T00:00:00</gml:beginPosition>
<gml:endPosition>2014-02-06T00:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>

17.1.3.2.27. TrafficVolumeActivation Object (ADR-E)

1. The time-based definition of when the traffic volume is active.

Example 51. Traffic volume activation

<activation>
<TrafficVolumeActivation id="ID_705_1423477842671_182">
<timeInterval>
<Timesheet id="ID_705_1423477842671_183">
<timeReference>UTC</timeReference>
<day>ANY</day>
<startTime>06:00</startTime>
<endTime>21:00</endTime>
<extension>
<TimesheetExtension id="ID_705_1423477842671_184">
<validTime>
<TimePeriod id="ID_705_1423477842671_185">
<beginPosition>2014-05-29T00:00:00</beginPosition>
<endPosition indeterminatePosition="unknown"/>
</TimePeriod>
</validTime>
</TimesheetExtension>
</extension>
</Timesheet>
</timeInterval>
</TrafficVolumeActivation>
</activation>

17.1.3.3. Choice types

17.1.3.3.1. PointUsageReferenceChoice (ADR-E)

1. The PointUsageReferenceChoice provides the choice of a reference location linked to a PointUsage

Object (ADR-E).

2. The reference location must be one of:

Edition: 27.0 6 321

Document Title: NM 27.0 - NM B2B Reference Manual

a. border

An AirspaceBorderCrossingObject that specifies the entered and exiting airspace

b. airspace

c. airportHeliport

d. airportHeliportSet

17.1.3.4. Data types

17.1.3.4.1. CodeConditionalRouteType (ADR-E)

1. The following information is also available from the EUROCONTROL ATM Lexicon.

2. A Conditional Route may have more than one category, and those categories may change at
specified times:

a. Category 1: Permanently Plannable CDR

CDR_1 routes are available for flight planning during times published in the relevant AIP

b. Category 2: Non-Permanently Plannable CDR

CDR_2 routes may be available for flight planning. Flights may only be planned on a CDR_2
in accordance with conditions published daily in the AUP.

c. Category 3: Not Plannable CDR

CDR_3 routes are not available for flight planning; however, ATC Units may issue tactical
clearances on such route segments

17.1.3.4.2. CodeFlightStatusType

Last updated: 27.0 - Edition 2

1. The value OTHER:__ADR__IOAT indicates a flight condition that selects iOAT flights.

17.1.3.4.3. CodePointNMDesignatorType (ADR-E) (new 27.0)

Last updated: 27.0 - Edition 2

1. This type is based on aixm:Character3Type and contains 2 to 5 characters.

17.1.3.4.4. CodePointUsageType (ADR-E)

Last updated: 27.0 - Edition 2

1. This enumerator specifies the role of a PointUsage (ADR-E).

a. EN_ROUTE: for potential future use

b. ENTRY: for potential future use (replacing SignificantPointInAirspace Feature)

Edition: 27.0 6 322

Document Title: NM 27.0 - NM B2B Reference Manual

c. ENTRY_EXIT: for potential future use (replacing SignificantPointInAirspace Feature)

d. EXIT: for potential future use (replacing SignificantPointInAirspace Feature)

e. FRA_ENTRY: FRA entry point

f. FRA_EXIT: FRA exit point

g. FRA_INTERMEDIATE: FRA intermediate point

h. FRA_ARRIVAL: FRA arrival point

i. FRA_DEPARTURE: FRA departure point

j. LAND_FALL: for potential future use

k. MILITARY (obsolete since NM-27.0): point type that cannot be used for General Air Traffic

l. OCEANIC_ENTRY_EXIT: for potential future use

m. TERMINAL: for potential future use

n. VFR: for potential future use

o. OAT (new 27.0): OAT point that can be used in iOAT flight plan

p. OTHER: standard AIXM extension mechanism value

17.1.3.4.5. CodeProcessingIndicatorType (ADR-E)

1. The NM restriction type (see Exposed Restriction Types):

a. AD_CP: Aerodrome DCT or Aerodrome Connecting Points restriction.

b. FRA_DCT: FRA DCT restriction.

c. FPR: Flight profile restriction.

d. RAD_DCT: RAD DCT restriction.

e. TFR: Traffic flow restriction.

f. OTHER:__ADR__AD_FLIGHT_RULE: Aerodrome flight rule restriction.

g. OTHER:__ADR__FLIGHT_PROPERTY_ON_TP: Flight property on terminal procedure restriction.

17.1.3.4.6. CodeScenarioType (ADR-E)

1. An Airspace Management Scenario is a pre-defined and coordinated set of areas.

2. Specific combinations of area activations in one or multiple countries, might trigger capacity
issues considered as critical for the Network.

3. The detection of these specific combinations of area activations enhances the coordination
process between AMCs and NM.

4. When a scenario is detected, a warning message is issued.

5. The value of the scenario enumerator indicates to which degree an allocated airspace
participates in a scenario:

a. NONE: none of the scenarios contains the airspace

b. INACTIVE: the airspace is part of one or more scenarios but, for none of these scenarios, all

Edition: 27.0 6 323

Document Title: NM 27.0 - NM B2B Reference Manual

the participating airspaces have been allocated

c. ACTIVE: the airspace is part of one or more scenarios and, for at least one of these scenarios,
all the participating airspaces have been allocated

17.1.3.4.7. ScenarioCategoryType (ADR-E)

Last updated: 27.0 - Edition 2

1. The category allows to define specific subcategories of Airspace Management Scenarios.

2. These subcategories may have specific usages or capabilities.

3. These are the values

a. MONITORED: ASM scenario that is monitored by the system

b. MANAGED: ASM scenario that can be activated by the user

c. MANAGED_MONITORED: ASM scenario that is monitored by the system and can be

activated by the user

17.1.3.5. Miscellania

17.1.3.5.1. gml:pos

1. Latitudes and longitudes are expressed using the WGE(WGS-84) datum. In coordinates, the
latitude is provided first. Latitudes and longitudes use a decimal notation instead of
minutes/seconds.

2. In AIXM (because it is based on GML) the datum must be encoded in the srsName attribute as
"urn:ogc:def:crs:EPSG::4326".

Example 52. Position

<gml:pos srsName="urn:ogc:def:crs:EPSG::4326">56.66833333333334 -
10.0</gml:pos>

This corresponds to 56°40'6"N, 10°W.

17.1.3.5.2. StandardLevel encoding

1. The StandardLevelColumns and StandardLevelTables are hardcoded in the Route domain.

2. When defining the RouteAvailability, the levels (see AirspaceLayer Object) will refer to a
discreteLevelSeries, which is a reference to a StandardLevelColumn Feature.

3. The CodeLevelSeriesType is extended with the value OTHER:__ADR__UNIDIRECTIONAL to express that

both EVEN and ODD can be used because the RouteSegment is unidirectional.

4. In total, 10 StandardLevelColumns are defined to express the possible combinations of

CodeLevelSeriesType and StandardColumnTable.

Edition: 27.0 6 324

Document Title: NM 27.0 - NM B2B Reference Manual

5. The following table shows the possible combinations:

Table 21. Possible combinations of CodeLevelSeriesType and StandardColumnTable

IFR IFR_RVSM VFR VFR_RVSM

EVEN X X X X

ODD X X X X

UNIDIRECTIONAL X X - -

Example 53. Definition of ODD/VFR combination

<aixm:StandardLevelColumn gml:id="ID_172_1385510754499_70">
<gml:identifier codeSpace="urn:uuid:">SLC_ODD_VFR</gml:identifier>
<aixm:timeSlice>
<aixm:StandardLevelColumnTimeSlice gml:id="ID_172_1385510754499_71">
<gml:validTime>
<gml:TimePeriod gml:id="ID_172_1385510754499_72">
<gml:beginPosition>1970-01-01T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_172_1385510754499_73">
<gml:beginPosition>1970-01-01T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:series>ODD</aixm:series>
<aixm:levelTable xlink:href="urn:uuid:SLT_VFR"/>
</aixm:StandardLevelColumnTimeSlice>
</aixm:timeSlice>
</aixm:StandardLevelColumn>

17.1.4. Airblocks and Airspaces

1. An Airspace feature can represent:

◦ an airblock

◦ an airspace composed of airblocks (associated with an altitude range to define a 3D volume)

◦ an airspace composed of other airspaces

17.1.4.1. Airblocks

1. The NM system uses airblocks to define the horizontal projections of a airspaces.

Edition: 27.0 6 325

Document Title: NM 27.0 - NM B2B Reference Manual

2. An airblock is modelled as an Airspace Feature of type PART.

3. An airblock is "anonymous" in the sense that it has no designator.

4. The horizontal projection is coded as a flat AIXM AirspaceVolume. None of the attributes of the
AirspaceGeometryComponent are set. The geometrical description is defined by the associated
Surface object (GML /ISO19107).

5. The Surface uses srsName set to urn:ogc:def:crs:EPSG::4326.

6. A GM_Surface is composed of an array of Patch objects - the Patch object used is PolygonPatch.

7. The PolygonPatch describes the exterior with a LinearRing.

8. The vertices canbe expressed as:

a. Point feature references (UUID’s)

b. gml:pos coordinates

Example 54. Airblock

<aixm:AirspaceTimeSlice gml:id="ID_171_1385510754499_5">
<aixm:type>PART</aixm:type>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_171_1385510754499_6">
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_171_1385510754499_7">
<aixm:horizontalProjection>
<aixm:Surface gml:id="ID_171_1385510754499_8"
srsName="urn:ogc:def:crs:EPSG::4326">
<gml:patches>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:pointProperty xlink:href="urn:uuid:da598262-..."/>
<gml:pointProperty xlink:href="urn:uuid:bbc5c700-..."/>
<gml:pos>56.66833333333334 -10.0</gml:pos>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
</gml:patches>
</aixm:Surface>
</aixm:horizontalProjection>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
</aixm:AirspaceTimeSlice>

Edition: 27.0 6 326

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.4.2. Airspaces Composed of Airblocks

1. An airspace composed of airblocks (associated to altitude ranges) is mapped to an AIXM

Airspace having airspace volumes.

2. There can be multiple associated AirspaceVolumes.

3. The AirspaceVolume defines the altitude range through the upperLimit and lowerLimit attributes.

4. For the first (in order of appearance) airspace volume, the corresponding
AirspaceGeometryComponent has its operation attribute set to BASE.

5. For subsequent (in order of appearance) airspace volumes, the corresponding

AirspaceGeometryComponent has its operation attribute set to UNION.

6. As the airspace volume depends on an airblock, the AirspaceVolumeDependency has its dependency
attribute set to HORZ_PROJECTION.

Edition: 27.0 6 327

Document Title: NM 27.0 - NM B2B Reference Manual

Example 55. Airspaces composed of airblocks

<aixm:AirspaceTimeSlice gml:id="ID_171_1385510754499_41296">
<aixm:type>SECTOR</aixm:type>
<aixm:designator>BIRDES</aixm:designator>
<aixm:designatorICAO>YES</aixm:designatorICAO>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_171_1385510754499_41297">
<aixm:operation>BASE</aixm:operation>
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_171_1385510754499_41298">
<aixm:upperLimit uom="FT">UNL</aixm:upperLimit>
<aixm:upperLimitReference>MSL</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">55</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
<aixm:contributorAirspace>
<aixm:AirspaceVolumeDependency gml:id="ID_171_1385510754499_41299">
<aixm:dependency>HORZ_PROJECTION</aixm:dependency>
<aixm:theAirspace xlink:href="urn:uuid:a2cf60ce-8fe9-4ee1-913f-
06cc0a9bdb84"/>
</aixm:AirspaceVolumeDependency>
</aixm:contributorAirspace>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_171_1385510754499_41300">
<aixm:operation>UNION</aixm:operation>
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_171_1385510754499_41301">
<aixm:upperLimit uom="FT">UNL</aixm:upperLimit>
<aixm:upperLimitReference>MSL</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">55</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
<aixm:contributorAirspace>
<aixm:AirspaceVolumeDependency gml:id="ID_171_1385510754499_41302">
<aixm:dependency>HORZ_PROJECTION</aixm:dependency>
<aixm:theAirspace xlink:href="urn:uuid:418f6ebc-1bfe-41f0-ac9b-
d70f584f3375"/>
</aixm:AirspaceVolumeDependency>
</aixm:contributorAirspace>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
</aixm:AirspaceTimeSlice>

Edition: 27.0 6 328

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.4.3. Airspaces Composed of Other Airspaces

1. An airspace composed of other airspaces defines its volume via airspace volumes.

2. There can be multiple associated airspace volumes.

3. For the first airspace volume, the corresponding AirspaceGeometryComponent has its operation
attribute set to BASE.

4. For subsequent airspace volumes, the corresponding AirspaceGeometryComponent has its

operation attribute set to UNION.

5. As the airspace volume depends on an airspace, the AirspaceVolumeDependency has its dependency
attribute set to FULL_GEOMETRY.

Edition: 27.0 6 329

Document Title: NM 27.0 - NM B2B Reference Manual

Example 56. Airspaces composed of other airspaces

<aixm:AirspaceTimeSlice gml:id="ID_171_1385510754499_198517">
<aixm:type>NAS</aixm:type>
<aixm:designator>EB</aixm:designator>
<aixm:designatorICAO>YES</aixm:designatorICAO>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_171_1385510754499_198518">
<aixm:operation>BASE</aixm:operation>
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_171_1385510754499_198519">
<aixm:contributorAirspace>
<aixm:AirspaceVolumeDependency gml:id="ID_171_1385510754499_198520">
<aixm:dependency>FULL_GEOMETRY</aixm:dependency>
<aixm:theAirspace xlink:href="urn:uuid:9be9ab99-3df5-4251-9cb9-
fba72afeb751"/>
</aixm:AirspaceVolumeDependency>
</aixm:contributorAirspace>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_171_1385510754499_198521">
<aixm:operation>UNION</aixm:operation>
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_171_1385510754499_198522">
<aixm:contributorAirspace>
<aixm:AirspaceVolumeDependency gml:id="ID_171_1385510754499_198523">
<aixm:dependency>FULL_GEOMETRY</aixm:dependency>
<aixm:theAirspace xlink:href="urn:uuid:265ffc98-d66f-454a-811b-
3b2f66d490e6"/>
</aixm:AirspaceVolumeDependency>
</aixm:contributorAirspace>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
</aixm:AirspaceTimeSlice>

17.1.5. FUA (Flexible Use of Airspace)

1. For more detailed information about FUA, see section Airspace Management in NM Flight
Planning Requirements - Guidelines.

Edition: 27.0 6 330

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.5.1. Flexible Use Levels

1. Flexible Use

The airspace is not designated as either military or civil airspace but should be used flexibly on
a day-to-day basis. Consequently, any necessary airspace segregation should be only of a
temporary nature.

2. Level 1

The airspace is manageable at the strategic level. The act of defining and reviewing as required
the national airspace policy taking into account national and international airspace
requirements. The RSA activation is determined by the Airspace.activation.

3. Level 2

The airspace is manageable at the pre-tactical level. The act of conducting operational
management within the framework of pre-determined existing ATM structure and procedures
defined in Level1 and of reaching specific agreement between civil and military authorities
involved. An RSA of Level2 must be included in AUP/UUP to become activated.

4. Level 3

The airspace is manageable at the tactical level.

5. Some business rules:

a. If flexibleUse = YES, then at least one of level1/2/3 must also be YES

b. If flexibleUse = NO, then all of level1/2/3 must be NO

c. If level2 = YES, then level1 must also be YES

6. The FUA airspaces can be categorized as:

a. NAM: Airspaces which can be activated by the military or other special users without prior
coordination with the civilian users, i.e. AMC during the times defined in the availability.

This corresponds to level1 = YES, level2 = NO.

b. AMA: Airspaces which can be activated in a flexible way for use by the military or other
special users after due coordination between military and civilian during the times defined
in the availability.

This corresponds to level1 = YES, level2 = YES.

17.1.5.2. Air Route Classification

1. Nearby

An air route can be classified as a nearby route for zero or more RSAs. The relationship is meant
to help AMCs in the decision process for which routes can be opened/closed by an RSA
activation. As this relationship is bi-directional, it suffices that the RSA/route segment vertical

Edition: 27.0 6 331

Document Title: NM 27.0 - NM B2B Reference Manual

limit combination exists in one direction. Activating an RSA implies closing the nearby air
routes.

2. Offload

An air route can be classified as an offload route for zero or more RSAs. The relationship is
meant to help AMCs in the decision process for which routes can be opened/closed by an RSA
activation. Activating an RSA implies opening an offload air route.

3. Not Affected

An air route can be classified as a not affected by RSA activation for zero or more RSAs. The
relationship is meant to help AMCs in the decision process for which routes can be
opened/closed by an RSA activation. Activating an RSA has no impact on the not_affected air
route, even if it geometrically crosses the RSA.

17.1.5.3. RSA Activation

1. The availability of the RSA is expressed with the association Airspace.activation where the
AirspaceActivation.status = AVBL_FOR_ACTIVATION. Note that the AIXM attribute is called
activation but it is in fact used to express the availability.

2. The activation of an RSA is expressed in the Airspace.rsaActivation in the AirspaceExtension,

with AirspaceActivation.status = ACTIVE.

17.1.6. Restrictions

Last updated: 27.0 - Edition 3

1. NM uses restrictions to impose restrictive measures on specific flights or traffic flows. They
affect the flight plan processing. The majority of restrictions in the NM system are created based
on the Route Availability Document (RAD). Other sources of information include ANSPs, AIPs,
NOTAMs, AIP SUP, NM crisis, etc.

2. The NM restriction model slightly diverges from the AIXM one:

◦ NM uses restrictions that have no equivalent in AIXM

◦ NM uses restrictions to model some aspects that AIXM addresses via specific features

3. The ADR-E complements the AIXM restriction model so that all NM restrictions can be exported
through it (see FlightRestriction Feature).

4. This section provides a high level view on the NM restriction model and on its mapping to AIXM
/ ADR-E.

17.1.6.1. Exposed Restriction Types

Last updated: 27.0 - Edition 3

1. The NM restriction type is expressed by the FlightRestriction.processingIndicator attribute

defined by the ADR-E.

Edition: 27.0 6 332

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.6.1.1. Traffic Flow Restriction

1. Such restrictions originate from the RAD, AIP, ENV-COR, NOTAMs and other communication
between ANSPs and NM.

2. processingIndicator = TFR

17.1.6.1.2. Flight Profile Restriction

1. A flight profile restriction (aka profile tuning restriction) influences the flight profile calculation
in order to count the flight in certain operational airspaces in accordance with applicable letters
of agreement. At a later stage, this flight profile is checked against the RAD. Additionally the
flight profile restrictions might also be used to correct addressing in IFPS (where special
conditions apply) and to better reflect controllers' workload through fine tuning of the profile.

2. See section Profile Tuning Restriction (PTR) in NM Flight Planning Requirements - Guidelines.

3. processingIndicator = FPR

IMPORTANT Flight profile restrictions are not used to invalidate flight plans.

17.1.6.1.3. Aerodrome Flight Rule Restriction

1. The AIXM airport/heliport availability with regards to IFR usage is modelled in the NM system
as an aerodrome flight rule restriction.

2. A flight plan is rejected if its specifier is IFR and the arriving/departing airport/heliport is not
supporting IFR at that time of the day.

3. The restriction is modelled with a flight condition arriving to / departing from an

airport/heliport.

4. In case of a violation of the restriction by a flight plan, IFPS returns the designator of the
restriction that the flight plan violates.

5. See section Aerodrome Flight Rule Restriction in NM Flight Planning Requirements - Guidelines.

6. processingIndicator = OTHER:__ADR__AD_FLIGHT_RULE

17.1.6.1.4. Flight Property Restriction on Terminal Procedure

1. The AIXM Procedure.aircraftCharacteristic is modelled in the NM system as a flight property

restriction on terminal procedure.

2. Such a restriction defines when the use of terminal procedures is often restricted to given flight
property conditions such as aircraft type/classification (e.g. "propellers only" or "jet only"), type
of flight (e.g. military), aircraft equipment (e.g. ILS).

3. It allows IFPS and the ETFMS profiler to select more accurately the most suitable terminal
procedure for a flight and invalidate those flight plans containing a wrong terminal procedure.

4. See section Flight Property Restriction on Terminal Procedure in NM Flight Planning

Requirements - Guidelines.

5. processingIndicator = OTHER:__ADR__FLIGHT_PROPERTY_ON_TP

Edition: 27.0 6 333

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.6.1.5. RAD-DCT Restriction

1. Such restrictions apply to the flights traversing or crossing the border of an airspace.

2. processingIndicator = RAD_DCT

3. The flight condition can be:

a. Airspace crossing

b. Airspace border crossing

4. The flight condition circumstance has fixed values:

a. referenceLocation = YES

b. relationWithLocation = YES

5. It is possible to express a DCT limit with allowed and disallowed segments. However, in such a
case, two restrictions have to be defined:

a. The first restriction expresses the DCT limit in an airspace (flight condition) and the allowed
flight routing (DCT segments longer than the DCT limit).

b. The second restriction expresses a flight condition on the same airspace but without DCT
limit. The flight routings are the disallowed DCT segments (DCT segments shorter than the
DCT limit specified in the other flight restriction).

17.1.6.1.6. FRA-DCT Restriction

1. A FRA DCT restriction defines the rules for flying direct (DCT) in a Free Route Airspace (FRA).

2. See section FRA DCT Restriction in NM Flight Planning Requirements - Guidelines.

3. processingIndicator = FRA_DCT

4. The flight condition can be:

a. Airspace crossing

A flight routing significant point has to be interpreted as an intermediate point in the

crossed airspace of the flight condition.

b. Single direction airspace border crossing (AS1 ⇒ As2)

A flight routing significant point has to be interpreted as follows:

i. Entry point for the entered airspace of an airspace border crossing flight condition.

ii. Exit point for the exited airspace of an airspace border crossing flight condition.

c. Bi-directional airspace border crossing (AS1 ⇒ As2 and AS2 ⇒ AS1)

A flight routing significant point has to be interpreted as an entry/exit point for both
airspaces.

5. The flight routing can be:

a. DirectFlightSegment

Edition: 27.0 6 334

Document Title: NM 27.0 - NM B2B Reference Manual

b. DesignatedPoint

c. Navaid

In order to find all the entry/exit points, all the FRA-DCT restrictions that make use
NOTE
of airspace border flight conditions have to be considered.

17.1.6.1.7. Aerodrome Connecting Point Restriction

1. Such restrictions are documented in RAD Appendix 5.

2. processingIndicator = AD_CP

3. Flight condition is a combination of:

◦ An arriving and/or departing airport/heliport flight condition

◦ A DCT flight condition

4. The flight routing describes the DCT connecting points from/to the airport/heliport

17.1.6.2. Dependent Applicability

Last updated: 27.0 - Edition 3

1. Dependent applicability consists in binding the activation of a restriction to to the availability of

a route portion, to the activation of an airspace or to the activation the restriction itself.

2. See sections Dependent Applicability based on Route availability and Dependent Applicability
based on Airspace Activation in NM Flight Planning Requirements - Guidelines.

17.1.6.3. AUP/UUP Manageable Restrictions

Last updated: 27.0 - Edition 3

17.1.6.3.1. FUA Restriction

1. A FUA restriction restricts flights trying to penetrate an RSA.

2. A FUA restriction has a RSA dependent applicability.

a. A DURING dependent applicability applies within the FL Range where the RSA is activated.

b. An OUTSIDE dependent applicability applies within the FL Range where the RSA is NOT
activated.

3. See section FUA/EU Restriction in NM Flight Planning Requirements - Guidelines.

4. processingIndicator = TFR

5. isFUA = Yes

6. fuaDefaultActive indicates whether the restriction should be proposed active by default to the
end user in the context of an AUP/UUP.

Edition: 27.0 6 335

Document Title: NM 27.0 - NM B2B Reference Manual

17.1.6.3.2. FUA-RAD Restriction

1. A FUA-RAD restriction impacts flights in the neighbourhood of an RSA.

2. A FUA-RAD restriction has a RSA dependent applicability.

a. A DURING dependent applicability applies within and not within the FL Range where the RSA
is activated.

b. An OUTSIDE dependent applicability applies within and not within the FL Range where the
RSA is NOT activated.

3. See section FUA/RAD Restriction in NM Flight Planning Requirements - Guidelines.

4. processingIndicator = TFR

5. isFuaRAD = Yes

17.1.6.3.3. AUP-RAD Restriction

1. An AUP-RAD restriction may or may not have an RSA dependent applicability.

2. An AUP-RAD restriction without RSA dependent applicability is associated to the air traffic
management service (see AirTrafficmanagementService.clientRestriction) delivered by its
owner FMP or AMC.

3. processingIndicator = TFR|FPR

4. isAupRAD = Yes

5. aupRadDefaultActive indicates whether the restriction should be proposed active by default to

the end user in the context of an AUP/UUP.

17.1.6.4. Restriction Enablement

1. In the NM system, a restriction can be enabled or not. Only enabled restrictions are taken into
account by the flight plan validation. This property is typically used for re-occurring events, like
annual exhibitions.

2. The NM restriction enablement is expressed by the FlightRestriction.enabled attribute defined

by the ADR-E.

17.1.7. Operational Usage

Last updated: 27.0 - Edition 3

1. The majority of airspaces and restrictions defined in the NM system are for operational use.
However, NM also defines some airspaces/restrictions that, although they may not be
operational at some moment, may become operational at some point in time. The reasons
behind the use of such airspaces/restrictions are varied. Some may be experimental, some may
be for contingency, others to allow reacting quickly to crisis situations, etc.

2. It would be desirable not to export such airspaces/restrictions because they are not of general
interest when not operational. However, if they do become operational they would have to be
exported. Also note that these airspaces/restrictions may potentially switch from operational to
not-operational several times. Therefore exporting an airspace/restriction only when it is

Edition: 27.0 6 336

Document Title: NM 27.0 - NM B2B Reference Manual

operational and not exporting it when not-operational would create "holes" in the feature’s
lifetime. The AIX model does not foresee "holes" in the lifetime of a feature.

3. For this reason the following approach has been chosen: such airspaces/restrictions, or any such
features in general, are always exported and the notion of being or not operational is exported
by means of a usage attribute (Airspace.usage / FlightRestriction.usage) defined by the ADR-E.

4. The usage attribute may take the following values:

◦ OPERATIONAL: the feature is for operational use.

◦ WITHHELD: the feature is not for operational use (or it cannot be exported in the requested NM
B2B version) and for this reason it has been withheld.

5. In addition to this WITHHELD value, to make more explicit that the restriction is not to be used, all
other attributes are nullified.

6. The following scenarios are possible:

a. The feature is new and it is not operational:

i. The feature is exported and all its properties in the only timeslice are nullified

ii. The usage attribute is set to WITHHELD

b. The feature is new and it is operational:

i. The feature is exported and its only timeslice has its properties set

ii. The usage attribute is set to OPERATIONAL

c. The feature is new and it is operational but its detailed definition is not supported by the
requested (old) NM B2B version:

i. The feature is exported and all properties of its only timeslice are nullified

ii. The usage attribute is set to WITHHELD

d. The feature is changed from operational to non-operational:

i. A new timeslice is exported and all its properties are nullified

ii. The usage attribute is set to WITHHELD

e. The feature is changed from non-operational to operational:

i. A new timeslice is exported with its properties set

ii. The usage attribute is set to OPERATIONAL

f. The feature is changed from non-operational to operational but its detailed definition is not
supported by the requested (old) NM B2B version:

i. A new timeslice is exported and all its properties are nullified

ii. The usage attribute is set to WITHHELD

Edition: 27.0 6 337

Document Title: NM 27.0 - NM B2B Reference Manual

Example 57. WITHHELD Airspace as PERMDELTA

<adrmsg:hasMember>
<aixm:Airspace gml:id="ID_36_1398421189613_755">
<gml:identifier codeSpace="urn:uuid:">d7064a20-6b6f-4bc6-a946-
5bb3cd887c7b</gml:identifier>
<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_36_1398421189613_756">
<gml:validTime>
<gml:TimeInstant>
<gml:timePosition>2006-06-08T00:00:00</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>PERMDELTA</aixm:interpretation>
<aixm:type xsi:nil="true" nilReason="withheld"> </aixm:type>
<aixm:designator xsi:nil="true" nilReason="withheld"> </aixm:designator>
<aixm:designatorICAO xsi:nil="true" nilReason="withheld">
</aixm:designatorICAO>
<aixm:geometryComponent xsi:nil="true" nilReason="withheld">
</aixm:geometryComponent>
<aixm:extension>
<adrext:AirspaceExtension gml:id="ID_36_1398421189613_762">
<adrext:usage>WITHHELD</adrext:usage>
</adrext:AirspaceExtension>
</aixm:extension>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</adrmsg:hasMember>

Edition: 27.0 6 338

Document Title: NM 27.0 - NM B2B Reference Manual

Example 58. WITHHELD FlightRestriction as PERMDELTA

<adrmsg:hasMember>
<aixm:FlightRestriction gml:id="ID_14_1398421187379_2">
<gml:identifier codeSpace="urn:uuid:">cca9c008-a718-4d5d-9339-
1bf013fbc94a</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_14_1398421187379_3">
<gml:validTime>
<gml:TimeInstant>
<gml:timePosition>2014-04-03T00:00:00</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>PERMDELTA</aixm:interpretation>
<aixm:instruction xsi:nil="true" nilReason="withheld"> </aixm:instruction>
<aixm:extension>
<adrext:FlightRestrictionExtension gml:id="ID_14_1398421187379_125">
<adrext:usage>WITHHELD</adrext:usage>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

Edition: 27.0 6 339

Document Title: NM 27.0 - NM B2B Reference Manual

Example 59. WITHHELD Airspace as BASELINE

<adrmsg:hasMember>
<aixm:Airspace gml:id="ID_36_1398421189613_755">
<gml:identifier codeSpace="urn:uuid:">d7064a20-6b6f-4bc6-a946-
5bb3cd887c7b</gml:identifier>
<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_36_1398421189613_756">
<gml:validTime>
<gml:TimePeriod gml:id="ID_36_1398421189613_757">
<gml:beginPosition>2006-06-08T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_36_1398421189613_758">
<gml:beginPosition>2006-06-08T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:extension>
<adrext:AirspaceExtension gml:id="ID_36_1398421189613_762">
<adrext:usage>WITHHELD</adrext:usage>
</adrext:AirspaceExtension>
</aixm:extension>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</adrmsg:hasMember>

Edition: 27.0 6 340

Document Title: NM 27.0 - NM B2B Reference Manual

Example 60. WITHHELD FlightRestriction as BASELINE

<adrmsg:hasMember>
<aixm:FlightRestriction gml:id="ID_14_1398421187379_2">
<gml:identifier codeSpace="urn:uuid:">cca9c008-a718-4d5d-9339-
1bf013fbc94a</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_14_1398421187379_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_14_1398421187379_4">
<gml:beginPosition>2014-04-03T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_14_1398421187379_5">
<gml:beginPosition>2014-04-03T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:extension>
<adrext:FlightRestrictionExtension gml:id="ID_14_1398421187379_125">
<adrext:usage>WITHHELD</adrext:usage>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

Edition: 27.0 6 341

Document Title: NM 27.0 - NM B2B Reference Manual

Example 61. OPERATIONAL Airspace as BASELINE

Edition: 27.0 6 342

Document Title: NM 27.0 - NM B2B Reference Manual

<adrmsg:hasMember>
<aixm:Airspace gml:id="ID_36_1398421189613_755">
<gml:identifier codeSpace="urn:uuid:">d7064a20-6b6f-4bc6-a946-
5bb3cd887c7b</gml:identifier>
<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_36_1398421189613_756">
<gml:validTime>
<gml:TimePeriod gml:id="ID_36_1398421189613_757">
<gml:beginPosition>2006-06-08T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_36_1398421189613_758">
<gml:beginPosition>2006-06-08T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:type>TMA</aixm:type>
<aixm:designator>LEBBTMA</aixm:designator>
<aixm:designatorICAO>YES</aixm:designatorICAO>
<aixm:geometryComponent>
<aixm:AirspaceGeometryComponent gml:id="ID_36_1398421189613_759">
<aixm:operation>BASE</aixm:operation>
<aixm:theAirspaceVolume>
<aixm:AirspaceVolume gml:id="ID_36_1398421189613_760">
<aixm:contributorAirspace>
<aixm:AirspaceVolumeDependency gml:id="ID_36_1398421189613_761">
<aixm:dependency>FULL_GEOMETRY</aixm:dependency>
<aixm:theAirspace xlink:href="urn:uuid:8627b55f-5f3e-4490-
9a87-1a03aa409f0c"/>
</aixm:AirspaceVolumeDependency>
</aixm:contributorAirspace>
</aixm:AirspaceVolume>
</aixm:theAirspaceVolume>
</aixm:AirspaceGeometryComponent>
</aixm:geometryComponent>
<aixm:extension>
<adrext:AirspaceExtension gml:id="ID_36_1398421189613_762">
<adrext:usage>OPERATIONAL</adrext:usage>
</adrext:AirspaceExtension>
</aixm:extension>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</adrmsg:hasMember>

Edition: 27.0 6 343

Document Title: NM 27.0 - NM B2B Reference Manual

Example 62. OPERATIONAL FlightRestriction BASELINE

<adrmsg:hasMember>
<aixm:FlightRestriction gml:id="ID_14_1398421187379_2">
<gml:identifier codeSpace="urn:uuid:">cca9c008-a718-4d5d-9339-
1bf013fbc94a</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_14_1398421187379_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_14_1398421187379_4">
<gml:beginPosition>2014-04-03T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_14_1398421187379_5">
<gml:beginPosition>2014-04-03T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>DS5525G</aixm:designator>
<aixm:type>MANDATORY</aixm:type>
<aixm:instruction>
DEP EKCH:THE USE OF SIDS IS MANDATORY EXCEPT FOR DEST.
WITHIN THE COPENHAGENGROUP,MALMO GROUP
INFO:
MANDATES THE ONLY POSSIBILITIES FOR JET AC,BEING
BETUD,KEMAX,LANGO,MIKSI,NEXEN,ODN,SIMEG AND VEDAR SIDS
OUTSIDE THE ACTIVATION OF THE RSA MULTEX/EKD352/53
</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_14_1398421187379_6">
...
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
<aixm:FlightRestrictionRoute gml:id="ID_14_1398421187379_23">
...
</aixm:FlightRestrictionRoute>
</aixm:regulatedRoute>
<aixm:regulatedRoute>
<aixm:FlightRestrictionRoute gml:id="ID_14_1398421187379_23">
...
</aixm:FlightRestrictionRoute>
</aixm:regulatedRoute>
<aixm:extension>
<adrext:FlightRestrictionExtension gml:id="ID_14_1398421187379_125">
<adrext:processingIndicator>TFR</adrext:processingIndicator>

Edition: 27.0 6 344

Document Title: NM 27.0 - NM B2B Reference Manual

<adrext:enabled>NO</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

17.2. PREOPS Testing

Last updated: 27.0 - Edition 1

17.2.1. NAT Tracks

1. The NAT Tracks are loaded and available on the PREOPS platform except during the 5 days
before AIRAC switches.

17.2.2. AIRSPACE_DATA P/S Messages

1. Unfortunately, due to the nature of the PREOPS setup, the AIRSPACE_DATA Messages are not
available on the PREOPS platform.

17.2.3. AUP/UUP Testing

17.2.3.1. Introduction

1. Manage AUP/UUP Release is and remains accessible via (CIAM) CHMI only and is limited to the
CADF user. It is defined as:

a. Promotion to RELEASED

b. Demotion from RELEASED

c. Set next UUP WEF

2. Each AMC is responsible of its area of concern. The CACD system will check if the AMC id
matches the AMC id associated with the RSA data present in the CACD database.

3. In order to test the UUP management, the associated AUPs must be in status RELEASED. To
arrive to this status, all the AUPs of all the AMCs must have been promoted to status READY
before the CADF can promote all AUPs to status RELEASED.

4. The AUP/UUPs data are validated against the CACD data that are kept up to date by LUs.

5. The test setup described below takes these requirements into account and tries to replace the
human activities by scripts.

17.2.3.2. PREOPS Platform Setup

1. The PREOPS platform is automated so as to provide the capability to test all AUP/UUP services

Edition: 27.0 6 345

Document Title: NM 27.0 - NM B2B Reference Manual

without any manual intervention.

2. The AUP/UUP are published on the PREOPS platform except the 5 days before AIRAC switches.

3. Everyday (except the 5 days before AIRAC switches), a script makes the AUPs releasable (by
complementing the AUPs already submitted with NIL- AUP), releases the AUPs, sets up UUP
times and releases UUPs. Here are the actions the script automatically performs:

a. At 22:00 UTC D-1 each day:

i. It deletes all remaining unpublished UUP valid for the current day

ii. It deletes all AUPs that are in status DRAFT or INTENT for next day

iii. It generates NIL-AUP for all AMCs that do not have AUP in status READY for next day

iv. It releases the AUPs for next day

v. It sets the first UUP time

b. UUP times are predefined at 10:00,12:00,14:00,16:00. At each UUP time on D-day:

i. It deletes all UUPs valid for current day in status DRAFT or INTENT

ii. It releases the UUP if any exists

iii. It sets next UUP time if applicable

17.3. AirspaceAvailability Port Type

17.3.1. Overview

1. The AirspaceAvailability port type services for both querying and modifying the airspace
availability. These services are of two kinds:

a. Management and sharing of AUP

b. Access to EAUP

2. It exposes the following services:

a. P/S EAUP

b. S-R/R AUPChainRetrievalRequest/Reply

c. S-R/R AUPRetrievalRequest/Reply

d. S-R/R AUPCreationRequest/Reply

e. S-R/R AUPUpdateRequest/Reply

f. S-R/R AUPValidationRequest/Reply

g. S-R/R AUPDeletionRequest/Reply

h. S-R/R AUPRSAAllocationExpansionRequest/Reply

i. S-R/R AUPServiceConfigurationRequest/Reply

j. S-R/R EAUPChainRetrievalRequest/Reply

k. S-R/R EAUPCDRRequest/Reply

Edition: 27.0 6 346

Document Title: NM 27.0 - NM B2B Reference Manual

l. S-R/R EAUPCDRCompareRequest/Reply

m. S-R/R EAUPRSARequest/Reply

n. S-R/R EAUPRSACompareRequest/Reply

o. S-R/R AUPGetManageableRoutesForAMCRequest/Reply

p. S-R/R AUPGetManageableRouteSegmentsForAMCAndRouteRequest/Reply

q. S-R/R DraftEAUPsRetrievalRequest/Reply

r. S-R/R DraftEAUPRSARequest/Reply

s. S-R/R DraftEAUPCDRRequest/Reply

t. S-R/R ASMScenarioListRequest/Reply

u. S-R/R ASMScenarioActivationListRequest/Reply

v. S-R/R ASMScenarioActivationCreationRequest/Reply

w. S-R/R ASMScenarioActivationUpdateRequest/Reply

x. S-R/R ASMScenarioActivationDeletionRequest/Reply

y. S-R/R RADRestrictionActivationListRequest/Reply (new 27.0)

z. S-R/R RADRestrictionActivationsUpdateRequest/Reply (new 27.0)

aa. S-R/R EAUPRADRestrictionActivationRequest/Reply (new 27.0)

ab. S-R/R EAUPRADRestrictionActivationCompareRequest/Reply (new 27.0)

ac. S-R/R DraftEAUPRADRestrictionActivationRequest/Reply (new 27.0)

17.3.2. Concepts

17.3.2.1. AUP Management

1. The management and sharing of AUP cannot be understood outside of the existing operational
ASM process, nor the CIAM.

2. "Airspace Use Plan", contains the decision of an AMC on the temporary allocation of the airspace
within its jurisdiction for a specific time period.

3. The convention for operational users is to make a naming distinction between the first AUP of a
chain or baseline AUP commonly referred as the "AUP" and the subsequent AUPs in a chain
referred as the UUPs (Updated AUPs).

4. Due to the equivalence of data structures, in this document, the term AUP refers to both, unless
otherwise stated.

5. The concept of "AUP chain" is defined as the sequence of AUPs for a given day and AMC. It is
made of:

a. The AUP baseline of the day

b. The ordered list of its subsequent versions (often called UUPs, but these are also AUPs)

The following rules apply:

Edition: 27.0 6 347

Document Title: NM 27.0 - NM B2B Reference Manual

c. Any AUP with a validity period comprised in the time span [6:00 day D, 6:00 day D+1 (the
next day)] is a member of the AUP-Chain of day D

d. The validity period of the Baseline AUP is always: from 6:00 day D till 6:00 D+1

6. An AUP has a state at any point in time: DRAFT, READY or RELEASED:

a. An AUP can be created/updated via NM B2B in state DRAFT or READY

b. Releasing an AUP is only permitted to the CADF

The following rule applies:

c. AUPs become immutable (cannot be updated anymore) once in RELEASED state

7. Important remark: when using the B2B AirspaceAvailabilityService Port Type, you must not
simultaneously create AUPs in CIAM. In CIAM the AUP can have a pre-draft state, i.e. INTENT.
When an AUP is created in CIAM in state INTENT, the operation retrieveAUPChain will fail.

8. The retrieval (unique) key of an AUP chain (AUPChain type) is the (day, AMC id) pair.

9. AUPSummary contains its unique identification, its validity period, its state and its last update
timestamp, among others.

10. By definition, a "post-ops AUP chain" is an AUP chain of which the 06:00 AM end is in the past.

11. In this document, the phrase "CDR update" is synonym to the phrase "CDR opening/closure".

12. A NIL AUP is a Baseline AUP that does not contain CDR updates, nor RSA allocations and is
explicitly flagged as such (AUPSummary.nilAUP set to true).

13. Airspace data:

a. The AUPs and EAUPs published by and retrieved from NM are encoded using the AIXM
exchange model.

b. The convention used for Feature identification and referencing within the
AirspaceAvailability service differs from the one used for the AirspaceStructure service in
the following:

i. it makes use of a SNAPSHOT timeslice for features identification;

ii. it uses the gml:id attribute for feature referencing.

c. The actual CDR opening/closures and RSA activations are expressed as a TEMPDELTA
timeslice.

d. Even if the Airspace data used by the client to prepare the AUP has a "local" origin, the final
AUP sent to the NM must use the UUIDs published by NM otherwise the AUP will be rejected;
therefore local and NM data must be correlated by the client.

e. The UUIDs sent to NM must belong to the corresponding AIRAC data published by NM.

14. Cross-AIRAC AUP:

a. An AUP validity period (from D 06:00 to D+1 06:00) may cross AIRAC boundaries

b. When provided to NM a CDR update or RSA allocation crossing the AIRAC switch (i.e.
midnight of the last day of the running AIRAC), must be split in two:

i. A CDR update/RSA allocation ending at midnight

Edition: 27.0 6 348

Document Title: NM 27.0 - NM B2B Reference Manual

ii. and a CDR update/RSA allocation beginning at midnight

The "pre-midnight" part must comply with the running AIRAC data definition; the "post-
midnight" part must comply with the next AIRAC data definition

15. AUP Availability Period:

a. All of the AUP requests (including the AUPChainRetrieval) must be performed within the
AUP Availability Period. The AUP Availability Period is defined as the ongoing AIRAC, plus,
once day 23 of the on-going AIRAC has been reached, and not before, the next AIRAC.

16. Typical sequence of events:

a. The AUP is prepared in advance by the client (AMC) with his own application

b. Once the time to coordinate comes, the AUP must have been created -in NM- in DRAFT status

c. The AUP can be updated while in DRAFT status

d. As long as a non-Baseline AUP (i.e. a UUP) is not in status RELEASED, the AUPSummary will
contain the flag isP3. That flag is a derived (calculated) flag that indicates whether the
update is a "Procedure 3" update. More information can be found in the ATFCM Operations
Manual

e. Once the AUP is considered ready for publication the AMC updates it to READY

i. If the AUP is a Baseline AUP: once the AUP is in READY, the AUP can be updated (in
READY or even back to DRAFT) before a cut-off time (cut-off time COT2)

ii. If the AUP is not a Baseline AUP (i.e. UUP): the AUP cannot be updated once in READY

f. Once all AUPs are in READY status, which is enforced by the CADF (cut-off time COT1), CADF
takes the responsibility for the AUP from then onwards. In coordination with the clients,
CADF modifies AUPs that still require manual intervention and finally publishes all AUPs.
Upon publication, the AUP status is changed to RELEASED.

g. Once RELEASED, the AUPs become immutable and the EAUP is published

17. The operational meaning of the AUP status must be respected.

18. The following diagram depicts the possible state transitions.

Edition: 27.0 6 349

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 16. AUP Status Transitions

19. Attention: A NIL AUP MUST be created directly in status READY. This is a legacy constraint.

20. Status transitions have operational cut-off times agreed in advance between the AMC and the
CADF in conformance with the operational procedures.

21. Creation of an AUP in DRAFT or READY by an AMC is only possible before a cut-off time (COT1),
after the cut-off time no creation/modification of AUP is allowed and it is up to the CADF to
create at the NM the AUP in coordination with the AMC.

22. Update of an AUP is also only possible before a cut-off time, but different cut-off times apply
depending on the transition and the AUP:

a. If the status transition is from DRAFT to DRAFT, COT1 applies. (same for Deletion when the
AUP to be deleted is DRAFT)

b. If the status transition is from DRAFT to READY, it must be done before COT1 too

c. If the status transition is from READY to READY or READY to DRAFT (same for Deletion when
the AUP we want to delete is in READY):

i. For Baseline AUP, the cut-off time (COT2) is not just operational but technical too; it is
configured in the NM system in accordance to the latest operational procedures
(therefore to be communicated by the CADF to the AMC). The NM system prevents any
update after such a cut-off time. In case modifications are required after such a cut-off
time the AMC coordinates with the CADF, which updates at the NM premises.

Edition: 27.0 6 350

Document Title: NM 27.0 - NM B2B Reference Manual

ii. For non-baseline AUP: not applicable, see below

d. For non-baseline AUP (i.e. UUP), once an AUP is READY, it cannot be modified by the AMC.
Therefore it is most convenient for the AMC to work with the DRAFT and only update to
READY when sure that the content is finalised (which is the meaning of READY).

23. Note that as of today COT1 > COT2, which means that there is a period between COT1 and COT2
in which a Baseline AUP can be updated from DRAFT to READY, but if the AUP is already READY
it cannot be modified.

24. Remark: No specific values for COT1 and COT2 are given as they are expected to change with
the introduction of the rolling UUP process.

17.3.2.2. EAUP

1. An EAUP is made of the simplified concatenated merged CDR updates, RSA allocations and RAD
restriction activations of all released AUPs for all AMCs.

2. In a nutshell:

a. The "EAUP chain" is defined as the sequence of EAUPs for a given day. It is made of:

i. The EAUP baseline of the day

ii. The ordered list of its subsequent versions (often called EUUPs, but these are also EAUPs)

b. All EAUPs of an EAUP chain are released EAUPs

c. EAUPs are immutable, i.e. they do not change after release

d. The retrieval (unique) key of an EAUP chain (EAUPChain type) is its day

e. EAUPChain is made of its date and a list of EAUP summaries (EAUPSummary type)

f. EAUPSummary contains its unique identification, its release timestamp and its validity
period

g. The service allows for querying the contents of an EAUP (CDR openings and closures, and
RSA allocations)

3. The replies in the EAUP related services are self-contained, i.e. all the Features are defined in
the resulting ADRMessageType.

17.3.2.3. Draft EAUP

1. A draft EAUP of a particular day is the consolidation of CDR updates and RSA allocations of the
non-published AUPs for that particular day.

2. In a nutshell:

a. Contrary to the EAUP, there is no chain for the draft EAUP. There is at most one draft EAUP
for a particular day.

b. Draft EAUPs are volatile. They are the result of concatenating unpublished AUPs. Every hour
there is a check to see whether there are updated AUPs and the corresponding draft EAUPs
are recalculated.

Edition: 27.0 6 351

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.2.4. ASM Scenario Activation

1. An AMC can activate ASM scenarios that refer to airspaces for which the AMC is responsible.

2. Given the AMC identifier, the ASMScenarioListRequest/Reply returns the ASM scenarios that
can be activated by that AMC.

3. The ASM scenarios are exported as ASMScenario Feature (ADR-E) by the Airspace Structure port
type.

4. The services that manage the life cycle of an ASM scenario activation are:

a. ASMScenarioActivationCreationRequest/Reply

b. ASMScenarioActivationUpdateRequest/Reply

c. ASMScenarioActivationDeletionRequest/Reply

5. The ASMScenarioActivationListRequest/Reply returns the list of ASM scenario activations linked

to a given AUP/UUP.

6. The AUPUpdateRequest/Reply shall not declare the RSA allocations that are defined in the linked
ASM scenario activations.

7. The AUPRetrievalRequest/Reply returns an AUP which also includes in the manual entries the
RSA allocations from the linked ASM scenario activations. The RSA allocations that originate
from a ASM scenario activations, have a fuaAsmScenario relationship that reveals the unique
identifiers of the ASM scenario and the ASM scenario activation.

the fuaAsmScenario relationship is also exported for the RSA allocations that are
NOTE
part of some MONITORED ASM scenario

17.3.2.5. ADR Messages

Last updated: 27.0 - Edition 3

1. The ADRMessage encapsulates the data exchanged in AIXM/ADR-E.

2. This section documents the ADRMessage payloads and their usage.

17.3.2.5.1. AUP CDRs Message

Last updated: 27.0 - Edition 3

1. An AUP CDRs Message is implemented as an ADRMessage with the following contents:

a. 0..n RouteSegment Feature with:

i. 0..n TEMPDELTA time slices

Edition: 27.0 6 352

Document Title: NM 27.0 - NM B2B Reference Manual

In the current version, when n closures periods are defined for

the same route segment, NM B2B exports n route segment
features with 1 time slice. This policy is wrong. NM B2B should
rather export one route segment feature with n time slices.
IMPORTANT
NM B2B supports both kinds of input: n route segment features
with 1 time slice or, one route segment feature with n time slices.

NM B2B recommends to send multiple closures of the same route

segment as one route segment feature with n time slices.

2. The AUP CDRs Message is used by:

◦ AUPComputedEntries.implicitCDRs

◦ AUPComputedEntries.mergedCDRs

◦ AUPManualEntries.cdrs

◦ AUPRSAAllocationExpansionReplyData.implicitCDRs

◦ AUPGetManageableRouteSegmentsForAMCAndRouteReplyData.manageableRouteSegments

3. The following type rules specify, per participating type, the attributes processed by the NM B2B:

a. RouteSegmentTimeSlice type rules

i. validTime

Mandatory - the route segment closure period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. featureLifetime

Optional - ignored by the NM B2B processing - shall be ignored by the client application
processing

iv. availability

Mandatory - the route segment availability

b. AirspaceLayer type rules

i. upperLimit

Mandatory.

ii. upperLimitReference

Mandatory.

iii. lowerLimit

Edition: 27.0 6 353

Document Title: NM 27.0 - NM B2B Reference Manual

Mandatory.

iv. lowerLimitReference

Mandatory.

v. amcUpperLimit (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vi. amcUpperLimitReference (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vii. amcLowerLimit (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

viii. amcLowerLimitReference (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

c. RouteAvailability type rules

i. status

Mandatory - always CLSD - closure of a CDR_1.

ii. levels

Mandatory - the airspace layer for which the CDR closure is defined.

iii. hostAirspace (ADR-E)

Optional - the airspace(s) where the route segment is located when available.

Edition: 27.0 6 354

Document Title: NM 27.0 - NM B2B Reference Manual

Example 63. AUP CDRs message

The below payload expresses that route segment with uuid 0be373d3-4c01-474a-afc9-
1fa68a75890d is closed between 2023-02-17T09:45:00 and 2023-02-17T12:15:00 from FL225 to
FL275.

<!-- The closed route segment -->

<aixmmsg:hasMember>
<aixm:RouteSegment gml:id="ID_991_1348067155492_1">
<gml:identifier codeSpace="urn:uuid:">0be373d3-4c01-474a-afc9-
1fa68a75890d</gml:identifier>
<aixm:timeSlice>
<aixm:RouteSegmentTimeSlice gml:id="ID_991_1348067155492_101">
<gml:validTime>
<gml:TimePeriod gml:id="ID_991_1348067155492_102">
<gml:beginPosition>2023-02-17T09:45:00</gml:beginPosition>
<gml:endPosition>2023-02-17T12:15:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_4_1674821432169_29">
<gml:beginPosition>2023-02-17T09:45:00</gml:beginPosition>
<gml:endPosition>2023-02-17T12:15:00</gml:endPosition>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:availability>
<aixm:RouteAvailability gml:id="ID_991_1348067155492_103">
<aixm:status>CLSD</aixm:status>
<aixm:levels>
<aixm:AirspaceLayer gml:id="ID_991_1348067155492_104">
<aixm:upperLimit>225</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit>275</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
</aixm:AirspaceLayer>
</aixm:levels>
</aixm:RouteAvailability>
</aixm:availability>
</aixm:RouteSegmentTimeSlice>
</aixm:timeSlice>
</aixm:RouteSegment>
</aixmmsg:hasMember>

17.3.2.5.2. AUP RAD Restriction Activations Message

Last updated: 27.0 - Edition 3

Edition: 27.0 6 355

Document Title: NM 27.0 - NM B2B Reference Manual

1. An AUP RAD Restriction Activations Message is implemented as an ADRMessage with the following
contents:

a. 0..n FlightRestriction Feature with 1..n TEMPDELTA time slices

2. The AUP RAD Restriction Activations Message is used by:

◦ AUPManualEntries.radRestrictionActivations

3. The following type rules specify, per participating type, the attributes processed by the NM B2B:

a. FlightRestrictionTimeSlice type rules

i. validTime

Mandatory - the restriction activation period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. featureLifetime

Optional - ignored by the NM B2B processing - shall be ignored by the client application
processing

iv. activation (ADR-E)

Mandatory.

b. FlightRestrictionActivation (ADR-E) type rules

i. isP3

Optional.

ii. remark

Optional.

iii. requestor

Optional. Provided when the restriction can be activated by an FMP.

Edition: 27.0 6 356

Document Title: NM 27.0 - NM B2B Reference Manual

Example 64. AUP RAD Restriction Activations Message

The below example represents the activation of the restriction with uuid 3b4413d8-0934-4d1c-
a497-253a1915ce3c between 2022-12-17T11:00:00 and 2022-12-17T12:00:00.

<!-- The restriction activation -->

<aixmmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="..aixm" gml:id="ID279_8">
<gml:identifier codeSpace="urn:uuid:">3b4413d8-0934-4d1c-a497-
253a1915ce3c</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID279_9">
<gml:validTime>
<gml:TimePeriod gml:id="ID279_10">
<gml:beginPosition>2022-12-17T11:00:00</gml:beginPosition>
<gml:endPosition>2022-12-17T12:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:extension>
<adrext:FlightRestrictionExtension xmlns:adrext="..adrext"
gml:id="ID279_12">
<adrext:activation>
<!-- no extra attributes, there are no flight levels -->
<adrext:FlightRestrictionActivation gml:id="ID279_13"/>
</adrext:activation>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</aixmmsg:hasMember>

17.3.2.5.3. AUP RSA Allocations Message

Last updated: 27.0 - Edition 3

1. An AUP RSA Allocations Message is implemented as an ADRMessage with the following contents:

a. 0..n Airspace Feature with:

i. 1..n TEMPDELTA time slices

Edition: 27.0 6 357

Document Title: NM 27.0 - NM B2B Reference Manual

In the current version, when n allocation periods are defined for

the same airspace, NM B2B exports n airspace features with 1
time slice. This policy is wrong. NM B2B should rather export one
airspace feature with n time slices.
IMPORTANT
NM B2B supports both kinds of input: n airspace features with 1
time slice or, one airspace feature with n time slices.

NM B2B recommends to send multiple allocation of the same

airspace as one airspace feature with n time slices.

2. The AUP RSA Allocations Message is used by:

◦ AUPRSAAllocationExpansionRequest.rsaAllocations

◦ ASMScenarioActivation.rsas

◦ AUPComputedEntries.implicitRSAs

◦ AUPManualEntries.rsas

3. The following type rules specify, per participating type, the attributes processed by the NM B2B:

a. AirspaceTimeSlice type rules

i. validTime

Mandatory - the RSA allocation period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. featureLifetime

Mandatory.

iv. activation

Mandatory

b. AirspaceActivation type rules

i. status

Mandatory.

ii. levels

Mandatory.

iii. isAMC (ADR-E)

Mandatory.

Edition: 27.0 6 358

Document Title: NM 27.0 - NM B2B Reference Manual

iv. isNotamExtension (ADR-E)

Mandatory.

v. remark (ADR-E)

Mandatory.

vi. scenarioState (ADR-E)

Mandatory.

vii. fuaAsmScenario (ADR-E)

Optional - returned when the RSA allocation results from an ASM scenario activation

c. AirspaceLayer type rules

i. upperLimit

Mandatory.

ii. upperLimitReference

Mandatory.

iii. lowerLimit

Mandatory.

iv. lowerLimitReference

Mandatory.

v. amcUpperLimit (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vi. amcUpperLimitReference (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vii. amcLowerLimit (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

viii. amcLowerLimitReference (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

Edition: 27.0 6 359

Document Title: NM 27.0 - NM B2B Reference Manual

d. FUAAsmScenarioActivation (ADR-E) type rules

i. scenarioActivationUuid

Mandatory.

ii. state

Mandatory - MANAGED.

iii. fuaAsmScenario

Mandatory.

Edition: 27.0 6 360

Document Title: NM 27.0 - NM B2B Reference Manual

Example 65. AUP RSA Allocations Message (not triggered by an ASM scenario activation)

The below example represents the allocation of the RSA with uuid 3b4413d8-0934-4d1c-a117-
253a1915ce3c between 2022-10-15T15:00 and 2022-10-18T21:00 from FL035 to FL095.

This RSA allocation does not result from an ASM scenario activation.

<adrmsg:hasMember>
<aixm:Airspace>
<gml:identifier codeSpace="urn:uuid:">ba3d93b6-38f8-4e14-8871-
d9feb5425b98</gml:identifier>
<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_5_1674821432170_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_5_1674821432170_4">
<gml:beginPosition>2023-01-28T06:00:00</gml:beginPosition>
<gml:endPosition>2023-01-29T06:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_5_1674821432170_5">
<gml:beginPosition>2023-01-28T06:00:00</gml:beginPosition>
<gml:endPosition>2023-01-29T06:00:00</gml:endPosition>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:activation>
<aixm:AirspaceActivation gml:id="ID_5_1674821432170_6">
<aixm:status>ACTIVE</aixm:status>
<aixm:levels>
<aixm:AirspaceLayer gml:id="ID_5_1674821432170_7">
<aixm:upperLimit uom="FL">180</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FT">GND</aixm:lowerLimit>
<aixm:lowerLimitReference>MSL</aixm:lowerLimitReference>
<aixm:extension>
<adrext:AirspaceLayerExtension

xmlns:adrext="http://www.aixm.aero/schema/5.1.1/extensions/EUR/ADR"
gml:id="ID_5_1674821432170_8"/>
</aixm:extension>
</aixm:AirspaceLayer>
</aixm:levels>
<aixm:extension>
<adrext:AirspaceActivationExtension

xmlns:adrext="http://www.aixm.aero/schema/5.1.1/extensions/EUR/ADR"
gml:id="ID_5_1674821432170_9">
<adrext:isAMC>YES</adrext:isAMC>

Edition: 27.0 6 361

Document Title: NM 27.0 - NM B2B Reference Manual

<adrext:isNotamExtension>NO</adrext:isNotamExtension>
<adrext:remark> </adrext:remark>
<adrext:scenarioState>NONE</adrext:scenarioState>
</adrext:AirspaceActivationExtension>
</aixm:extension>
</aixm:AirspaceActivation>
</aixm:activation>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</adrmsg:hasMember>

17.3.2.5.4. EAUP CDRs Message

Last updated: 27.0 - Edition 3

1. An EAUP CDRs Message is implemented as an ADRMessage with the following contents:

a. 0..n RouteSegment Feature with:

i. 1 SNAPSHOT time slice

ii. 1..n TEMPDELTA time slices

b. 0..n Airspace Feature (representing the airspaces in which the route segments are located)
with:

i. 1 SNAPSHOT time slice

c. 0..n DesignatedPoint Feature or Navaid Feature (representing the segment start/end points)
with:

i. 1 SNAPSHOT time slice

d. 0..n Route Feature (representing the segment routes) with:

i. 1 SNAPSHOT time slice

2. The EAUP CDRs Message is used by:

◦ EAUPMessage.cdrOpeningsClosures

◦ EAUPCDRCompareReplyData.commonCDROpeningsClosures

◦ EAUPCDRCompareReplyData.cdrOpeningsClosuresIn1Only

◦ EAUPCDRCompareReplyData.cdrOpeningsClosuresIn2Only

◦ EAUPCDRReplyData.cdrOpeningsClosures

3. The following type [and interpretation] rules specify, per participating type and (when
meaningful) per interpretation, the attributes processed by the NM B2B:

a. RouteSegmentTimeSlice SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

Edition: 27.0 6 362

Document Title: NM 27.0 - NM B2B Reference Manual

ii. interpretation

Mandatory - SNAPSHOT.

iii. start
Mandatory - the route segment start point.

iv. routeFormed
Mandatory - the route reference.

v. end

Mandatory - the route segment end point.

b. RouteSegmentTimeSlice TEMPDELTA type rules

i. validTime

Mandatory - the route segment opening/closure period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. availability

Mandatory - the route segment availability

c. Airspace SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. type

Mandatory.

iv. designator

Mandatory.

v. designatorICAO

Mandatory.

d. DesignatedPoint SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

Edition: 27.0 6 363

Document Title: NM 27.0 - NM B2B Reference Manual

ii. interpretation

Mandatory - SNAPSHOT.

iii. designator

Mandatory.

iv. type

Mandatory.

e. Navaid SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. designator

Mandatory.

f. Route SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. designatorPrefix

Optional.

iv. designatorSecondLetter

Mandatory.

v. designatorNumber

Mandatory.

g. AirspaceLayer type rules

i. upperLimit

Mandatory.

Edition: 27.0 6 364

Document Title: NM 27.0 - NM B2B Reference Manual

ii. upperLimitReference

Mandatory.

iii. lowerLimit

Mandatory.

iv. lowerLimitReference

Mandatory.

v. amcUpperLimit (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vi. amcUpperLimitReference (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vii. amcLowerLimit (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

viii. amcLowerLimitReference (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

h. EnRouteSegmentPoint type rules

i. pointChoice_fixDesignatedPoint

Mandatory if the referenced point is a designated point.

ii. pointChoice_navaidSystem

Mandatory if the referenced point is a navaid system.

i. RouteAvailability type rules

i. direction

Mandatory - always BOTH.

ii. status

Mandatory.

If EAUP was created after NM 27.0 release deployment - always CLSD - closure of a CDR_1.

Edition: 27.0 6 365

Document Title: NM 27.0 - NM B2B Reference Manual

If EAUP was created before NM 27.0 release deployment:

▪ CLSD represents pre NM 27.0 CDR_1 closure

▪ OPEN represents pre NM 27.0 CDR_2 opening

iii. levels

Mandatory - the airspace layer for which the CDR opening/closure is defined.

iv. hostAirspace (ADR-E)

Optional - the airspace(s) where the route segment is located when available.

Edition: 27.0 6 366

Document Title: NM 27.0 - NM B2B Reference Manual

Example 66. EAUP CDRs Message

The example below expresses that route segment REMBA to RITAX of route M624 in airspace
EBBUFIR will be CDR_1 closed between 2023-02-17T09:45:00 and 2023-02-17T12:15:00 from FL225
to FL275.

<!-- The REMBA - RITAX route segment -->

<aixmmsg:hasMember>
<aixm:RouteSegment gml:id="ID_991_1348067155492_1">

<!-- The SNAPSHOT time slice -->

<aixm:timeSlice>
<aixm:RouteSegmentTimeSlice gml:id="ID_991_1348067155492_97">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_98">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:start>
<aixm:EnRouteSegmentPoint gml:id="ID_991_1348067155492_99">
<aixm:pointChoice_fixDesignatedPoint
xlink:href="urn:uuid:#xpointer(id('ID_991_1348067155492_4'))"/>
</aixm:EnRouteSegmentPoint>
</aixm:start>
<aixm:routeFormed
xlink:href="urn:uuid:#xpointer(id('ID_991_1348067155492_1'))"/>
<aixm:end>
<aixm:EnRouteSegmentPoint gml:id="ID_991_1348067155492_100">
<aixm:pointChoice_fixDesignatedPoint
xlink:href="urn:uuid:#xpointer(id('ID_991_1348067155492_5'))"/>
</aixm:EnRouteSegmentPoint>
</aixm:end>
</aixm:RouteSegmentTimeSlice>
</aixm:timeSlice>

<!-- One TEMPDELTA time slice -->

<aixm:timeSlice>
<aixm:RouteSegmentTimeSlice gml:id="ID_991_1348067155492_101">
<gml:validTime>
<gml:TimePeriod gml:id="ID_991_1348067155492_102">
<gml:beginPosition>2023-02-17T09:45:00</gml:beginPosition>
<gml:endPosition>2023-02-17T12:15:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:availability>
<aixm:RouteAvailability gml:id="ID_991_1348067155492_103">
<aixm:direction>BOTH</aixm:direction>

Edition: 27.0 6 367

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:status>CLSD</aixm:status>
<aixm:levels>
<aixm:AirspaceLayer gml:id="ID_991_1348067155492_104">
<aixm:upperLimit>225</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit>275</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
</aixm:AirspaceLayer>
</aixm:levels>
<aixm:extension>
<adr:RouteAvailabilityExtension gml:id="ID_991_1348067155492_105">
<adr:hostAirspace

xlink:href="urn:uuid:#xpointer(id('ID_991_1348067155492_2'))"/>
</adr:RouteAvailabilityExtension>
</aixm:extension>
</aixm:RouteAvailability>
</aixm:availability>
</aixm:RouteSegmentTimeSlice>
</aixm:timeSlice>
</aixm:RouteSegment>
</aixmmsg:hasMember>

<!-- The EBBUFIR airspace -->

<aixmmsg:hasMember>
<aixm:Airspace gml:id="ID_991_1348067155492_2">
<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_991_1348067155492_510">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_511">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:type>FIR</aixm:type>
<aixm:designator>EBBU</aixm:designator>
<aixm:designatorICAO>YES</aixm:designatorICAO>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</aixmmsg:hasMember>

<!-- The REMBA designated point -->

<aixmmsg:hasMember>
<aixm:DesignatedPoint gml:id="ID_991_1348067155492_4">
<aixm:timeSlice>
<aixm:DesignatedPointTimeSlice gml:id="ID_991_1348067155492_488">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_489">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>

Edition: 27.0 6 368

Document Title: NM 27.0 - NM B2B Reference Manual

</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>REMBA</aixm:designator>
<aixm:type>ICAO</aixm:type>
</aixm:DesignatedPointTimeSlice>
</aixm:timeSlice>
</aixm:DesignatedPoint>
</aixmmsg:hasMember>

<!-- The RITAX designated point -->

<aixmmsg:hasMember>
<aixm:DesignatedPoint gml:id="ID_991_1348067155492_5">
<aixm:timeSlice>
<aixm:DesignatedPointTimeSlice gml:id="ID_991_1348067155492_600">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_601">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>...</aixm:designator>
<aixm:type>ICAO</aixm:type>
</aixm:DesignatedPointTimeSlice>
</aixm:timeSlice>
</aixm:DesignatedPoint>
</aixmmsg:hasMember>

<!-- The M624 route -->

<aixmmsg:hasMember>
<aixm:Route gml:id="ID_991_1348067155492_1">
<aixm:timeSlice>
<aixm:RouteTimeSlice gml:id="ID_991_1348067155492_404">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_405">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designatorSecondLetter>M</aixm:designatorSecondLetter>
<aixm:designatorNumber>624</aixm:designatorNumber>
</aixm:RouteTimeSlice>
</aixm:timeSlice>
</aixm:Route>
</aixmmsg:hasMember>

17.3.2.5.5. EAUP RAD Restriction Activations Message

Last updated: 27.0 - Edition 3

Edition: 27.0 6 369

Document Title: NM 27.0 - NM B2B Reference Manual

1. An EAUP RAD Restriction Activations Message is implemented as an ADRMessage with the

following contents:

a. 0..n FlightRestriction Feature with:

i. 1 SNAPSHOT time slice

ii. 1..n TEMPDELTA time slices

b. 0..n Unit Feature (representing the flight restriction activation requestors) with:

i. 1 SNAPSHOT time slice

2. The EAUP RAD Restriction Activations Message is used by:

◦ EAUPMessage.radRestrictionActivations

◦ DraftEAUPRADRestrictionActivationReplyData.radRestrictionActivations

◦ EAUPRADRestrictionActivationCompareReplyData.commonRADRestrictionActivations

◦ EAUPRADRestrictionActivationCompareReplyData.radRestrictionActivationsIn1Only

◦ EAUPRADRestrictionActivationCompareReplyData.radRestrictionActivationsIn2Only

◦ EAUPRADRestrictionActivationReplyData.radRestrictionActivations

3. The following type [and interpretation] rules specify, per participating type and (when
meaningful) per interpretation, the attributes processed by the NM B2B:

a. FlightRestrictionTimeSlice SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. designator

Mandatory - the restriction designator.

iv. instruction

Optional.

b. FlightRestrictionTimeSlice TEMPDELTA type rules

i. validTime

Mandatory - the restriction activation period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. activation (ADR-E)

Edition: 27.0 6 370

Document Title: NM 27.0 - NM B2B Reference Manual

Mandatory.

c. FlightRestrictionActivation (ADR-E) type rules

i. remark

Optional.

ii. requestor

Optional. Provided when the restriction can be activated by an FMP.

d. UnitTimeSlice type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. designator

Mandatory - the unit designator.

Edition: 27.0 6 371

Document Title: NM 27.0 - NM B2B Reference Manual

Example 67. EAUP RAD Restriction Activations Message

The example below expresses that restriction LF50107ARA is set active between 2023-02-
17T11:00:00 and 2023-02-17T12:00:00 by FMPLFBB.

<!-- The activated restriction -->

<aixmmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="..aixm" gml:id="ID279_8">
<gml:identifier codeSpace="urn:uuid:">3b4413d8-0934-4d1c-a497-
253a1915ce3c</gml:identifier>

<!-- The SNAPSHOT time slice -->

<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID279_9">
<gml:validTime>
<gml:TimeInstant gml:id="ID_991_1348067155492_601">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>LF50107ARA</aixm:designator>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>

<!-- One TEMPDELTA time slice -->

<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID279_9">
<gml:validTime>
<gml:TimePeriod gml:id="ID279_10">
<gml:beginPosition>2023-02-17T11:00:00</gml:beginPosition>
<gml:endPosition>2023-02-17T12:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:extension>
<adrext:FlightRestrictionExtension xmlns:adrext="..adrext"
gml:id="ID279_12">
<adrext:activation>
<adrext:FlightRestrictionActivation gml:id="ID279_13"/>
</adrext:activation>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</aixmmsg:hasMember>

<!-- The requestor -->

<aixmmsg:hasMember>

Edition: 27.0 6 372

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:Unit xmlns:aixm="..aixm" gml:id="...">

<gml:identifier codeSpace="urn:uuid:">...</gml:identifier>
<aixm:timeSlice>
<aixm:UnitTimeSlice gml:id="...">
<gml:validTime>
<gml:TimeInstant gml:id="...">
<gml:timePosition>2023-02-16T15:05:55</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>FMPLFBB</aixm:designator>
</aixm:UnitTimeSlice>
</aixm:timeSlice>
</aixm:Unit>
</aixmmsg:hasMember>

17.3.2.5.6. EAUP RSA Allocations Message

Last updated: 27.0 - Edition 3

1. An EAUP RSA Allocations Message is implemented as an ADRMessage with the following contents:

a. 0..n Airspace Feature with:

i. 1 SNAPSHOT time slice

ii. 1..n TEMPDELTA time slices

b. 0..n FlightRestriction Feature (representing the FUA restrictions having a dependent

applicability on one airspace) with:

i. 1 SNAPSHOT time slice

2. The EAUP RSA Allocations Message is used by:

◦ EAUPMessage.rsaAllocations

◦ EAUPRSACompareReplyData.commonRSAAllocations

◦ EAUPRSACompareReplyData.rsaAllocationsIn1Only

◦ EAUPRSACompareReplyData.rsaAllocationsIn2Only

◦ EAUPRSAReplyData.rsaAllocations

3. The following type [and interpretation] rules specify, per participating type and (when
meaningful) per interpretation, the attributes processed by the NM B2B:

a. Airspace SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Edition: 27.0 6 373

Document Title: NM 27.0 - NM B2B Reference Manual

Mandatory - SNAPSHOT.

iii. designator
Mandatory.

iv. designatorICAO
Mandatory.

v. extension
Mandatory - AirspaceExtension (ADE-E).

b. Airspace TEMPDELTA type rules

i. validTime

Mandatory - the airspace allocation period.

ii. interpretation

Mandatory - TEMPDELTA.

iii. activation
Mandatory.

c. FlightRestriction SNAPSHOT type rules

i. validTime

Mandatory - the EAUP publication time (gml:instant).

ii. interpretation

Mandatory - SNAPSHOT.

iii. type

Mandatory.

iv. designator

Mandatory.

v. instruction

Mandatory.

d. AirspaceActivation type rules

i. status

Mandatory.

ii. levels

Mandatory.

Edition: 27.0 6 374

Document Title: NM 27.0 - NM B2B Reference Manual

iii. extension

Mandatory - AirspaceActivationExtension (ADE-E).

e. AirspaceActivationExtension (ADR-E) type rules

i. fuaRestriction

Mandatory - FUARestrictionActivation (ADR-E).

f. AirspaceExtension (ADE-E) type rules

i. level1

Mandatory.

ii. level2

Mandatory.

g. AirspaceLayer type rules

i. upperLimit

Mandatory.

ii. upperLimitReference

Mandatory.

iii. lowerLimit

Mandatory.

iv. lowerLimitReference

Mandatory.

v. amcUpperLimit (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vi. amcUpperLimitReference (ADR-E)

Optional - present only in output messages when upperLimit was input with a unit
different from FL.

vii. amcLowerLimit (ADR-E)

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

viii. amcLowerLimitReference (ADR-E)

Edition: 27.0 6 375

Document Title: NM 27.0 - NM B2B Reference Manual

Optional - present only in output messages when lowerLimit was input with a unit
different from FL.

h. FUARestrictionActivation (ADR-E) type rules

i. active

Mandatory.

ii. theFlightRestriction

Mandatory - the restrictions with dependent applicability to the airspace.

Edition: 27.0 6 376

Document Title: NM 27.0 - NM B2B Reference Manual

Example 68. EAUP RSA Allocations Message

The below payload expresses that:

• airspace ECNPZ1 is set ACTIVE between 2022-10-12T12:30:00 and 2022-10-13T06:00:00 from

FL315 to FL660

• restriction ECNPZ1R is activated during the same period

<!-- The activated airspace -->

<aixmmsg:hasMember>
<aixm:Airspace xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_101366_1665579017851_1">

<!-- The SNAPSHOT time slice -->

<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_101366_1665579017851_2049">
<gml:validTime>
<gml:TimeInstant gml:id="ID_101366_1665579017851_2050">
<gml:timePosition>2022-10-12T12:34:01</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>ECNPZ1</aixm:designator>
<aixm:designatorICAO>YES</aixm:designatorICAO>
<aixm:extension>
<adrext:AirspaceExtension
xmlns:adrext="http://www.aixm.aero/schema/5.1.1/extensions/EUR/ADR"
gml:id="ID_101366_1665579017851_2051">
<adrext:level1>YES</adrext:level1>
<adrext:level2>NO</adrext:level2>
</adrext:AirspaceExtension>
</aixm:extension>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>

<!-- The TEMPDELTA time slice -->

<aixm:timeSlice>
<aixm:AirspaceTimeSlice gml:id="ID_101366_1665579017851_2043">
<gml:validTime>
<gml:TimePeriod gml:id="ID_101366_1665579017851_2044">
<gml:beginPosition>2022-10-12T12:30:00</gml:beginPosition>
<gml:endPosition>2022-10-13T06:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:activation>
<aixm:AirspaceActivation gml:id="ID_101366_1665579017851_2045">
<aixm:status>ACTIVE</aixm:status>
<aixm:levels>

Edition: 27.0 6 377

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:AirspaceLayer gml:id="ID_101366_1665579017851_2046">
<aixm:upperLimit uom="FL">660</aixm:upperLimit>
<aixm:upperLimitReference>STD</aixm:upperLimitReference>
<aixm:lowerLimit uom="FL">315</aixm:lowerLimit>
<aixm:lowerLimitReference>STD</aixm:lowerLimitReference>
</aixm:AirspaceLayer>
</aixm:levels>
<aixm:extension>
<adrext:AirspaceActivationExtension

xmlns:adrext="http://www.aixm.aero/schema/5.1.1/extensions/EUR/ADR"
gml:id="ID_101366_1665579017851_2047">
<adrext:fuaRestriction>
<adrext:FUARestrictionActivation
gml:id="ID_101366_1665579017851_2048">
<adrext:active>YES</adrext:active>
<adrext:theFlightRestriction
xmlns:xlink="http://www.w3.org/1999/xlink"

xlink:href="urn:uuid:#xpointer(id('ID_101366_1665579017851_2'))"/>
</adrext:FUARestrictionActivation>
</adrext:fuaRestriction>
</adrext:AirspaceActivationExtension>
</aixm:extension>
</aixm:AirspaceActivation>
</aixm:activation>
</aixm:AirspaceTimeSlice>
</aixm:timeSlice>
</aixm:Airspace>
</aixmmsg:hasMember>

<!-- The restriction with dependent applicability -->

<aixmmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_101366_1665579017851_2">
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_101366_1665579017851_14318">
<gml:validTime>
<gml:TimeInstant gml:id="ID_101366_1665579017851_14319">
<gml:timePosition>2022-10-12T12:34:01</gml:timePosition>
</gml:TimeInstant>
</gml:validTime>
<aixm:interpretation>SNAPSHOT</aixm:interpretation>
<aixm:designator>ECNPZ1R</aixm:designator>
<aixm:instruction>RAD ANNEX 2C ECNPZ1 VARIK$ NOT AVAILABLE FOR
TRAFFIC</aixm:instruction>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</aixmmsg:hasMember>

Edition: 27.0 6 378

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.2.5.7. RAD Restriction Activations Update

Last updated: 27.0 - Edition 4

1. A RAD Restriction Activations Update Message is implemented as an ADRMessage with the

following contents:

a. 0..n FlightRestriction Feature with 1..n TEMPDELTA time slices

2. The RAD Restriction Activations Update Message is used by:

◦ RADRestrictionActivationsUpdateRequest.radRestrictionActivations

3. The following type rules specify, per participating type, the attributes processed by the NM B2B:

a. FlightRestrictionTimeSlice type rules

i. validTime

Mandatory - the restriction activation period.

ii. interpretation

Mandatory - TEMPDELTA.

b. FlightRestrictionExtension (ADR-E) type rules

i. activation (ADR-E)

Mandatory.

c. FlightRestrictionActivation (ADR-E) type rules

i. remark

Optional.

ii. requestor

Optional - when the restriction is activated by an FMP, it shall contain the UUID of the
FMP. The FMP UUID can be obtained either by getting the corresponding Unit feature,
see AirspaceStructure port type, or from the RADRestrictionActivationListReply.

Edition: 27.0 6 379

Document Title: NM 27.0 - NM B2B Reference Manual

Example 69. RAD Restriction Activations Update Message

<!-- The restriction activation -->

<aixmmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="..aixm" gml:id="ID279_8">
<gml:identifier codeSpace="urn:uuid:">3b4413d8-0934-4d1c-a497-
253a1915ce3c</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID279_9">
<gml:validTime>
<gml:TimePeriod gml:id="ID279_10">
<gml:beginPosition>2022-12-17T11:00:00</gml:beginPosition>
<gml:endPosition>2022-12-17T12:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:extension>
<adrext:FlightRestrictionExtension xmlns:adrext="..adrext"
gml:id="ID279_12">
<adrext:activation>
<!-- no extra attributes, there are no flight levels -->
<adrext:FlightRestrictionActivation gml:id="ID279_13"/>
</adrext:activation>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</aixmmsg:hasMember>

17.3.2.5.8. RAD Restriction Activation List Message

Last updated: 27.0 - Edition 4

1. A RAD Restriction Activation List Message is implemented as an ADRMessage with the following
contents:

a. 0..n FlightRestriction Feature with 1..n TEMPDELTA time slices

2. The RAD Restriction Activation List Message is used by:

◦ RADRestrictionActivationListReplyData.radRestrictionActivations

3. The following type rules specify, per participating type, the attributes processed by the NM B2B:

a. FlightRestrictionTimeSlice type rules

i. validTime

Mandatory - the restriction activation availability period.

Edition: 27.0 6 380

Document Title: NM 27.0 - NM B2B Reference Manual

ii. interpretation

Mandatory - TEMPDELTA.

iii. activation (ADR-E)

Mandatory.

b. FlightRestrictionActivation (ADR-E) type rules

i. requestor

Optional. Provided when the restriction can be activated by an FMP.

Example 70. RAD Restriction Activation List Message

<!-- The restriction available for activation -->

<aixmmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="..aixm" gml:id="ID279_8">
<gml:identifier codeSpace="urn:uuid:">3b4413d8-0934-4d1c-a497-
253a1915ce3c</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID279_9">
<gml:validTime>
<gml:TimePeriod gml:id="ID279_10">
<gml:beginPosition>2022-12-17T11:00:00</gml:beginPosition>
<gml:endPosition>2022-12-17T12:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>TEMPDELTA</aixm:interpretation>
<aixm:extension>
<adrext:FlightRestrictionExtension xmlns:adrext="..adrext"
gml:id="ID279_12">
<adrext:activation>
<adrext:FlightRestrictionActivation gml:id="ID279_13"/>
</adrext:activation>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</aixmmsg:hasMember>

17.3.3. Publish/Subscribe Topics

17.3.3.1. EAUP

Edition: 27.0 6 381

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: EAUPMessage

Ordering policy:

Messages referring to EAUP/EUUP with the same chain date shall be ordered by numerically
sorting on the field summary.eaupId.sequenceNumber.

Payload configuration: EAUPPayloadConfiguration

Subscription management (topic specific):

• S-R/R EAUPSubscriptionCreationRequest/Reply

• S-R/R EAUPSubscriptionUpdateRequest/Reply

• S-R/R EAUPSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Notification about the publication of EAUPs and EUUPs.

17.3.3.1.1. EAUPMessage (new 27.0)

<<class>>

The business P/S message for topic EAUP.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. EAUPSummary summary (Mandatory)

The summary of this EAUPMessage.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

cdrOpeningsClosures (Optional)

Documentation last updated: 27.0 - Edition 3

The CDR openings and closures for this EAUPMessage.

See EAUP CDRs Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

Edition: 27.0 6 382

Document Title: NM 27.0 - NM B2B Reference Manual

rsaAllocations (Optional)

Documentation last updated: 27.0 - Edition 3

The RSA allocations for this EAUPMessage.

See EAUP RSA Allocations Message.

d. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Optional)

Documentation last updated: 27.0 - Edition 3

The RAD restriction activations for this EAUPMessage.

See EAUP RAD Restriction Activations Message.

17.3.3.1.2. EAUPSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: EAUPSubscriptionCreationRequest

Reply: EAUPSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EAUPSubscriptionCreationReply
createEAUPSubscription(EAUPSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic EAUP.

EAUPSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 383

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic EAUP.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. EAUPPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

EAUPSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to EAUPSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPSubscriptionCreationReplyData data (Optional)

The reply payload.

17.3.3.1.3. EAUPSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 384

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EAUPSubscriptionUpdateRequest

Reply: EAUPSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EAUPSubscriptionUpdateReply updateEAUPSubscription(EAUPSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic EAUP.

EAUPSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic EAUP.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. EAUPPayloadConfiguration payloadConfiguration (Mandatory)

The message payload.

Edition: 27.0 6 385

Document Title: NM 27.0 - NM B2B Reference Manual

EAUPSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to EAUPSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPSubscriptionUpdateReplyData data (Optional)

The reply payload.

17.3.3.1.4. EAUPSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: EAUPSubscriptionRetrievalRequest

Reply: EAUPSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EAUPSubscriptionRetrievalReply
retrieveEAUPSubscription(EAUPSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic EAUP.

EAUPSubscriptionRetrievalRequest (new 27.0)

<<class>>

Edition: 27.0 6 386

Document Title: NM 27.0 - NM B2B Reference Manual

Subscription retrieval request for topic EAUP.

1. Inherits from: SubscriptionRetrievalRequest

EAUPSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to EAUPSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPSubscriptionRetrievalReplyData data (Optional)

The reply payload.

17.3.4. Requests/Replies

17.3.4.1. AUPChainRetrievalRequest/Reply

MEP: S-R/R

Request: AUPChainRetrievalRequest

Reply: AUPChainRetrievalReply

Response time: 10 / 42 / 390 (ms)

Default settings: request count quotas

SOAP operation:

AUPChainRetrievalReply retrieveAUPChain(AUPChainRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves one or more AUP chains.

17.3.4.1.1. AUPChainRetrievalRequest

Edition: 27.0 6 387

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to retrieve one or more AUP chains from its date (that is to say, from the release date of its
AUP baseline) and one or more owning AMCs.

Client applications must take into account that past AUP chains are immutable: they will not gain or
lose AUPs, and the AUPs they contain will not be modified anymore. Consequently, NM requires the
client applications to avoid retrieving the same past AUP chains repeatedly.

Regarding mutable AUP chains (today and future), NM requires client applications not to poll the
service with high frequency, certainly not more than every 5 minutes, and recommends to rather
make use of the EAUP P/S services.

1. Inherits from: Request

2. Attributes:

a. AirNavigationUnitId[] amcIds (Optional)

The ANU ids of the AMCs of which the AUP chain is requested.

Default is all.

b. DateYearMonthDay chainDate (Mandatory)

The date of the requested AUP chain

17.3.4.1.2. AUPChainRetrievalReply

<<class>>

Returned in response to AUPChainRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPChainRetrievalReplyData data (Optional)

The AUPChainRetrievalReply data

Edition: 27.0 6 388

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.2. AUPRetrievalRequest/Reply

MEP: S-R/R

Request: AUPRetrievalRequest

Reply: AUPRetrievalReply

Response time: 2600 / 5600 / 8600 (ms)

Default settings: request count quotas

SOAP operation:

AUPRetrievalReply retrieveAUP(AUPRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves one AUP.

17.3.4.2.1. AUPRetrievalRequest

<<class>>

Request to retrieve an AUP from its unique id.

Client applications must take into account that RELEASED AUPs are immutable: they will not be
modified anymore. Consequently, NM requires the client applications to avoid retrieving the same
RELEASED AUPs repeatedly.

Regarding non-RELEASED AUPs, NM requires client applications not to poll the service with high
frequency, i.e. certainly not more than every 10 minutes.

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 389

Document Title: NM 27.0 - NM B2B Reference Manual

a. AUPId aupId (Mandatory)

Unique id of the requested AUP: found in AUPSummary.aupId

b. boolean returnComputed (Optional)

Specifies if computed AUP entries are to be returned in addition to manual AUP entries,
which are always returned as part of an AUP.

False by default.

17.3.4.2.2. AUPRetrievalReply

<<class>>

Returned in response to AUPRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPRetrievalReplyData data (Optional)

The AUPRetrievalReply data

17.3.4.3. AUPCreationRequest/Reply

MEP: S-R/R

Request: AUPCreationRequest

Reply: AUPCreationReply

Response time: 14000 / 36000 / 55000 (ms)

Default settings: request count quotas

SOAP operation:

AUPCreationReply createAUP(AUPCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to /aups

Edition: 27.0 6 390

Document Title: NM 27.0 - NM B2B Reference Manual

Creates a new AUP.

17.3.4.3.1. AUPCreationRequest

<<class>>

Request to validate a new AUP and, on success, to create it.

Via NM B2B, an AUP can only be created by an AMC, and is thereby owned by the AMC: the AUP can
then be updated by a user (certificate) associated to that AMC only.

This service is constrained in terms of timing/process. See AUP Status Transitions.

1. Inherits from: Request

2. Attributes:

a. AUP aup (Mandatory)

An AUP containing manual AUP entries only, i.e. its aupComputedEntries must be null

b. boolean returnComputed (Optional)

Specifies if computed AUP entries are to be returned in addition to manual AUP entries,
which are always returned as part of an AUP.

False by default.

17.3.4.3.2. AUPCreationReply

<<class>>

Returned in response to AUPCreationRequest.

Edition: 27.0 6 391

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. AUPCreationReplyData data (Optional)

The AUPCreationReply data

17.3.4.4. AUPUpdateRequest/Reply

MEP: S-R/R

Request: AUPUpdateRequest

Reply: AUPUpdateReply

Response time: 21000 / 43000 / 63000 (ms)

Default settings: request count quotas

SOAP operation:

AUPUpdateReply updateAUP(AUPUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to /aups

Updates an existing AUP.

17.3.4.4.1. AUPUpdateRequest

Edition: 27.0 6 392

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to validate a new AUP and, on success, to update it.

Via NM B2B, an AUP can only be updated by its owning AMC.

This service is constrained in terms of timing/process. See AUP Status Transitions.

Note that if the intention of the client is simply to update the status of a previously created AUP, the
original AUP must be provided again.

AUPSummary.lastUpdate helps in the concurrency control mechanism: in order to overwrite a

previously saved AUP in DRAFT or READY state, the provided AUPSummary.lastUpdate must match the
AUPSummary.lastUpdate of the AUP version being updated. Hence, when updating an AUP, users must
pass the lastUpdate of the previous AUP version that they know.

1. Inherits from: Request

2. Attributes:

a. AUP aup (Mandatory)

The updated AUP, containing manual AUP entries only, i.e. its aupComputedEntries must be
null

b. boolean returnComputed (Optional)

Specifies if computed AUP entries are to be returned in addition to manual AUP entries,
which are always returned as part of an AUP.

False by default.

17.3.4.4.2. AUPUpdateReply

<<class>>

Edition: 27.0 6 393

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to AUPUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPUpdateReplyData data (Optional)

The AUPUpdateReply data

17.3.4.5. AUPValidationRequest/Reply

MEP: S-R/R

Request: AUPValidationRequest

Reply: AUPValidationReply

Response time: 8100 / 38000 / 43000 (ms)

Default settings: request count quotas

SOAP operation:

AUPValidationReply validateAUP(AUPValidationRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Validates an AUP.

17.3.4.5.1. AUPValidationRequest

Edition: 27.0 6 394

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to validate an AUP.

No transaction takes place: the AUP is neither created or updated. The validation service is meant
for the user to validate an AUP at any time, e.g. to work on an AUP prior to storing it within the NM
system.

1. Inherits from: Request

2. Attributes:

a. AUP aup (Mandatory)

The AUP to be validated, containing manual AUP entries only, i.e. its aupComputedEntries
must be null

17.3.4.5.2. AUPValidationReply

<<class>>

Returned in response to AUPValidationRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPValidationReplyData data (Optional)

The AUPValidationReply data

17.3.4.6. AUPDeletionRequest/Reply

Edition: 27.0 6 395

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AUPDeletionRequest

Reply: AUPDeletionReply

Response time: 170 / 640 / 1200 (ms)

Default settings: request count quotas

SOAP operation:

AUPDeletionReply deleteAUP(AUPDeletionRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to /aups

Deletes an existing AUP.

17.3.4.6.1. AUPDeletionRequest

<<class>>

Request to delete an existing AUP.

Via NM B2B, an AUP can only be deleted by the AMC is the owner of the AUP.

Edition: 27.0 6 396

Document Title: NM 27.0 - NM B2B Reference Manual

Deleting an AUP can only be done when updating is possible (See AUP Status Transitions).

1. Inherits from: Request

2. Attributes:

a. AUPId aupId (Mandatory)

Id of the AUP to be deleted

b. LastUpdate lastUpdate (Mandatory)

See AUPUpdateRequest.lastUpdate

17.3.4.6.2. AUPDeletionReply

<<class>>

Returned in response to AUPDeletionRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPDeletionReplyData data (Optional)

The AUPDeletionReply data

17.3.4.7. AUPRSAAllocationExpansionRequest/Reply

MEP: S-R/R

Request: AUPRSAAllocationExpansionRequest

Reply: AUPRSAAllocationExpansionReply

Response time: 15000 / 37000 / 39000 (ms)

Default settings: request count quotas

SOAP operation:

AUPRSAAllocationExpansionReply
expandRSAAllocations(AUPRSAAllocationExpansionRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Edition: 27.0 6 397

Document Title: NM 27.0 - NM B2B Reference Manual

Computes a list of CDR opening/closures based on:

• the provided list of RSA allocations

• the pre-defined RSA allocations as stored in NM

• the pre-defined relationships between RSA and CDRs (is-nearby, is-not-affected, etc) as
stored in NM

• a period

17.3.4.7.1. AUPRSAAllocationExpansionRequest

<<class>>

Request to obtain the following expansion.

The expansion algorithm or simply "expansion" computes a list of CDR opening/closures based on:

1. A provided list of RSA allocations, and

2. The pre-defined RSA allocations as stored in NM, and

3. The pre-defined relationships between RSA and CDRs (is-nearby, is-not-affected, etc) as stored in
NM

4. A period for which the calculation on the affected routes will done

The output list of CDR openings/closures is labelled implicit to distinguish it from CDR openings and
closures managed by the customer.

This request does not imply any update transaction within the NM system.

It is up to the client to extract from the returned CDR updates those of interest to him, and include
those in the AUP to be created/updated.

Remark
CHMI users can select the computed CDR updates of interest while creating an AUP. This results
in the automatic inclusion of the implicitCDRs CDR updates in the AUP upon saving. The
implicitCDRs list of CDR updates is readable by B2B users per AUP. However, B2B users will
never generate an AUP with a separate list of implicitCDRs, i.e. all CDR updates in an AUP from a
B2B user are always considered explicit.

Edition: 27.0 6 398

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Request

2. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

rsaAllocations (Optional)

Documentation last updated: 27.0 - Edition 3

List of explicit RSA allocations input to the expansion algorithm.

See AUP RSA Allocations Message.

b. DateTimeMinutePeriod expansionPeriod (Mandatory)

Period of time input to the expansion algorithm

i. Constraints:

▪ AUPRSAAllocationExpansionRequest.INVALID_EXPANSION_PERIOD

3. Constraints:

a. INVALID_EXPANSION_PERIOD

Period must be greater or equal to 1 second

Constrained attributes: expansionPeriod

Constrained requests: any using request

17.3.4.7.2. AUPRSAAllocationExpansionReply

<<class>>

Returned in response to AUPRSAAllocationExpansionRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPRSAAllocationExpansionReplyData data (Optional)

The AUPRSAAllocationExpansionReply data

17.3.4.8. AUPServiceConfigurationRequest/Reply

Edition: 27.0 6 399

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AUPServiceConfigurationRequest

Reply: AUPServiceConfigurationReply

Response time: 8 / 30 / 370 (ms)

Default settings: request count quotas

SOAP operation:

AUPServiceConfigurationReply
getAUPServiceConfiguration(AUPServiceConfigurationRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the dynamic part of the AUP service configuration.

17.3.4.8.1. AUPServiceConfigurationRequest

<<class>>

Request to obtain the dynamic part of the AUP service configuration.

The AUP service configuration data is provided a long time prior to its applicability, hence NM
requires the client applications not to retrieve it with high frequency, certainly not more than once
every 10 minutes.

1. Inherits from: Request

17.3.4.8.2. AUPServiceConfigurationReply

<<class>>

Returned in response to AUPServiceConfigurationRequest.

Edition: 27.0 6 400

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. AUPServiceConfigurationReplyData data (Optional)

The AUPServiceConfigurationReply data

17.3.4.9. EAUPChainRetrievalRequest/Reply

MEP: S-R/R

Request: EAUPChainRetrievalRequest

Reply: EAUPChainRetrievalReply

Response time: 7 / 69 / 610 (ms)

Default settings: request count quotas

SOAP operation:

EAUPChainRetrievalReply retrieveEAUPChain(EAUPChainRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the EAUP chain of given date.

17.3.4.9.1. EAUPChainRetrievalRequest

<<class>>

Request to retrieve an EAUP chain from its date, i.e. from the release date of its EAUP baseline.

Users must take into account that post-ops (i.e. post-tactical) released EAUP chains are immutable:
they will not gain or lose EAUPs, and the EAUPs they contain will not be modified anymore.
Consequently, NM requires its customers to undertake their best effort to avoid to repeatedly

Edition: 27.0 6 401

Document Title: NM 27.0 - NM B2B Reference Manual

retrieve the same post-ops EAUP chain.

In addition, given that some hours always elapse between two successive EAUP releases, NM
requires its customers not to poll the service with high frequency, i.e. certainly not more than every
5 minutes, a lower frequency being preferred. P/S solution is recommended.

1. Inherits from: Request

2. Attributes:

a. DateYearMonthDay chainDate (Mandatory)

The date of the requested EAUP chain

i. Constraints:

▪ EAUPChainRetrievalRequest.INVALID_CHAIN_DATE

3. Constraints:

a. INVALID_CHAIN_DATE

Valid chain dates are:

1. D-1 (pre-tactical, tomorrow)

2. D (tactical, today)

3. [ D + 1 (yesterday), D +15 months ] (post-ops)

Constrained attributes: chainDate

Constrained requests: any using request

17.3.4.9.2. EAUPChainRetrievalReply

Edition: 27.0 6 402

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to EAUPChainRetrievalRequest.

The returned EAUPChain contains EAUP summaries, each containing among others the EAUP
identification to be used subsequently to retrieve a complete EAUP or to query its contents.

1. Inherits from: Reply

2. Attributes:

a. EAUPChainRetrievalReplyData data (Optional)

The EAUPChainRetrievalReply data

17.3.4.10. EAUPCDRRequest/Reply

Edition: 27.0 6 403

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EAUPCDRRequest

Reply: EAUPCDRReply

Response time: 1100 / 3200 / 7400 (ms)

Default settings: request count quotas

SOAP operation:

EAUPCDRReply retrieveEAUPCDRs(EAUPCDRRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the CDR openings and/or closures within a given EAUP.

17.3.4.10.1. EAUPCDRRequest

<<class>>

Used to retrieve the CDR openings and/or closures within a given EAUP, while possibly applying a

Edition: 27.0 6 404

Document Title: NM 27.0 - NM B2B Reference Manual

filter on the returned result set, as described in AbstractEAUPCDRRequest, from which this request
inherits.

The queried EAUP is identified using the EAUPIdentification from the EAUPSummary returned as part
of an EAUPChain.

1. Inherits from: AbstractEAUPCDRRequest

2. Attributes:

a. EAUPIdentification eaupId (Mandatory)

The identification of the EAUP, extracted (and left unchanged) from an EAUPSummary.

If no other attribute is specified in this request, all the CDR openings and closures of the
EAUP are returned.

17.3.4.10.2. EAUPCDRReply

<<class>>

Returned in response to EAUPCDRRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPCDRReplyData data (Optional)

The EAUPCDRReply data

17.3.4.11. EAUPCDRCompareRequest/Reply

MEP: S-R/R

Request: EAUPCDRCompareRequest

Reply: EAUPCDRCompareReply

Response time: 3600 / 5000 / 6700 (ms)

Default settings: request count quotas

SOAP operation:

EAUPCDRCompareReply compareEAUPCDRs(EAUPCDRCompareRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 405

Document Title: NM 27.0 - NM B2B Reference Manual

Compares the CDR openings and closures of two distinct EAUPs.

17.3.4.11.1. EAUPCDRCompareRequest

<<class>>

Facility used to retrieve the CDR openings and closures that the two given EAUPs have in common,
and those that are in one of these EAUPs only, while possibly applying a filter on the returned result
set, as described in AbstractEAUPCDRRequest.

The queried EAUPs are identified using the EAUPIdentification from the EAUPSummary returned as
part of an EAUPChain

1. Inherits from: AbstractEAUPCDRRequest

2. Attributes:

a. EAUPIdentification eaupId1 (Mandatory)

The identification of the first EAUP, extracted (and left unchanged) from an EAUPSummary.

i. Constraints:

▪ EAUPCDRCompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

b. EAUPIdentification eaupId2 (Mandatory)

The identification of the second EAUP, extracted (and left unchanged) from an EAUPSummary.

Edition: 27.0 6 406

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ EAUPCDRCompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

3. Constraints:

a. EAUP_IDS_CANNOT_BE_THE_SAME

eaupId1 and eaupId2 cannot be the same EAUPs

Constrained attributes: eaupId1, eaupId2

Constrained requests: any using request

17.3.4.11.2. EAUPCDRCompareReply

<<class>>

Returned in response to EAUPCDRCompareRequest.

The three lists below are mandatory, i.e. cannot be null, but are left empty if no matching CDR
openings or closures were found

1. Inherits from: Reply

2. Attributes:

a. EAUPCDRCompareReplyData data (Optional)

The EAUPCDRCompareReply data

17.3.4.12. EAUPRSARequest/Reply

Edition: 27.0 6 407

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EAUPRSARequest

Reply: EAUPRSAReply

Response time: 530 / 2500 / 3600 (ms)

Default settings: request count quotas

SOAP operation:

EAUPRSAReply retrieveEAUPRSAs(EAUPRSARequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the RSA allocations within a given EAUP.

17.3.4.12.1. EAUPRSARequest

<<class>>

Used to retrieve the RSA allocations within a given EAUP, while possibly applying a filter on the

Edition: 27.0 6 408

Document Title: NM 27.0 - NM B2B Reference Manual

returned result set, as described in AbstractEAUPRSARequest, from which this request inherits.

The queried EAUP is identified using the EAUPIdentification from the EAUPSummary returned as part
of an EAUPChain

1. Inherits from: AbstractEAUPRSARequest

2. Attributes:

a. EAUPIdentification eaupId (Mandatory)

The identification of the EAUP, extracted (and left unchanged) from an EAUPSummary. If no
other attribute is specified in this request, all the RSA allocations of the EAUP are returned.

17.3.4.12.2. EAUPRSAReply

<<class>>

Returned in response to EAUPRSARequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPRSAReplyData data (Optional)

The EAUPRSAReply data

17.3.4.13. EAUPRSACompareRequest/Reply

MEP: S-R/R

Request: EAUPRSACompareRequest

Reply: EAUPRSACompareReply

Response time: 3900 / 6300 / 11000 (ms)

Default settings: request count quotas

SOAP operation:

EAUPRSACompareReply compareEAUPRSAs(EAUPRSACompareRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Compares the RSA allocations of two distinct EAUPs.

Edition: 27.0 6 409

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.13.1. EAUPRSACompareRequest

<<class>>

Used to retrieve the RSA allocations that the two given EAUPs have in common, and those that are
in one of these EAUPs only, while possibly applying a filter on the returned result set, as described
in AbstractEAUPRSARequest.

The queried EAUPs are identified using the EAUPIdentification from the EAUPSummary returned as
part of an EAUPChain.

1. Inherits from: AbstractEAUPRSARequest

2. Attributes:

a. EAUPIdentification eaupId1 (Mandatory)

The identification of the first EAUP, extracted (and left unchanged) from an EAUPSummary

i. Constraints:

▪ EAUPRSACompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

b. EAUPIdentification eaupId2 (Mandatory)

The identification of the second EAUP, extracted (and left unchanged) from an EAUPSummary

i. Constraints:

▪ EAUPRSACompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

3. Constraints:

Edition: 27.0 6 410

Document Title: NM 27.0 - NM B2B Reference Manual

a. EAUP_IDS_CANNOT_BE_THE_SAME

eaupId1 and eaupId2 cannot be the same

Constrained attributes: eaupId1, eaupId2

Constrained requests: any using request

17.3.4.13.2. EAUPRSACompareReply

<<class>>

Returned in response to EAUPRSACompareRequest.

The three lists below are mandatory, i.e. cannot be null, but are left empty if no matching RSA
allocations were found.

1. Inherits from: Reply

2. Attributes:

a. EAUPRSACompareReplyData data (Optional)

The EAUPRSACompareReply data

17.3.4.14. AUPGetManageableRoutesForAMCRequest/Reply

Edition: 27.0 6 411

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AUPGetManageableRoutesForAMCRequest

Reply: AUPGetManageableRoutesForAMCReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AUPGetManageableRoutesForAMCReply
getManageableRoutesForAMC(AUPGetManageableRoutesForAMCRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the openable and closeable Routes for a given AMC.

17.3.4.14.1. AUPGetManageableRoutesForAMCRequest

<<class>>

An AMC is responsible for the management of Elementary and Composed Manageable Airspaces.

This service returns the potential openable and closeable Routes.

1. Inherits from: Request

2. Attributes:

a. AirNavigationUnitId amcId (Mandatory)

The id to identify the AMC

b. DateTimeMinutePeriod period (Mandatory)

Edition: 27.0 6 412

Document Title: NM 27.0 - NM B2B Reference Manual

The period to consider: typically the validity of an AUP or a part of that validity period

17.3.4.14.2. AUPGetManageableRoutesForAMCReply

<<class>>

Returned in response to AUPGetManageableRoutesForAMCRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPGetManageableRoutesForAMCReplyData data (Optional)

The reply payload

17.3.4.15. AUPGetManageableRouteSegmentsForAMCAndRouteRequest/Reply

MEP: S-R/R

Request: AUPGetManageableRouteSegmentsForAMCAndRouteRequest

Reply: AUPGetManageableRouteSegmentsForAMCAndRouteReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AUPGetManageableRouteSegmentsForAMCAndRouteReply
getManageableRouteSegmentsForAMCAndRoute(AUPGetManageableRouteSegmentsForAMCAndRou
teRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the RouteSegments that can be managed for the given AMC and Route.

17.3.4.15.1. AUPGetManageableRouteSegmentsForAMCAndRouteRequest

Edition: 27.0 6 413

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Return the RouteSegments that can be managed for the given AMC and Route

1. Inherits from: Request

2. Attributes:

a. AirNavigationUnitId amcId (Mandatory)

The id to identify the AMC

b. DateTimeMinutePeriod period (Mandatory)

The period to consider: typically the validity of an AUP or a part of that validity period

c. UUID routeUUID (Mandatory)

The Route UUID

17.3.4.15.2. AUPGetManageableRouteSegmentsForAMCAndRouteReply

<<class>>

Returned in response to AUPGetManageableRouteSegmentsForAMCAndRouteRequest.

1. Inherits from: Reply

2. Attributes:

a. AUPGetManageableRouteSegmentsForAMCAndRouteReplyData data (Optional)

The reply payload

17.3.4.16. DraftEAUPsRetrievalRequest/Reply

Edition: 27.0 6 414

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: DraftEAUPsRetrievalRequest

Reply: DraftEAUPsRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

DraftEAUPsRetrievalReply retrieveDraftEAUPSummaries(DraftEAUPsRetrievalRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the DRAFT EAUP summaries for tyhe given day of operation.

17.3.4.16.1. DraftEAUPsRetrievalRequest

<<class>>

Request to retrieve DRAFT EAUP summaries

1. Inherits from: Request

2. Attributes:

a. DateYearMonthDay dayOfOperation (Optional)

Day for which the DRAFT EAUP summary is requested; if not set all the DRAFT EAUP
summaries are returned

17.3.4.16.2. DraftEAUPsRetrievalReply

<<class>>

Returned in response to DraftEAUPsRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. DraftEAUPsRetrievalReplyData data (Optional)

The DraftEAUPsRetrievalReply data

Edition: 27.0 6 415

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.17. DraftEAUPRSARequest/Reply

MEP: S-R/R

Request: DraftEAUPRSARequest

Reply: DraftEAUPRSAReply

Response time: not available

Default settings: request count quotas

SOAP operation:

DraftEAUPRSAReply retrieveDraftEAUPRSAs(DraftEAUPRSARequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the DRAFT EAUP RSA Allocations for a given day of operation.

17.3.4.17.1. DraftEAUPRSARequest

<<class>>

Request to retrieve the DRAFT EAUP RSA Allocation of a given day

1. Inherits from: AbstractEAUPRSARequest

2. Attributes:

a. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the DRAFT EAUP RSA Allocation is requested

17.3.4.17.2. DraftEAUPRSAReply

<<class>>

Returned in response to DraftEAUPRSARequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPRSAReplyData data (Optional)

The DraftEAUPRSAReply data

Edition: 27.0 6 416

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.18. DraftEAUPCDRRequest/Reply

MEP: S-R/R

Request: DraftEAUPCDRRequest

Reply: DraftEAUPCDRReply

Response time: not available

Default settings: request count quotas

SOAP operation:

DraftEAUPCDRReply retrieveDraftEAUPCDRs(DraftEAUPCDRRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the DRAFT EAUP CDR Allocation of a given day of operation.

17.3.4.18.1. DraftEAUPCDRRequest

<<class>>

Request to retrieve the DRAFT EAUP CDR Allocation of a given day

1. Inherits from: AbstractEAUPCDRRequest

2. Attributes:

a. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the DRAFT EAUP CDR Allocation is requested

17.3.4.18.2. DraftEAUPCDRReply

<<class>>

Returned in response to DraftEAUPCDRRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPCDRReplyData data (Optional)

The DraftEAUPCDRReply data

Edition: 27.0 6 417

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.19. ASMScenarioListRequest/Reply

MEP: S-R/R

Request: ASMScenarioListRequest

Reply: ASMScenarioListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ASMScenarioListReply queryASMScenarios(ASMScenarioListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries ASM Scenarios.

17.3.4.19.1. ASMScenarioListRequest

<<class>>

Request to query ASM scenarios.

1. Inherits from: Request

2. Attributes:

a. AirNavigationUnitId amcId (Mandatory)

Edition: 27.0 6 418

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 1

Filters ASM scenarios according to their lead AMC. See ASMScenario.leadAmc feature attribute.

b. DateTimeMinutePeriod period (Mandatory)

Documentation last updated: 27.0 - Edition 1

The period during which the ASM scenario can be activated.

17.3.4.19.2. ASMScenarioListReply

<<class>>

Returned in response to ASMScenarioListRequest.

1. Inherits from: Reply

2. Attributes:

a. ASMScenarioListReplyData data (Optional)

The ASMScenarioListReply data

17.3.4.20. ASMScenarioActivationListRequest/Reply

MEP: S-R/R

Request: ASMScenarioActivationListRequest

Reply: ASMScenarioActivationListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ASMScenarioActivationListReply
queryASMScenarioActivations(ASMScenarioActivationListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries ASM Scenario Activations.

Edition: 27.0 6 419

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.20.1. ASMScenarioActivationListRequest

<<class>>

Request to query ASM scenario activations.

1. Inherits from: Request

2. Attributes:

a. AUPId aupId (Mandatory)

Documentation last updated: 27.0 - Edition 1

The identifier of the AUP to which this ASM scenario activation belongs.

b. DateTimeMinutePeriod period (Mandatory)

Documentation last updated: 27.0 - Edition 1

The filter period. An ASM scenario activation is returned only if its period overlaps the filter
period.

17.3.4.20.2. ASMScenarioActivationListReply

<<class>>

Returned in response to ASMScenarioActivationListRequest.

1. Inherits from: Reply

2. Attributes:

a. ASMScenarioActivationListReplyData data (Optional)

The ASMScenarioActivationListReply data

Edition: 27.0 6 420

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.21. ASMScenarioActivationCreationRequest/Reply

MEP: S-R/R

Request: ASMScenarioActivationCreationRequest

Reply: ASMScenarioActivationCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ASMScenarioActivationCreationReply
createASMScenarioActivation(ASMScenarioActivationCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates ASM Scenario Activation.

17.3.4.21.1. ASMScenarioActivationCreationRequest

<<class>>

Creates an ASM scenario activation.

1. Inherits from: Request

2. Attributes:

a. ASMScenarioActivation asmScenarioActivation (Mandatory)

Edition: 27.0 6 421

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.21.2. ASMScenarioActivationCreationReply

<<class>>

Returned in response to ASMScenarioActivationCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. ASMScenarioActivationCreationReplyData data (Optional)

The ASMScenarioActivationCreationReply data

17.3.4.22. ASMScenarioActivationUpdateRequest/Reply

MEP: S-R/R

Request: ASMScenarioActivationUpdateRequest

Reply: ASMScenarioActivationUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ASMScenarioActivationUpdateReply
updateASMScenarioActivation(ASMScenarioActivationUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates ASM Scenario Activation.

17.3.4.22.1. ASMScenarioActivationUpdateRequest

Edition: 27.0 6 422

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Updates an ASM scenario activation.

1. Inherits from: Request

2. Attributes:

a. ASMScenarioActivation asmScenarioActivation (Mandatory)

17.3.4.22.2. ASMScenarioActivationUpdateReply

<<class>>

Returned in response to ASMScenarioActivationUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. ASMScenarioActivationUpdateReplyData data (Optional)

The ASMScenarioActivationUpdateReply data

17.3.4.23. ASMScenarioActivationDeletionRequest/Reply

Edition: 27.0 6 423

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ASMScenarioActivationDeletionRequest

Reply: ASMScenarioActivationDeletionReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ASMScenarioActivationDeletionReply
deleteASMScenarioActivation(ASMScenarioActivationDeletionRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Deletes ASM Scenario Activation.

17.3.4.23.1. ASMScenarioActivationDeletionRequest

<<class>>

Deletes an ASM scenario activation.

1. Inherits from: Request

2. Attributes:

a. AUPId aupId (Mandatory)

Unique id of the requested AUP: found in AUPSummary.aupId

b. UUID asmScenarioActivationId (Mandatory)

Edition: 27.0 6 424

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.23.2. ASMScenarioActivationDeletionReply

<<class>>

Returned in response to ASMScenarioActivationDeletionRequest.

1. Inherits from: Reply

2. Attributes:

a. ASMScenarioActivationDeletionReplyData data (Optional)

The ASMScenarioActivationDeletionReply data

17.3.4.24. RADRestrictionActivationListRequest/Reply (new 27.0)

MEP: S-R/R

Request: RADRestrictionActivationListRequest

Reply: RADRestrictionActivationListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RADRestrictionActivationListReply
queryRADRestrictionActivations(RADRestrictionActivationListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 3

Retrieves the RAD restriction activations which can be dynamically activated during the
validity period of the AUP/UUP.

17.3.4.24.1. RADRestrictionActivationListRequest (new 27.0)

Edition: 27.0 6 425

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 3

Request to retrieve the RAD restriction activations which can be dynamically activated by an AMC
or FMP in the context of AUP/UUP.

1. Inherits from: Request

2. Attributes:

a. AUPId aupId (Mandatory)

Unique id of the requested AUP: found in AUPSummary.aupId

17.3.4.24.2. RADRestrictionActivationListReply (new 27.0)

<<class>>

Returned in response to RADRestrictionActivationListRequest.

1. Inherits from: Reply

2. Attributes:

a. RADRestrictionActivationListReplyData data (Optional)

The RADRestrictionActivationListReply data

17.3.4.25. RADRestrictionActivationsUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 426

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RADRestrictionActivationsUpdateRequest

Reply: RADRestrictionActivationsUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RADRestrictionActivationsUpdateReply
updateRADRestrictionActivations(RADRestrictionActivationsUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to /restrictions#activation_time_table?aup_activatable=true

Updates the RADRestrictionActivations in the context of an AUP/UUP.

17.3.4.25.1. RADRestrictionActivationsUpdateRequest (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 2

Updates the RADRestrictionActivations in the context of an AUP/UUP.

1. Inherits from: Request

2. Attributes:

a. AUPId aupId (Mandatory)

Edition: 27.0 6 427

Document Title: NM 27.0 - NM B2B Reference Manual

Unique id of the requested AUP: found in AUPSummary.aupId

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Mandatory)

Documentation last updated: 27.0 - Edition 3

The AMC/FMP sends the complete list of AUP-RAD restriction activations for which the
AMC/FMP is responsible. All the RAD restriction activation currently saved are removed and
replaced by the given list. To clear the list, an empty list needs to be provided.

See RAD Restriction Activations Update.

17.3.4.25.2. RADRestrictionActivationsUpdateReply (new 27.0)

<<class>>

Returned in response to RADRestrictionActivationsUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. RADRestrictionActivationsUpdateReplyData data (Optional)

The RADRestrictionActivationsUpdateReplyData data

17.3.4.26. EAUPRADRestrictionActivationRequest/Reply (new 27.0)

MEP: S-R/R

Request: EAUPRADRestrictionActivationRequest

Reply: EAUPRADRestrictionActivationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EAUPRADRestrictionActivationReply
retrieveEAUPRADRestrictionActivations(EAUPRADRestrictionActivationRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 428

Document Title: NM 27.0 - NM B2B Reference Manual

Retrieves the RADRestrictionActivations in the context of an AUP/UUP.

17.3.4.26.1. EAUPRADRestrictionActivationRequest (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 3

Retrieves the AUP-RAD restriction activations within the given EAUP. The queried EAUP is identified
using the EAUPIdentification from the EAUPSummary returned as part of an EAUPChain

1. Inherits from: Request

2. Attributes:

a. EAUPIdentification eaupId (Mandatory)

The identification of the EAUP, extracted (and left unchanged) from an EAUPSummary.

17.3.4.26.2. EAUPRADRestrictionActivationReply (new 27.0)

<<class>>

Returned in response to EAUPRADRestrictionActivationRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPRADRestrictionActivationReplyData data (Optional)

The EAUPRADRestrictionActivationReply data

Edition: 27.0 6 429

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.27. EAUPRADRestrictionActivationCompareRequest/Reply (new 27.0)

MEP: S-R/R

Request: EAUPRADRestrictionActivationCompareRequest

Reply: EAUPRADRestrictionActivationCompareReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EAUPRADRestrictionActivationCompareReply
compareEAUPRADRestrictionActivations(EAUPRADRestrictionActivationCompareRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Compares the RAD Restriction activations of two distinct EAUPs.

17.3.4.27.1. EAUPRADRestrictionActivationCompareRequest (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 3

Request to retrieve the RAD Restriction activations that the two given EAUPs have in common, and
those that are in one of these EAUPs only.

Edition: 27.0 6 430

Document Title: NM 27.0 - NM B2B Reference Manual

The queried EAUPs are identified using the EAUPIdentification from the EAUPSummary returned as
part of an EAUPChain.

1. Inherits from: Request

2. Attributes:

a. EAUPIdentification eaupId1 (Mandatory)

The identification of the first EAUP, extracted (and left unchanged) from an EAUPSummary

i. Constraints:

▪ EAUPRADRestrictionActivationCompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

b. EAUPIdentification eaupId2 (Mandatory)

The identification of the second EAUP, extracted (and left unchanged) from an EAUPSummary

i. Constraints:

▪ EAUPRADRestrictionActivationCompareRequest.EAUP_IDS_CANNOT_BE_THE_SAME

3. Constraints:

a. EAUP_IDS_CANNOT_BE_THE_SAME

eaupId1 and eaupId2 cannot be the same

Constrained attributes: eaupId1, eaupId2

Constrained requests: any using request

17.3.4.27.2. EAUPRADRestrictionActivationCompareReply (new 27.0)

<<class>>

Returned in response to EAUPRADRestrictionActivationCompareRequest.

1. Inherits from: Reply

2. Attributes:

a. EAUPRADRestrictionActivationCompareReplyData data (Optional)

The EAUPRADRestrictionActivationCompareReply data

17.3.4.28. DraftEAUPRADRestrictionActivationRequest/Reply (new 27.0)

Edition: 27.0 6 431

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: DraftEAUPRADRestrictionActivationRequest

Reply: DraftEAUPRADRestrictionActivationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

DraftEAUPRADRestrictionActivationReply
retrieveDraftEAUPRADRestrictionActivations(DraftEAUPRADRestrictionActivationReques
t request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the RADRestrictionActivations in the context of an AUP/UUP.

17.3.4.28.1. DraftEAUPRADRestrictionActivationRequest (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 3

Retrieves the AUP-RAD restriction activations within a given day of operations.

1. Inherits from: Request

2. Attributes:

a. DateYearMonthDay dayOfOperation (Mandatory)

Documentation last updated: 27.0 - Edition 3

Day for which the AUP-RAD restriction activations are requested.

Edition: 27.0 6 432

Document Title: NM 27.0 - NM B2B Reference Manual

17.3.4.28.2. DraftEAUPRADRestrictionActivationReply (new 27.0)

<<class>>

Returned in response to DraftEAUPRADRestrictionActivationRequest.

1. Inherits from: Reply

2. Attributes:

a. DraftEAUPRADRestrictionActivationReplyData data (Optional)

The DraftEAUPRADRestrictionActivationReply data

17.4. AirspaceStructure Port Type

17.4.1. Overview

1. The AirspaceStructure port type provides query and retrieve services on airspace data:

a. P/S AIRSPACE_DATA

b. S-R/R CompleteAIXMDatasetRequest/Reply

c. S-R/R IncrementalAIXMDatasetRequest/Reply

d. S-R/R AirspaceDataIncrementListRequest/Reply

e. A-R/R AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage

f. A-R/R AirspaceDataRetrievalRequest/Reply/ReplyMessage

17.4.2. Concepts

17.4.2.1. Airspace Data

1. The Airspace Data published by NM is composed of the following AIXM Feature Types:

a. AirportHeliport, AirportHeliportCollocation, AirportHeliportSet

b. AngleIndication, DesignatedPoint, DistanceIndication, NavaidPointSet

c. ArrivalLeg, DepartureLeg, Route, RouteSegment, StandardInstrumentArrival,

StandardInstrumentDeparture, SunriseSunsetTable

d. Airspace

e. AirTrafficControlService, AirTrafficManagementService, InformationService,

OrganisationAuthority, SpecialDate, Unit

f. FlightRestriction

g. Flow, ReferenceLocation, TrafficVolume, TrafficVolumeSet

17.4.2.2. AIXM Temporality Model Profile for NM B2B

1. The AIXM Temporality Model Profile for NM B2B defines the rules governing the temporality

Edition: 27.0 6 433

Document Title: NM 27.0 - NM B2B Reference Manual

aspects during the export of the CACD data into AIXM (see the document AIXM Temporality
Model Profile for more details).

17.4.2.3. Complete / Incremental Airspace Dataset

1. A Complete Airspace Dataset (CDS) is a consistent and self contained set of AIXM Features
representing the complete Airspace Data as it is known at a given point in time.

Remarks
a. One Complete Airspace Dataset is published every day by NM.

b. A Complete Airspace Dataset is associated with an Airspace Data Update Id (see below)
that represents the latest Update included in the dataset.

c. This Update Id must be used to query for subsequent Updates.

d. The AIXM Features included in the Complete Airspace Dataset contain only BASELINE
Timeslices.

2. An Incremental Airspace Dataset (IDS) is a consistent set of AIXM Features that represents an
update of the Airspace Data. The content of the Incremental Airspace Dataset is the set of
updated Features.

Remarks
a. Several Incremental Airspace Datasets may be published by NM every day.

b. Each Incremental Airspace Dataset is associated with an Airspace Data Update Id (see
below) that corresponds to the Airspace Data Update included in the dataset.

c. Each Incremental Airspace Dataset has a reference to the previous Airspace Data Update
Id, so the Incremental Airspace Datasets form a contiguous chain.

d. The Incremental Airspace Datasets must be applied in the order explicitly specified by
NM and one Incremental Airspace Dataset should not be applied if the previous
Incremental Airspace Dataset has not been applied.

e. An Incremental Airspace Dataset can be downloaded as BASELINE or PERMDELTA

timeslices. It is up to the data consumer to decide the type of timeslices:

▪ If the data consumer asks for BASELINE timeslices, each Feature included in the
Dataset will contain all known BASELINE timeslices which are not in the past with
respect to the operational AIRAC at the time of the publication of the Dataset.

▪ If the data consumer asks for PERMDELTA timeslices, each Feature included in the
Dataset will contain the set of PERMDELTA timeslices, computed according to the
AIXM Temporality Model Profile for NM B2B .

f. In both cases the Incremental Airspace Dataset will only contain the updated Features.

17.4.2.4. Filtered Airspace Dataset

Last updated: 27.0 - Edition 4

1. A Filtered Airspace Dataset contains the AIXM Features presents in the CACD Database that

Edition: 27.0 6 434

Document Title: NM 27.0 - NM B2B Reference Manual

verify one or more filtering criteria.

2. In this version, the only supported filtering criteria is the AMC.

A Filtered (by AMC) Complete or Incremental Dataset contains only the AIXM Features that
belong to the selected AMC.

3. More precisely, the AIXM Features that belong to an AMC are:

a. the AMC Unit Feature

b. the AirTrafficManagementService Feature that the AMC unit delivers

c. the Airspace Features (1 NAS and 0..n RSAs) for which the AMC delivers the air traffic
management service (AirTrafficManagementService.clientAirspace association)

d. the Airspace Features that compose to the NAS

e. all RouteSegment Features of each route portion that has some relation with an included
RSA:

i. delegated - see AirTrafficManagementService.clientRoute association

ii. crossing - a route portion that crosses one RSA geometry

iii. nearby - see air route classification / nearby

iv. not affected - see air route classification / not affected

v. offload - see air route classification / offload

f. any FUA, RAD FUA or RAD AUP FlightRestriction Feature that is related to an included RSA

g. any ASMScenario Feature (ADR-E) of which leadAmc association points to the AMC unit

h. any ASMScenario Feature (ADR-E) which is conflicting (conflictingScenario association)

with an included ASM scenario

i. any AirportHeliport Feature, AirportHeliportSet Feature (ADR-E), Airspace Feature,

DesignatedPoint Feature, Navaid Feature, PointSet Feature (ADR-E)
,StandardInstrumentDeparture Feature or StandardInstrumentArrival Feature that is
referenced (condition or routing) by an included restriction

j. any airblock that contributes to the geometry of an included elementary airspace (RSA or
other)

k. any AirportHeliport Feature, DesignatedPoint Feature or Navaid Feature that is referenced

by an included feature (airblock, airport/heliport set, point set, route segment, SID, STAR,
restriction, etc.)

l. any AngleIndication Feature/DistanceIndication Feature that references (fix association) an

included designated point of type __ADR__REFERENCE

m. any AngleIndication Feature/DistanceIndication Feature that references (pointChoice

association) an included navaid

17.4.2.5. Airspace Data Update

1. An Airspace Data Update is a modification to the NM Airspace Data. It is published as an

Edition: 27.0 6 435

Document Title: NM 27.0 - NM B2B Reference Manual

Incremental Airspace Dataset. One Airspace Data Update may affect one or more Airspace Data
entities and therefore result into one or more AIXM Feature updates. An Airspace Data Update
may happen as a result of:

a. Changes performed between two consecutive AIRAC cycles

b. Changes performed during an operational AIRAC cycle

Remark
Each Airspace Data Update has a unique identifier (an Airspace Data Update Id, or simply
Update Id)

2. The Complete Airspace Datasets and Incremental Airspace Datasets are such that: The Complete
Airspace Dataset published at day D is the result of applying all Incremental Airspace Datasets
of day D-1 to the Complete Airspace Dataset of day D-1 (see picture below).

17.4.2.6. Airspace Dataset Publication

1. The publication of Complete and Incremental Airspace Datasets by NM is summarized by the

following picture.

Figure 17. Datasets Publication Diagram

2. The example shows a simplified scenario of dataset daily publication from 7 days before the

Edition: 27.0 6 436

Document Title: NM 27.0 - NM B2B Reference Manual

AIRAC switch to one day after the AIRAC switch (transition between AIRAC 1402 to AIRAC 1403)

3. One Complete Airspace Dataset is published every day (shown as green circles: CDS stands for
Complete Airspace Dataset)

4. Several Incremental Airspace Datasets are published every day (shown as red circles: IDS stands
for Incremental Airspace Dataset)

5. Each dataset, Complete or Incremental, is associated with an Airspace Data Update Id that
uniquely identifies an update to the NM Airspace Data.

6. Each Incremental Airspace Dataset corresponds to a single Airspace Data Update.

7. The Update Id associated to a Complete Airspace Dataset corresponds to the latest update
included in the dataset: for example CDS 43 is up-to-date with the Airspace Data Update 43, i.e. it
contains all the Updates up to 43 included.

8. The AIRAC numbers shown at the bottom of the picture show which AIRACS may be affected by
the Updates: normally the data corresponding to an AIRAC starts to be available 6 days before
the AIRAC switch. It means that the datasets published between AIRAC -6 and AIRAC day may
contain data both for the current AIRAC and the next. In the example shown in the picture
above, the datasets (both Complete and Incremental) published on the 28/02 may contain
changes to both AIRAC 1402 and 1403.This information is useful to easily identify all the
datasets associated to a particular AIRAC.

9. Each dataset is composed of a number of zipped files, one per AIXM Feature type.

10. NM requires the service consumers not to massively poll the service to know when there are
new datasets available: the service consumer should not query for datasets more than once
every 5 minutes.

11. One of the primary objectives of this service is to provide data that can be automatically
processed by ASM tools. However, applicability timetables must be exported as entered by the
user. This implies usage of complex time expressions such as weekly expressions (e.g.THU, FRI)
and special days (e.g. holidays); in other words, applicability timetables require an
interpretation.

12. See the ADR-Extension Document for more details on the AIXM features and properties that are
published.

17.4.2.7. Getting Airspace Data

Last updated: 27.0 - Edition 1

1. The Airspace Structure services are exposed via different message exchange patterns.

2. The AirspaceDataRetrievalRequest/Reply/ReplyMessage and

AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage services respectively allow the
client application to retrieve Filtered (by AMC) Complete and Incremental datasets via the A-
R/R message exchange pattern.

These two services are complemented by the

NOTE AirspaceDataIncrementListRequest/Reply S-R/R service that allows the client
application to obtain the Update Id of the last airspace data update(s).

Edition: 27.0 6 437

Document Title: NM 27.0 - NM B2B Reference Manual

3. The CompleteAIXMDatasetRequest/Reply and IncrementalAIXMDatasetRequest/Reply services

allow the client application to retrieve Complete and Incremental datasets via the File
Download message exchange pattern.

4. The AIRSPACE_DATA Subscription Topic exposes the airspace data updates via the P/S message
exchange pattern. The client application can subscribe to:

◦ Complete and/or Incremental datasets

◦ Filtered (by AMC) or unfiltered datasets

17.4.2.8. Recommended Workflows

Last updated: 27.0 - Edition 1

1. The service offers a certain level of flexibility in order to allow many possible use cases.

2. A client application should use one of the recommended reconciliation workflows to fully re-
populate its database with a Complete Airspace Dataset.

NM publishes a Complete Airspace Datasets once a day (see Airspace Dataset

NOTE Publication). A client application should not execute more than one
reconciliation per day.

3. A client application should use one of the recommended synchronisation workflows to update
its database according to the published Incremental Airspace Datasets.

17.4.2.8.1. Complete Airspace Dataset Reconciliation

1. The client application executes a CompleteAIXMDatasetRequest/Reply S-R/R for a given AIRAC

or a given date.

2. The client application downloads the files containing the feature types of interest.

17.4.2.8.2. Filtered Complete Airspace Dataset Reconciliation

1. The client application executes a AirspaceDataIncrementListRequest/Reply S-R/R for the AMC of

interest but with no Update Id.

2. The client application executes a AirspaceDataRetrievalRequest/Reply/ReplyMessage A-R/R for

the AMC of interest with the received Update Id.

3. The client application connects (if not yet connected) to the NM B2B Broker and consumes the
published AirspaceDataRetrievalReplyMessage.

17.4.2.8.3. Incremental Airspace Dataset Synchronisation

1. The client application subscribes to the AIRSPACE_DATA Subscription Topic with the following
AirspaceDataMessageFilter parameters:

◦ datasetTypes: [INCREMENTAL]

◦ airspaceDataFilter: none

2. The client application connects (if not yet connected) to the NM B2B broker then consumes the

Edition: 27.0 6 438

Document Title: NM 27.0 - NM B2B Reference Manual

published AirspaceDataMessage’s.

3. On AirspaceDataMessage consumption, the client application downloads the files containing the
feature types of interest.

In case the client application is not capable to use the P/S service, it can also
synchronise the Overall Airspace Dataset by periodically executing the
NOTE
IncrementalAIXMDatasetRequest/Reply and downloading the returned Overall
Incremental Airspace Datasets.

17.4.2.8.4. Filtered Complete Airspace Dataset Synchronisation

1. The client application subscribes to the AIRSPACE_DATA Subscription Topic with the following
AirspaceDataMessageFilter parameters:

◦ datasetTypes: none

◦ airspaceDataFilter: amc-of-interest

a. The client application connects (if not yet connected) to the NM B2B broker then
consumes the published AirspaceDataMessage’s.

b. On AirspaceDataMessage consumption:

i. The client application executes a

AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage A-R/R for the AMC of
interest with the received Update Id.

ii. The client application consumes the published

AirspaceDataIncrementRetrievalReplyMessage.

17.4.2.9. NAT Tracks Publication

Last updated: 27.0 - Edition 3

17.4.2.9.1. Description

1. NAT Tracks are used to fly over the Atlantic Ocean. They are published daily by Shanwick
Center.

a. The Daytime - Westbound OTS NAT tracks are available between 11:30 - 19:00. The most
northerly starts with designator 'A'.

b. The Nighttime - Eastbound OTS NAT tracks are available between 01:00 - 08:00. The most
southerly start with the designator 'Z'.

2. The same NAT track (same UUID) may change shape over different days. For example one day it
may be composed of some segments, and another day of other segments. In other words, the
same segment may be used in the NAT track in one day, and not used in another day, and then
used again.

This creates a conceptual problem: when a RouteSegment is not used in any NAT track, it still
continues to exist in the NM system with its own UUID and it may become part of a NAT track
later in the future. This behaviour must be reflected in the exported feature lifetime. A feature

Edition: 27.0 6 439

Document Title: NM 27.0 - NM B2B Reference Manual

cannot have holes in its lifetime (this would also cause problems in the computation of
PERMDELTAs). So rather than omitting timeslices, the chosen solution was to always export the
RouteSegment timeslices as follows:

a. when the RouteSegment is in use, i.e. it is part of a NAT track, a new timeslice is created with a
reference to the route (attribute routeFormed) and its availability;

b. when the RouteSegment is not in use, i.e. it is not part of any NAT tracks, a new timeslice is
created without a reference to any NAT track (attribute routeFormed omitted or null) and
with no availability;

This behaviour should also be quite intuitive because it reflects the reality.

3. The availability of a RouteSegment corresponds to the NAT Signal Period, which is as follows:

For Westbound:

a. lifetime from 19:00 till 19:00

b. NAT Signal Period from 11:30 till 19:00

For Eastbound:

c. lifetime from 08:00 till 8:00

d. NAT Signal Period from 01:00 till 08:00

17.4.2.9.2. Publication

Edition: 27.0 6 440

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 18. AIXM features and objects used to publish the NAT Tracks

Published Routes

1. The attribute Route.name contains the ICAO id of the OTS route (e.g. NATZ)

2. The attribute Route.type is set to NAT.

Published Route Segments

Route segments tend to have many timeslices towards the end of an AIRAC
CAUTION
cycle. Potentially they may have up to 1 timeslice per day.

1. Each RouteSegment feature is exported with following contents:

a. start - the route segment start point

b. end - - the route segment end point

c. routeFormed - the reference to the NAT track when the segment is in use

d. availability - the route segment availability exported with following contents

i. direction is set to FORWARD

ii. status is set to OPEN

iii. timeInterval is populated as follows:

▪ timeReference is set to UTC

Edition: 27.0 6 441

Document Title: NM 27.0 - NM B2B Reference Manual

▪ day is set to ANY

▪ exluded is set to NO

▪ extension is set to adr:TimesheetExtension with validPeriod as a gml:TimePeriod

Edition: 27.0 6 442

Document Title: NM 27.0 - NM B2B Reference Manual

Example 71. NAT Tracks Publication

<adrmsg:ADRMessage
gml:id="ID_51_1352812234877_1"
xmlns:adrmsg="http://www.eurocontrol.int/cfmu/b2b/ADRMessage"
xmlns:adr="http://www.aixm.aero/schema/5.1.1/extensions/EUR/ADR"
xmlns:gml="http://www.opengis.net/gml/3.2"
xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
xmlns:xlink="http://www.w3.org/1999/xlink">
<adrmsg:hasMember>
<aixm:Route gml:id="ID_40_1377648348105_74">
<gml:identifier codeSpace="urn:uuid:">6b2791d6-c61d-4d8a-8fef-
eb74b4bd07e3</gml:identifier>
<aixm:timeSlice>
<aixm:RouteTimeSlice gml:id="ID_40_1377648348105_75">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_76">
<gml:beginPosition>2013-07-25T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_40_1377648348105_77">
<gml:beginPosition>2013-07-25T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:name>NATZ</aixm:name>
<aixm:type>NAT</aixm:type>
</aixm:RouteTimeSlice>
</aixm:timeSlice>
</aixm:Route>
</adrmsg:hasMember>
<adrmsg:hasMember>
<aixm:RouteSegment gml:id="ID_40_1377648348105_78">
<gml:identifier
codeSpace="urn:uuid:">Route_6b2791d6-c61d-4d8a-8fef-eb74b4bd07e3.
51855585-f528-41f1-b254-4b7c139d46a8.
2ca64b3c-535f-47f0-a57f-adb3cda37600</gml:identifier>
<aixm:timeSlice>
<aixm:RouteSegmentTimeSlice gml:id="ID_40_1377648348105_79">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_80">
<gml:beginPosition>2013-07-24T08:00:00</gml:beginPosition>
<gml:endPosition>2013-07-25T08:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>

Edition: 27.0 6 443

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_40_1377648348105_81">
<gml:beginPosition>2013-07-24T08:00:00</gml:beginPosition>
<gml:endPosition>2013-07-25T08:00:00</gml:endPosition>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:start>
<aixm:EnRouteSegmentPoint gml:id="ID_40_1377648348105_82">
<!--YQX -->
<aixm:pointChoice_fixDesignatedPoint
xlink:href="urn:uuid:51855585-f528-41f1-b254-4b7c139d46a8"/>
</aixm:EnRouteSegmentPoint>
</aixm:start>
<aixm:routeFormed xlink:href="urn:uuid:024bb6f8-3265-472a-9988-
c765f519bcef"/>
<aixm:end>
<aixm:EnRouteSegmentPoint gml:id="ID_40_1377648348105_83">
<!-- KOBEV -->
<aixm:pointChoice_fixDesignatedPoint
xlink:href="urn:uuid:2ca64b3c-535f-47f0-a57f-adb3cda37600"/>
</aixm:EnRouteSegmentPoint>
</aixm:end>
<aixm:availability>
<aixm:RouteAvailability gml:id="ID_40_1377648348105_84">
<!-- Timesheet -->
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_50_1352812184610_10_1">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adr:TimesheetExtension gml:id="ID_50_1352812184610_10_2">
<gml:validTime>
<gml:TimePeriod gml:id="ID_40_1377648348105_83">
<gml:beginPosition>2013-07-
25T01:00:00</gml:beginPosition>
<gml:endPosition>2013-07-25T08:00:00</gml:endPosition>
</gml:TimePeriod>
</gml:validTime>
</adr:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:direction>FORWARD</aixm:direction>
<aixm:status>OPEN</aixm:status>
</aixm:RouteAvailability>
</aixm:availability>
</aixm:RouteSegmentTimeSlice>
</aixm:timeSlice>
</aixm:RouteSegment>

Edition: 27.0 6 444

Document Title: NM 27.0 - NM B2B Reference Manual

</adrmsg:hasMember>
<!-- other RouteSegments -->
</adrmsg:ADRMessage>

17.4.2.10. Airport/Heliport without ICAO/IATA Designator

17.4.2.10.1. Description

1. In order to support future VFR flight plan processing, airports/heliports without ICAO/IATA
designators are published.

17.4.2.10.2. Publication

1. For an airport/heliport without ICAO designator, the ADR-E nmDesignator is set to the 4
uppercase alphabetic characters internal NM identifier.

Edition: 27.0 6 445

Document Title: NM 27.0 - NM B2B Reference Manual

Example 72. Aerodrome EG00 Publication

<?xml version="1.0"?>
<adrmsg:hasMember>
<aixm:AirportHeliport xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_16_1504675130924_8521">
<gml:identifier codeSpace="urn:uuid:">f7832ed8-e3d5-4d55-a5ab-
1fdf57a186b9</gml:identifier>
<aixm:timeSlice>
<aixm:AirportHeliportTimeSlice gml:id="ID_16_1504675130924_8522">
<gml:validTime>
<gml:TimePeriod gml:id="ID_16_1504675130924_8523">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_16_1504675130924_8524">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>EB004</aixm:designator>
<aixm:name>SOVET</aixm:name>
<aixm:controlType>CIVIL</aixm:controlType>
<aixm:servedCity>
<aixm:City gml:id="ID_16_1504675130924_8525">
<aixm:name>SOVET</aixm:name>
</aixm:City>
</aixm:servedCity>
<aixm:ARP>
<aixm:ElevatedPoint gml:id="ID_16_1504675130924_8526">
<gml:pos srsName="urn:ogc:def:crs:EPSG::4326">55.86666488647461
-4.333333492279053</gml:pos>
<aixm:elevation uom="FT">0</aixm:elevation>
</aixm:ElevatedPoint>
</aixm:ARP>
<aixm:extension>
<adrext:AirportHeliportExtension ...>
<adrext:defaultTaxiTime uom="MIN">15</adrext:defaultTaxiTime>
<adrext:nmDesignator>EB04</adrext:nmDesignator>
</adrext:AirportHeliportExtension>
</aixm:extension>
</aixm:AirportHeliportTimeSlice>
</aixm:timeSlice>
</aixm:AirportHeliport>
</adrmsg:hasMember>

Edition: 27.0 6 446

Document Title: NM 27.0 - NM B2B Reference Manual

17.4.2.11. Restrictions Publication

17.4.2.11.1. FlightRestriction with FlightConditionElementChoice being AircraftCharacteristic as defined in

ICAO 2012

Description

1. In ICAO 2012 the content of some fields of the flight plan message changed, describing the
precise NAV/COM/SUR capabilities of the flight.

2. This information is now used to determine whether an aircraft can or can not operate in an
airspace.

3. The density of traffic in certain locations requires restrictions on the communication,

navigation, and surveillance capabilities of aircraft traversing them. Therefore, NM will now
prevent aircraft from flying through locations where they are not properly equipped to operate
based on communication, navigation, and surveillance capabilities.

4. Complicated manoeuvres or terrain shapes (Mountains) require restrictions on the PBN

capabilities required to use SIDs and STARs.

Example 73. Operational goal of the FlightRestriction

EDDF EMPAX STARS COMPULSORY FOR TRAFFIC TYPE RNAV VIA SONOM

Publication

1. AIXM didn’t follow the pace with ICAO 2012; as a result, the Aircraft Capability model within
AIXM is not rich enough to represent the full set of Aircraft Capabilities.

2. AIXM provides an easy extension mechanism to support enumerates and values not yet catered
for.

3. XML/XSD can be extended using the codelist inline extension mechanism.

Example 74. Extension of CodeNavigationSpecificationBaseType

OTHER:____RNP_APCH_BARO_RNAV

4. FlightRestrictions can contain FlightCondtions on communication, navigation, and surveillance

capabilities of an Aircraft.

Edition: 27.0 6 447

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 19. FlightRestriction with combination of AircraftCharacteristic conditions

Edition: 27.0 6 448

Document Title: NM 27.0 - NM B2B Reference Manual

5. The navigation capabilities are expressed by a codelist inline extension of the

CodeNavigationEquipmentBaseType class.

Figure 20. Extension of the CodeNavigationEquipmentBaseType class

6. Mapping between ICAO 2012 navigation equipment capabilities and the extension of the
CodeNavigationEquipmentBaseType class:

Table 22. Navigation Equipment Mapping

ICAO Code AIXM Extended Code Description

A __ADR__GBAS_CAPABILIT GBAS capability

Y

B __ADR__LPV LPV capability

C __ADR__LORAN_C LORAN-C capability

D __ADR__DME DME capability

F __ADR__ADF ADF capability

G __ADR__GNSS GNSS capability

I __ADR__INERTIAL_NAVIG Inertial Navigation capability

ATION

K __ADR__MLS MLS capability

L __ADR__ILS ILS capability

O __ADR__VOR VOR capability

T __ADR__TACAN TACAN capability

Edition: 27.0 6 449

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO Code AIXM Extended Code Description

W __ADR__RVSM_APPROVED RVSM capability

X __ADR__MNPS_APPROVED MNPS capability

7. The communication capabilities are expressed by an AIXM ADR extension of the

CodeCommunicationModeBaseType class.

Figure 21. Extension of the CodeCommunicationModeBaseType class

8. Mapping between ICAO 2012 communication capabilities and the extension of the
CodeCommunicationModeBaseType class:

Table 23. Communication Equipment Mapping

ICAO Code AIXM Extended Code Description

J1 __ADR__CPDLC_ATN_VDL_ Controller Pilot Data Link Communications ATN VDL

MODE_2 Mode 2

J2 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_HFDL HFDL

J3 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_VDL_MODE_A VDL Mode A

J4 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_VDL_MODE_2 VDL MODE 4 capability

J5 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_SATCOM_INMARSAT SATCOM (INMARSAT)

Edition: 27.0 6 450

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO Code AIXM Extended Code Description

J6 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_SATCOM_MTSAT SATCOM (MTSAT)

J7 __ADR__CPDLC_FANS_1_A Controller Pilot Data Link Communications FANS 1/A

_SATCOM_IRIDIUM SATCOM (Iridium)

E1 __ADR__FMC_WPR_ACARS Flight Management Computer Waypoint Reporting

Aircraft Communications Addressing and Reporting
System

E2 __ADR__DFIS_ACARS Digital-Flight Information Services Aircraft

Communications Addressing and Reporting System

E3 __ADR__ACARS_OVER_AV ACARS over AVLC

LC

H __ADR__HF_RTF Hi frequency Radio Transmission Frequency

M1 __ADR__ATC_RTF_SATCO Aeronautical Telecommunication Network RTF

M_INMARSAT INMARSAT

M2 __ADR__ATC_RTF_MTSAT Aeronautical Telecommunication Network RTF

MTSAT

M3 __ADR__ATC_RTF_IRIDIU Aeronautical Telecommunication Network RTF

M Iridium

P1 __ADR__RCP_1 (Reserved) Required Communications Performance

P2 __ADR__RCP_2 (Reserved) Required Communications Performance

P3 __ADR__RCP_3 (Reserved) Required Communications Performance

P4 __ADR__RCP_4 (Reserved) Required Communications Performance

P5 __ADR__RCP_5 (Reserved) Required Communications Performance

P6 __ADR__RCP_6 (Reserved) Required Communications Performance

P7 __ADR__RCP_7 (Reserved) Required Communications Performance

P8 __ADR__RCP_8 (Reserved) Required Communications Performance

P9 __ADR__RCP_9 (Reserved) Required Communications Performance

U __ADR__UHF_RTF Ultra-High frequency Radio Transmission Frequency

V __ADR__VHF_RTF Very High frequency Radio Transmission Frequency

Y __ADR__VHF_WITH_8_33_ 8.33 KHz equipment status

KHZ_CHANNEL_SPACING
_CAPABILITY

S __ADR__STANDARD_EQUI Standard communication and navigation equipment

PMENT

9. The surveillance capabilities are expressed by a codelist inline extension of the

CodeTransponderBaseType class.

Edition: 27.0 6 451

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 22. Extension of the CodeTransponderBaseType class

10. Mapping between ICAO 2012 surveillance capabilities and the extension of the
CodeTransponderBaseType class:

Table 24. Surveillance Equipment Mapping

ICAO Code AIXM Extended Code Description

A __ADR__MODE_A Transponder Mode A (4 digits - 4096 codes)

B1 __ADR__ADS_B_1090MHZ_ ADS-B with dedicated 1090 MHz ADS-B 'out' capability

ADS_B_OUT

B2 __ADR__ADS_B_1090MHZ_ ADS-B with dedicated 1090 MHz ADS-B 'out' and 'in'
ADS_B_OUT_IN capability

C __ADR__MODE_A_AND_C Transponder Mode A (4 digits - 4096 codes) and Mode

C

D1 __ADR__ADS_C_FANS_1A ADS-C with FANS 1/A capabilities

G1 __ADR__ADS_C_ATN ADS-C with ATN capabilities

E __ADR__MODE_S_ID_PRES Transponder Mode S, including aircraft identification

SURE_EXTENDED_SQUITT transmission, pressure-altitude transmission and
ER extended squitter (ADS-B) capability

H __ADR__MODE_S_ID_PRES Transponder Mode S, including aircraft identification

SURE_ENHANCED_SURVE transmission, pressure-altitude transmission and
ILLANCE enhanced surveillance capability

I __ADR__MODE_S_ID_NO_P Transponder Mode S, including aircraft identification

RESSURE transmission, but no pressure-altitude capability

Edition: 27.0 6 452

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO Code AIXM Extended Code Description

L __ADR__MODE_S_ID_PRES Transponder Mode S, including aircraft identification

SURE_EXT_SQUITTER_EN transmission, pressure-altitude transmission,
HANCED_SURVL extended squitter (ADS-B) capability and enhanced
surveillance capability

S __ADR__MODE_S Transponder Mode S, including both pressure-

altitude and aircraft identification capability

P __ADR__MODE_S_NO_ID_P Transponder Mode S, including pressure-altitude

RESSURE transmission, but no aircraft identification capability

X __ADR__MODE_S_NO_ID_ Transponder Mode S without both aircraft

NO_PRESSURE identification and pressure-altitude capability

U1 __ADR__ADS_B_OUT_UAT ADS-B 'out' capability using UAT

U2 __ADR__ADS_B_OUT_IN_U ADS-B 'out' and 'in' capability using UAT

AT

V1 __ADR__ADS_B_OUT_VDL_ ADS-B 'out' capability using VDL Mode 4

MODE_4

V2 __ADR__ADS_B_OUT_IN_V ADS-B 'out' and 'in' capability using VDL Mode 4

DL_MODE_4

11. The navigation specification capabilities are expressed by an AIXM ADR extension of the
CodeNavigationSpecificationBaseType class.

Figure 23. Extension of the CodeNavigationSpecificationBaseType class

Edition: 27.0 6 453

Document Title: NM 27.0 - NM B2B Reference Manual

12. Mapping between ICAO 2012 navigation specification capabilities and the extension of the
CodeNavigationSpecificationBaseType class:

Table 25. Navigation Specification Mapping

ICAO Code AIXM Extended Code Description

A1 __ADR__RNAV_10 RNAV 10 (RNP 10) capability

B1 __ADR__RNAV_5_ALL_PER RNAV 5 all permitted sensors capability

MITTED_SENSORS

B2 __ADR__RNAV_5_GNSS RNAV 5 GNSS capability

B3 __ADR__RNAV_5_DME_D RNAV 5 DME DME capability

ME

B4 __ADR__RNAV_5_VOR_DM RNAV 5 VOR DME capability

E

B5 __ADR__RNAV_5_INS_OR_I RNAV 5 INS or IRS capability

RS

B6 __ADR__RNAV_5_LORANC RNAV 5 LORAN C capability

C1 __ADR__RNAV_2_ALL_PER RNAV 2 all permitted sensors capability

MITTED_SENSORS

C2 __ADR__RNAV_2_GNSS RNAV 2 GNSS capability

C3 __ADR__RNAV_2_DME_D RNAV 2 DME DME capability

ME

C4 __ADR__RNAV_2_DME_D RNAV 2 DME DME IRU capability

ME_IRU

D1 __ADR__RNAV_1_ALL_PER RNAV 1 all permitted sensors capability

MITTED_SENSORS

D2 __ADR__RNAV_1_GNSS RNAV 1 GNSS capability

D3 __ADR__RNAV_1_DME_D RNAV 1 DME DME capability

ME

D4 __ADR__RNAV_1_DME_D RNAV 1 DME DME IRU capability

ME_IRU

L1 __ADR__RNP4 RNP associated with operations in oceanic and

remote continental airspaces

O1 __ADR__BASIC_RNP_1_AL Basic RNP 1 all permitted sensors capability

L_PERMITTED_SENSORS

O2 __ADR__BASIC_RNP_1_GN Basic RNP 1 GNSS capability

SS

O3 __ADR__BASIC_RNP_1_DM Basic RNP 1 DME DME capability

E_DME

Edition: 27.0 6 454

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO Code AIXM Extended Code Description

O4 __ADR__BASIC_RNP_1_DM Basic RNP 1 DME DME IRU capability

E_DME_IRU

S1 __ADR__RNP_APCH RNP APCH capability

S2 __ADR__RNP_APCH_WITH RNP APCH with BARO VNAV capability

_BARO_VNAV

T1 __ADR__RNP_AR_APCH_W RNP AR APCH with RF capability

ITH_RF

T2 __ADR__RNP_AR_APCH_W RNP AR APCH without RF capability

ITHOUT_RF

13. FlightConditionCombination can be defined between AircraftCharateristics. The logical

operators supported are:

◦ OR

◦ AND

◦ NOT

14. The NOT logical operator has been defined as a codelist inline extension of the
CodeFlowConditionOperationBaseType class.

Edition: 27.0 6 455

Document Title: NM 27.0 - NM B2B Reference Manual

Example 75. Restriction LO5509A Publication

<?xml version="1.0"?>
<adrmsg:hasMember>
<aixm:FlightRestriction ...>
<gml:identifier codeSpace="urn:uuid:">e7ed96c2-ced2-4b77-900e-
d4f33db82674</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_45_1488621985525_536433">
<gml:validTime>
<gml:TimePeriod gml:id="ID_45_1488621985525_536434">
<gml:beginPosition>2015-10-15T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_45_1488621985525_536435">
<gml:beginPosition>2015-10-15T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>LO5509A</aixm:designator>
<aixm:type>MANDATORY</aixm:type>
<aixm:instruction>APP 5 SBG$COMPULSORY FOR TRAFFIC
TYPE NON RNAV</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_45_1488621985525_536436">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_45_1488621985525_536437">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_45_1488621985525_536439">
<gml:beginPosition>2015-10-
15T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>

Edition: 27.0 6 456

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:element>
<aixm:FlightConditionElement gml:id="ID_45_1488621985525_536440">
<aixm:flightCondition_airportHeliportCondition ...>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_45_1488621985525_536441">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>ARR</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_45_1488621985525_536442">
<aixm:flightCondition_operand>
<aixm:FlightConditionCombination
gml:id="ID_45_1488621985525_536443">
<aixm:logicalOperator>OR</aixm:logicalOperator>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_45_1488621985525_536444">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_45_1488621985525_536445">

<aixm:navigationSpecification>OTHER:__ADR__RNAV_5_ALL_PERMITTED_SENSORS
</aixm:navigationSpecification>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_45_1488621985525_536446">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_45_1488621985525_536447">

<aixm:navigationSpecification>OTHER:__ADR__RNAV_5_GNSS
</aixm:navigationSpecification>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_45_1488621985525_536448">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_45_1488621985525_536449">

Edition: 27.0 6 457

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:navigationSpecification>OTHER:__ADR__RNAV_5_DME_DME
</aixm:navigationSpecification>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_45_1488621985525_536450">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_45_1488621985525_536451">

<aixm:navigationSpecification>OTHER:__ADR__RNAV_5_VOR_DME
</aixm:navigationSpecification>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_45_1488621985525_536452">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_45_1488621985525_536453">

<aixm:navigationSpecification>OTHER:__ADR__RNAV_5_INS_OR_IRS
</aixm:navigationSpecification>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flightCondition_operand>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
<aixm:FlightRestrictionRoute gml:id="ID_45_1488621985525_536454">
<aixm:routeElement>
<aixm:FlightRoutingElement gml:id="ID_45_1488621985525_536455">
<aixm:orderNumber>1</aixm:orderNumber>
<aixm:pointElement_navaidSystem ...>
</aixm:FlightRoutingElement>
</aixm:routeElement>
</aixm:FlightRestrictionRoute>
</aixm:regulatedRoute>
<aixm:annotation>

Edition: 27.0 6 458

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:Note gml:id="ID_45_1488621985525_536456">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_45_1488621985525_536457">
<aixm:note>RNAV EQUIPPED FLIGHTS SHALL FILE VIA PUBLISHED
STAR</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

17.4.2.11.2. Multiple Dependent Applicabilities

Last updated: 27.0 - Edition 5

Description

1. A restriction might depend on a CDR that passes through more than one danger area and that
can be activated independently of each other.

Publication

1. NM publishes multiple DependentApplicabilities in all possible AND/OR combinations.

2. The publication of multiple DependentApplicabilities is performed within the standard AIXM

XML Schema. No AIXM extension has been used.

Multiple Dependent Applicabilities

Edition: 27.0 6 459

Document Title: NM 27.0 - NM B2B Reference Manual

Edition: 27.0 6 460

Document Title: NM 27.0 - NM B2B Reference Manual

Example 76. Multiple Dependent Applicabilities Publication

The FlightRestriction EBED5000A has dependent applicability associations with the

Airspaces EBTRANA and EBTRANB

<?xml version="1.0" encoding="UTF-8"?>

<adrmsg:ADRMessage ...>
<adrmsg:hasMember>
<aixm:FlightRestriction ...>
<gml:identifier codeSpace="urn:uuid:">7406424d-5212-48a5-bd66-
cf346aaae8e9</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_6_1489090835692_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_6_1489090835692_4">
<gml:beginPosition>2017-03-02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_6_1489090835692_5">
<gml:beginPosition>2017-03-02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>EBED5000A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>NETEX DCT DELOM APP4$ONLY AVAILABLE FOR TRAFFIC
DEP EDDL/LV
WITH ARR PARIS GROUP
WITH RFL ABOVE FL195
SEE AUP/UUP/AIP</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_6_1489090835692_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_6_1489090835692_7">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_6_1489090835692_9">
<gml:beginPosition>2017-03-
02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>

Edition: 27.0 6 461

Document Title: NM 27.0 - NM B2B Reference Manual

</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_6_1489090835692_10">
<aixm:flightCondition_directFlightCondition>
<aixm:DirectFlightSegment gml:id="ID_6_1489090835692_11">
<aixm:end_fixDesignatedPoint
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:69871243-17e0-4214-9d2d-
fd13a9de58b4"/>
<aixm:start_fixDesignatedPoint
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:8ac259c8-65e9-4d18-ad00-
283121ecd6d4"/>
</aixm:DirectFlightSegment>
</aixm:flightCondition_directFlightCondition>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_6_1489090835692_12">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>
XNG</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
<aixm:flightLevel>
<aixm:FlightRestrictionLevel gml:id=
"ID_6_1489090835692_13">
<aixm:upperLevel uom="FL">245</aixm:upperLevel>
<aixm:upperLevelReference>STD</aixm:upperLevelReference>
<aixm:lowerLevel uom="FL">105</aixm:lowerLevel>
<aixm:lowerLevelReference>STD</aixm:lowerLevelReference>
</aixm:FlightRestrictionLevel>
</aixm:flightLevel>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_6_1489090835692_14">
<aixm:flightCondition_airspaceCondition
xmlns:xlink="http://www.w3.org/1999/xlink"
link:href="urn:uuid:d8bcbdba-b993-4953-9ec5-
b8d6e21ae651"/>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_6_1489090835692_15">
<aixm:referenceLocation>YES</aixm:referenceLocation>

Edition: 27.0 6 462

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:relationWithLocation>
ACT</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_6_1489090835692_16">
<aixm:flightCondition_airspaceCondition
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:e90918d9-0ce1-4db2-a870-
e370a3d83048"/>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_6_1489090835692_17">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>
ACT</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
<aixm:FlightRestrictionRoute gml:id="ID_6_1489090835692_18">
<aixm:routeElement>
<aixm:FlightRoutingElement gml:id="ID_6_1489090835692_19">
<aixm:orderNumber>1</aixm:orderNumber>
<aixm:pointElement_fixDesignatedPoint
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:8ac259c8-65e9-4d18-ad00-
283121ecd6d4"/>
</aixm:FlightRoutingElement>
</aixm:routeElement>
</aixm:FlightRestrictionRoute>
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_6_1489090835692_20">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_6_1489090835692_21">
<aixm:note>BETTER FLIGHT PLANNING
WHEN EBTRANA/EBTRANB/ EBTRASB NOT ACTIVE</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>

Edition: 27.0 6 463

Document Title: NM 27.0 - NM B2B Reference Manual

<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>
</adrmsg:ADRMessage>

17.4.2.11.3. FlightRestriction Conditions Based on Flight Special Status for a Flight Plan

Description

1. Currently NM operators have to manually exempt from restrictions aircraft with certain Special
Status and/or Flight Type.

2. It is a common use case not to restrict aircraft with certain Flight Special Status (Medical
Evacuation, Fire Fighting ).

3. For humanitarian or for defence reasons these aircraft should automatically be able to skip
certain restrictions.

4. The Flight Special Status represents the reason for special handling by ATS.

5. The Flight Special Status can be provided via the ICAO/ADEXP field STS.

6. Example: -STS STATE (ADEXP)

Publication

1. FlightRestrictions can contain FlightConditions based on Flight Special Status.

2. In AIXM the Flight Special Status is defined by the class CodeFlightStatusBaseType .

3. This class has been extended to express the full ICAO possibilities.

4. AIXM provides an easy extension mechanism to support enumerates and values not yet catered
for.

5. XML/XSD can be extended using the codelist inline extension mechanism.

Example: OTHER:__ADR__ALTRV

6. Here is the description of the CodeFlightStatusBaseType class.

Edition: 27.0 6 464

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 24. Extension of the CodeFlightStatusBaseType class

7. Mapping between ICAO flight special status and the extension of the CodeFlightStatusBaseType
class:

Table 26. Flight Special Status Mapping

ICAO Code AIXM Extended Code Description

ALTRV __ADR__ALTRV The ALTRV descriptor indicates a flight operating in

accordance with an altitude reservation.

ATFMX __ADR__ATFMX The ATFMX descriptor shall be used for a flight

approved for exemption from flow regulations by the
appropriate ATS authority.

FFR __ADR__FFR The FFR descriptor indicates a flight engaged in a

fire-fighting mission.

FLTCK __ADR__FLTCK The FLTCK descriptor indicates a flight check for

calibration of navaids.

HAZMAT __ADR__HAZMAT The HAZMAT descriptor indicates a flight carrying

hazardous material.

MARSA __ADR__MARSA The MARSA descriptor indicates a flight for which a

military entity assumes responsibility for separation
of military aircraft.

MEDEVAC __ADR__MEDEVAC The MEDEVAC descriptor indicates a flight for a life

critical emergency evacuation.

Edition: 27.0 6 465

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO Code AIXM Extended Code Description

NONRVSM __ADR__NONRVSM The NONRVSM descriptor indicates a non-RVSM

capable flight intending to operate in RVSM airspace.

Edition: 27.0 6 466

Document Title: NM 27.0 - NM B2B Reference Manual

Example 77. Restriction LF5545A

Short description:

Designator = LF5545A
Type = FORBID
Instruction = APP5 LFPN/PO/PV DCT EVX/LGL/MTD/NIPOR$
BELOW FL115 AND NON RNAV ONLY
ProcessingIndicator = TFR
Enabled = True
Usage = OPERATIONAL
isFUA = False
fuaDefaultActive = False
temporality = BASELINE
validbegintime = 2017-08-17T00:00:00
validendtime = 9999-12-31T23:59:59
featurebegintime = 2017-08-17T00:00:00
featureendtime = 9999-12-31T23:59:59
Excluding ANY 00:00 UTC - 24:00 UTC from 2017-08-17T00:00:00 until unknown
(
(
Crossing Navaid urn:uuid:eaebccf2-c78b-4420-a450-f30fa9516a03
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing Navaid urn:uuid:fc7b1c60-5743-41ce-9913-9f7c9077a47c
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing Navaid urn:uuid:f6bbebc2-9edc-4f74-881d-41979412b3ec
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing DesignatedPoint NIPOR between lower 115 FL ref STD upper UNL FT ref
STD
)
)
AND
(
Flight status HOSP
)

XML publication:

<?xml version="1.0" encoding="UTF-8"?>

Edition: 27.0 6 467

Document Title: NM 27.0 - NM B2B Reference Manual

<adrmsg:ADRMessage ...>
<adrmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_208_1504080504557_2">
<gml:identifier codeSpace="urn:uuid:">376a2072-baca-44a0-9ef1-
f384013eb663</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_208_1504080504557_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_208_1504080504557_4">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_208_1504080504557_5">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>LF5545A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>APP5 LFPN/PO/PV DCT EVX/LGL/MTD/NIPOR$
BELOW FL115 AND NON RNAV ONLY</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_208_1504080504557_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_208_1504080504557_7">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_208_1504080504557_9">
<gml:beginPosition>2017-08-
17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>
<aixm:element>
...

Edition: 27.0 6 468

Document Title: NM 27.0 - NM B2B Reference Manual

</aixm:element>
<!-- START: New flight condition based on the Flight Special
Status -->
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_208_1504080504557_24">
<aixm:flightCondition_flight>
<aixm:FlightCharacteristic gml:id=
"ID_208_1504080504557_25">
<aixm:status>HOSP</aixm:status>
</aixm:FlightCharacteristic>
</aixm:flightCondition_flight>
</aixm:FlightConditionElement>
</aixm:element>
<!-- END: New flight condition based on the Flight Special Status
-->
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
...
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_208_1504080504557_62">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_208_1504080504557_63">
<aixm:note>BELOW FL115 ONLY</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>
</adrmsg:ADRMessage>

Edition: 27.0 6 469

Document Title: NM 27.0 - NM B2B Reference Manual

17.4.2.11.4. FlightRestriction Conditions Based on the Aircraft Address (CODE) and/or the Aircraft
Registration (REG) Flight Plan Fields

Last updated: 27.0 - Edition 6

Description

1. The aircraft registration (REG) and CODE squawked by the MODE-S transponder of the aircraft
needs to be the same as the CODE present in the Flight Plan in order to automatically correlate
them in the Flight Plan Processing system. The presence of the CODE and REG fields in flight
plans is mandatory to cross specific reference locations (e.g. NAT region).

2. The ICAO EUR Regional Supplementary Procedures (Doc 7030) include a provision that makes it
mandatory to include the aircraft registration (REG) in FPLs for flights operating in RVSM
airspace (290FL to 410FL).

3. Example: -REG EIFNW (ADEXP) or REG/YLBAH (ICAO)

4. The field CODE is the aircraft address code in 24 bit or six hexadecimal characters. It is a unique
identification code programmed into the aircraft transponder or ABS-B transmitter during
installation. The code, expressed as six alphanumeric characters, provides a digital
identification of the aircraft. It is used by the air traffic system to link information contained in
the flight notification (notified flight plan) to the aircraft position information received by the
ADS-B.

Example: CODE/4B9688O (ICAO)

Publication

1. The Aircraft Address (CODE) and/or the Aircraft Registration (REG) flight plan fields of a
FlightRestriction Condition are published via the aircraftAddresses and aircraftRegistrations
properties of the AircraftCharacteristic extension:

Edition: 27.0 6 470

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 25. Extension of the AircraftCharacteristic class

2. The FlightCondition based on the aircraft addresses is expressed by the following regular
expression:

a. ([A-F0-9\*\?]){1,6}

b. Example: AF????

3. The FlightCondition based on the aircraft registrations is expressed by the following regular
expression:

a. ([A-Z0-9\?\*]){1,7}

b. Example: EI*

Edition: 27.0 6 471

Document Title: NM 27.0 - NM B2B Reference Manual

Example 78. Restriction LF5544A

Short description:

Designator = LF5544A
Type = FORBID
Instruction = APP 5 LFPG DCT ALIMO/EVX/LGL/MTD/NIPOR$
ONLY AVAILABLE FOR TRAFFIC
TYPE NON RNAV
WITH RFL BELOW FL115
ProcessingIndicator = TFR
Enabled = True
Usage = OPERATIONAL
isFUA = False
fuaDefaultActive = False
temporality = BASELINE
validbegintime = 2017-08-17T00:00:00
validendtime = 9999-12-31T23:59:59
featurebegintime = 2017-08-17T00:00:00
featureendtime = 9999-12-31T23:59:59
Excluding ANY 00:00 UTC - 24:00 UTC from 2017-08-17T00:00:00 until unknown
(
(
Crossing DesignatedPoint ALIMO between lower 115 FL ref STD upper UNL FT ref
STD
)
OR
(
Crossing Navaid urn:uuid:eaebccf2-c78b-4420-a450-f30fa9516a03
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing Navaid urn:uuid:fc7b1c60-5743-41ce-9913-9f7c9077a47c
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing Navaid urn:uuid:f6bbebc2-9edc-4f74-881d-41979412b3ec
between lower 115 FL ref STD upper UNL FT ref STD
)
OR
(
Crossing DesignatedPoint NIPOR between lower 115 FL ref STD upper UNL FT ref
STD
)
)
AND
(

Edition: 27.0 6 472

Document Title: NM 27.0 - NM B2B Reference Manual

Crossing Airspace LF between lower 115 FL ref STD upper UNL FT ref STD
)
AND
(
Aircraft aircraftAddresses AF????
)
AND
(
Aircraft aircraftRegistrations EI*w
)

XML publication:

<?xml version="1.0"?>
<adrmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_494_1504314076928_451499">
<gml:identifier codeSpace="urn:uuid:">b32e7a82-48ea-4a92-a53a-
332c9b366547</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_494_1504314076928_451500">
<gml:validTime>
<gml:TimePeriod gml:id="ID_494_1504314076928_451501">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_494_1504314076928_451502">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>LF5544A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>APP 5 LFPG DCT ALIMO/EVX/LGL/MTD/NIPOR$
ONLY AVAILABLE FOR TRAFFIC
TYPE NON RNAV
WITH RFL BELOW FL115</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id=
"ID_494_1504314076928_451503">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_494_1504314076928_451504">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>

Edition: 27.0 6 473

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_494_1504314076928_451506">
<gml:beginPosition>2017-08-
17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>
<aixm:element>
...
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id=
"ID_494_1504314076928_451527">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_494_1504314076928_451528">
<aixm:extension>
<adrext:AircraftCharacteristicExtension ...>
<adrext:aircraftAddresses>
AF????</adrext:aircraftAddresses>
</adrext:AircraftCharacteristicExtension>
</aixm:extension>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id=
"ID_494_1504314076928_451530">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_494_1504314076928_451531">
<aixm:extension>
<adrext:AircraftCharacteristicExtension ...>
<adrext:aircraftRegistrations>
EI*</adrext:aircraftRegistrations>
</adrext:AircraftCharacteristicExtension>
</aixm:extension>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>

Edition: 27.0 6 474

Document Title: NM 27.0 - NM B2B Reference Manual

</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
...
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_494_1504314076928_451548">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_494_1504314076928_451549">
<aixm:note>BELOW FL115 ONLY</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

17.4.2.11.5. FlightRestriction Conditions Based on Aircraft Operator Identification

Description

1. Airlines and airports have agreements on the terminal to be used. When there are special
circumstances that prevent a terminal of an airport from being used, the flight plan of the
airlines supposed to land in that terminal should be automatically invalidated.

2. NMOC receives requests from countries asking to forbid the overflying of their airspace by
certain Aircraft Operators.

3. NMOC should, after coordination with the relevant actors, be able to restrict flight plans based
on Aircraft Operator Identification (AO Id).

4. Example of flight plan fields associated to an AO id:

a. -AOARCID HOP

b. -AOOPR AFR

c. -ARCID HOP42LR

Edition: 27.0 6 475

Document Title: NM 27.0 - NM B2B Reference Manual

Publication

1. FlightRestrictions can contain FlightConditions based on Aircraft Operator Identification (AO

id.).

2. The FlightConditions uses the existing FlightConditionElement organisationCondition property

of type Organisation::OrganisationAuthority :

Figure 26. FlightConditions based on Aircraft Operator Identification

Edition: 27.0 6 476

Document Title: NM 27.0 - NM B2B Reference Manual

Example 79. Restriction LF5543A

Short description:

Designator = LF5543A
Type = FORBID
Instruction = APP 5 LFOB DCT EVX$
EVX (BELOW FL115 AND NON RNAV ONLY)
ProcessingIndicator = TFR
Enabled = True
Usage = OPERATIONAL
isFUA = False
fuaDefaultActive = False
temporality = BASELINE
validbegintime = 2017-08-17T00:00:00
validendtime = 9999-12-31T23:59:59
featurebegintime = 2017-08-17T00:00:00
featureendtime = 9999-12-31T23:59:59
Excluding ANY 00:00 UTC - 24:00 UTC from 2017-08-17T00:00:00 until unknown
(
(
Departing from AirportHeliport LFOB
)
SEQ
(
Crossing Navaid urn:uuid:eaebccf2-c78b-4420-a450-f30fa9516a03
)
)
AND
(
Crossing Airspace LF between lower 115 FL ref STD upper UNL FT ref STD
)
AND
(
Organisation urn:uuid:09e78910-e9a1-4f08-9a36-7a6c68aeacca
)

XML publication:

<?xml version="1.0" encoding="UTF-8"?>

<adrmsg:ADRMessage ...>
<adrmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_726_1504512846632_2">
<gml:identifier codeSpace="urn:uuid:">a82dc6eb-5604-4dbb-b0c2-
50c6f9d2190a</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_726_1504512846632_3">

Edition: 27.0 6 477

Document Title: NM 27.0 - NM B2B Reference Manual

<gml:validTime>
<gml:TimePeriod gml:id="ID_726_1504512846632_4">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_726_1504512846632_5">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>LF5543A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>APP 5 LFOB DCT EVX$
EVX (BELOW FL115 AND NON RNAV ONLY)</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_726_1504512846632_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_726_1504512846632_7">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_726_1504512846632_9">
<gml:beginPosition>2017-08-
17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>
<aixm:element>
...
</aixm:element>
<aixm:FlightConditionElement gml:id="ID_726_1504512846632_19">
<aixm:flightCondition_organisationCondition
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:09e78910-e9a1-4f08-9a36-7a6c68aeacca"/>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>

Edition: 27.0 6 478

Document Title: NM 27.0 - NM B2B Reference Manual

</aixm:flight>
<aixm:regulatedRoute>
...
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_726_1504512846632_23">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_726_1504512846632_24">
<aixm:note>BELOW FL115 ONLY</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>
</adrmsg:ADRMessage>

17.4.2.11.6. FlightRestriction Conditions Based on Flight Plan Source

Description

1. Flight conditions based on the Flight Plan Source will be used in combination with other Flight
condition types. Examples:

a. AOs do not known which REG will fly when they submit RPLs. The flight restriction we want
to express is: reject flight plans that contain aircraft with a navigation equipment W and
where the registration mark field must be present. To avoid this rejection the flight
restriction we want to express is:

i. FlightPlanSource is not RPL

ii. NavigationEquipment is W

iii. REG field presence is TRUE

b. It happens that AOs are massively rerouted when the flight plan processing system receives
FNM or MFS messages. The aircraft involved may have just exactly the enough calculated
fuel to the destination. In order to avoid this massive re-routing for these AOs and to

Edition: 27.0 6 479

Document Title: NM 27.0 - NM B2B Reference Manual

highlight these messages to the operator, the flight restriction we want to express is:

i. AO id is ELY

ii. FlightPlanSource is MFS or FNM

2. Example of flight plan field associated to a flight plan source:

a. SRC/RPL (ICAO)

b. -SRC AFP (ADEXP)

Publication

1. FlightRestrictions can contain FlightConditions based on Flight Plan Source.

2. The class FlightCharacteristic has been extended with a new property called flightPlanSource :

Figure 27. Extension of the FlightCharacteristic class

3. Two new classes CodeFlightPlanSourceBaseType and CodeFlightPlanSourceType have been

created in the NM AIXM extension.

Edition: 27.0 6 480

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 28. New class CodeFlightPlanSourceType

Edition: 27.0 6 481

Document Title: NM 27.0 - NM B2B Reference Manual

Example 80. Restriction LF5542A

Short description:

Edition: 27.0 6 482

Document Title: NM 27.0 - NM B2B Reference Manual

Designator = LF5542A
Type = FORBID
Instruction = APP 5 LFOB DCT ROU$
NOT AVAILABLE FOR TRAFFIC
DEP LFOB
EXCEPT DEST LFOH/OP/RG
ProcessingIndicator = TFR
Enabled = True
Usage = OPERATIONAL
isFUA = False
fuaDefaultActive = False
temporality = BASELINE
validbegintime = 2017-08-17T00:00:00
validendtime = 9999-12-31T23:59:59
featurebegintime = 2017-08-17T00:00:00
featureendtime = 9999-12-31T23:59:59

Excluding ANY 00:00 UTC - 24:00 UTC from 2017-08-17T00:00:00 until unknown
(
(
Crossing Navaid urn:uuid:725906e2-9a4f-442c-a3cd-e9e0e4418508
)
ANDNOT
(
(
Arriving at AirportHeliport LFOH
)
OR
(
Arriving at AirportHeliport LFOP
)
OR
(
Arriving at AirportHeliport LFRG
)
)
)
AND
(
Aircraft aircraftRegistrations EI*
)
AND
(
Flight flightPlanSource RPL
)
AND
(
Aircraft verticalSeparationCapability RVSM
)

Edition: 27.0 6 483

Document Title: NM 27.0 - NM B2B Reference Manual

XML publication:

<?xml version="1.0" encoding="UTF-8"?>

<adrmsg:ADRMessage ...>
<adrmsg:hasMember>
<aixm:FlightRestriction xmlns:aixm="http://www.aixm.aero/schema/5.1.1"
gml:id="ID_736_1504535716984_2">
<gml:identifier codeSpace="urn:uuid:">6a6074e8-f308-4dfe-a8e3-
c4ca57ce8a56</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_736_1504535716984_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_736_1504535716984_4">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_736_1504535716984_5">
<gml:beginPosition>2017-08-17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>LF5542A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>APP 5 LFOB DCT ROU$
NOT AVAILABLE FOR TRAFFIC
DEP LFOB
EXCEPT DEST LFOH/OP/RG</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_736_1504535716984_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_736_1504535716984_7">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_736_1504535716984_9">
<gml:beginPosition>2017-08-
17T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>

Edition: 27.0 6 484

Document Title: NM 27.0 - NM B2B Reference Manual

</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>
<aixm:element>
...
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_736_1504535716984_22">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_736_1504535716984_23">
<aixm:extension>
<adrext:AircraftCharacteristicExtension ...>
<adrext:registrationMarkPresence>
YES</adrext:registrationMarkPresence>
</adrext:AircraftCharacteristicExtension>
</aixm:extension>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_736_1504535716984_25">
<aixm:flightCondition_flight>
<aixm:FlightCharacteristic gml:id=
"ID_736_1504535716984_26">
<aixm:extension>
<adrext:FlightCharacteristicExtension ...>
<adrext:flightPlanSource>
RPL</adrext:flightPlanSource>
</adrext:FlightCharacteristicExtension>
</aixm:extension>
</aixm:FlightCharacteristic>
</aixm:flightCondition_flight>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_736_1504535716984_28">
<aixm:flightCondition_aircraft>
<aixm:AircraftCharacteristic
gml:id="ID_736_1504535716984_29">
<aixm:verticalSeparationCapability>
RVSM</aixm:verticalSeparationCapability>
</aixm:AircraftCharacteristic>
</aixm:flightCondition_aircraft>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flight>

Edition: 27.0 6 485

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:regulatedRoute>
...
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_736_1504535716984_33">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_736_1504535716984_34">
<aixm:note>NA</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>
</adrmsg:ADRMessage>

17.4.2.11.7. NM Flight Plan Processing Use of the FL/RFL RAD Flight Restrictions Flag

Last updated: 27.0 - Edition 3

Description

1. In RAD flight restrictions, RFL are sometimes entered into the textual descriptions of the RAD
document.

2. These Operational Instructions are for NM flight plan processing system operators to manually
ignore errors when the RFL complies with the textual description in the Restrictions.

3. In order to avoid repetitive and not useful task for operators, NM implements the possibility for
a RAD flight restriction to process the level compliance with both computed profile (FL) and
RFL.

4. Example:

a. Considering the following restriction EG5026 from RAD document:

i. Operational goal:

Edition: 27.0 6 486

Document Title: NM 27.0 - NM B2B Reference Manual

To provide an alternative routing ARR EGBB via MOSUN through military ATC. This
service is subject to no-notice withdrawal and traffic may be required to accept a tactical
re-route or re-file in such cases.

ii. Textual description: (in yellow we have a mention of RFL reference)

Only available for traffic ARR EGBB.

▪ Type Propeller Via STU With RFL below FL165 in EGTTFIR/UIR

▪ Via STU

▪ DEP GC??/LP?? Via STU

b. If we consider the following flight plan message:

(FPL-RFL012-IS
-AT76/M-SDGILRVY/S
-EIBT1200
-N0264F210 DCT NAVEM DCT SHA L9 SLANY/N0250F150 L9 BCN DCT MOSUN DCT GROVE
-EGBB0125 EGNX
-PBN/B1)

c. NM executes the following controls:

i. When the restriction is defined in CACD to use the fligh level (FL), the NM flight plan
processing system uses the calculated profile. The flight plan processing returns an error
like this one:

PROF204: RS: TRAFFIC VIA BCN MOSUN:F000..F245 IS ON FORBIDDEN ROUTE REF:[EG5026C]

BCN DCT MOSUN

i. When the restriction is defined in ENV to use the requested flight level (RFL), the NM flight
plan processing system uses the levels defined in the route field of the flight plan message.
The flight plan processing accepts the flight plan message.

Publication

1. The Vertical Limit Reference of a RAD FlightRestrictions is published via the

verticalLimitReference property of the FlightRestriction extension:

Edition: 27.0 6 487

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 29. Extension of the FlightRestriction class

2. Two new classes CodeVerticalLimitReferenceBaseType and CodeVerticalLimitReferenceType

have been created in the NM AIXM extension.

Edition: 27.0 6 488

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 30. New class CodeVerticalLimitReferenceType

Edition: 27.0 6 489

Document Title: NM 27.0 - NM B2B Reference Manual

Example 81. RAD FlightRestriction EG5026A

Short description

Designator = EG5026A
Type = FORBID
Instruction = BCN DCT MOSUN APP4$ONLY AVAILABLE FOR TRAFFIC ARR EGBB
1. (H24) TYPE PROPELLER VIA STU WITH RFL BELOW FL165 IN EGTTFIR/UIR
2.MON,FRI 17:00,09:00(16:00,08:00)FRI 17:00(16:00),MON 09:00(08:00)VIA STU
3.MON,FRI 09:00,10:00(08:00,09:00)DEP GC**/LP**VIA STU
ProcessingIndicator = TFR
Enabled = True
Usage = OPERATIONAL
isFUA = False
fuaDefaultActive = False
verticalLimitReference = CALCULATED
temporality = BASELINE
validbegintime = 2017-08-17T00:00:00
validendtime = 9999-12-31T23:59:59
featurebegintime = 2017-08-17T00:00:00
featureendtime = 9999-12-31T23:59:59

Excluding ANY 00:00 UTC - 24:00 UTC from 2017-08-17T00:00:00 until unknown
(
Crossing DirectFlightSegment MOSUN between lower GND FT ref MSL upper 245 FL
ref MSL
)
ANDNOT
(
(
Crossing Navaid urn:uuid:12740d55-530d-436f-b23e-6a05afb2204f
)
SEQ
(
Arriving at AirportHeliport EGBB
)
)

XML publication

<?xml version="1.0"?>
<adrmsg:hasMember>
<aixm:FlightRestriction ...>
<gml:identifier codeSpace="urn:uuid:">28f7a61a-0e33-4853-86db-
7229299a53e8</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_76_1504675228268_220079">
<gml:validTime>

Edition: 27.0 6 490

Document Title: NM 27.0 - NM B2B Reference Manual

<gml:TimePeriod gml:id="ID_76_1504675228268_220080">
<gml:beginPosition>2017-05-25T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_76_1504675228268_220081">
<gml:beginPosition>2017-05-25T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>EG5026A</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>BCN DCT MOSUN APP4$ONLY AVAILABLE FOR TRAFFIC ARR
EGBB
1. (H24) TYPE PROPELLER VIA STU WITH RFL BELOW FL165 IN EGTTFIR/UIR
2.MON,FRI 17:00,09:00(16:00,08:00)FRI 17:00(16:00),MON 09:00(08:00)VIA STU
3.MON,FRI 09:00,10:00(08:00,09:00)DEP GC**/LP**VIA STU</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_76_1504675228268_220082">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_76_1504675228268_220083">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_76_1504675228268_220085">
<gml:beginPosition>2017-05-
25T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>ANDNOT</aixm:logicalOperator>
...
</aixm:flight>
<aixm:regulatedRoute>
...
</aixm:regulatedRoute>
<aixm:annotation>
<aixm:Note gml:id="ID_76_1504675228268_220098">
<aixm:propertyName>instruction</aixm:propertyName>

Edition: 27.0 6 491

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_76_1504675228268_220099">
<aixm:note>TO PROVIDE AN ALTERNATIVE ROUTING ARR EGBB VIA MOSUN
THROUGH MILITARY ATC.
THIS SERVICE IS SUBJECT TO NO-NOTICE WITHDRAWAL AND TRAFFIC MAY
BE REQUIRED
TO ACCEPT A TACTICAL RE-ROUTE OR RE-FILE IN SUCH
CASES.</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

17.4.2.11.8. RAD Restriction - Dependent Applicability Can Apply to Traffic Not Crossing Referenced CDRs or
RSAs

Description

1. For restrictions with dependent applicability set to CDR(s) or RSA(s), the dependent applicability
should be considered valid even if traffic is not crossing the CDR(s) or RSA(s).

2. In other words, for the purpose of reducing the traffic management complexity, RSA activation
or CDR availability/unavailability should be able to re-route traffic not crossing the concerned
entities.

3. The dependant applicability based on RSA activation should be able to:

a. Use the RSA(s) as reference location taking into account the time and optionally the level
definitions set by the RSA(s) activation.

b. Use other entities than the RSA(s) as reference location but taking into account the time (as it
is now) and optionally the level definition set by the RSA(s) activation.

c. By optionally, it is meant that it must be possible for the user to take into account the level
information or not.

Edition: 27.0 6 492

Document Title: NM 27.0 - NM B2B Reference Manual

Example 82. Restriction EBR04Z depends on a RSA activation and its vertical limits

ID Number RSA Operational Goal

value

EBR04Z EBR04 EBR04 FL 030_120 FORBIDDEN OUTSIDE ACTIVATION

10:00_12:00

Figure 31. Restriction EBR04Z - on the map

Figure 32. Restriction EBR04Z - overall applicability

Edition: 27.0 6 493

Document Title: NM 27.0 - NM B2B Reference Manual

Example 83. Re-routed traffic not crossing the concerned RSA

1. Entry/Exit point A is forbidden for all flight levels if the destination is C

2. Entry/Exit point B is mandatory for destination C between FL100-FL200 at point B

Publication

1. The RAD FlightRestrictions can have dependent level applicability.

2. The class FlightRestriction has been extended with a new property called
dependentVerticalLimits :

Edition: 27.0 6 494

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 33. Extension of the FlightRestriction class

3. The property dependentVerticalLimits provided on the dependent applicability indicates if

there is a level dependency in addition to the time dependency.

The meaning of the property’s value is:

Table 27. Property dependentVerticalLimits

dependentVerticalLimits value Description

YES The FlightRestriction has dependent level

applicability. Time and Level dependency.

NO The FlightRestriction has no dependent level

applicability. Time dependency only

4. The dependent level applicability is only valid for reference location of type Airspace or Point.

Edition: 27.0 6 495

Document Title: NM 27.0 - NM B2B Reference Manual

Example 84. RAD Restriction EBR04Z Publication

<?xml version="1.0"?>
<adrmsg:hasMember>
<aixm:FlightRestriction ...>
<gml:identifier codeSpace="urn:uuid:">80baa235-6fef-4159-91b6-
84933875a29e</gml:identifier>
<aixm:timeSlice>
<aixm:FlightRestrictionTimeSlice gml:id="ID_64_1507215112982_13284">
<gml:validTime>
<gml:TimePeriod gml:id="ID_64_1507215112982_13285">
<gml:beginPosition>2017-09-14T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_64_1507215112982_13286">
<gml:beginPosition>2017-09-14T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:designator>EBR04Z</aixm:designator>
<aixm:type>FORBID</aixm:type>
<aixm:instruction>EBR04 FL 030_120 FORBIDDEN OUTSIDE ACTIVATION
10:00_12:00</aixm:instruction>
<aixm:flight>
<aixm:FlightConditionCombination gml:id="ID_64_1507215112982_13287">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_64_1507215112982_13288">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>ANY</aixm:day>
<aixm:startTime>00:00</aixm:startTime>
<aixm:endTime>24:00</aixm:endTime>
<aixm:excluded>NO</aixm:excluded>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_64_1507215112982_13290">
<gml:beginPosition>2017-09-
14T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:logicalOperator>AND</aixm:logicalOperator>

Edition: 27.0 6 496

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:element>
<aixm:FlightConditionElement gml:id="ID_64_1507215112982_13291">
<aixm:flightCondition_airspaceCondition .../>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_64_1507215112982_13292">
<aixm:referenceLocation>YES</aixm:referenceLocation>
<aixm:relationWithLocation>XNG</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
</aixm:FlightConditionElement>
</aixm:element>
<aixm:element>
<aixm:FlightConditionElement gml:id="ID_64_1507215112982_13293">
<aixm:flightCondition_operand>
<aixm:FlightConditionCombination
gml:id="ID_64_1507215112982_13294">
<aixm:logicalOperator>
OTHER:__ADR__NOT</aixm:logicalOperator>
<aixm:element>
<aixm:FlightConditionElement
gml:id="ID_64_1507215112982_13295">
<aixm:flightCondition_airspaceCondition ..../>
<aixm:operationalCondition>
<aixm:FlightConditionCircumstance
gml:id="ID_64_1507215112982_13296">
<aixm:referenceLocation>
YES</aixm:referenceLocation>
<aixm:relationWithLocation>
ACT</aixm:relationWithLocation>
</aixm:FlightConditionCircumstance>
</aixm:operationalCondition>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flightCondition_operand>
</aixm:FlightConditionElement>
</aixm:element>
</aixm:FlightConditionCombination>
</aixm:flight>
<aixm:regulatedRoute>
<aixm:FlightRestrictionRoute gml:id="ID_64_1507215112982_13297">
<aixm:routeElement>
<aixm:FlightRoutingElement gml:id="ID_64_1507215112982_13298">
<aixm:orderNumber>1</aixm:orderNumber>
<aixm:element_airspaceElement .../>
</aixm:FlightRoutingElement>
</aixm:routeElement>
</aixm:FlightRestrictionRoute>
</aixm:regulatedRoute>

Edition: 27.0 6 497

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:annotation>
<aixm:Note gml:id="ID_64_1507215112982_13299">
<aixm:propertyName>instruction</aixm:propertyName>
<aixm:purpose>REMARK</aixm:purpose>
<aixm:translatedNote>
<aixm:LinguisticNote gml:id="ID_64_1507215112982_13300">
<aixm:note>EBR04 FL 030_120 FORBIDDEN OUTSIDE ACTIVATION
10:00_12:00</aixm:note>
</aixm:LinguisticNote>
</aixm:translatedNote>
</aixm:Note>
</aixm:annotation>
<aixm:extension>
<adrext:FlightRestrictionExtension ...>
<adrext:processingIndicator>TFR</adrext:processingIndicator>
<adrext:enabled>YES</adrext:enabled>
<adrext:usage>OPERATIONAL</adrext:usage>
<adrext:isFUA>YES</adrext:isFUA>
<adrext:fuaDefaultActive>YES</adrext:fuaDefaultActive>
<adrext:verticalLimitReference>
CALCULATED</adrext:verticalLimitReference>
<adrext:dependentVerticalLimits>
YES</adrext:dependentVerticalLimits>
</adrext:FlightRestrictionExtension>
</aixm:extension>
</aixm:FlightRestrictionTimeSlice>
</aixm:timeSlice>
</aixm:FlightRestriction>
</adrmsg:hasMember>

17.4.2.12. Lead AMC Publication

17.4.2.12.1. Description

1. The lead AMC is a predetermined AMC responsible for the coordination with adjacent AMCs of
the harmonised allocation of Cross Border Areas (CBAs) and/or the availability of specific Cross-
Border Routes (CDRs).

Lead AMC

Edition: 27.0 6 498

Document Title: NM 27.0 - NM B2B Reference Manual

2. The lead AMC was previously update-able on an AIRAC cycle basis only. However, some AMCs
requested to handle it on a daily basis. Therefore, the association between the lead AMC and the
RSA Airspaces is time dependent.

Lead AMC and RSA relationship

17.4.2.12.2. Publication

1. The Delegated Airspaces in the AMC are exported by the B2B AirspaceStructure Service using
the mapping as explained in the following diagram:

Delegated Airspace in AMC

Edition: 27.0 6 499

Document Title: NM 27.0 - NM B2B Reference Manual

2. The concept of default lead AMC is defined in AIXM as:

For each validity period of an AirTrafficManagementService

◦ An AirTrafficManagementService.isProvidedBy a serviceProvider (Unit)

◦ An AirTrafficManagementService manages zero or more clientAirspace (Airspace)

Example 85. EBBRZAMC

The AirTrafficManagementService provided by the Unit EBBRZAMC manages the

following list of client Airspaces EBR20, EBR21, ..

3. The concept of delegated airspaces to lead AMC is defined in AIXM as:

◦ An AirTrafficManagementService.isProvidedBy a serviceProvider (Unit) during specific

periods of time is model as a Service.isAvailableBy relationship where:

▪ The ServiceOperationStatus.operationalStatus is defined as LIMITED and

▪ The ServiceOperationStatus.timesheet defines when the

AirTrafficManagementService.clientAirspace is managed by the AMC.

◦ The NM-UUID of these AirTraficManagementService features is the concatenation of the

UUIDs of the Unit and the Airspace features.

Edition: 27.0 6 500

Document Title: NM 27.0 - NM B2B Reference Manual

Example 86. EBBRZAMC

The AirTrafficManagementService provided by the Unit EBBRZAMC manages the client

Airspace EDR10D the Thursday 02/03/2107 from 02:00 till 03:00 UTC and the client
Airspace EHD02 during the week-end from 06:00 till 08:00 UTC.The rest of the time, the
Airspace EHD02 is managed by the default lead AMC EHMCZAMC and the Airspace
EDR10D is managed by the default lead AMC EDDAZAMC

17.4.2.12.3. Example

1. In the below example, the first part represents the publication of a delegation of an airspace to
a lead AMC for a period of time. The second part represents the publication of the default lead
AMC.

2. The UUID of a delegate airspace to a lead AMC is composed of:

◦ The string "AirTrafficManagementService_" followed by

◦ the UUID of the AirTrafficManagementService followed by

◦ the character "_" followed by

◦ the UUID of the Airspace.

Edition: 27.0 6 501

Document Title: NM 27.0 - NM B2B Reference Manual

Example 87. AirTrafficManagementService_4cfcafb8-1841-405c-9c75-454dafd8e5d4_1305adf2-d353-4a83-

99c8-26885f156514

<?xml version="1.0" encoding="UTF-8"?>

<adrmsg:ADRMessage ...>
<adrmsg:hasMember>
<aixm:AirTrafficManagementService ...>
<gml:identifier
codeSpace="urn:x-nmb2b:">
AirTrafficManagementService_
4cfcafb8-1841-405c-9c75-454dafd8e5d4_1305adf2-d353-4a83-99c8-26885f156514
</gml:identifier>
<aixm:timeSlice>
<aixm:AirTrafficManagementServiceTimeSlice gml:id="ID_57_1488621997395_3">
<gml:validTime>
<gml:TimePeriod gml:id="ID_57_1488621997395_4">
<gml:beginPosition>2017-03-02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_57_1488621997395_5">
<gml:beginPosition>2017-03-02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:serviceProvider .../>
<aixm:availability>
<aixm:ServiceOperationalStatus gml:id="ID_57_1488621997395_6">
<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_57_1488621997395_7">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SUN</aixm:day>
<aixm:startTime>06:00</aixm:startTime>
<aixm:endTime>08:00</aixm:endTime>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_57_1488621997395_9">
<gml:beginPosition>2017-03-
02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>

Edition: 27.0 6 502

Document Title: NM 27.0 - NM B2B Reference Manual

<aixm:timeInterval>
<aixm:Timesheet gml:id="ID_57_1488621997395_10">
<aixm:timeReference>UTC</aixm:timeReference>
<aixm:day>SAT</aixm:day>
<aixm:startTime>06:00</aixm:startTime>
<aixm:endTime>08:00</aixm:endTime>
<aixm:extension>
<adrext:TimesheetExtension ...>
<gml:validTime>
<gml:TimePeriod gml:id="ID_57_1488621997395_12">
<gml:beginPosition>2017-03-
02T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
</adrext:TimesheetExtension>
</aixm:extension>
</aixm:Timesheet>
</aixm:timeInterval>
<aixm:operationalStatus>LIMITED</aixm:operationalStatus>
</aixm:ServiceOperationalStatus>
</aixm:availability>
<aixm:clientAirspace .../>
</aixm:AirTrafficManagementServiceTimeSlice>
</aixm:timeSlice>
</aixm:AirTrafficManagementService>
</adrmsg:hasMember>
<adrmsg:hasMember>
<aixm:AirTrafficManagementService ...>
<gml:identifier
codeSpace="urn:x-nmb2b:">AirTrafficManagementService_4cfcafb8-1841-405c-
9c75-454dafd8e5d4
</gml:identifier>
<aixm:timeSlice>
<aixm:AirTrafficManagementServiceTimeSlice gml:id=
"ID_57_1488621997395_14">
<gml:validTime>
<gml:TimePeriod gml:id="ID_57_1488621997395_15">
<gml:beginPosition>2016-11-10T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</gml:validTime>
<aixm:interpretation>BASELINE</aixm:interpretation>
<aixm:featureLifetime>
<gml:TimePeriod gml:id="ID_57_1488621997395_16">
<gml:beginPosition>2016-11-10T00:00:00</gml:beginPosition>
<gml:endPosition indeterminatePosition="unknown"/>
</gml:TimePeriod>
</aixm:featureLifetime>
<aixm:serviceProvider

Edition: 27.0 6 503

Document Title: NM 27.0 - NM B2B Reference Manual

xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:4cfcafb8-1841-405c-9c75-454dafd8e5d4"/>
<aixm:clientAirspace
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:f4e93f7a-c908-4657-b5ec-b909da1ef971"/>
<aixm:clientAirspace
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:f0a6d4eb-41e5-46b6-a1d8-9e8d5663b6a7"/>
...
<aixm:clientRoute>
<aixm:RoutePortion gml:id="ID_57_1488621997395_17">
<aixm:start_fixDesignatedPoint
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:2a92b8db-9617-489c-b854-5c791bf5caa7"/>
<aixm:referencedRoute
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:1bf5f9a1-f00a-4d2b-8db1-fcf27c271bcc"/>
<aixm:end_fixDesignatedPoint
xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="urn:uuid:c253fb18-fe15-4232-ae82-323253660771"/>
</aixm:RoutePortion>
</aixm:clientRoute>
...
</aixm:AirTrafficManagementServiceTimeSlice>
</aixm:timeSlice>
</aixm:AirTrafficManagementService>
</adrmsg:hasMember>
</adrmsg:ADRMessage>

17.4.3. Publish/Subscribe Topics

17.4.3.1. AIRSPACE_DATA

Edition: 27.0 6 504

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: AirspaceDataMessage

Ordering policy:

Messages shall be ordered by numerically sorting on the field

payload.[completeDataset|incrementalDataset|airspaceDataIncrement].updateId.

Message filter: AirspaceDataMessageFilter

Subscription management (topic specific):

• S-R/R AirspaceDataSubscriptionCreationRequest/Reply

• S-R/R AirspaceDataSubscriptionUpdateRequest/Reply

• S-R/R AirspaceDataSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Notification about the publication of new Complete and Incremental Airspace Datasets.

17.4.3.1.1. AirspaceDataMessage (new 27.0)

<<class>>

The business P/S message for topic AIRSPACE_DATA.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. AirspaceDataMessagePayload payload (Mandatory)

The message payload.

17.4.3.1.2. AirspaceDataSubscriptionCreationRequest/Reply (new 27.0)

Edition: 27.0 6 505

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AirspaceDataSubscriptionCreationRequest

Reply: AirspaceDataSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AirspaceDataSubscriptionCreationReply
createAirspaceDataSubscription(AirspaceDataSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic AIRSPACE_DATA.

AirspaceDataSubscriptionCreationRequest (new 27.0)

<<class>>

It allows creating a new subscription for topic AIRSPACE_DATA.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. AirspaceDataMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

Edition: 27.0 6 506

Document Title: NM 27.0 - NM B2B Reference Manual

AirspaceDataSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to AirspaceDataSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. AirspaceDataSubscriptionCreationReplyData data (Optional)

The reply payload.

17.4.3.1.3. AirspaceDataSubscriptionUpdateRequest/Reply (new 27.0)

MEP: S-R/R

Request: AirspaceDataSubscriptionUpdateRequest

Reply: AirspaceDataSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AirspaceDataSubscriptionUpdateReply
updateAirspaceDataSubscription(AirspaceDataSubscriptionUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic AIRSPCE_DATA.

AirspaceDataSubscriptionUpdateRequest (new 27.0)

Edition: 27.0 6 507

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows updating an existing subscription for topic AIRSPACE_DATA.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. AirspaceDataMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

AirspaceDataSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to AirspaceDataSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. AirspaceDataSubscriptionUpdateReplyData data (Optional)

The reply payload.

17.4.3.1.4. AirspaceDataSubscriptionRetrievalRequest/Reply (new 27.0)

Edition: 27.0 6 508

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: AirspaceDataSubscriptionRetrievalRequest

Reply: AirspaceDataSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AirspaceDataSubscriptionRetrievalReply
retrieveAirspaceDataSubscription(AirspaceDataSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic AIRSPACE_DATA.

AirspaceDataSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic AIRSPACE_DATA.

1. Inherits from: SubscriptionRetrievalRequest

AirspaceDataSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to AirspaceDataSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. AirspaceDataSubscriptionRetrievalReplyData data (Optional)

Edition: 27.0 6 509

Document Title: NM 27.0 - NM B2B Reference Manual

The reply payload.

17.4.4. Requests/Replies

17.4.4.1. CompleteAIXMDatasetRequest/Reply

MEP: S-R/R

Request: CompleteAIXMDatasetRequest

Reply: CompleteAIXMDatasetReply

Response time: 59 / 110 / 3100 (ms)

Default settings: request count quotas

SOAP operation:

CompleteAIXMDatasetReply queryCompleteAIXMDatasets(CompleteAIXMDatasetRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the Complete Airspace Datasets (CDS).

17.4.4.1.1. CompleteAIXMDatasetRequest

Edition: 27.0 6 510

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query complete Airspace Datasets

1. Inherits from: Request

2. Attributes:

a. CompleteDatasetQueryCriteria queryCriteria (Optional)

The criteria to query Complete Airspace Datasets

17.4.4.1.2. CompleteAIXMDatasetReply

Edition: 27.0 6 511

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to CompleteAIXMDatasetRequest.

The service returns a list of datasets available for downloads. More precisely, it returns a list of
CompleteDatasetSummary objects. Each summary contains relevant information about the dataset.

A Complete Airspace Dataset is a set of AIXM files, one per AIXM feature type.

Remark
These services do not return the content of each file, but only the file identifiers. Each file must
then be downloaded separately (see document File Download for a detailed description).

When querying the datasets for a given AIRAC, the service returns all the Complete Airspace
Datasets published for that AIRAC: this means from six days before the AIRAC switch until the end
of the cycle.

Past timeslices which are no longer relevant to the correspondent AIRACS are not included in the
dataset.

1. Inherits from: Reply

2. Attributes:

a. CompleteAIXMDatasetReplyData data (Optional)

The CompleteAIXMDatasetReply data

Edition: 27.0 6 512

Document Title: NM 27.0 - NM B2B Reference Manual

17.4.4.2. IncrementalAIXMDatasetRequest/Reply

MEP: S-R/R

Request: IncrementalAIXMDatasetRequest

Reply: IncrementalAIXMDatasetReply

Response time: 52 / 170 / 4400 (ms)

Default settings: request count quotas

SOAP operation:

IncrementalAIXMDatasetReply
queryIncrementalAIXMDatasets(IncrementalAIXMDatasetRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the Incremental Airspace Datasets (IDS).

17.4.4.2.1. IncrementalAIXMDatasetRequest

Edition: 27.0 6 513

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query incremental Airspace Datasets.

In the most common scenario the client provides the last known UpdateId and the service returns
all available Incremental Airspace Datasets newer than the given UpdateId.

The UpdateId provided by the client must be a valid UpdateId previously obtained through:

1. The download of a Complete Airspace Dataset, or

2. The retrieval of an Incremental Airspace Dataset

The method also supports other query parameters.

1. Inherits from: Request

2. Attributes:

a. IncrementalDatasetQueryCriteria queryCriteria (Mandatory)

The criteria by which to query for Incremental Airspace Datasets

b. AIXMTemporality timesliceType (Mandatory)

Allows the client to choose whether to get the dataset as BASELINE or PERMDELTA
timeslices

17.4.4.2.2. IncrementalAIXMDatasetReply

Edition: 27.0 6 514

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to IncrementalAIXMDatasetRequest.

The service returns a list of available Incremental Airspace Datasets. More precisely it returns a list
of Incremental Airspace Dataset Summaries.

1. Inherits from: Reply

2. Attributes:

a. IncrementalAIXMDatasetReplyData data (Optional)

The IncrementalAIXMDatasetReply data

17.4.4.3. AirspaceDataIncrementListRequest/Reply

MEP: S-R/R

Request: AirspaceDataIncrementListRequest

Reply: AirspaceDataIncrementListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

AirspaceDataIncrementListReply
queryAirspaceDataIncrements(AirspaceDataIncrementListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 1

Queries the airspace data increments according to the provided filter.

17.4.4.3.1. AirspaceDataIncrementListRequest

Edition: 27.0 6 515

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to list the airspace data increments from a past update and for a given filter.

1. Inherits from: Request

2. Attributes:

a. AirspaceDataUpdateId fromUpdateId (Optional)

The airspace data update from which to list the airspace data increments. If null, the
returned list contains only the airspace data increment that corresponds to the last update.

b. AirspaceDataFilter filter (Mandatory)

The airspace data filter.

17.4.4.3.2. AirspaceDataIncrementListReply

<<class>>

Returned in response to AirspaceDataIncrementListRequest.

1. Inherits from: Reply

2. Attributes:

a. AirspaceDataIncrementListReplyData data (Optional)

The AirspaceDataIncrementListReply data

17.4.4.4. AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage

Edition: 27.0 6 516

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: A-R/R

Request: AirspaceDataIncrementRetrievalRequest

Reply: AirspaceDataIncrementRetrievalReply

Reply message: AirspaceDataIncrementRetrievalReplyMessage

Response time: not available

Default settings: request count quotas / reply message settings

SOAP operation:

AirspaceDataIncrementRetrievalReply
retrieveAirspaceDataIncrement(AirspaceDataIncrementRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 1

Retrieves an airspace data increment according to the provided filter.

17.4.4.4.1. AirspaceDataIncrementRetrievalRequest

<<class>>

Retrieves an airspace data increment.

1. Inherits from: AsyncRequest

Edition: 27.0 6 517

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. AirspaceDataUpdateId updateId (Optional)

The increment update id. If null, the latest airspace data increment is returned.

b. AirspaceDataFilter filter (Mandatory)

The filter used to produce the increment.

c. AIXMTemporality timesliceType (Mandatory)

Allows the client to choose whether to get the dataset as BASELINE or PERMDELTA
timeslices

17.4.4.4.2. AirspaceDataIncrementRetrievalReply

<<class>>

Returned in response to AirspaceDataIncrementRetrievalRequest.

1. Inherits from: AsyncReply

17.4.4.4.3. AirspaceDataIncrementRetrievalReplyMessage

<<class>>

The AirspaceDataIncrementRetrievalReply asynchronous reply message.

1. Inherits from: ARMessage

2. Attributes:

a. AirspaceDataIncrementRetrievalReplyData data (Optional)

17.4.4.5. AirspaceDataRetrievalRequest/Reply/ReplyMessage

Edition: 27.0 6 518

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: A-R/R

Request: AirspaceDataRetrievalRequest

Reply: AirspaceDataRetrievalReply

Reply message: AirspaceDataRetrievalReplyMessage

Response time: not available

Default settings: request count quotas / reply message settings

SOAP operation:

AirspaceDataRetrievalReply retrieveAirspaceData(AirspaceDataRetrievalRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 1

Retrieves the airspace data according to the provided filter.

17.4.4.5.1. AirspaceDataRetrievalRequest

<<class>>

Retrieves an airspace data.

1. Inherits from: AsyncRequest

Edition: 27.0 6 519

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. AirspaceDataUpdateId updateId (Optional)

The update id. If not present, then the latest airspace data will be retrieved.

b. AirspaceDataFilter filter (Mandatory)

The filter used to produce the airspace data.

17.4.4.5.2. AirspaceDataRetrievalReply

<<class>>

Returned in response to AirspaceDataRetrievalRequest.

1. Inherits from: AsyncReply

17.4.4.5.3. AirspaceDataRetrievalReplyMessage

<<class>>

The AirspaceDataRetrievalReply asynchronous reply message.

1. Inherits from: ARMessage

2. Attributes:

a. AirspaceDataRetrievalReplyData data (Optional)

17.5. Data Types

17.5.1. AbstractEAUPCDRRequest

<<abstract class>>

Edition: 27.0 6 520

Document Title: NM 27.0 - NM B2B Reference Manual

Used to retrieve the CDR openings and closures within an EAUP, or between EAUPs, while possibly
applying a filter on the returned result set, i.e. keep only the CDR openings/closures for:

1. A CDR type (i.e. opening and/or closure)

2. A list of route wildcards

3. A list of FIR and/or UIR UUIDs

4. A list of FIR and/or UIR designator wildcards

5. A flight level range

6. An applicability period

The logical AND operator applies between all these query attributes.

Since released EAUPs are immutable (their content will not be modified anymore), NM requires its
customers to undertake their best effort to avoid repeatedly sending the same requests on the same
EAUP.

1. Inherits from: Request

2. Attributes:

a. boolean cdrOpenings (Optional)

If true, CDR openings are returned. True by default.

b. boolean cdrClosures (Optional)

If true, CDR closures are returned. True by default.

c. UUID[] routeUUIDs (Optional)

Query attribute on route UUIDs. The default meaning is "all route UUIDs".

i. Constraints:

▪ array size range : [1, unbounded[

▪ AbstractEAUPCDRRequest.ROUTE_UUIDS_CANNOT_CONTAIN_DUPLICATE

d. string[] routeDesignators (Optional)

Query attribute on route designators.

Each string item in the array can be a full route designator or a wildcard for a route
designator. Supported wildcards are limited to at least one character and the star sign ("*")
at the end of the expression.

The default meaning is "all routes".

i. Constraints:

▪ array size range : [1, unbounded[

Edition: 27.0 6 521

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Item pattern: (UALPHA|DIGIT){1,7}|(UALPHA|DIGIT){1,6}*

▪ AbstractEAUPCDRRequest.ROUTE_DESIGNATORS_CANNOT_CONTAIN_DUPLICATE

e. IRFilter irFilter (Optional)

Used to filter the IR airspaces on which CDR openings/closures apply, based on UUIDs or on
IR designators.

f. FlightLevelRange flightLevelRange (Optional)

Query attribute on flight level range. The CDR opening/closure matches this query attribute
if its flight level range and the given flight level range overlap.

The FlightLevelRange is right-opened, i.e. if for example a CDR opening flight level range is [
300, 400 [ and the caller queries on flight level range [ 400, 500 [, the CDR opening does not
match the query.

The default meaning is "any flight level range".

g. DateTimeMinutePeriod applicability (Optional)

Query attribute on CDR opening/closure applicability period. The CDR opening/closure

matches this query attribute if its applicability period and the given applicability period
overlap.

Note that time periods are left-closed and right-opened, i.e. no match is obtained if the CDR
opening/closure applicability period starts at the time corresponding to the end of the query
attribute.

The default meaning is "any applicability".

3. Constraints:

a. ROUTE_UUIDS_CANNOT_CONTAIN_DUPLICATE

If specified (not null), the array cannot be empty and does not accept duplicates.

Constrained attributes: routeUUIDs

Constrained requests: any using request

b. ROUTE_DESIGNATORS_CANNOT_CONTAIN_DUPLICATE

Query attribute on route designators.

Each string item in the array can be a full route designator or a wildcard for a route
designator. Supported wildcards are limited to at least one character and the star sign ("*")
at the end of the expression.

The default meaning is "all routes".

Constrained attributes: routeDesignators

Edition: 27.0 6 522

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

17.5.2. AbstractEAUPRSARequest

<<abstract class>>

Used to retrieve the RSA allocations within an EAUP, or between EAUPs, while possibly applying a
filter on the returned result set, i.e. keep only the RSA allocations for:

1. An RSA allocation type (i.e. implicit and/or explicit)

2. A list of RSA wildcards

3. A list of FIR and/or UIR UUIDs

4. A list of FIR and/or UIR designator wildcards

5. A flight level range

6. An applicability period

The logical AND operator applies between all these query attributes.

Since released EAUPs are immutable (their content will not be modified anymore), NM requires its
customers to undertake their best effort to avoid repeatedly sending the same requests on the same
EAUP.

1. Inherits from: Request

2. Attributes:

a. boolean implicit (Optional)

If true, implicit RSA allocations are returned. True by default.

Edition: 27.0 6 523

Document Title: NM 27.0 - NM B2B Reference Manual

b. boolean explicit (Optional)

If true, explicit RSA allocations are returned. True by default.

c. UUID[] rsaUUIds (Optional)

Query attribute on RSA UUIDs. The default meaning is "all RSA UUIDs".

i. Constraints:

▪ array size range : [1, unbounded[

▪ AbstractEAUPRSARequest.RSA_UUIDS_CANNOT_CONTAIN_DUPLICATE

d. string[] rsaDesignators (Optional)

Query attribute on ICAO-compliant RSA designators.

Each string item in the array can be a full RSA designator or a wildcard for a RSA designator.
Supported wildcards are limited to at least one character and the star sign ("*") at the end of
the expression.

The default meaning is "all RSAs".

i. Constraints:

▪ array size range : [1, unbounded[

▪ Item pattern: (UALPHA|DIGIT){1,7}|(UALPHA|DIGIT){1,6}*

▪ AbstractEAUPRSARequest.RSA_DESIGNATORS_CANNOT_CONTAIN_DUPLICATE

e. IRFilter irFilter (Optional)

Used to filter the IR airspaces on which RSA allocations apply, based on UUIDs or on IR
designators

f. FlightLevelRange flightLevelRange (Optional)

Query attribute on flight level range. The RSA allocation matches this query attribute if its
flight level range and the given flight level range overlap.

Note that the FlightLevelRange is right-opened, i.e. if for example an RSA allocation flight
level range is [ 300, 400 [ and the caller queries on flight level range [ 400, 500 [, the RSA
allocation does not match the query.

The default meaning is "any flight level range".

g. DateTimeMinutePeriod applicability (Optional)

Query attribute on RSA allocation applicability period. The RSA allocation matches this
query attribute if its applicability period and the given applicability period overlap.

Note that time periods are left-closed and right-opened, i.e. no match if obtained if the RSA
allocation applicability period starts at the time corresponding to the end of the query

Edition: 27.0 6 524

Document Title: NM 27.0 - NM B2B Reference Manual

attribute.

The default meaning is "any applicability".

3. Constraints:

a. RSA_UUIDS_CANNOT_CONTAIN_DUPLICATE

If specified (not null), the array cannot be empty and does not accept duplicates

Constrained attributes: rsaUUIds

Constrained requests: any using request

b. RSA_DESIGNATORS_CANNOT_CONTAIN_DUPLICATE

If specified (not null), the array cannot be empty and does not accept duplicates

Constrained attributes: rsaDesignators

Constrained requests: any using request

17.5.3. AerodromeIATAId
<<typedef[string]>>

IATA identifier of an aerodrome

1. Pattern: UALPHA{3}

2. Used by: PredictedDPIRequest, ACDMAlertRequest

17.5.4. AerodromeIATAOrICAOId
<<typedef[string]>>

IATA or ICAO identifier of an aerodrome

1. Pattern: UALPHA{3,4}

2. Used by: TerminalProcedureIdentifier, ACC3Accreditation

17.5.5. AerodromeICAOId
<<typedef[string]>>

ICAO id of an Aerodrome

1. Pattern: UALPHA{4}

2. Used by: StandardRouteId, AlternateAerodrome, FlightPoint, Aerodrome, ReclearanceInFlight,

ATFCMSituationRegulation, FlightInformationUpdateRequest, FlightListByAerodromeRequest,
TrafficCountsByAerodromeRequest, ReferenceLocationAerodrome, RunwayConfigurationPlan,

Edition: 27.0 6 525

Document Title: NM 27.0 - NM B2B Reference Manual

AerodromeDAL, FlightKeys, Flight, RunwayConfigurationPlanRetrievalRequest, TargetTime,

AerodromeOrPublishedPointId

17.5.6. AerodromeICAOIdWildcard
<<typedef[string]>>

ICAO identifier of an aerodrome, or a simple wildcard for aerodrome identifiers (e.g. "EB*")

1. Pattern: (UALPHA){3,4}|(UALPHA){1,3}*

2. Used by: FlightSetDefinitionElement

17.5.7. AerodromeOrPublishedPointId
<<union>>

Represents an aerodrome or a published point ICAO identifier

1. Choices:

a. AerodromeICAOId aerodrome

The aerodrome ICAO identifier

b. PublishedPointId point

The published point ICAO identifier

2. Used by: ArrivalInformation, TargetAPIRequest

17.5.8. AerodromeOrPublishedPointIdType
<<enumeration>>

This enumerator allows to classify positioned objects as either aerodrome or point

1. Values:

a. aerodrome

This value indicates that the positioned object is an aerodrome

b. point

This value indicates that the positioned object is a point

2. Used by: AerodromeOrPublishedPointId

17.5.9. AerodromeSetId
<<typedef[string]>>

NM unique id of the AerodromeSet

Edition: 27.0 6 526

Document Title: NM 27.0 - NM B2B Reference Manual

1. Pattern: TEXT{1,8}

2. Used by: TrafficCountsByAerodromeSetRequest, FlightListByAerodromeSetRequest,

ReferenceLocationAerodromeSet

17.5.10. AIRACId
<<typedef[string]>>

Identifier of the AIRAC based on the year and a sequence number in the year.

Its format is "YYSS", where "YY" contains the last two digits of the year and "SS" the two digits for
the AIRAC sequence number within the year. Example: "1203" is the third AIRAC of 2012.

1. Pattern: DIGIT{4}

2. Used by: AiracIdentifier

17.5.11. AiracIdentifier
<<union>>

Identification of an AIRAC, via an AIRAC id or via an AIRAC sequence number

1. Choices:

a. AIRACId airacId

Specific AIRAC id

b. int airacSequenceNumber

Specific AIRAC sequence number

2. Used by: AirspaceDataIncrementSummary, CompleteDatasetQueryCriteria,

IncrementalDatasetSummary, AirspaceDataRetrievalReplyData, CompleteDatasetSummary,
IncrementalDatasetQueryCriteria

17.5.12. AirspaceDataFilter
<<class>>

A filter used to determine which feature has to be included in an airspace data increment or an
airspace dataset.

NOTE In the current version, the responsible AMC is the only supported attribute.

1. Attributes:

a. AirNavigationUnitId responsibleAMC (Optional)

Documentation last updated: 27.0 - Edition 3

The identifier of the responsible AMC.

Edition: 27.0 6 527

Document Title: NM 27.0 - NM B2B Reference Manual

See Filtered Airspace Dataset.

i. Constraints:

▪ AirspaceDataFilter.RESPONSIBLE_AMC_CANNOT_BE_NULL

2. Constraints:

a. RESPONSIBLE_AMC_CANNOT_BE_NULL

The responsibleAMC attribute cannot be null.

Constrained attributes: responsibleAMC

Constrained requests: any using request

3. Used by: AirspaceDataIncrementRetrievalRequest, AirspaceDataIncrementSummary,

AirspaceDataIncrementListRequest, AirspaceDataMessageFilter, AirspaceDataRetrievalRequest,
AirspaceDataRetrievalReplyData

17.5.13. AirspaceDataIncrementListReplyData
<<class>>

The AirspaceDataIncrementListReply payload.

1. Attributes:

a. AirspaceDataIncrementSummary[] increments (Mandatory)

The list of airspace data increment summaries.

2. Used by: AirspaceDataIncrementListReply

17.5.14. AirspaceDataIncrementRetrievalReplyData
<<class>>

The AirspaceDataIncrementRetrievalReply payload.

1. Attributes:

a. AirspaceDataIncrementSummary summary (Mandatory)

Summary information about this increment.

b. Base64Encoded featureSet (Mandatory)

The ADRMessage containing the AIXM payload, i.e. the AIXM features included in this
airspace data increment.

Note that the ADRMessage is zipped and encoded in Base64, hence this field must be first
decoded from Base64 and then unzipped.

2. Used by: AirspaceDataIncrementRetrievalReplyMessage

Edition: 27.0 6 528

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.15. AirspaceDataIncrementSummary
<<class>>

Summarises the airspace data increment that results from an airspace data update on some area of
interest.

1. Attributes:

a. AirspaceDataFilter filter (Mandatory)

The filter used to produce this increment summary.

b. AirspaceDataUpdateId updateId (Mandatory)

The increment update id.

c. AirspaceDataUpdateId previousUpdateId (Optional)

The previous increment update id. It enables the verification of the continuity in the chain
of updates.

d. DateYearMonthDay publicationDate (Mandatory)

The increment publication date by NM.

e. AiracIdentifier[] sourceAIRACs (Mandatory)

The list of AIRAC cycles that are included by the airspace data increment.

i. Constraints:

▪ array size range : [1, 2]

f. map< AIXMFeatureType, int > affectedFeatures (Optional)

The number of features affected by this airspace data increment.

i. Constraints:

▪ item range : [0, unbounded[

2. Used by: AirspaceDataMessagePayload, AirspaceDataIncrementListReplyData,

AirspaceDataIncrementRetrievalReplyData

17.5.16. AirspaceDataMessageFilter (new 27.0)

<<class>>

A message filter for subscription topic AIRSPACE_DATA .

1. Attributes:

a. set< AIXMDatasetType > datasetTypes (Optional)

The types of dataset (COMPLETE or INCREMENTAL) for which to be notified.

Edition: 27.0 6 529

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ set size range : [1, unbounded[

▪ AirspaceDataMessageFilter.INVALID_AIRSPACE_DATA_MESSAGE_FILTER

b. AirspaceDataFilter airspaceDataFilter (Optional)

The Airspace Data filter.

i. Constraints:

▪ AirspaceDataMessageFilter.INVALID_AIRSPACE_DATA_MESSAGE_FILTER

2. Constraints:

a. INVALID_AIRSPACE_DATA_MESSAGE_FILTER

datasetTypes and airspaceDataFilter cannot be both null

Constrained attributes: datasetTypes, airspaceDataFilter

Constrained requests: any using request

3. Used by: AirspaceDataSubscriptionUpdateRequest, AirspaceDataSubscriptionCreationRequest,

AirspaceDataSubscription

17.5.17. AirspaceDataMessagePayload (new 27.0)

<<class>>

Payload of a AirspaceDataMessage.

It may represent either a Complete Dataset summary or an Incremental Dataset summary or an

Airspace Data Increment summary (see AirspaceServices Manual)

1. Attributes:

a. CompleteDatasetSummary completeDataset (Optional)

The complete data set summary.

b. IncrementalDatasetSummary incrementalDataset (Optional)

The incremental data set summary.

c. AirspaceDataIncrementSummary airspaceDataIncrement (Optional)

The airspace data increment summary.

2. Used by: AirspaceDataMessage

17.5.18. AirspaceDataRetrievalReplyData
<<class>>

Edition: 27.0 6 530

Document Title: NM 27.0 - NM B2B Reference Manual

The AirspaceDataRetrievalReply payload.

1. Attributes:

a. AirspaceDataFilter filter (Mandatory)

The filter used to define this airspace data.

b. AirspaceDataUpdateId updateId (Mandatory)

The updateId corresponding to this airspace data, i.e. the updateId of the latest increment
included in this airspace data.

c. DateYearMonthDay publicationDate (Mandatory)

The publication date of this airspace data (by NM).

d. AiracIdentifier[] sourceAIRACs (Mandatory)

The list of AIRAC cycles impacted by the airspace data.

i. Constraints:

▪ array size range : [1, 2]

e. Base64Encoded featureSet (Mandatory)

The ADRMessage containing the AIXM payload, i.e. all the AIXM features included in this
airspace data.

Note that the ADRMessage is zipped and encoded in Base64, hence this field must be first
decoded from Base64 and then unzipped.

2. Used by: AirspaceDataRetrievalReplyMessage

17.5.19. AirspaceDataSubscription (new 27.0)

<<class>>

Edition: 27.0 6 531

Document Title: NM 27.0 - NM B2B Reference Manual

Subscription of topic AIRSPACE_DATA.

1. Inherits from: Subscription

2. Attributes:

a. AirspaceDataMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

3. Used by: AirspaceDataSubscriptionRetrievalReplyData, AirspaceDataSubscriptionUpdateReplyData,

AirspaceDataSubscriptionCreationReplyData

17.5.20. AirspaceDataSubscriptionCreationReplyData (new 27.0)

<<class>>

The AirspaceDataSubscriptionCreationReply payload.

1. Attributes:

a. AirspaceDataSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: AirspaceDataSubscriptionCreationReply

17.5.21. AirspaceDataSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The AirspaceDataSubscriptionRetrievalReply payload.

1. Attributes:

a. AirspaceDataSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: AirspaceDataSubscriptionRetrievalReply

17.5.22. AirspaceDataSubscriptionUpdateReplyData (new 27.0)

<<class>>

The AirspaceDataSubscriptionUpdateReply payload.

1. Attributes:

a. AirspaceDataSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: AirspaceDataSubscriptionUpdateReply

Edition: 27.0 6 532

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.23. AirspaceDataUpdateId
<<typedef[long]>>

Airspace data update identifier

1. Used by: AirspaceDataIncrementRetrievalRequest, AirspaceDataIncrementSummary,

AirspaceDataIncrementListRequest, IncrementalDatasetSummary, AirspaceDataRetrievalRequest,
AirspaceDataRetrievalReplyData, CompleteDatasetSummary, IncrementalDatasetQueryCriteria

17.5.24. AirspaceId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

NM unique id of the Airspace.

Airspace identifiers are exposed by the Airspace Structure service, see

AirspaceStructure Port Type.

The airspace identifier can be extracted from an Airspace Feature as follows:

IMPORTANT
• If the airspace type is one of FIR or UIR, the airspace identifier is equal to
the designator suffixed by the type. For example, BRUSSELS FIR is exported
as designator=EBBU and type=FIR: its airspace identifier is EBBUFIR.

• Otherwise, the identifier is equal to the designator.

1. Pattern: TEXT{1,12}

2. Used by: SectorConfigurationPlan, TrafficCountsByAirspaceRequest, MeasureIdAndTV, DeltaEntry,

ReferenceLocationAirspace, ScenarioAttributes, FlightAirspace, FlightListByAirspaceRequest,
SectorConfigurationPlanRetrievalRequest, AvoidViaAirspaceReroutingConstraint

17.5.25. AirspaceType
<<enumeration>>

Enumerates airspace types

1. Values:

a. REG

Region

b. FIR

Flight Information Region

c. AUA

Edition: 27.0 6 533

Document Title: NM 27.0 - NM B2B Reference Manual

ATC Unit Airspace

d. ES

Elementary Sector

e. CS

Collapsed Sector

f. ERSA

Elementary Manageable Airspace

g. CRSA

Composed Manageable Airspace.

h. CDA

Client Defined Airspace

i. AUAG

ATC Unit Airspace Group

j. AREA

NM or Eurocontrol Defined Area

k. NAS

National Airspace

l. IFPZ

IFPS Zone

m. AOI

Area of Interest

n. AOP

Area of Protection

o. CLUS

Cluster

p. CRAS

CRAS

Edition: 27.0 6 534

Document Title: NM 27.0 - NM B2B Reference Manual

q. ERAS

ERAS

2. Used by: FlightAirspace

17.5.26. AirSpeed

<<class>>

Representation of a true air speed, together with its unit.

1. Attributes:

a. AirSpeed_DataType speed (Mandatory)

The true air speed value, in the provided unit.

Must be in [0, 9999].

b. SpeedUnit unit (Mandatory)

Speed unit

2. Used by: Flight, LevelAndSpeedReroutingConstraint

17.5.27. AirSpeed_DataType
<<typedef[int]>>

Airspeed data type

1. Used by: AirSpeed

17.5.28. AIXMDatasetType
<<enumeration>>

Enumerates the supported Airspace Datasets

Edition: 27.0 6 535

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. COMPLETE

Complete Airspace Dataset

b. INCREMENTAL

Incremental Airspace Dataset

2. Used by: AirspaceDataMessageFilter

17.5.29. AIXMFeatureType
<<enumeration>>

The AIXM Feature type.

1. Values:

a. AirportHeliport

A defined area on land or water (including any buildings, installations and equipment)
intended to be used either wholly or in part for the arrival, departure and surface
movement of aircraft/helicopters.

b. AirportHeliportCollocation

Two aerodromes/heliports may be co-located sharing some or all of their ground facilities.
E.g. a civil and a military aerodrome using the same runway.

c. AirportHeliportSet

A set of AirportHeliports.

d. Navaid

A service providing guidance information or position data for the efficient and safe
operation of aircraft supported by one or more radio navigation aids.

e. DesignatedPoint

A geographical location not marked by the site of a radio navigation aid, used in defining an
ATS route, the flight path of an aircraft or for other navigation or ATS purposes.

f. AngleIndication

An angular reference from a navaid or with reference to a designated point.

g. DistanceIndication

A distance reference from a navaid or with reference to a designated point.

Edition: 27.0 6 536

Document Title: NM 27.0 - NM B2B Reference Manual

h. Route

A specified route designed for channelling the flow of traffic as necessary for the provision
of air traffic services, from the end of the take-off and initial climb phase to the
commencement of the approach and landing phase.

i. RouteSegment

A portion of a route to be flown usually without an intermediate stop, as defined by two

consecutive significant points.

j. StandardInstrumentDeparture

A designated IFR departure route linking the aerodrome or a specific runway of the
aerodrome with a specified significant point, normally on a designated ATS route, at which
the en-route phase of a flight commences.

k. DepartureLeg

A portion of a departure procedure as defined by two consecutive significant points.

l. StandardInstrumentArrival

A designated IFR arrival route linking a significant point, normally on an ATS route, with a
point from which a published instrument approach procedure can be commenced.

m. ArrivalLeg

A portion of an arrival procedure as defined by two consecutive significant points.

n. StandardLevelColumn

A column of consecutive cruising levels within a standard level table.

o. StandardLevelTable

A table of consecutive cruising levels described under vertical separation criteria limited by
an upper and lower level and used by General Air Traffic.

p. Airspace

A defined three dimensional region of space relevant to air traffic.

q. OrganisationAuthority

A group of people, businesses, administrative concerns, or other entities that are

systematically structured and managed to meet a need or to pursue collective goals on a
continuing basis. This group has the ability to delegate roles, responsibilities, and authority
over cognizant areas. For example: ATS Organisations, Aircraft Operating Agencies, States,
Groups of States, companies, government entities, etc.

Edition: 27.0 6 537

Document Title: NM 27.0 - NM B2B Reference Manual

r. Unit

A generic term referring to all types of entities providing all types of aeronautical related
services. This primarily includes ATM Units but also includes entities such as Search and
Rescue entities, Meteorological offices, Communications office/centres, etc.

s. SpecialDate

A calendar date that has a special meaning for a particular State/organisation and which
may be referred to in the description of the schedules associated with various aeronautical
features.

t. AirTrafficManagementService

A kind of service that provides flight planning and flow management operations.

u. FlightRestriction

A rule meant to regulate the use of the route network, by identifying a set of flights which
fulfil a combination of elementary flow conditions, and either forbidding them on a
particular routing, or obliging them to follow one routing out of a set of mandatory
alternatives.

v. Flow

A Flow is a definition of flights with common entry locations upstream, downstream or both
with respect to a reference location.

w. ReferenceLocation

A ReferenceLocation is the reference point with respect to which tactical activities

(monitoring and CASA) may be specified.

x. TrafficVolume

A TrafficVolume provides the data for which "Tactical ATFM Activities" may be specified.

y. TrafficVolumeSet

A set of TrafficVolumes.

z. SunriseSunsetTable

A table containing Sunrise/Sunset information.

aa. ApproachLeg

A portion of a terminal approach procedure as defined by two consecutive significant

points.

ab. InstrumentApproachProcedure

Edition: 27.0 6 538

Document Title: NM 27.0 - NM B2B Reference Manual

A series of pre-determined manoeuvres by reference to flight instruments with specified

protection from obstacles from the initial approach fix, or where applicable, from the
beginning of a defined arrival route to a point from which a landing can be completed and
thereafter, if a landing is not completed, to a position at which holding or en route obstacle
clearance criteria apply.

ac. FlightRestrictionGroup

A group of FlightRestrictions.

ad. FlightPlanProcessingRule

Flight Plan Processing Rules incorporate Error Management (EM) Restrictions. The EM
Restrictions are NOT Flight Restrictions. EM Restrictions are used to enable IFPS to
systematically handle errors matching the conditions of a particular restriction. The
conditions are typically arguments of an Error String reported in IFPS.

ae. AsmScenario

ASM Scenarios.

af. PointSet

Set of Points.

ag. AirTrafficControlService (new 27.0)

Air traffic control service.

ah. InformationService (new 27.0)

Information service.

2. Used by: AirspaceDataIncrementSummary, IncrementalDatasetSummary

17.5.30. AIXMFile
<<class>>

Represents an ADR AIXM file for a given DATE, DATA_SET_TYPE, UPDATE_ID, NM_RELEASE, AIXM
feature type and temporality.

1. Inherits from: File

2. Used by: IncrementalDatasetSummary, CompleteDatasetSummary

17.5.31. AIXMTemporality
<<enumeration>>

The temporality of the data in accordance with AIXM 5.1 (or higher) model

Edition: 27.0 6 539

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. BASELINE

The TimeSlice provides all the attributes

b. PERM_DELTA

The TimeSlice only provides the attributes which are overwritten compared to the BASELINE
version

2. Used by: AirspaceDataIncrementRetrievalRequest, IncrementalAIXMDatasetRequest

17.5.32. ASMScenarioActivation

<<class>>

Documentation last updated: 27.0 - Edition 3

An ASM scenario activation.

See ASM Scenario Activation.

1. Attributes:

a. ASMScenarioActivationSummary summary (Mandatory)

Documentation last updated: 27.0 - Edition 3

The summary information of the ASM scenario activation.

b. FlightLevelRange flightLevelRange (Optional)

Documentation last updated: 27.0 - Edition 3

The flight level range for which the ASM scenario is activated.

c. DateTimeMinutePeriod applicability (Optional)

Documentation last updated: 27.0 - Edition 3

Edition: 27.0 6 540

Document Title: NM 27.0 - NM B2B Reference Manual

The period during which the ASM scenario is activated.

d. string remark (Optional)

Documentation last updated: 27.0 - Edition 3

Short remark associated to the ASM scenario activation.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1024}

e. ASMScenarioStatus asmScenarioStatus (Mandatory)

Documentation last updated: 27.0 - Edition 3

The status of the ASM scenario.

f. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) rsas

(Mandatory)

Documentation last updated: 27.0 - Edition 4

The list of RSA allocations that define the ASM scenario activation.

See AUP RSA Allocations Message.

2. Used by: ASMScenarioActivationCreationRequest, ASMScenarioActivationUpdateRequest,

ASMScenarioActivationUpdateReplyData, ASMScenarioActivationCreationReplyData,
ASMScenarioActivationListReplyData

17.5.33. ASMScenarioActivationCreationReplyData
<<class>>

The ASMScenarioActivationCreationReply payload.

1. Attributes:

a. ASMScenarioActivation asmScenarioActivation (Mandatory)

Documentation last updated: 27.0 - Edition 3

The created ASM scenario activation.

2. Used by: ASMScenarioActivationCreationReply

17.5.34. ASMScenarioActivationDeletionReplyData
<<class>>

The ASMScenarioActivationDeletionReply payload.

1. Used by: ASMScenarioActivationDeletionReply

Edition: 27.0 6 541

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.35. ASMScenarioActivationListReplyData
<<class>>

The ASMScenarioActivationListReply payload.

1. Attributes:

a. ASMScenarioActivation[] asmScenarioActivations (Mandatory)

Documentation last updated: 27.0 - Edition 1

The list of matching ASM scenario activations.

2. Used by: ASMScenarioActivationListReply

17.5.36. ASMScenarioActivationSummary
<<class>>

Documentation last updated: 27.0 - Edition 3

The summary of an ASM scenario activation.

1. Attributes:

a. UUID asmScenarioId (Mandatory)

Id of the ASM scenario.

b. AUPId aupId (Mandatory)

Id of the AUP.

c. UUID asmScenarioActivationId (Contextual)

Id of the ASM scenario activation.

i. Presence:

▪ Must be null in ASMScenarioActivationCreationRequest

▪ Mandatory otherwise

2. Used by: ASMScenarioActivation

17.5.37. ASMScenarioActivationUpdateReplyData
<<class>>

The ASMScenarioActivationUpdateReply payload.

1. Attributes:

a. ASMScenarioActivation asmScenarioActivation (Mandatory)

Edition: 27.0 6 542

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 3

The updated ASM scenario activation.

2. Used by: ASMScenarioActivationUpdateReply

17.5.38. ASMScenarioListReplyData
<<class>>

The ASMScenarioListReply payload.

1. Attributes:

a. UUID[] asmScenarios (Mandatory)

Documentation last updated: 27.0 - Edition 3

The list of ASM scenarios that can be activated.

2. Used by: ASMScenarioListReply

17.5.39. ASMScenarioStatus
<<enumeration>>

1. Values:

a. NONE

No ASM scenario or ASM scenario in undefined state (applies to monitored or managed

scenarios).

b. INACTIVE

ASM scenario is not active (applies to monitored or managed scenarios).

c. ACTIVE

ASM scenario is active (applies to monitored scenarios).

d. ACTIVATED_CONFIRMED

ASM scenario is activated, confirmed valid (applies to managed scenarios).

e. ACTIVATED_NOT_CONFIRMED

ASM scenario is activated, not completely confirmed valid (applies to managed scenarios).

2. Used by: ASMScenarioActivation

Edition: 27.0 6 543

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.40. AUP
<<class>>

Represents an AUP, i.e. either indeed a (baseline) AUP or a UUP

1. Attributes:

a. AUPSummary summary (Mandatory)

Contains the summary information of the AUP/UUP

i. Constraints:

▪ AUP.INCONSISTENT_AUP_MANUAL_ENTRIES_AND_SUMMARY_NIL_AUP

b. AUPManualEntries aupManualEntries (Optional)

The list of manual AUP entries managed by the client application

i. Constraints:

▪ AUP.INCONSISTENT_AUP_MANUAL_ENTRIES_AND_SUMMARY_NIL_AUP

c. AUPComputedEntries aupComputedEntries (Contextual)

The list of computed AUP entries as computed by the NM system

i. Presence:

▪ Must be null in AUPCreationRequest AUPUpdateRequest AUPValidationRequest

▪ Optional otherwise

2. Constraints:

a. INCONSISTENT_AUP_MANUAL_ENTRIES_AND_SUMMARY_NIL_AUP

The attribute aupManualEntries must be null if summary.nilAUP is true.

Cannot be null otherwise.

Constrained attributes: summary, aupManualEntries

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

3. Used by: AUPValidationRequest, AUPCreationRequest, AUPCreationReplyData,

AUPRetrievalReplyData, AUPUpdateReplyData, AUPUpdateRequest

17.5.41. AUPChain
<<class>>

Represents an AUP chain, i.e. the AUP baseline of a (AMC, day) pair and its subsequent versions
(UUPs) in the day

1. Attributes:

Edition: 27.0 6 544

Document Title: NM 27.0 - NM B2B Reference Manual

a. DateYearMonthDay chainDate (Mandatory)

The date of the AUP chain

b. AirNavigationUnitId amcId (Mandatory)

The ANU id of the AMC to which this AUP chain belongs

c. AUPSummary[] aups (Mandatory)

The ordered list of AUP summaries in the chain.

The list is ordered according to the sequence of versions: the first summary in the list is the
baseline AUP, the second one is the first update version after the baseline AUP, and so forth.

The array can be empty.

2. Used by: AUPChainRetrievalReplyData

17.5.42. AUPChainRetrievalReplyData
<<class>>

The AUPChainRetrievalReply payload.

The returned AUPChain objects contain AUP summaries, each containing among others the AUP
identification to be used subsequently to retrieve a complete AUP, or update/delete it.

The chain retrieval fails if the chain date is not supported or if one of the requested AMC ids does
not exist in the AIRAC corresponding to the chain date.

1. Attributes:

a. AUPChain[] chains (Mandatory)

The retrieved AUP chains.

The array can be empty.

Remark
OBJECT_NOT_FOUND is returned if the AUPChain has never been created in the NM
system, being for the AUPChain of today, or in the future. The situation is slightly different
for an AUPChain in the past: it is immutable (will not change anymore) so that if at the end
of the day it contains no AUP, the NM system creates it empty — when requested such an
AUPChain is returned with OK status and an empty AUP/UUP list.

2. Used by: AUPChainRetrievalReply

17.5.43. AUPComputedEntries
<<class>>

Edition: 27.0 6 545

Document Title: NM 27.0 - NM B2B Reference Manual

AUP entries that are not manual, i.e. computed by the NM system based on default RSA availability
(implicitRSAs) and/or based on the result of the expansion via CHMI

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) implicitCDRs

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of implicit CDR openings and closures of this AUP.

Available (not null) only after an AMC has executed the expansion via
WARNING
CHMI.

Presence
1. Must be null if summary.expandedAUP is false, or if summary.nilAUP is true

2. Cannot be null (but can be empty) otherwise

See AUP CDRs Message.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) mergedCDRs

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of merged CDR openings and closures of this AUP.

This list is computed based on merging the explicit CDRs and the implicit CDRs (if any)
according to the following criteria (simplified): Merge all CDR updates for the same route,
CDR type and source that overlap or touch in flight level range, applicability period or CDR
update portion, where "merge" means taking the union of overlapping and touching
elements. E.g. periods 09:00 until 12:00 and 10:00 until 14:00 are merged into 09:00 until
14:00.

Presence
1. Must be null if summary.nilAUP is true

2. Cannot be null otherwise

See AUP CDRs Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) implicitRSAs

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of implicit RSA allocations of this AUP. Implicit RSA are non manageable airspaces
that are automatically allocated based on the default definition existing in NM. If a non
manageable Airspace is allocated explicitly instead, it will not be included in this list.

Edition: 27.0 6 546

Document Title: NM 27.0 - NM B2B Reference Manual

Presence
1. Must be null if summary.nilAUP is true

2. Cannot be null otherwise

See AUP RSA Allocations Message.

2. Used by: AUP

17.5.44. AUPCreationReplyData
<<class>>

The AUPCreationReply payload.

1. Attributes:

a. AUP aup (Mandatory)

The created AUP.

If returnComputed is true in the request, both manual and computed AUP entries are
returned.

2. Used by: AUPCreationReply

17.5.45. AUPDeletionReplyData
<<class>>

The AUPDeletionReply payload.

1. Used by: AUPDeletionReply

17.5.46. AUPGetManageableRouteSegmentsForAMCAndRouteReplyData
<<class>>

The AUPGetManageableRouteSegmentsForAMCAndRouteReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

manageableRouteSegments (Optional)

Documentation last updated: 27.0 - Edition 4

The route segments that can be managed.

See AUP CDRs Message.

2. Used by: AUPGetManageableRouteSegmentsForAMCAndRouteReply

Edition: 27.0 6 547

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.47. AUPGetManageableRoutesForAMCReplyData
<<class>>

The AUPGetManageableRoutesForAMCReply payload.

1. Attributes:

a. UUID[] openableRouteUUIDs (Mandatory)

Routes which contain CDRs to open

b. UUID[] closeableRouteUUIDs (Mandatory)

Routes which contain CDRs to close

2. Used by: AUPGetManageableRoutesForAMCReply

17.5.48. AUPId
<<typedef[string]>>

Unique id of an AUP, allocated by the NM system

1. Pattern: HEXA{24}

2. Used by: ASMScenarioActivationDeletionRequest, ASMScenarioActivationListRequest,

ASMScenarioActivationSummary, AUPRetrievalRequest, RADRestrictionActivationListRequest,
AUPDeletionRequest, AUPSummary, RADRestrictionActivationsUpdateRequest

17.5.49. AUPManualEntries
<<class>>

AUP Entries, i.e. CDR openings/closures and RSA allocations, to be provided by the client to NM.

The NM system does not support cross-AIRAC AUP entries, i.e. an AUPRSAAllocation or
AUPCDROpeningClosure cannot have a validity period crossing an AIRAC boundary (midnight on an
AIRAC date). It is the client’s responsibility to "cut" the AUP entries within an AUP to comply with
this constraint.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) cdrs

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of explicit CDR openings and closures of this AUP.

See AUP CDRs Message.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) rsas

Edition: 27.0 6 548

Document Title: NM 27.0 - NM B2B Reference Manual

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of explicit RSA allocations of this AUP.

See AUP RSA Allocations Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 4

The list of explicit RAD Restriction activations of this AUP.

See AUP RAD Restriction Activations Message.

2. Used by: AUP

17.5.50. AUPRetrievalReplyData
<<class>>

The AUPRetrievalReply payload.

1. Attributes:

a. AUP aup (Mandatory)

The retrieved AUP.

If returnComputed is true in the request, both manual and computed AUP entries are
returned.

2. Used by: AUPRetrievalReply

17.5.51. AUPRSAAllocationExpansionReplyData
<<class>>

The AUPRSAAllocationExpansionReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage ) implicitCDRs

(Optional)

Documentation last updated: 27.0 - Edition 4

The list of implicit CDRs computed by applying the expansion algorithm.

See AUP CDRs Message.

Edition: 27.0 6 549

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: AUPRSAAllocationExpansionReply

17.5.52. AUPServiceConfigurationReplyData
<<class>>

The AUPServiceConfigurationReply payload.

1. Attributes:

a. DateTimeMinute[] plannedUpdateStartTimes (Mandatory)

Next planned update (UUP) start times. At the moment, these are possibly:

1. One planned update start time for the current AUP chain

2. One planned update start time for the next AUP chain

2. Used by: AUPServiceConfigurationReply

17.5.53. AUPState
<<enumeration>>

Enumerates the possible states of an AUP.

1. Values:

a. DRAFT

After initial upload and successful validation, the AUP is in status DRAFT

b. READY

Once the AUP is in DRAFT status, operational coordination between adjacent AMCs and
FMPs takes place. Once the coordination is completed the AUP is promoted to READY status
by the AMC.

c. RELEASED

AUPs in READY are promoted to RELEASED by the CADF after the CADF has validated the
AUPs for completeness and consistency.

2. Used by: AUPSummary

17.5.54. AUPSummary
<<class>>

Represents an AUP summary, i.e. all its associated data apart from its main contents (CDR
openings/closures and RSA allocations).

1. Attributes:

Edition: 27.0 6 550

Document Title: NM 27.0 - NM B2B Reference Manual

a. AUPId id (Contextual)

Unique id that the NM system associates to the AUP

i. Presence:

▪ Mandatory in AUPUpdateRequest

▪ Must be null in AUPCreationRequest AUPValidationRequest

▪ Optional otherwise

b. AUPId originatingAupId (Optional)

Unique id of the originating AUP.

It must be the value of the use plan this UUP is based on.

i. Constraints:

▪ AUPSummary.ORIGINATING_AUP_ID_CANNOT_BE_NULL_IF_UUP_WRITE

▪ AUPSummary.ORIGINATING_AUP_ID_MUST_BE_NULL_IF_AUP_WRITE

c. DateYearMonthDay chainDate (Mandatory)

The date of the chain to which this AUP belongs

d. AirNavigationUnitId amcId (Contextual)

The ANU id of the AMC to which this AUP belongs.

It is associated to the AUP at creation time by the NM system.

Must be equal to the caller’s ANU id in any service that modifies an existing AUP.

i. Presence:

▪ Mandatory in AUPUpdateRequest

▪ Must be null in AUPCreationRequest AUPValidationRequest

▪ Optional otherwise

e. AUPType aupType (Mandatory)

Specifies if this AUP is a BASELINE (AUP) or an UPDATE (UUP). Redundant, used to check
that the client and server share the same understanding of what the object represents,
especially at creation time.

f. DateTimeMinutePeriod validityPeriod (Mandatory)

The period in which this AUP is valid.

When saving an AUP of type AUPType.BASELINE, must be [ 06:00, 06:00 [; when saving an
AUP of type AUPType.UPDATE, must be [ S, 06:00 [ where S is posterior or equal to the start
time of the validity period of the predecessor.

Edition: 27.0 6 551

Document Title: NM 27.0 - NM B2B Reference Manual

g. DateTimeMinute releaseTime (Contextual)

The time at which the AUP was released

i. Presence:

▪ Must be null in AUPCreationRequest AUPUpdateRequest AUPValidationRequest

▪ Optional otherwise

h. AUPState aupState (Mandatory)

Current state of this AUP

i. Constraints:

▪ AUPSummary.DRAFT_STATUS_NOT_ALLOWED_FOR_NIL_AUP

▪ AUPSummary.RELEASED_STATUS_NOT_ALLOWED_IN_WRITE_MODE

i. boolean nilAUP (Mandatory)

Indicates whether this AUP is nil or not

j. string remark (Mandatory)

Short remark associated to the AUP

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,128}

▪ AUPSummary.INVALID_REMARK

k. string[] note (Mandatory)

Additional information on the AUP

i. Constraints:

▪ array size range : [0, 25]

▪ Item pattern: MULTILINE_TEXT{0,255}

l. boolean expandedAUP (Mandatory)

Indicates whether the AUP contains implicit CDRs as a result of the AMC running the
expansion via CHMI.

Attention: the value of this attribute is not affected by the B2B - AUP expand service. Ignored
in all input AUPs.

m. LastUpdate lastUpdate (Contextual)

Last update information — set by system

i. Presence:

Edition: 27.0 6 552

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Mandatory in AUPUpdateRequest

▪ Must be null in AUPCreationRequest AUPValidationRequest

▪ Optional otherwise

n. boolean isP3 (Contextual)

Indicates alert for P3 requests

i. Presence:

▪ Must be null in AUPCreationRequest AUPUpdateRequest AUPValidationRequest

▪ Optional otherwise

2. Constraints:

a. ORIGINATING_AUP_ID_MUST_BE_NULL_IF_AUP_WRITE

Must be null when it is an AUP

Constrained attributes: originatingAupId

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

b. ORIGINATING_AUP_ID_CANNOT_BE_NULL_IF_UUP_WRITE

Cannot be null when it is a UUP

Constrained attributes: originatingAupId

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

c. RELEASED_STATUS_NOT_ALLOWED_IN_WRITE_MODE

Must be either DRAFT or READY in all write services — can be DRAFT, READY or RELEASED in read-
only services.

Constrained attributes: aupState

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

d. DRAFT_STATUS_NOT_ALLOWED_FOR_NIL_AUP

DRAFT status is not allowed for a nil AUP

Constrained attributes: aupState

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

e. INVALID_REMARK

According to the current CIAM/CHMI process, the AUP remark must start with the phrase
"NIL AUP " or "NIL UUP " if nilAUP is true and cannot start with these phrases otherwise; the
"AUP" or "UUP" bit must match the actual AUP type. In order to remove this constraint from

Edition: 27.0 6 553

Document Title: NM 27.0 - NM B2B Reference Manual

the client applications, the NM B2B system prefixes the given remark value with the
appropriate phrase (hence 8 characters) when nilAUP is true. As a consequence the character
set is:

1. (UALPHA|DIGIT|/| ){0,128} in output

2. (UALPHA|DIGIT|/| ){0,120} in input

Constrained attributes: remark

Constrained requests: AUPCreationRequest, AUPValidationRequest, AUPUpdateRequest

3. Used by: AUPChain, AUP

17.5.55. AUPType
<<enumeration>>

Enumerates the possible types of an AUP

1. Values:

a. BASELINE

Actual AUP, starting an AUPChain

b. UPDATE

Actual UUP, following an AUP or UUP in an AUPChain

2. Used by: AUPSummary

17.5.56. AUPUpdateReplyData
<<class>>

The AUPUpdateReply payload.

1. Attributes:

a. AUP aup (Mandatory)

In case of successful update, the saved AUP. If returnComputed is true in the request, both
manual and computed AUP entries are returned.

2. Used by: AUPUpdateReply

17.5.57. AUPValidationReplyData
<<class>>

The AUPValidationReply payload.

Edition: 27.0 6 554

Document Title: NM 27.0 - NM B2B Reference Manual

1. Used by: AUPValidationReply

17.5.58. CompleteAIXMDatasetReplyData
<<class>>

The CompleteAIXMDatasetReply payload.

1. Attributes:

a. CompleteDatasetSummary[] datasetSummaries (Mandatory)

The references to the requested ADR AIXM files

2. Used by: CompleteAIXMDatasetReply

17.5.59. CompleteDatasetQueryCriteria
<<union>>

The criteria to query Complete Airspace Datasets

1. Choices:

a. AiracIdentifier airac

Specific AIRAC (AIRAC id or AIRAC sequence number) for which datasets are requested.
Only datasets related to the specified AIRAC are returned. Normally, the data effective at a
particular AIRAC is made available by NM 6 days before the AIRAC switch, so a query for all
datasets of a given AIRAC may return from 0 to 34 datasets (28 days of AIRAC + 6 days in
advance).

b. DateYearMonthDay date

Allows querying for datasets based on their publication date

c. DateYearMonthDayPeriod publicationPeriod

Allows querying for datasets based on their publication date: only datasets published within
the given period will be returned

2. Used by: CompleteAIXMDatasetRequest

17.5.60. CompleteDatasetSummary
<<class>>

Describes a Complete Airspace Dataset

1. Attributes:

a. AirspaceDataUpdateId updateId (Mandatory)

Edition: 27.0 6 555

Document Title: NM 27.0 - NM B2B Reference Manual

The id of the latest update included in the data set. This updateId is the key to be used to
query for subsequent updates (Incremental Airspace Datasets).

Remark
This key must be considered as opaque: it is not supposed to be modified by the user.

b. DateYearMonthDay publicationDate (Mandatory)

The date in which the dataset was made available by NM

c. AiracIdentifier[] sourceAIRACs (Mandatory)

This is an array of either one or two elements that contains the identifiers of the AIRAC
cycles potentially affected by the data set

i. Constraints:

▪ array size range : [1, 2]

d. AIXMFile[] files (Mandatory)

The list of AIXM file ids that compose the dataset

2. Used by: AirspaceDataMessagePayload, CompleteAIXMDatasetReplyData

17.5.61. DBEOrPublishedPointId
<<union>>

Represents a DBE or Published point identifier

1. Choices:

a. DBEPointId DBE

The DBE point identifier

b. PublishedPointId PUBLISHED

The PUBLISHED point identifier

2. Used by: DeltaLevelReroutingConstraint, ScenarioLevelConstraint,

LevelAndSpeedReroutingConstraint, AvoidViaPointReroutingConstraint

17.5.62. DBEPoint
<<class>>

Represents a non-published DBE point

1. Inherits from: NonPublishedPoint

2. Attributes:

Edition: 27.0 6 556

Document Title: NM 27.0 - NM B2B Reference Manual

a. DBEPointId dbePointId (Mandatory)

DBE point identifier

i. Constraints:

▪ DBEPoint.UNSUPPORTED_POINT_TYPE

3. Constraints:

a. UNSUPPORTED_POINT_TYPE

The DBEPoint is supported only in FLIGHT_LIST_REPLY context

Constrained attributes: dbePointId

Constrained requests: FlightListByAerodromeReply, FlightListByAerodromeSetReply,

FlightListByAircraftOperatorReply, FlightListByAircraftRegistrationMarkReply,
FlightListByAirspaceReply, FlightListByHotspotReply, FlightListByKeysReply,
FlightListByMeasureReply, FlightListByPointReply, FlightListByTrafficVolumeReply,
FlightRetrievalReply

17.5.63. DBEPointId
<<typedef[string]>>

Old Point id still in use by IPFS and EFTMS

1. Pattern: (UALPHA|DIGIT|*){1,5}

2. Used by: DBEOrPublishedPointId, DBEPoint, ReferenceLocationDBEPoint

17.5.64. DraftEAUPRADRestrictionActivationReplyData (new 27.0)

<<class>>

The DraftEAUPRADRestrictionActivationReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RAD restriction activations matching the request.

See EAUP RAD Restriction Activations Message.

2. Used by: DraftEAUPRADRestrictionActivationReply

Edition: 27.0 6 557

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.65. DraftEAUPsRetrievalReplyData
<<class>>

The DraftEAUPsRetrievalReply payload.

1. Attributes:

a. DraftEAUPSummary[] draftEaups (Mandatory)

Requested DRAFT EAUPs

2. Used by: DraftEAUPsRetrievalReply

17.5.66. DraftEAUPSummary
<<class>>

Summary (used as reference) of a DRAFT EAUP

1. Attributes:

a. DateTimeMinute releaseTime (Mandatory)

The time at which the DRAFT EAUP has been released and therefore became available to the
user

b. DateTimeMinutePeriod validityPeriod (Mandatory)

The period in which this DRAFT EAUP is valid

2. Used by: DraftEAUPsRetrievalReplyData

17.5.67. EAUPCDRCompareReplyData
<<class>>

The EAUPCDRCompareReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

commonCDROpeningsClosures (Optional)

Documentation last updated: 27.0 - Edition 4

The list of CDR openings and closures matching the request and that are common to the two
requested EAUPs.

See EAUP CDRs Message.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

cdrOpeningsClosuresIn1Only (Optional)

Edition: 27.0 6 558

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 4

The list of CDR openings and closures matching the request and that only appear in the
EAUP identified by eaupId1.

See EAUP CDRs Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

cdrOpeningsClosuresIn2Only (Optional)

Documentation last updated: 27.0 - Edition 4

The list of CDR openings and closures matching the request and that only appear in the
EAUP identified by eaupId2.

See EAUP CDRs Message.

2. Used by: EAUPCDRCompareReply

17.5.68. EAUPCDRReplyData
<<class>>

The EAUPCDRReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

cdrOpeningsClosures (Optional)

Documentation last updated: 27.0 - Edition 4

The list of CDR openings and closures matching the request.

Null if no CDR opening/closure matched the request.

See EAUP CDRs Message.

2. Used by: DraftEAUPCDRReply, EAUPCDRReply

17.5.69. EAUPChain

Edition: 27.0 6 559

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Represents an EAUP chain, i.e. the EAUP baseline of a day and its subsequent versions in the day

1. Attributes:

a. DateYearMonthDay chainDate (Mandatory)

The date of the EAUP chain. Valid chain dates are:

1. D-1 (pre-tactical, tomorrow)

2. D (tactical, today)

3. [ D+1 (yesterday), D+15 months ] (post-ops)

b. EAUPSummary[] eaups (Mandatory)

The ordered list of EAUP summaries in the chain. The list is sorted according to the sequence
of versions: the first summary in the list is the baseline EAUP, the second one is the first
update version (EUUP) after the baseline EAUP, and so forth. This sorting is recalled in the
EAUPIdentification through a sequence number.

The array can be empty.

Remark
OBJECT_NOT_FOUND is returned if the EAUPChain has never been created in the NM
system, being for the EAUPChain of today, or in the future. The situation is slightly different
for an EAUPChain in the past: it is immutable (will not change anymore) so that if at the
end of the day it contains no EAUP, the NM system creates it empty — when requested
such an EAUPChain is returned with OK status and an empty EAUP/EUUP list.

2. Used by: EAUPChainRetrievalReplyData

Edition: 27.0 6 560

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.70. EAUPChainRetrievalReplyData
<<class>>

The EAUPChainRetrievalReply payload.

1. Attributes:

a. EAUPChain chain (Mandatory)

The retrieved EAUP chain

2. Used by: EAUPChainRetrievalReply

17.5.71. EAUPIdentification
<<class>>

Represents the unique id of a released EAUP

1. Attributes:

a. DateYearMonthDay chainDate (Mandatory)

The date of the chain to which this EAUP belongs

i. Constraints:

▪ EAUPIdentification.INVALID_CHAIN_DATE

b. int sequenceNumber (Mandatory)

The position of the EAUP in its chain — the baseline occupies position 0

i. Constraints:

▪ range : [0, unbounded[

2. Constraints:

a. INVALID_CHAIN_DATE

The chainDate must be a date which belongs to interval [ today - 15 months, today + 2 days ]

Constrained attributes: chainDate

Constrained requests: DraftEAUPCDRRequest, DraftEAUPRSARequest, EAUPCDRCompareRequest,

EAUPCDRRequest, EAUPRSACompareRequest, EAUPRSARequest

3. Used by: EAUPCDRRequest, EAUPRADRestrictionActivationCompareRequest, EAUPRSACompareRequest,

EAUPCDRCompareRequest, EAUPSummary, EAUPRADRestrictionActivationRequest, EAUPRSARequest

Edition: 27.0 6 561

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.72. EAUPPayloadConfiguration (new 27.0)

<<class>>

A payload configuration for subscription topic SubscriptionTopic.EAUP .

1. Attributes:

a. boolean includeCDROpeningsClosures (Mandatory)

Indicates whether the message will contain or not the CDR Openings Closures.

b. boolean includeRSAAllocations (Mandatory)

Indicates whether the message will contain or not the RSA Allocations.

c. boolean includeRADRestrictionActivations (Mandatory)

Indicates whether the message will contain or not the RAD Restriction Activations.

2. Used by: EAUPSubscription, EAUPSubscriptionCreationRequest, EAUPSubscriptionUpdateRequest

17.5.73. EAUPRADRestrictionActivationCompareReplyData (new 27.0)

<<class>>

The EAUPRADRestrictionActivationCompareReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

commonRADRestrictionActivations (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RAD restriction activations present in both EAUPs.

See EAUP RAD Restriction Activations Message.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivationsIn1Only (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RAD restriction activations present only in the first EAUP.

See EAUP RAD Restriction Activations Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivationsIn2Only (Optional)

Documentation last updated: 27.0 - Edition 4

Edition: 27.0 6 562

Document Title: NM 27.0 - NM B2B Reference Manual

The list of RAD restriction activations present only in the second EAUP.

See EAUP RAD Restriction Activations Message.

2. Used by: EAUPRADRestrictionActivationCompareReply

17.5.74. EAUPRADRestrictionActivationReplyData (new 27.0)

<<class>>

The EAUPRADRestrictionActivationReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RAD restriction activations matching the request.

Null if no RAD restriction activation matched the request.

See EAUP RAD Restriction Activations Message.

2. Used by: EAUPRADRestrictionActivationReply

17.5.75. EAUPRSACompareReplyData
<<class>>

The EAUPRSACompareReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

commonRSAAllocations (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RSA allocations matching the request and that are common to the two requested
EAUPs.

See EAUP RSA Allocations Message.

b. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

rsaAllocationsIn1Only (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RSA allocations matching the request and that only appear in the EAUP identified
by eaupId1.

Edition: 27.0 6 563

Document Title: NM 27.0 - NM B2B Reference Manual

See EAUP RSA Allocations Message.

c. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

rsaAllocationsIn2Only (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RSA allocations matching the request and that only appear in the EAUP identified
by eaupId2.

See EAUP RSA Allocations Message.

2. Used by: EAUPRSACompareReply

17.5.76. EAUPRSAReplyData
<<class>>

The EAUPRSAReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

rsaAllocations (Optional)

Documentation last updated: 27.0 - Edition 4

The list of RSA allocations matching the request.

Null if no RSA allocation matched the request.

See EAUP RSA Allocations Message.

2. Used by: DraftEAUPRSAReply, EAUPRSAReply

17.5.77. EAUPSubscription (new 27.0)

Edition: 27.0 6 564

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic EAUP.

1. Inherits from: Subscription

2. Attributes:

a. EAUPPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: EAUPSubscriptionRetrievalReplyData, EAUPSubscriptionUpdateReplyData,

EAUPSubscriptionCreationReplyData

17.5.78. EAUPSubscriptionCreationReplyData (new 27.0)

<<class>>

The EAUPSubscriptionCreationReply payload.

1. Attributes:

a. EAUPSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: EAUPSubscriptionCreationReply

17.5.79. EAUPSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The EAUPSubscriptionRetrievalReply payload.

1. Attributes:

a. EAUPSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: EAUPSubscriptionRetrievalReply

17.5.80. EAUPSubscriptionUpdateReplyData (new 27.0)

<<class>>

The EAUPSubscriptionUpdateReply payload.

1. Attributes:

a. EAUPSubscription subscription (Mandatory)

Instance of the newly updated subscription.

Edition: 27.0 6 565

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: EAUPSubscriptionUpdateReply

17.5.81. EAUPSummary
<<class>>

Represents an EAUP summary, i.e. all its associated data apart from its main contents (CDR
openings/closures and RSA allocations)

1. Attributes:

a. DateTimeMinute releaseTime (Mandatory)

The time at which the EAUP has been released and therefore became available to the user of
this service

b. DateTimeMinutePeriod validityPeriod (Mandatory)

The period in which this EAUP is valid

c. EAUPIdentification eaupId (Mandatory)

The unique id of the EAUP. This is the object to be subsequently used for retrieving the
contents of the EAUP.

2. Used by: EAUPMessage, EAUPChain

17.5.82. ErrorCategory
<<enumeration>>

Documentation last updated: 27.0 - Edition 1

Error categories for this service group.

1. Values:

a. FUA

For all input validation errors related to AUP/EAUP

17.5.83. ErrorType
<<enumeration>>

Error types for this service group.

1. Values:

a. AUP_ALREADY_EXISTS

The referred AUP already exists

Edition: 27.0 6 566

Document Title: NM 27.0 - NM B2B Reference Manual

b. AUP_AMC_BID_NOT_FOUND

The AMC must exist in NM

c. AUP_AMC_MUST_EXIST

The AMC must exist for the whole lifetime of the AUP

d. AUP_CDR_UPDATE_AMC_NOT_RESPONSIBLE

The originator AMC must be completely responsible for the CDR update segment of the CDR
update

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

e. AUP_CDR_UPDATE_CLOSURE_CDR_TYPE

A CDR closure must refer to route segments that are closeable in at least one direction, i.e.
ATS and CDR1 in one direction, and not CDR2 in the other direction

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

f. AUP_CDR_UPDATE_FL_RANGE

A singleton altitude range cannot be opened/closed

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

g. AUP_CDR_UPDATE_FL_RANGE_ERROR

The provided flight level range must be valid e.g. lower limit < upper limit

Parameters:

1. "LOWERLIMIT": Lower limit of the flight level range

2. "UPPERLIMIT": Upper limit of the flight level range

Edition: 27.0 6 567

Document Title: NM 27.0 - NM B2B Reference Manual

3. "ROUTE": Route segment given by its NM unique id

4. "START_POINT": Start point of the route segment, given by its NM unique id

5. "END_POINT": End point of the route segment, given by its NM unique id

h. AUP_CDR_UPDATE_FL_TOO_LARGE

In CDR update, the flight level range must be inside the flight level range of the route

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

i. AUP_CDR_UPDATE_LOWER_CRUISING_LEVEL

In CDR update, if there is no cruising flight level between the lower limit of the CDR update
and the lower limit of the default route availability, the lower limit of the CDR update must
be extended to the lower limit of the default route availability

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT_1": Start point of the first route segment, given by its NM unique id

3. "END_POINT_1": End point of the first route segment, given by its NM unique id

4. "START_POINT_2": Start point of the second route segment, given by its NM unique id

5. "END_POINT_2": End point of the second route segment, given by its NM unique id

6. "FLIGHT_LEVEL": Altitude given by a flight level value

7. "EXPECTED_FL": Expected lower limit of the CDR update given by a flight level value

j. AUP_CDR_UPDATE_LOWER_FL_NOT_CRUISING_LEVEL

For bi-directional route segments, the lower limit of the CDR update must be such that the
CDR update covers the lower cruising level of the route segment

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT_1": Start point of the first route segment, given by its NM unique id

3. "END_POINT_1": End point of the first route segment, given by its NM unique id

4. "START_POINT_2": Start point of the second route segment, given by its NM unique id

5. "END_POINT_2": End point of the second route segment, given by its NM unique id

6. "FLIGHT_LEVEL": Altitude given by a flight level value

Edition: 27.0 6 568

Document Title: NM 27.0 - NM B2B Reference Manual

7. "EXPECTED_FL": Expected lower limit of the CDR update given by a flight level value

k. AUP_CDR_UPDATE_NOTAM_CLOSURE

A CDR closure must refer to route segments that are closed by NOTAM for the whole flight
level range and applicability period

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

l. AUP_CDR_UPDATE_NO_CRUISING_LEVEL

In CDR update, the flight level range must include at least one cruising level

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

m. AUP_CDR_UPDATE_OPENING_CDR_TYPE

A CDR opening must refer to route segments that can be opened in at least one direction, i.e.
CDR2, and not ATS or CDR1 in the other

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

n. AUP_CDR_UPDATE_OVERLAP

Applicability period and flight level range of CDR updates cannot overlap

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

o. AUP_CDR_UPDATE_OVERLAPS_AIRAC_SWITCH

AUP CDR update overlaps with AIRAC switch

Edition: 27.0 6 569

Document Title: NM 27.0 - NM B2B Reference Manual

p. AUP_CDR_UPDATE_PERIOD_AUP_MISMATCH

AUP CDR update period does not match AUP period

q. AUP_CDR_UPDATE_POINT_IN_ROUTE

The points forming the route segment of CDR update must be part of the route

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

r. AUP_CDR_UPDATE_PTS_ROUTE

The CDR update is not allowed for a PTS route

Parameters:

1. "ROUTE":Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

s. AUP_CDR_UPDATE_ROUTE_MUST_EXIST

The route must exist for the whole lifetime of the CDR update

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

t. AUP_CDR_UPDATE_STATUS_CONFLICT

AUP CDR update status conflict

u. AUP_CDR_UPDATE_UPPER_CRUISING_LEVEL

In CDR update, if there is no cruising flight level between the upper limit of the CDR update
and the upper limit of the default route availability, the upper limit of the CDR update must
be extended to the upper limit of the default route availability

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT_1": Start point of the first route segment, given by its NM unique id

Edition: 27.0 6 570

Document Title: NM 27.0 - NM B2B Reference Manual

3. "END_POINT_1": End point of the first route segment, given by its NM unique id

4. "START_POINT_2": Start point of the second route segment, given by its NM unique id

5. "END_POINT_2": End point of the second route segment, given by its NM unique id

6. "FLIGHT_LEVEL": Altitude given by a flight level value

7. "EXPECTED_FL": Expected upper limit of the CDR update given by a flight level value

v. AUP_CDR_UPDATE_UPPER_FL_NOT_CRUISING_LEVEL

In CDR update, for bi-directional route segments, the upper limit of the CDR update must be
such that the CDR update covers a cruising level

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT_1": Start point of the first route segment, given by its NM unique id

3. "END_POINT_1": End point of the first route segment, given by its NM unique id

4. "START_POINT_2": Start point of the second route segment, given by its NM unique id

5. "END_POINT_2": End point of the second route segment, given by its NM unique id

6. "FLIGHT_LEVEL": Altitude given by a flight level value

7. "EXPECTED_FL": Expected upper limit of the CDR update given by a flight level value

w. AUP_CDR_UPDATE_VALID_POINT_TYPES

The start and end points of merged opened or closed route segment (one or more segments)
must be way points or navigation aid points (this validation does not refer to manual CDR
updates)

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

x. AUP_CDR_UPDATE_WRONG_ROUTE_TYPE

CDR updates are not allowed on oceanic routes

Parameters:

1. "ROUTE": Route segment given by its NM unique id

2. "START_POINT": Start point of the route segment, given by its NM unique id

3. "END_POINT": End point of the route segment, given by its NM unique id

y. AUP_DOES_NOT_EXIST

Edition: 27.0 6 571

Document Title: NM 27.0 - NM B2B Reference Manual

The referred AUP must exist

z. AUP_EMPTY

The AUP is not nil and does not contain any AUP manual entry

aa. AUP_FL_RANGE_UOM_ERROR

The unit of measurement is not correct

ab. AUP_NIL_AUP_MANUAL_MUST_BE_NULL

In a nil AUP, AUP manual entries must be null

ac. AUP_NIL_AUP_NOT_EMPTY

Nil AUP must be empty

ad. AUP_NIL_AUP_STATE

A nil AUP cannot be in DRAFT state

ae. AUP_OUTSIDE_AVAILABILITY_PERIOD

The AUP and its content must be defined within the availability period

af. AUP_RSA_ALLOCATION_AMC_NOT_RESPONSIBLE

The originator AMC must be responsible for the RSA of the RSA allocations

ag. AUP_RSA_ALLOCATION_COMPOSED_OVERLAP

Applicability period and flight level range of (composed) RSA allocations cannot overlap
with (composing) RSA allocations

Parameters:

1. "RESTRICTED_AIRSPACE_COMPOSED": Composed restricted airspace given by its NM

unique id

2. "RESTRICTED_AIRSPACE_COMPOSING": Composing restricted airspace given by its NM

unique id

ah. AUP_RSA_ALLOCATION_FL_RANGE

In RSA allocation, a singleton altitude range cannot be allocated

ai. AUP_RSA_ALLOCATION_FL_RANGE_ERROR

The provided flight level range must be valid e.g. lower limit < upper limit

Parameters:

Edition: 27.0 6 572

Document Title: NM 27.0 - NM B2B Reference Manual

1. "LOWERLIMIT": Lower limit of the flight level range

2. "UPPERLIMIT": Upper limit of the flight level range

3. "AIRSPACE": The Airspace that is allocated, given by its NM unique id

aj. AUP_RSA_ALLOCATION_OVERLAP

Applicability period and flight level range of RSA allocations cannot overlap

ak. AUP_RSA_ALLOCATION_PERIOD_AUP_MISMATCH

The RSA allocation period must be within the validity period of the AUP

al. AUP_RSA_ALLOCATION_PERIOD_RSA_MISMATCH

The RSA allocation period must be within the availability period of the RSA

am. AUP_RSA_ALLOCATION_RSA_MUST_EXIST

The RSA must exist for the whole lifetime of the RSA allocation

an. AUP_RSA_ALLOCATION_VERTICAL_LIMITS

Vertical limits of an RSA allocation must be within the vertical limits of the RSA

ao. AUP_RSA_UPDATE_OVERLAPS_AIRAC_SWITCH

AUP RSA update overlaps with AIRAC switch

ap. AUP_UNDEFINED_UUP_START_TIME

The start time of an UUP must have been defined by the CADF

aq. AUP_VALID_STATUS

The AUP must have a valid status

ar. EXPAND_WRONG_PERIOD

The period provided for expansion should end at 06:00 AM and cannot be longer than 24
hours

as. INVALID_UUID

The provided AUP UUID must have a valid format

at. TIMESTAMP_MISMATCH

The provided AUP timestamp does not match the timestamp of the existing AUP

au. AUP_ORIGINATING_ID_INVALID

The originating AUP id is invalid. Valid AUP ids are the results of a creation or query.

Edition: 27.0 6 573

Document Title: NM 27.0 - NM B2B Reference Manual

av. AUP_ORIGINATING_ID_NON_EMPTY

When creating an AUP, the originating AUP id should be empty

aw. AUP_ORIGINATING_ID_EMPTY

When creating a UUP, the originating AUP id should not be empty

ax. AUP_ORIGINATING_ID_NON_UPDATEABLE

Read-only originating AUPs cannot be updated

ay. UUP_WILL_CANCEL_PREVIOUS_AUP_UUP

This is a warning to indicate that all RSA allocations and CDR updates from the previous
AUP/UUP will be overwritten

az. UUP_RSA_ALLOCATION_LEAD_TIME_TOO_SHORT

Users should be warned of any new or extended (flight level range or applicability) RSA
allocation with lead time of less than configured value

ba. UUP_CDR_CLOSURE_LEAD_TIME_TOO_SHORT

Users should be warned of any new or extended (flight level range or applicability)
CDR1/ATS route closure with lead time of less than configured value

bb. UUP_CDR_RECLOSURE_LEAD_TIME_TOO_SHORT

Users should be warned of any new or extended (flight level range or applicability) CDR2 re-
closure with lead time of less than configured value

bc. UUP_CDR_RECLOSURE_FOUND

When promoting UUP to the READY status, the users must be warned of any occurrence of
CDR2 closure of a route portion which was previously open by AUP or UUP

bd. AUP_UUP_NO_CLOSURE_WITH_NOTAM

An AUP closure is not at all covered by a NOTAM closure

be. AUP_UUP_PARTIALLY_COVERED_BY_NOTAM

An AUP closure is only partially covered by NOTAM closures

bf. AUP_UUP_PARTIALLY_COVERS_NOTAM

A NOTAM closure is only partially covered by AUP closures

bg. AUP_AMC_DELEGATED_ROUTE_PORTION_NOT_USED

This is a warning indicating that the AUP/UUP does not use a route portion that was

Edition: 27.0 6 574

Document Title: NM 27.0 - NM B2B Reference Manual

delegated to the corresponding AMC

bh. AUP_USES_ROUTE_PORTION_DELEGATED_TO_OTHER_AMC

This is a warning indicating that the AUP/UUP is using a route portion that was delegated to
another AMC

bi. AUP_INVALID_PERIOD

The provided AUP period is invalid

bj. AUP_ONLY_ONE_SEGMENT_PROVIDED_AT_AIRAC_SWITCH

Only one AUP segment was provided at AIRAC switch

bk. AUP_PERIOD_BETWEEN_6_AND_6_AM

AUP period should be 06:00 AM of day till 06:00 AM of following day

bl. AUP_CDR_UPDATE_OVERLAPS_BETWEEN_AMCS

A CDR update conflicts with a CDR update from another AMC

Parameters:

1. "ROUTE": NM unique id of the route from the CDR update

2. "START_POINT": NM unique id of the start point from the CDR update

3. "END_POINT": NM unique id of the end point from the CDR update

4. "ROUTE": NM unique id of the route from the CDR update of the other AMC

5. "START_POINT": NM unique id of the start point from the CDR update of the other AMC

6. "END_POINT": NM unique id of the end point from the CDR update of the other AMC

7. "AMC": AMC id of the other AMC

bm. AUP_FUA_ACTIVATION_FUA_MUST_EXIST

The FUA Restriction that is being activated does not exist (yet or anymore) in the AIRAC of
the RSA allocation

Parameters:

1. "FUA_RESTRICTION": NM unique id of the FUA restriction

2. "RESTRICTED_AIRSPACE": NM unique id of the RSA

bn. AUP_FUA_ACTIVATION_REMARK_INVALID_FORMAT

The FUA activation remark is composed of a limited set of characters. Lowercase characters
are not part of this limited set

Parameters:

Edition: 27.0 6 575

Document Title: NM 27.0 - NM B2B Reference Manual

1. "FUA_RESTRICTION": NM unique id of the FUA restriction

bo. AUP_FUA_ACTIVATION_REMARK_TOO_LONG

The size of the FUA activation remark is limited to 128 characters

Parameters:

1. "FUA_RESTRICTION": NM unique id of the FUA restriction

bp. AUP_FUA_ACTIVATION_REMARK_INVALID_CHARS

The FUA restriction activation remark contains invalid characters

Parameters:

1. "FUA_RESTRICTION": NM unique id of the FUA restriction

bq. AUP_RSA_ALLOCATION_RSA_FBZ_OVERLAP

When both FBZ and its owner RSA are allocated, the allocations must not overlap in time or
flight level range

Parameters:

1. "RESTRICTED_AIRSPACE_1": NM unique id of the FBZ

2. "RESTRICTED_AIRSPACE_2": NM unique id of the owner RSA

br. AUP_FBZ_ALLOCATION_MUST_HAVE_FUA_ALLOCATION

An FBZ allocation must have at least one activated FUA activation

Parameters:

1. "RESTRICTED_AIRSPACE_1": NM unique id of the FBZ

bs. AUP_FUA_ACTIVATION_FOR_DISABLED_RESTRICTION

The FUA restriction of the FUA allocation must be enabled in the AIRAC of the activation

Parameters:

1. "FUA_RESTRICTION": NM unique id of the FUA restriction which is not enabled

bt. AUP_FUA_ACTIVATION_IS_NOT_RELATED_TO_RSA

The FUA restriction of the RSA allocation must have the allocated RSA as its reference
location

Parameters:

1. "FUA_RESTRICTION": NM unique id of the FUA restriction

Edition: 27.0 6 576

Document Title: NM 27.0 - NM B2B Reference Manual

2. "RESTRICTED_AIRSPACE": NM unique id of the RSA

bu. AUP_RSA_ALLOCATION_MUST_HAVE_FUA_ALLOCATION

All the FUA restrictions which have the RSA as their reference location should be explicitly
mentioned as activated or not

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

2. "FUA_RESTRICTION": NM unique id of the FUA restriction that is not in the list of FUA
activations

bv. AUP_RSA_ALLOCATIONS_OVERLAP

Two geometrically overlapping RSAs under the responsibility of on AMC must not have RSA
allocations overlapping in time and flight level

Parameters:

1. "RESTRICTED_AIRSPACE_1": NM unique id of the first RSA

2. "WEF_TIME": start time of the time overlap (e.g. 10:00)

3. "TIL_TIME": end time of the time overlap (e.g. 11:00)

4. "RESTRICTED_AIRSPACE_2": NM unique id of the second RSA

5. "LOWER_FL": lower flight level of the flight level overlap

6. "UPPER_FL": upper flight level of the flight level overlap

bw. AUP_RSA_ALLOCATIONS_OVERLAP_OTHER_AMC

Two geometrically overlapping RSAs under the responsibility of two different AMCs must
not have RSA allocations overlapping in time and flight level range

Parameters:

1. "RESTRICTED_AIRSPACE_1": NM unique id of the first RSA

2. "WEF_TIME": start time of the time overlap (e.g. 10:00)

3. "TIL_TIME": end time of the time overlap (e.g. 11:00)

4. "RESTRICTED_AIRSPACE_2": NM unique id of the second RSA

5. "LOWER_FL": lower flight level of the flight level overlap

6. "UPPER_FL": upper flight level of the flight level overlap

bx. AUP_PUBLISH_TIME_MUST_NOT_BE_SET

The AUP must have an empty publication time

by. UUP_MUST_NOT_BE_EMPTY

Edition: 27.0 6 577

Document Title: NM 27.0 - NM B2B Reference Manual

The UUP cannot be empty

bz. UUP_PUBLISH_IN_PROGRESS

UUP publish is in progress

ca. RSA_DEALLOCATED_WHILE_FBZ_STILL_ALLOCATED

This is a warning that the RSA has been de-allocated for an applicability period and a flight
level range while its FBZ is still allocated

cb. RSG_NOT_VALID_FUA_RSG

The restriction group must be of category FUA or FUARAD.

cc. RSG_NOT_ENABLED

An airspace allocation in an AUP wants to activate a restriction group, but the enabled flag
of that restriction group is set to false.

cd. SET_FUA_RSG_CONFIRMED_INDICATOR_TO_TRUE

Confirmed indicator of FUA RSG activation must be set to 'true'.

Such an error appears in the NM B2B services for technical reason only. It
NOTE
shall never occur.

ce. FUA_RSG_ACTIVATION_REMARK_TOO_LONG

Too many characters in remark field of the restriction group activation.

cf. FUA_RSG_ACTIVATION_REMARK_INVALID_CHARS

Some submitted characters are not allowed by the backend (ENV). Alternatively this could
be coded in the XML Schema but a relaxation of the allowed character set would lead to
backward compatibility problems.

cg. ALL_RS_IN_RSG_MUST_BE_ACTIVATED

In some cases the activation of a restriction implies the allocation of a whole group. The
restrictions inside the group are explicitly listed because restrictions groups were initially
not exported in the B2B.

ch. RSG_NOT_LINKED_TO_RSA_ERROR_MSG

An airspace allocation in an AUP wants to activate a restriction group, but that restriction
group is not related to that airspace.

ci. UUP_P3_FLAG_SET

The 'Procedure 3' ('P3') flag is only used by AMCs and CADF before publication of a UUP. In

Edition: 27.0 6 578

Document Title: NM 27.0 - NM B2B Reference Manual

this case the CDR2 opening of a previous AUP/UUP in the chain was removed and the 'P3'
flag indicates this.

Parameters:

1. "ROUTE_SEGMENT": route segment

2. "APPLICABILITY_PERIOD": applicability period

3. "FL_RANGE": altitude range

cj. AUP_RSA_FLEXIBLE_USE_NOT_TRUE

The flag 'FUA Flexible Use' of the restricted airspace must be set to true in order to perform
the allocation.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

ck. AUP_RSG_DEFAULT_FUA_ACTIVE_NOT_SAME

The value of the 'Default FUA Active' flag of the restriction group must be the same for all
the restrictions that are part of this restriction group.

cl. AUP_CDR_UPDATE_PORTION_MUST_EXIST

Both points of the portion must exist for the whole lifetime of the CDR update

cm. NOTAM_EXTENSION_OVERLAPS_DELEGATION_PERIOD

The NOTAM extended allocation period overlaps with a period when the RSA is delegated to
another AMC.

cn. NOTAM_EXTENSION_WITH_EMPTY_REMARK

The remark is expected to be of the form NOTAM followed by a number indicating the
NOTAM number, e.g. NOTAM12345.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

co. NOTAM_EXTENSION_NOT_SUPPORTED

ComposedRsa airspaces cannot (yet) be allocated outside the normal limits.

cp. AUP_INVALID_RSG_ID

The provided RSG id is invalid

cq. AMC_UPDATEABLE_ONLY_FOR_AMA

Edition: 27.0 6 579

Document Title: NM 27.0 - NM B2B Reference Manual

The airspace allocation cannot update the (is)AMC flag for NAM airspaces.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cr. AMC_ACTIVE1

An ASM scenario has been triggered - some coordination is needed. Lists the involved
scenario and RSAs.

cs. AMC_ACTIVE2

An ASM Scenario has been triggered - some coordination is needed. Lists the involved AMCs.

ct. AUP_RSA_ALLOCATION_LOWER_LIMIT_FT_NOT_IN_FEET

RSA allocation the unit of measurement of lower limit Ft must be 'feet'.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cu. AUP_RSA_ALLOCATION_LOWER_LIMIT_FT_NOT_IN_RANGE

RSA allocation lower Limit Ft must be ≥ 0 and ≤ 99999.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cv. AUP_RSA_ALLOCATION_LOWER_LIMIT_FT_NOT_DEFINED

RSA allocation lower limit in Ft must be provided when the upper limit in Ft is defined.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cw. AUP_RSA_AVAILABILITY_LOWER_LIMIT_FT_NOT_DEFINED

RSA allocation lower limit in Ft can only be defined if Rsa availability lower limit in Ft is
defined.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cx. AUP_RSA_ALLOCATION_LOWER_LIMIT_FT_NOT_EQUAL_RSA_LOWER_LIMIT

RSA allocation lower limit in Ft must be equal to the RSA lower limit or must be blank.

Parameters:

Edition: 27.0 6 580

Document Title: NM 27.0 - NM B2B Reference Manual

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cy. AUP_RSA_ALLOCATION_LOWER_LIMIT_FT_NOT_IN_RSA_RANGE

RSA allocation lower limit in Ft must be < RSA upper limit and ≥ RSA lower limit.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

cz. AUP_RSA_ALLOCATION_UPPER_LIMIT_FT_NOT_IN_FEET

RSA allocation the unit of measurement of upper limit Ft must be 'feet'.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

da. AUP_RSA_ALLOCATION_UPPER_LIMIT_FT_NOT_IN_RANGE

RSA allocation upper Limit Ft must be > 0 and ≤ 99999.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

db. AUP_RSA_ALLOCATION_LIMIT_FT_INVALID_RANGE

RSA allocation upper limit in Ft must be > lower limit in Ft.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

dc. AUP_RSA_AVAILABILITY_UPPER_LIMIT_FT_NOT_DEFINED

RSA allocation upper limit in Ft can only be defined if Rsa availability upper limit in Ft is
defined.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

dd. AUP_RSA_ALLOCATION_UPPER_LIMIT_FT_NOT_DEFINED

RSA allocation upper limit in Ft must be defined.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

de. AUP_RSA_ALLOCATION_UPPER_LIMIT_FT_NOT_IN_RSA_RANGE

Edition: 27.0 6 581

Document Title: NM 27.0 - NM B2B Reference Manual

RSA allocation upper limit in Ft must be ≤ RSA upper limit.

Parameters:

1. "RESTRICTED_AIRSPACE": NM unique id of the RSA

df. FURTHER_UUPS_IN_CHAIN_DELETED

Warning reported when the client application deletes a UUP which is not the last one in the
chain. The UUPs further in the chain are deleted.

dg. INVALID_ORIGINATING_AUP

Error reported when one of the following conditions is not verified:

▪ AUPSummary.originatingAupId is a valid AupId

▪ AUPSummary.originatingAupId identifies an existing AUP

▪ AUPSummary.originatingAupId identifies an AUP in status READY or PUBLISHED

dh. ASM_SCENARIO_ACTIVATION_FL_RANGE_APPLICABILITY

Warning reported when a monitored ASM scenario is active in the flight level range and
during the period indicated in the warning message.

di. ASM_SCENARIO_ACTIVATION_APPLICABILITY

Warning reported when a monitored ASM scenario is active during the period indicated in
the warning message.

dj. SCENARIO_ACTIVATION_FL_RANGE

Warning reported when a monitored ASM scenario is active in the flight level range
indicated in the warning message.

dk. SCENARIO_ACTIVATION_COORDINATION

Warning reported when the client application saves an AUP/UUP that triggers the activation
of a MONITORED scenario.

dl. INVALID_SCENARIO_ACTIVATION_REMARK

Error reported when a scenario activation remark does not respect the pattern (
ALPHA|DIGIT|SPECIAL_CHARACTERS ).

dm. SCENARIO_ACTIVATION_MISSING_RSA_ALLOCATION

Error reported when a scenario activation does not contain an RSA allocation for each RSA
of the scenario.

dn. RSA_ALLOCATION_APPL_NOT_WITHIN_SCENARIO_ACTIVATION_APPL

Edition: 27.0 6 582

Document Title: NM 27.0 - NM B2B Reference Manual

Error reported when an RSA allocation applicability is not within the ASM scenario
activation applicability.

do. RSA_ALLOCATION_FL_RANGE_NOT_WITHIN_SCENARIO_ACTIVATION_FL_RANGE

Error reported when an RSA allocation flight level range is not within the ASM scenario
activation flight level range.

dp. SCENARIO_ACTIVATION_DELETION_REQUIRES_AUP_STATE_DRAFT

Error reported when the client application deletes a scenario activation while its associated
AUP/UUP is not in state DRAFT.

dq. SCENARIO_ACTIVATION_UPDATE_REQUIRES_AUP_STATE_DRAFT

Error reported when the client application updates a scenario activation while its associated
AUP/UUP is not in state DRAFT.

dr. SCENARIO_RSA_ALLOCATION_UNRELATED_TO_AMC

Error reported when the client application manages a scenario activation which contains an
allocation of an RSA for which the AMC is not responsible.

ds. SCENARIO_ACTIVATION_MUST_BE_CONFIRMED

Error reported when the client application activates a scenario without setting the status to
ACTIVATED_CONFIRMED.

dt. SCENARIO_UNRELATED_TO_AMC

Error reported when the client application activates an unrelated scenario. A scenario is
unrelated to an AMC when the AMC is not responsible for any of the RSAs of the scenario.

du. SCENARIO_ACTIVATION_REQUIRES_MANAGED_SCENARIO

Error reported when the client application activates a non-managed scenario.

dv. SCENARIO_DOES_NOT_EXIST

Error reported when the scenario does not exist.

dw. RSA_ALLOCATION_APPLICABILITY_NOT_WITHIN_SCENARIO_APPLICABILITY

Error reported when an RSA allocation applicability is not within the lifetime of an ASM
scenario. This typically happens when the RSA allocation applicability:

▪ begins before the start of the lifetime of an ASM scenario

▪ ends after the end of the lifetime of an ASM scenario

dx. SCENARIO_ACTIVATION_DISABLED (new 27.0)

Edition: 27.0 6 583

Document Title: NM 27.0 - NM B2B Reference Manual

Error reported when scenario activation is disabled.

dy. SCENARIO_ACTIVATION_CONFLICT (new 27.0)

Error reported when there is a conflict in scenario activations.

dz. RAD_RESTRICTION_DOES_NOT_EXIST (new 27.0)

The RAD Restriction does not exist.

ea. RAD_RESTRICTION_INVALID_ACTIVATION_PERIOD (new 27.0)

The RAD Restriction activated outside of availability period.

eb. RAD_RESTRICTION_INVALID_AMC (new 27.0)

The RAD Restriction activated by incorrect AMC/FMP.

ec. RAD_RESTRICTION_ACTIVATION_NOT_SAVED (new 27.0)

The RAD Restriction is activated but not saved.

ed. RAD_RESTRICTION_ACTIVATION_NOT_CONFIRMED (new 27.0)

The RAD Restriction is activated but not confirmed.

ee. RAD_RESTRICTION_ACTIVATION_CONFIRMED_IN_INTENT (new 27.0)

ef. RAD_RESTRICTION_ACTIVATION_NO_UPDATE_ALLOWED (new 27.0)

RAD Restriction activations can be updated only when AUP status is DRAFT or INTENT.

eg. RAD_RESTRICTION_ACTIVATION_NO_LOCK (new 27.0)

Activation of RAD Restriction can not be modified because it is locked.

eh. RAD_RESTRICTION_ACTIVATION_REFRESH (new 27.0)

RAD Restriction activations have been modified by another user.

ei. RAD_RESTRICTION_INVALID_FMP (new 27.0)

The RAD Restriction belongs to AMC/FMP but is being activated by another AMC/FMP.

ej. RAD_RESTRICTION_IS_DISABLED (new 27.0)

The RAD Restriction is disabled and can not be activated.

ek. NIL_AUP_IMPLIES_ZERO_RAD_RESTRICTION_ACTIVATIONS (new 27.0)

A NIL AUP implies zero RAD restriction activations.

el. RAD_RESTRICTION_REMARK_LENGTH (new 27.0)

Edition: 27.0 6 584

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 4

The length of RAD Restriction activation remark is incorrect.

em. RAD_RESTRICTION_REMARK_ALPHANUMERIC (new 27.0)

The RAD Restriction activation remark must contain only alphanumeric characters.

17.5.84. FIRICAOId
<<typedef[string]>>

ICAO id of an FIR

1. Pattern: UALPHA{4}

2. Used by: EstimatedElapsedTimeAtLocation

17.5.85. FlightLevel

<<class>>

Flight level value together with its flight level unit

1. Attributes:

a. FlightLevelUnit unit (Mandatory)

Unit used to express this flight level

i. Constraints:

▪ FlightLevel.LEVEL_VALUE_OUT_OF_RANGE

b. FlightLevel_DataType level (Optional)

Flight level value in the given unit

Edition: 27.0 6 585

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ FlightLevel.LEVEL_GROUND_CEILING_MUTUALLY_EXCLUSIVE

▪ FlightLevel.LEVEL_VALUE_OUT_OF_RANGE

c. boolean ground (Optional)

Indicates the ground flight level, i.e. 0

i. Constraints:

▪ FlightLevel.LEVEL_GROUND_CEILING_MUTUALLY_EXCLUSIVE

d. boolean ceiling (Optional)

Indicates the highest flight level, which corresponds to level F999

i. Constraints:

▪ FlightLevel.LEVEL_GROUND_CEILING_MUTUALLY_EXCLUSIVE

2. Constraints:

a. LEVEL_VALUE_OUT_OF_RANGE

Documentation last updated: 27.0 - Edition 2

When unit is FlightLevelUnit.F or FlightLevelUnit.A, then level must be in [0, 990].

When unit is FlightLevelUnit.S or FlightLevelUnit.M, then level must be in [0, 3020].

When unit is FlightLevelUnit.SM or FlightLevelUnit.MM, then level must be in [0, 30200].

Constrained attributes: unit, level

Constrained requests: any using request

b. LEVEL_GROUND_CEILING_MUTUALLY_EXCLUSIVE

level, ground and ceiling are mutually exclusive: exactly one of them must be not null

Constrained attributes: level, ground, ceiling

Constrained requests: any using request

3. Used by: FourDFlightPoint, RequestedFlightLevel, AirFiledData, FlightPoint, Flight,

FlightLevelRange, FlightTrafficVolume, FourDPosition, TargetTime,
LevelAndSpeedReroutingConstraint, FlightRestriction, FlightAirspace

17.5.86. FlightLevel_DataType
<<typedef[int]>>

A flight level value.

Edition: 27.0 6 586

Document Title: NM 27.0 - NM B2B Reference Manual

1. Used by: ScenarioLevelConstraint, FlightLevel

17.5.87. FlightLevelRange
<<class>>

Interval of flight levels.

The range is left-closed and right-opened, i.e. a flight level range from 100 to 200 is interpreted as
[100, 200[.

1. Attributes:

a. FlightLevel min (Mandatory)

Bottom boundary of the flight level range

b. FlightLevel max (Mandatory)

Top boundary of the flight level range

2. Used by: AbstractEAUPCDRRequest, AbstractEAUPRSARequest, ASMScenarioActivation,

FlightListByPointRequest, TrafficCountsByPointRequest, TrafficVolumeLocation

17.5.88. FlightLevelUnit
<<enumeration>>

Enumerates the units in which a flight level can be expressed

1. Values:

a. F

Standard flight level (as in "F330")

b. A

Altitude in hundreds of feet (as in "A330")

c. S

Standard metric level in tens of meters (as in "S1130")

d. M

Altitude in tens of meters (as in "S1130")

e. SM

Standard metric level in meters

f. MM

Edition: 27.0 6 587

Document Title: NM 27.0 - NM B2B Reference Manual

Altitude in meters

2. Used by: FlightLevel

17.5.89. FlightPlanProcessing
<<enumeration>>

Indicates the kind of restriction with regards to flight plan processing

1. Values:

a. RAD

Indicates a RAD restriction that can be used by NM to invalidate a flight plan

b. PROFILE_TUNING

Represents "Letters of Agreements" i.e. agreements between ATCs to transfer flights between
them - when met they should only be used for profile tuning (avoid/force airspace
penetration)

c. AERODROME_FLIGHT_RULE

This restriction defines that arrivals to or departures from the aerodrome reference location
must be conducted under VFR

d. TP_AIRCRAFT_TYPE_CLASSIFICATION

This restriction indicates if terminal procedures are restricted to given aircraft type
classification e.g. propellers only or jets only

e. DCT_LIMIT

This restriction indicates a DCT segment limit for FIRs and for Aerodromes, as well as the
general exceeding limit — specific DCT segments which are longer but nevertheless allowed
can be defined and DCT segments which are shorter but still not allowed can also be defined

f. SSR_CODE_ALLOCATION

Denotes a restriction which will be used in the allocation of SSR Codes (by CCAMS)

g. FRA_DCT_LIMIT

This is an extension of DCT_LIMIT for FRA - in addition to the DCT_LIMIT restrictions, it

defines FRA entry/exit and intermediate points

2. Used by: FlightRestriction

17.5.90. GeoPoint
<<class>>

Edition: 27.0 6 588

Document Title: NM 27.0 - NM B2B Reference Manual

Represents a non-published point expressed via its position

1. Inherits from: NonPublishedPoint

2. Attributes:

a. Position position (Mandatory)

Position of the point

17.5.91. ICAOPoint
<<union>>

Either a published point id, or an explicit non-published point

1. Choices:

a. PublishedPointId pointId

Published point id

b. NonPublishedPoint nonPublishedPoint

Non-published point and therefore expressed inline

2. Used by: FourDFlightPoint, OceanicInformation, EstimatedElapsedTimeAtLocation, AirFiledData,

OtherAerodromeDesignation, PointDAL, FlightPoint, EnrouteDelay, TargetTime,
DepartureInformation, EnRouteInformation

17.5.92. IncrementalAIXMDatasetReplyData
<<class>>

The IncrementalAIXMDatasetReply payload.

1. Attributes:

a. IncrementalDatasetSummary[] datasetSummaries (Mandatory)

A collection of summaries of the available Incremental Airspace Datasets

2. Used by: IncrementalAIXMDatasetReply

17.5.93. IncrementalDatasetQueryCriteria
<<union>>

The criteria for querying Incremental Airspace Datasets

1. Choices:

a. AirspaceDataUpdateId lastKnownUpdateId

Edition: 27.0 6 589

Document Title: NM 27.0 - NM B2B Reference Manual

This is the latest UpdateId known by the client

b. AiracIdentifier airac

The AIRAC the datasets refer to

c. DateYearMonthDay date

Allows querying for datasets based on their publication date

d. DateYearMonthDayPeriod publicationPeriod

Allows querying for datasets based on their publication date: only datasets published within
the given period will be returned

2. Used by: IncrementalAIXMDatasetRequest

17.5.94. IncrementalDatasetSummary
<<class>>

Describes an Incremental Airspace Dataset

1. Attributes:

a. AirspaceDataUpdateId updateId (Mandatory)

The id of the Airspace Data Update included in this Dataset

b. AirspaceDataUpdateId previousUpdateId (Mandatory)

The id of the previous Airspace Data Update: to ensure continuity in the chain of Updates

c. DateYearMonthDay publicationDate (Mandatory)

The date at which the dataset was made available by NM

d. AiracIdentifier[] sourceAIRACs (Mandatory)

This is an array of either one or two elements that contains the identifiers of the AIRAC
cycles included in the dataset

i. Constraints:

▪ array size range : [1, 2]

e. AIXMFile[] files (Mandatory)

The list of AIXM file ids that compose the dataset

f. map< AIXMFeatureType, int > affectedFeatures (Optional)

Provides information about the content of the update: it specifies for each AIXM Feature
Type how many features are affected by this Update.

Edition: 27.0 6 590

Document Title: NM 27.0 - NM B2B Reference Manual

This allows for the following scenario: if for example an Incremental Airspace Dataset only
contains changes to FlightRestriction features and the client is not interested in
FlightRestrictions, the client may decide not to download this Incremental Airspace Dataset.
The map can be null, denoting an update to the NM Airspace Data that does not map to any
AIXM Feature or property currently exported.

i. Constraints:

▪ item range : [0, unbounded[

2. Used by: AirspaceDataMessagePayload, IncrementalAIXMDatasetReplyData

17.5.95. IRDesignatorFilter
<<class>>

Represents a filter on IR airspace designator (ICAO-compliant FIR/UIR location indicators)

wildcards

1. Attributes:

a. string[] firDesignators (Optional)

FIR designator wildcards. Each string item in the array can be a full FIR designator or a
wildcard for FIR designators. Supported wildcards are limited to at least one character and
the star sign ("*") at the end of the expression. If null, all FIRs match.

i. Constraints:

▪ array size range : [1, unbounded[

▪ Item pattern: UALPHA{4}|UALPHA{1,3}*

▪ IRDesignatorFilter.FIRDESIGNATORS_AND_UIRDESIGNATORS_CANNOT_BE_BOTH_NULL

▪ IRDesignatorFilter.FIRDESIGNATORS_CANNOT_CONTAIN_DUPLICATE

b. string[] uirDesignators (Optional)

UIR designator wildcards. Each string item in the array can be a full UIR designator or a
wildcard for UIR designators. Supported wildcards are limited to at least one character and
the star sign ("*") at the end of the expression. If null, all UIRs match.

i. Constraints:

▪ array size range : [1, unbounded[

▪ Item pattern: UALPHA{4}|UALPHA{1,3}*

▪ IRDesignatorFilter.FIRDESIGNATORS_AND_UIRDESIGNATORS_CANNOT_BE_BOTH_NULL

▪ IRDesignatorFilter.UIRDESIGNATORS_CANNOT_CONTAIN_DUPLICATE

c. LogicalOperator logicalOperator (Optional)

Specifies if AND or OR is meant between firDesignators and uirDesignators. AND by default.

Edition: 27.0 6 591

Document Title: NM 27.0 - NM B2B Reference Manual

2. Constraints:

a. FIRDESIGNATORS_AND_UIRDESIGNATORS_CANNOT_BE_BOTH_NULL

firDesignators and uirDesignators cannot be both null

Constrained attributes: firDesignators, uirDesignators

Constrained requests: any using request

b. FIRDESIGNATORS_CANNOT_CONTAIN_DUPLICATE

If specified, the firDesignators array cannot be null, and cannot contain null or duplicate
items

Constrained attributes: firDesignators

Constrained requests: any using request

c. UIRDESIGNATORS_CANNOT_CONTAIN_DUPLICATE

If specified, the uirDesignators array cannot be null, and cannot contain null or duplicate
items

Constrained attributes: uirDesignators

Constrained requests: any using request

3. Used by: IRFilter

17.5.96. IRFilter
<<union>>

Used to filter the IR airspaces on which CDR openings/closures apply, based on either UUIDs or IR
designators

1. Choices:

a. IRUUIDFilter irUUIDFilter

Filters the IR airspaces based on UUIDs

b. IRDesignatorFilter irDesignatorFilter

Filters the IR airspaces based on IR designators

2. Used by: AbstractEAUPCDRRequest, AbstractEAUPRSARequest

17.5.97. IRUUIDFilter
<<class>>

Edition: 27.0 6 592

Document Title: NM 27.0 - NM B2B Reference Manual

Filters on IR airspace UUIDs.

1. Attributes:

a. UUID[] firUUIDs (Optional)

Matching FIR UUIDs. If null, all FIR UUIDs match.

i. Constraints:

▪ array size range : [1, unbounded[

▪ IRUUIDFilter.FIRUUIDS_AND_UIRUUIDS_CANNOT_BE_BOTH_NULL

▪ IRUUIDFilter.FIRUUIDS_CANNOT_CONTAIN_DUPLICATE

b. UUID[] uirUUIDs (Optional)

Documentation last updated: 27.0 - Edition 2

Matching UIR UUIDs. If null, all UIR UUIDs match.

i. Constraints:

▪ array size range : [1, unbounded[

▪ IRUUIDFilter.FIRUUIDS_AND_UIRUUIDS_CANNOT_BE_BOTH_NULL

▪ IRUUIDFilter.UIRUUIDS_CANNOT_CONTAIN_DUPLICATE

c. LogicalOperator logicalOperator (Optional)

Specifies if AND or OR is meant between firUUIDs and uirUUIDs. AND by default.

2. Constraints:

a. FIRUUIDS_AND_UIRUUIDS_CANNOT_BE_BOTH_NULL

firUUIDs and uirUUIDs cannot be both null

Constrained attributes: firUUIDs, uirUUIDs

Constrained requests: any using request

b. FIRUUIDS_CANNOT_CONTAIN_DUPLICATE

If specified, the firUUIDs array cannot be null, and cannot contain null or duplicate items

Constrained attributes: firUUIDs

Constrained requests: any using request

c. UIRUUIDS_CANNOT_CONTAIN_DUPLICATE

If specified, the uirUUIDs array cannot be null, and cannot contain null or duplicate items

Constrained attributes: uirUUIDs

Edition: 27.0 6 593

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

3. Used by: IRFilter

17.5.98. LoadState
<<enumeration>>

Enumeration of possible load states, i.e. counts vs declared capacity.

1. Values:

a. NORMAL

Load is below 90% of declared capacity.

b. LOW_THRESHOLD

Load is between 90% and 100% of declared capacity.

c. HIGH_THRESHOLD

Load is between 100% and 110% of declared capacity.

d. OVERLOAD

Load is above 110% of declared capacity.

e. UNDEFINED

Capacity values not defined.

2. Used by: LoadStateAtReferenceLocation

17.5.99. Network
<<enumeration>>

Enumerates the possible network types used for flight message exchange

1. Values:

a. AFTN

Aeronautical Fixed Telecommunications Network.

b. SITA

SITA network.

c. OTHER

Other.

Edition: 27.0 6 594

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: NetworkAddress

17.5.100. NetworkAddress
<<class>>

Address on a network.

1. Attributes:

a. Network network (Mandatory)

Type of network

b. NetworkAddress_DataType address (Mandatory)

Documentation last updated: 27.0 - Edition 6

Examples
EGGOZDZX, LOVVZRZO, …

2. Used by: MessageOriginator, ReroutingApplyRequest

17.5.101. NetworkAddress_DataType
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

A network address value.

Examples
EGGOZDZX, LOVVZRZO, …

1. Pattern: TEXT{1,8}

2. Used by: NetworkAddress

17.5.102. NonPublishedPoint

Edition: 27.0 6 595

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Represents a non-published point, i.e. expressed inline (not via a reference)

1. Used by: ICAOPoint, OtherAerodromeDesignation

17.5.103. OceanicAreaControlCentre
<<enumeration>>

Oceanic area control centre.

1. Values:

a. GANDER

Oceanic Area Control Centre at Gander, Canada

b. SHANWICK

Shanwick, i.e. Shannon and Prestwick Oceanic Control

c. SANTA_MARIA

Oceanic Area Control Center at Santa Maria, Azores, Portugal

2. Used by: OceanicInformation

17.5.104. PublishedPointId
<<typedef[string]>>

ICAO identifier for way points and navigation aid points

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,5}

Edition: 27.0 6 596

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: ArrivalInformation, ICAOPoint, ReferencePoint, FlightListByPointRequest,

ReferenceLocationPublishedPoint, TerminalProcedure, TrafficCountsByPointRequest,
DBEOrPublishedPointId, AerodromeOrPublishedPointId

17.5.105. RADRestrictionActivationListReplyData (new 27.0)

<<class>>

The RADRestrictionActivationListReply payload.

1. Attributes:

a. ADRMessageType (namespace: http://www.eurocontrol.int/cfmu/b2b/ADRMessage )

radRestrictionActivations (Mandatory)

Documentation last updated: 27.0 - Edition 4

The list of all the RAD restriction activations which can be dynamically activated during the
validity period of the AUP/UUP.

See RAD Restriction Activation List Message.

2. Used by: RADRestrictionActivationListReply

17.5.106. RADRestrictionActivationsUpdateReplyData (new 27.0)

<<class>>

The RADRestrictionActivationsUpdateReply payload.

1. Used by: RADRestrictionActivationsUpdateReply

17.5.107. ReferenceLocation

<<abstract class>>

Abstract reference location, i.e. a reference to an aerodrome, an aerodrome set, an airspace or a

point

1. Attributes:

a. ReferenceLocationType type (Mandatory)

Specifies the type of the reference location and therefore the attribute selected to pass the
location id

Edition: 27.0 6 597

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RegulationOrMCDMOnly, TrafficVolumeLocationInfo, FlightRegulationLocation,

FlightHotspotLocation, TrafficVolumeLocation, ScenarioAttributes

17.5.108. ReferenceLocationAerodrome
<<class>>

Reference to an aerodrome.

The type must be ReferenceLocationType.AERODROME.

1. Inherits from: ReferenceLocation

2. Attributes:

a. AerodromeICAOId id (Mandatory)

ICAO id of the referenced aerodrome

17.5.109. ReferenceLocationAerodromeSet
<<class>>

Reference to an aerodrome set.

The type must be ReferenceLocationType.AERODROME_SET.

1. Inherits from: ReferenceLocation

2. Attributes:

a. AerodromeSetId id (Mandatory)

Id of the referenced aerodrome set

17.5.110. ReferenceLocationAirspace
<<class>>

Reference to an airspace.

The type must be ReferenceLocationType.AIRSPACE.

1. Inherits from: ReferenceLocation

2. Attributes:

a. AirspaceId id (Mandatory)

Id of the referenced airspace

Edition: 27.0 6 598

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.111. ReferenceLocationDBEPoint
<<class>>

Reference to a DBE point (internal to NM).

The type must be ReferenceLocationType.DBE_POINT.

1. Inherits from: ReferenceLocation

2. Attributes:

a. DBEPointId id (Mandatory)

Id of the referenced DBE point

17.5.112. ReferenceLocationPublishedPoint
<<class>>

Reference to a published point.

The type must be ReferenceLocationType.PUBLISHED_POINT.

1. Inherits from: ReferenceLocation

2. Attributes:

a. PublishedPointId id (Mandatory)

Id of the referenced published point

17.5.113. ReferenceLocationType
<<enumeration>>

Enumerates reference location types

1. Values:

a. AERODROME

The location refers to an aerodrome

b. AERODROME_SET

The location refers to a set of aerodromes

c. AIRSPACE

The location refers to an airspace

d. PUBLISHED_POINT

Edition: 27.0 6 599

Document Title: NM 27.0 - NM B2B Reference Manual

The location refers to a published point

e. DBE_POINT

The location refers to a DBE point

2. Used by: ReferenceLocation

17.5.114. ReferencePoint
<<class>>

Represents a non-published point expressed via a bearing and distance with regards to a reference
published point

1. Inherits from: NonPublishedPoint

2. Attributes:

a. PublishedPointId reference (Mandatory)

Reference point

b. Bearing bearing (Mandatory)

Bearing with regards to the reference point

c. DistanceNM distance (Mandatory)

Distance to the reference point

17.5.115. RestrictionId
<<typedef[string]>>

Unique id of a restriction

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,10}

2. Used by: RestrictionActivationPlan, RestrictionActivationPlanRetrievalRequest, Rerouting,

RestrictionActivationPlans, FlightRestriction, ScenarioAttributes

17.5.116. RouteId
<<typedef[string]>>

ICAO identifier of a route

1. Pattern: (UALPHA|DIGIT){1,7}

2. Used by: TerminalProcedureIdentifier, TerminalProcedure, RouteOrTerminalProcedure

Edition: 27.0 6 600

Document Title: NM 27.0 - NM B2B Reference Manual

17.5.117. RouteOrTerminalProcedure
<<union>>

Represents either a Route or a Terminal Procedure (ICAO or non-ICAO) or a DCT

1. Choices:

a. void DCT

A DCT route or terminal procedure

b. RouteId route

The Route identifier

c. TerminalProcedureIdentifier SID

The departure procedure identifier

d. TerminalProcedureIdentifier STAR

The arrival procedure identifier

2. Used by: FlightPoint

17.5.118. RunwayId
<<typedef[string]>>

Unique id of a runway within an aerodrome

1. Pattern: DIGIT{2}(UALPHA| ){0,1}

2. Used by: GeneralAPIRequest, RunwayConfigurationPlan, ArrivalInformation, CDMInfo,

RunwayConfiguration, UpdateDPIRequest

17.5.119. SpeedUnit
<<enumeration>>

Enumerates the supported speed units

1. Values:

a. UNDEFINED

Undefined.

b. KNOTS

Nautical miles.

c. KILOMETERS_PER_HOUR

Edition: 27.0 6 601

Document Title: NM 27.0 - NM B2B Reference Manual

Kilometers per hour.

d. MACH_NUMBER

Mach number. Related to the speed of sound.

e. FEET_PER_MINUTE

Feet per minute.

2. Used by: AirSpeed

17.5.120. TerminalProcedure
<<union>>

Represents either a Terminal Procedure (ICAO or non-ICAO) or a DCT

1. Choices:

a. RouteId id

The ICAO or non-ICAO id of the terminal procedure

b. void DCT

Depending on the context (SID or STAR), indicates that the terminal procedure is a DCT from
ADEP to the first en-route point (SID), or a DCT from the last en-route point to the ADES (
STAR).

c. PublishedPointId pointId

Depending on the context (SID or STAR), indicates that the terminal procedure is a DCT from
ADEP to the specified point (SID), or a DCT from the specified point to the ADES (STAR). The
specified point can be an intermediate point of the current SID/STAR, or an intermediate
point of the route, or even an ad-hoc point not part of the SID/STAR definition neither part of
the route.

2. Used by: ArrivalInformation, CDMInfo, ArrivalPlanningInformationRequest, TaxiTimeAndProcedure,

DepartureInformation, EnRouteInformation, UpdateDPIRequest

17.5.121. TerminalProcedureIdentifier
<<class>>

Terminal procedure identifier.

1. Attributes:

a. RouteId id (Mandatory)

Terminal procedure identifier.

Edition: 27.0 6 602

Document Title: NM 27.0 - NM B2B Reference Manual

b. AerodromeIATAOrICAOId aerodromeId (Mandatory)

Aerodrome identifier.

2. Used by: RouteOrTerminalProcedure

17.5.122. TrafficVolumeId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 4

NM unique identifier of a traffic volume.

To ensure the correct interpretation of TrafficVolumeIdWildcard, the ‘*’ is

never used in a traffic volume identifier.
IMPORTANT
If received in a request, the ‘’ *is not interpreted as a wildcard but as the ‘*’
character.

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,8}

2. Used by: OTMVPlan, HotspotPlans, TrafficVolumeActivationPlans, MeasureIdAndTV,

OTMVWithDuration, HotspotId, NetworkImpactAssessmentRetrievalReplyData, TrafficVolumeScenarios,
TrafficCountsByTrafficVolumeRequest, HotspotListRequest, OTMVPlans, OTMV, TrafficVolumeLocation,
ATFCMSituationRegulation, TrafficVolumeActivationPlanRetrievalRequest, RouteInfo,
TrafficVolumeLocationInfo, CapacityPlans, FlightTrafficVolume,
FlightListByTrafficVolumeRequest, ScenarioListRequest, CapacityPlanRetrievalRequest,
TrafficVolumeActivationPlan, NetworkImpactAssessmentFilter, ScenarioAttributes

17.5.123. TrafficVolumeIdWildcard
<<typedef[string]>>

NM identifier for a traffic volume, with basic wildcard support (the ‘*’ is replaced by 0 or more
characters).

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER|*){1,8}

2. Used by: RegulationMessageFilter, ReroutingMessageFilter, MeasureListRequest

17.5.124. TrafficVolumeLocationInfo (new 27.0)

<<class>>

The traffic volume identifier and its reference location.

1. Attributes:

a. TrafficVolumeId trafficVolumeId (Mandatory)

The traffic volume identifier.

Edition: 27.0 6 603

Document Title: NM 27.0 - NM B2B Reference Manual

b. ReferenceLocation referenceLocation (Mandatory)

The reference location.

2. Used by: FlightAtfcmMeasureLocation

17.5.125. TrafficVolumeSetId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 4

NM unique identifier for a traffic volume set.

To ensure the correct interpretation of TrafficVolumeSetIdWildcard, the ‘*’ is

never used in a traffic volume set identifier.
IMPORTANT
If received in a request, the ‘’ *is not interpreted as a wildcard but as the ‘*’
character.

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,8}

2. Used by: RegulationOrMCDMOnly, TrafficVolumeSelection, NetworkImpactAssessmentFilter,

TrafficVolumeLocation

17.5.126. TrafficVolumeSetIdWildcard
<<typedef[string]>>

Either a full traffic volume set id, with basic wildcard support ("*" is replaced by 0 or more
characters)

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER|*){1,8}

2. Used by: RegulationMessageFilter, ReroutingMessageFilter, MeasureListRequest

Appendix E: AIRM Semantic Correspondence

• AbstractEAUPCDRRequest.routeDesignators

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route@
designatorPrefix

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route@
designatorSecondLetter

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route@
designatorNumber

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route@
multipleIdentifier

Edition: 27.0 6 604

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeRouteDesignat
orLetterType (additional)

• AbstractEAUPCDRRequest.flightLevelRange

urn:aero:airm:1.0.0:LogicalModel:DataTypes:RangeTypes:AltitudeRangeType

• AbstractEAUPRSARequest.rsaUUIds

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• AbstractEAUPRSARequest.flightLevelRange

urn:aero:airm:1.0.0:LogicalModel:DataTypes:RangeTypes:AltitudeRangeType

• AerodromeOrPublishedPointId.aerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• AerodromeOrPublishedPointId.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeSignificantPoin
tDesignatorType@ICAO (additional)

• AiracIdentifier.airacId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Aeronautical_information_regulation
_and_control (additional)

• AiracIdentifier.airacSequenceNumber

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Aeronautical_information_regulation
_and_control (additional)

• AirspaceType.REG

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@REGION

• AirspaceType.FIR

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@FIR

• AirspaceType.AUA

Edition: 27.0 6 605

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@AUA

• AirspaceType.ES

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@ES

• AirspaceType.CS

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@CS

• AirspaceType.ERSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@ERSA

• AirspaceType.CRSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@CRSA

• AirspaceType.CDA

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@CDA

• AirspaceType.AUAG

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@AUAG

• AirspaceType.AREA

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@AREA

• AirspaceType.NAS

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@NAS

• AirspaceType.IFPZ

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@IFPZ

• AirspaceType.AOI

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType

Edition: 27.0 6 606

Document Title: NM 27.0 - NM B2B Reference Manual

@AREA_OF_INTEREST

• AirspaceType.AOP

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@AREA_OF_PROTECTION

• AirspaceType.CLUS

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@CLUS

• AirspaceType.CRAS

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@CRSA

• AirspaceType.ERAS

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType
@ERSA

• AirSpeed.speed

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeSpeedReferenceType@TRUE_AI
RSPEED

• AirSpeed.unit

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomVelocityType

• ASMScenarioActivation.flightLevelRange

urn:aero:airm:1.0.0:LogicalModel:DataTypes:RangeTypes:AltitudeRangeType

• ASMScenarioActivationSummary.aupId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPChain.amcId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@isAirspaceManagem
entCell (additional)

• AUPComputedEntries.implicitCDRs

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo

Edition: 27.0 6 607

Document Title: NM 27.0 - NM B2B Reference Manual

uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• AUPComputedEntries.mergedCDRs

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• AUPGetManageableRouteSegmentsForAMCAndRouteReplyData.manageableRouteSegments

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:RouteSe
gment

• AUPGetManageableRoutesForAMCReplyData.openableRouteUUIDs

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• AUPGetManageableRoutesForAMCReplyData.closeableRouteUUIDs

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• AUPManualEntries.cdrs

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPRSAAllocationExpansionReplyData.implicitCDRs

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• AUPState.DRAFT

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

Edition: 27.0 6 608

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPState.READY

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPState.RELEASED

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPSummary.amcId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@isAirspaceManagem
entCell (additional)

• AUPSummary.validityPeriod

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@startValidity

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@endValidity

• AUPType.BASELINE

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• AUPType.UPDATE

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• CompleteDatasetQueryCriteria.airac

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Aeronautical_information_regulation
_and_control (additional)

• DBEOrPublishedPointId.DBE

Edition: 27.0 6 609

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint (additional)

• DBEOrPublishedPointId.PUBLISHED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• DBEPoint.dbePointId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint (additional)

• EAUPCDRCompareReplyData.commonCDROpeningsClosures

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• EAUPCDRCompareReplyData.cdrOpeningsClosuresIn1Only

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• EAUPCDRCompareReplyData.cdrOpeningsClosuresIn2Only

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:conditional_route
(additional)

• EAUPCDRReplyData.cdrOpeningsClosures

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeConditionalRo
uteType

• EAUPSummary.validityPeriod

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@startValidity

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@endValidity

• EAUPSummary.eaupId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

Edition: 27.0 6 610

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirspaceManagementInformationProduct:AirspaceUsePlan (additional)

• FlightLevel.unit

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomLengthType

• FlightLevel.level

urn:aero:airm:1.0.0:LogicalModel:DataTypes:MeasureTypes:ValAltitudeType

• FlightLevel.ground

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:Cod
eSpecialHeightValueType@GND

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Flight_level (additional)

• FlightLevel.ceiling

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:Cod
eSpecialHeightValueType@CEILING

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Flight_level (additional)

• FlightLevelRange.min

urn:aero:airm:1.0.0:LogicalModel:DataTypes:RangeTypes:DistanceVerticalRangeType@lower

• FlightLevelRange.max

urn:aero:airm:1.0.0:LogicalModel:DataTypes:RangeTypes:DistanceVerticalRangeType@upper

• FlightLevelUnit.F

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomLengthType@FL

• FlightLevelUnit.A

urn:aero:airm:1.0.0:LogicalModel:DataTypes:MeasureTypes:ValVerticalDistanceType

• FlightLevelUnit.S

urn:aero:airm:1.0.0:LogicalModel:DataTypes:MeasureTypes:ValVerticalDistanceType

• FlightLevelUnit.M

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomLengthType@M

• FlightLevelUnit.SM

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomLengthType@SM

Edition: 27.0 6 611

Document Title: NM 27.0 - NM B2B Reference Manual

• FlightLevelUnit.MM

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomLengthType@M

• GeoPoint.position

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType

• ICAOPoint.pointId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• IRDesignatorFilter.firDesignators

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@FIR

• IRUUIDFilter.firUUIDs

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@FIR (additional)

• IRUUIDFilter.uirUUIDs

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• Network.AFTN

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Codelists:CodeTelecomNetworkType@
AFTN

• Network.SITA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Codelists:CodeTelecomNetworkType@S
ITA

• ReferenceLocation.type

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation@type

• ReferenceLocationAerodrome.id

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• ReferenceLocationAerodromeSet.id

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:AerodromeSet@designator

Edition: 27.0 6 612

Document Title: NM 27.0 - NM B2B Reference Manual

• ReferenceLocationAirspace.id

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Airspace:Airspace@designato
r

• ReferenceLocationDBEPoint.id

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation@significantPoint

• ReferenceLocationPublishedPoint.id

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation@significantPoint

• ReferenceLocationType.AERODROME

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
eferenceLocationType@AERODROME

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO (additional)

• ReferenceLocationType.AERODROME_SET

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
eferenceLocationType@SET_OF_AERODROMES

• ReferenceLocationType.AIRSPACE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
eferenceLocationType@AIRSPACE

• ReferenceLocationType.PUBLISHED_POINT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
eferenceLocationType@SIGNIFICANT_POINT

• ReferenceLocationType.DBE_POINT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
eferenceLocationType@SIGNIFICANT_POINT

• ReferencePoint.reference

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:PointReference

• ReferencePoint.bearing

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:AngleIndication@angle

• ReferencePoint.distance

Edition: 27.0 6 613

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:DistanceIndication@distance

• RouteOrTerminalProcedure.DCT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectorySegmentType@
DIRECT_FLIGHT_SEGMENT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectorySegment@type

• RouteOrTerminalProcedure.route

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route@
name

• RouteOrTerminalProcedure.SID

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentDeparture (additional)

• RouteOrTerminalProcedure.STAR

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentArrival

• SpeedUnit.KNOTS

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomVelocityType@KT

• SpeedUnit.KILOMETERS_PER_HOUR

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomVelocityType@KM/H

• SpeedUnit.MACH_NUMBER

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomVelocityType@MACH

• SpeedUnit.FEET_PER_MINUTE

urn:aero:airm:1.0.0:LogicalModel:DataTypes:UnitsOfMeasure:CodeUomVelocityType@FT/MIN

• TerminalProcedure.id

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentDeparture@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentArrival@designator

urn:aero:airm:1.0.0:ConceptualModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Ter
minalProcedure (additional)

Edition: 27.0 6 614

Document Title: NM 27.0 - NM B2B Reference Manual

• TerminalProcedure.DCT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectorySegmentType@
DIRECT_FLIGHT_SEGMENT

• TerminalProcedure.pointId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• TerminalProcedureIdentifier.id

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• TerminalProcedureIdentifier.aerodromeId

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@designator

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@designatorIATA

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

Appendix F: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

17.F.1. Request / Reply Settings

Table 28. Compression settings

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

Edition: 27.0 6 615

Document Title: NM 27.0 - NM B2B Reference Manual

17.F.2. Time Window Request / Reply Count Quotas

Table 29. AirspaceAvailability Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

AUPChainRetrievalReque 30 36 60
st/Reply

AUPRetrievalRequest/Re 30 36 60
ply

AUPCreationRequest/Rep 30 36 60
ly

AUPUpdateRequest/Reply 30 36 60

AUPValidationRequest/R 30 36 60
eply

AUPDeletionRequest/Rep 30 36 60
ly

AUPRSAAllocationExpans 30 36 60
ionRequest/Reply

AUPServiceConfiguratio 30 36 60
nRequest/Reply

EAUPChainRetrievalRequ 375 450 600

est/Reply

EAUPCDRRequest/Reply 225 275 600

EAUPCDRCompareRequest/ 150 180 600

Reply

EAUPRSARequest/Reply 125 150 600

EAUPRSACompareRequest/ 150 180 600

Reply

AUPGetManageableRoutes 30 36 60
ForAMCRequest/Reply

AUPGetManageableRouteS 30 36 60
egmentsForAMCAndRouteR
equest/Reply

DraftEAUPsRetrievalReq 375 450 600

uest/Reply

DraftEAUPRSARequest/Re 125 150 600

ply

DraftEAUPCDRRequest/Re 225 275 600

ply

ASMScenarioListRequest 30 36 60
/Reply

ASMScenarioActivationL 30 36 60
istRequest/Reply

Edition: 27.0 6 616

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

ASMScenarioActivationC 30 36 60
reationRequest/Reply

ASMScenarioActivationU 30 36 60
pdateRequest/Reply

ASMScenarioActivationD 30 36 60
eletionRequest/Reply

EAUPSubscriptionCreati 30 36 60
onRequest/Reply

EAUPSubscriptionUpdate 30 36 60
Request/Reply

EAUPSubscriptionRetrie 30 36 60
valRequest/Reply

RADRestrictionActivati 30 36 60
onListRequest/Reply

RADRestrictionActivati 30 36 60
onsUpdateRequest/Reply

EAUPRADRestrictionActi 30 36 60
vationRequest/Reply

EAUPRADRestrictionActi 30 36 60
vationCompareRequest/R
eply

DraftEAUPRADRestrictio 30 36 60
nActivationRequest/Rep
ly

Table 30. AirspaceStructure Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

CompleteAIXMDatasetReq 300 360 600

uest/Reply

IncrementalAIXMDataset 300 360 600

Request/Reply

AirspaceDataIncrementL 300 360 600

istRequest/Reply

AirspaceDataIncrementR 300 360 600

etrievalRequest/Reply/
ReplyMessage

AirspaceDataRetrievalR 300 360 600

equest/Reply/ReplyMess
age

Edition: 27.0 6 617

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

AirspaceDataSubscripti 30 36 60
onCreationRequest/Repl
y

AirspaceDataSubscripti 30 36 60
onUpdateRequest/Reply

AirspaceDataSubscripti 30 36 60
onRetrievalRequest/Rep
ly

17.F.3. A-R/R Message Settings

Table 31. AirspaceDataIncrementRetrievalRequest/Reply/ReplyMessage

Parameter (unit) Default Description

TTL (min) 5 Message TTL

COMPRESSION THRESHOLD (KB) N/A Message compression threshold

Table 32. AirspaceDataRetrievalRequest/Reply/ReplyMessage

Parameter (unit) Default Description

TTL (min) 5 Message TTL

COMPRESSION THRESHOLD (KB) N/A Message compression threshold

17.F.4. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Table 33. EAUP

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 300 Delay from the release of the EAUP/EUUP

MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B

certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 34. AIRSPACE_DATA

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 300 Delay from the release of the airspace data

Edition: 27.0 6 618

Document Title: NM 27.0 - NM B2B Reference Manual

Parameter (unit) Default Description

MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Appendix G: AIXM Temporality Model Profile

17.G.1. Need for an AIXM Temporality Model Profile in NM

1. The AIXM Temporality Model is not fully applicable when mapping the CACD data to AIXM. The
main difficulty is due to the fact that the CACD database always stores the full states of each
object (which are in a way similar to AIXM BASELINEs), not the changes between states. So the
difficulty is that the PERMDELTAs are not available but need to be derived from the full states.
At times it would be impossible to know whether a state is a corrected version of an existing
state or if it is a new one. Hence we cannot make a meaningful use of the properties
correctionNumber and sequenceNumber .

2. Even without using the sequenceNumber and correctionNumber properties it is still possible to
create PERMDELTAs to achieve the same final result, which is the new life of the object after
applying the PERMDELTAs.

3. The sequenceNumber and correctionNumber properties are especially needed when dealing with
TEMPDELTA timeslices. For their nature, the TEMPDELTA timeslices always overlay on each
other so that the latest TEMPDELTA "hides" all previous TEMPDELTAs during its validity period.
If a TEMPDELTA is supposed to correct a previously given TEMPDELTA (e.g. to shorten its
validity period) it needs to explicitly say that it is a correction and not another overlay.

4. Currently there seem to be no need for using TEMPDELTA timeslices when exporting the CACD
data. Should there be a need in the future the same result can be achieved without
sequenceNumber and correctionNumber , like for the PERMDELTAs.

17.G.2. Differences with respect to AIXM Temporality

1. The AIXM Temporality Model Profile differs from the AIXM Temporality Model in the following:

a. It does not use TEMPDELTA timeslices

b. It does not make use of sequenceNumber and correctionNumber

c. It allows communicating a decommissioning also using a BASELINE timeslice. This is useful

because it allows the data consumers to choose to always ignore PERMDELTA timeslices and
only process BASELINE timeslices, which are simpler and less error prone to apply.

17.G.3. AIXM Temporality Model Profile for NM usage

1. This chapter shows how the profiled temporality model is used by NM to export changes to the
Airspace data. This is done by providing several examples.

Edition: 27.0 6 619

Document Title: NM 27.0 - NM B2B Reference Manual

17.G.3.1. Timeslices

1. The AIXM temporality forces a data consumer to be able to process both BASELINE and
PERMDELTA timeslices. BASELINE timeslices are easy to process because they always carry the
full state of a Feature. PERMDELTA timeslices are however much more error prone to use. A
small error in applying a PERMDELA timeslice may have large consequences because the error
is propagated, causing the data consumers database to diverge from the original data source.

2. The advantages of the PERMDELTA timeslices should be that they carry less information and
they should pinpoint the changes, however if the change happens inside a complex property,
the whole property must be re-issued, making the advantage of PERMDELTA very thin.

3. In addition to the inherent complexity of the PERMDELTA timeslices, the NM systems

impossibility to use the sequenceNumber and correctionNumber attributes make the
PERMDELTA timeslices even more complex to use.

4. For these reasons, the AIXM Temporality Model Profile for NM is built in such a way that it
allows the data consumer to choose whether to process only BASELINE timeslices or
PERMDELTA timeslices too. In other words a data consumer may choose to safely and simply
process only BASELINE timeslices.

5. To this purpose the AIXM Temporality Model Profile for NM defines a way to use a BASELINE
timeslice also to communicate a decommissioning (for which only a PERMDELTA can be used in
the AIXM Temporality Model).

6. However, the AIXM Temporality Model Profile for NM still provides full support for
PERMDELTA timeslices.

7. It is useful to define the following concepts:

a. Commissioning timeslice

b. Decommissioning timeslice

c. Permanent change timeslice

These concepts can be applied to both BASELINE and PERMDELTA timeslices.

17.G.3.1.1. BASELINE timeslices

Commissioning BASELINE timeslice

1. It is a BASELINE timeslice that communicates a commissioning of a Feature. It contains:

a. featureLifetime.beginPosition

b. featureLifetime.endPosition (it can be unknown)

c. validTime.beginPosition = featureLifetime.beginPosition

d. validTime.endPosition (it can be unknown)

e. all the non null properties

Edition: 27.0 6 620

Document Title: NM 27.0 - NM B2B Reference Manual

Decommissioning BASELINE timeslice

1. It is a BASELINE timeslice that communicates a decommissioning. It only contains a value for:

a. featureLifetime.endPosition

b. validTime.beginPosition = validTime.endPosition = featureLifetime.endPosition

Permanent Change BASELINE timeslice

1. It is a BASELINE timeslice that communicates a permanent change. It contains:

a. validTime.beginPosition

b. validTime.endPosition (it can be unknown)

c. all the non null properties

17.G.3.1.2. PERMDELTA timeslices

1. And the same concepts are defined for the PERMDELTA timeslices:

Commissioning PERMDELTA timeslice

1. It is a PERMDELTA timeslice that communicates a commissioning. It contains:

a. featureLifetime.beginPosition

b. validTime.instant = featureLifetime.beginPosition

c. all the non null properties

Decommissioning PERMDELTA timeslice

1. It is a PERMDELTA timeslice that communicates a decommissioning. It contains:

a. featureLifetime.endPosition

b. validTime.instant = featureLifetime.endPosition

Permanent Change PERMDELTA timeslice

1. It is a PERMDELTA timeslice that communicates a permanent change. It contains:

a. validTime.instant

b. all the changed properties

A PERMDELTA timesice can also set the end of life to "unknown" to indicate an
"undecommissioning", i.e. to extend the feature’s life time to eternity for a feature that was
previously decommissioned (see examples below).

17.G.3.2. PERMDELTA examples

1. This paragraph illustrates the use of PERMDELTA timeslices by means of simple examples.

2. Each example is based on an AirportHeliport Feature and simulates changes to the following

Edition: 27.0 6 621

Document Title: NM 27.0 - NM B2B Reference Manual

properties:

a. name: a string

b. cities: a list of strings

c. degrees: a pair of decimal numbers

3. The notation allotherfields is used to indicate all the other properties other than the three
mentioned above.

4. The notation (…) in a timeslice means that the timeslice’s end of time is undetermined.

5. When a property undergoes a change of value between two consecutive timeslices, this is
highlighted in red.

6. Each example shows two consecutive versions of the same Feature, labelled V1 and V2
respectively. V2 is a new version of the feature obtained by applying some changes to V1. Each
example shows the lifetime of the Feature at version V1 and that at version V2.

7. Each example focuses on the production of the PERMDELTA timeslices and therefore shows the
PERMDELTA timeslices that are exported by NM and that need to be applied to V1 in order to
obtain V2 .

17.G.3.2.1. Commissioning

1. The commissioning of a feature is when the entity starts its life.

Example: Commissioning of a feature with a single timeslice

1. The example shows the commissioning of a feature that contains a single timeslice ( V1 is null in
the sense that the feature does not exist)

V1: NULL

T0
V2: <-------------------------------------------------------------- (...)
cities={A}
degrees=(45, 10)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> featureLifetime.beginPosition=T0
|-> cities={A}
|-> degrees=(45, 10)
|-> all_other_fields

2. In this case a single PERMDELTA is published effective at T0, that sets the start of life of the
Feature to T0 and contains all non null properties.

Edition: 27.0 6 622

Document Title: NM 27.0 - NM B2B Reference Manual

Example: Commissioning of a feature with multiple timeslices

1. This example is similar to the above but the commissioned Feature already contains more than
one timeslice.

2. In this case a PERMDELTA is published for the commissioning and another one for the change
that produces the second timeslice.

V1: NULL

T0 T1
V2: <------------TS1----------><-------------------TS2---------------
(...)
cities={A} cities={A}
degrees=(45, 10) degrees=(45, 10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> featureLifetime.beginPosition=T0
|-> cities={A}
|-> degrees=(45, 10)
|-> all_other_fields

PD2: |-> validTime.timeInstant=T1

|-> degrees=(45,10.2)

3. The second PERMDELTA (PD2) only contains the changed attribute with respect to PD1.

Example: Earlier commissioning

1. In this example the Feature was published as being commissioned at time T1 but its
commissioning was than moved to T0.

Edition: 27.0 6 623

Document Title: NM 27.0 - NM B2B Reference Manual

T1
V1:
<-------------------------------------------- (...)
cities={A,B}
degrees=(45,10)
T0
V2:
<---------------------------------------------------------------------- (...)
cities={A,B}
degrees=(45,10)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> featureLifetime.beginPosition=T0
|-> cities={A,B}
|-> degrees=(45,10)
|-> all_other_fields

Example: Delayed commissioning

1. In this example the Feature was published as being commissioned at time T0 but its
commissioning was than postponed to T1.

2. This is done by re-publishing a new PERMDELTA timeslice that postpones the Features start of
life.

T0
V1:
<------------------------------------------------------------------------- (...)
cities={A}
degrees=(45,10)

T1
V2:
<------------------------------------------------------------ (...)
cities={A}
degrees=(45,10)

PermDeltas:

PD1: |-> validTime.timeInstant=T1

|-> featureLifetime.beginPosition=T1
|-> cities={A}
|-> degrees=(45,10)
|-> all_other_fields

Edition: 27.0 6 624

Document Title: NM 27.0 - NM B2B Reference Manual

Example: Undo Commissioning

1. The example shows a feature that was supposed to be commissioned at time T0, but it was then
decided to withdraw it.

2. This is done by issuing a decommissioning PERMDELTA effective at T0.

T0
V1: <---------------------------------------------------------- (...)
cities={A}
degrees=(45,10)

T0
V2: | (stopped)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> featureLifetime.endPosition=T0

17.G.3.2.2. Decommissioning

1. The decommissioning of a feature is when the entity ends its life.

Example: Decommissioning of a feature

1. The example shows the decommissioning of a feature. The feature had an undetermined end of
life, so a PERMDELTA timeslice is issued to set its end of life.

V1: <------------------
><----------------------------------------------------- (...)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

T0
V2: <------------------><---------------------->| (stopped)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|->
featureLifetime.endPosition=T0

Edition: 27.0 6 625

Document Title: NM 27.0 - NM B2B Reference Manual

Example: Earlier decommissioning

1. The example shows a feature that was supposed to be decommissioned at time T1, but its
decommissioning was moved to time T0, effectively removing an entire timeslice.

T1
V1: <-------------------><-------------------------------><-------------->|
(stopped)
cities={A} cities={A} cities={A,B}
degrees=(45,10) degrees=(45,10.2) degrees=(45,10)

T0
V2: <-------------------><------------------------>| (stopped)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

PermDeltas:

PD1: |->
validTime.timeInstant=T0
|->
featureLifetime.endPosition=T0

Example: Delayed decommissioning

1. The example shows a feature that was supposed to be decommissioned at time T0, but its
decommissioning was postponed to time T1 by adding a new timeslice.

T0
V1: <----------------><------------------->| (stopped)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

T1
V2: <----------------><-------------------><---------------->| (stopped)
cities={A} cities={A} cities={A,B}
degrees=(45,10) degrees=(45,10.2) degrees=(45,10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|->
featureLifetime.endPosition=unknown
|-> cities={A,B}

PD2: |->
validTime.timeInst...=T1

Edition: 27.0 6 626

Document Title: NM 27.0 - NM B2B Reference Manual

2. NOTE: The first PERMDELTA timeslice (PD1) that communicates the permanent change to the
cities property must also set the end of life to "unknown", to undo the decommissioning
previously communicated in V1.

3. The second PERMDELTA timeslice (PD2) will communicate the new decommissioning time.

Example: Undo decommissioning

1. The example shows a feature that was supposed to be decommissioned at time T0, but its
decommissioning was cancelled, i.e. the end of life is unknown.

T0
V1: <-------------------><------------------------>| (stopped)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

V2: <-------------------
><---------------------------------------------------- (...)
cities={A} cities={A}
degrees=(45,10) degrees=(45,10.2)

PermDeltas:

PD1: |->
validTime.timeInstant=T0
|->
f...Lifetime.endPosition=unknown

17.G.3.2.3. Permanent changes

1. This is the nominal case for a PERMDELTA.

Example 1

1. The example shows the evolution of a feature from version V1 _ to version _V2. The feature
maintains its three timeslices, but the properties undergo the following changes:

a. The name property changes at T0

b. The change of degrees is postponed until T1

c. The cities property still changes at T1 but it has now a new value.

Edition: 27.0 6 627

Document Title: NM 27.0 - NM B2B Reference Manual

T0 T1
V1: <-------------------------><-----------TS2-----------
><-------------------- (...)
name=X name=X name=X
cities={A} cities={A} cities={A,B}
degrees=(45,10) degrees=(45,10.2)
degrees=(45,10.2)

T0 T1
V2: <-------------------------><-------------------------
><-------------------- (...)
name=X name=Y name=Y
cities={A} cities={A}
cities={A,B,C}
degrees=(45,10) degrees=(45,10)
degrees=(45,10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> name=Y
|-> degrees=(45,10)

PD2: |->
validTime.timeInstant=T1
|->
cities={A,B,C}
|->
degrees=(45,10.2)

2. Note that the first PERMDELTA timeslice (PD1) must re-communicate the value of the property
degrees because it has to overrule what was published in timeslice TS2

Example 2

1. The example shows a case in which some changes to a feature are anticipated. In particular the
change of property cities is anticipated from T1 to T0.

Edition: 27.0 6 628

Document Title: NM 27.0 - NM B2B Reference Manual

T1
V1: <----------------------------------><-------------------------- (...)
cities={A} cities={A,B}
degrees=(45,10) degrees=(45,10)

T0
V2: <-------------------------><----------------------------------- (...)
cities={A} cities={A,B}
degrees=(45,10) degrees=(45,10)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> cities={A,B}

Example 3

1. The example shows several changes effective at different times.

V1:
<------------------------------------------------------------------------ (...)
cities={A}
degrees=(45,10)

T0 T1 T2
V2: <---------------------><----------------------
><------------------------- (...)
cities={A,B} cities={A,B,C} cities={A,B,C}
degrees=(45,10) degrees=(45,10) degrees=(45,10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> cities={A,B}

PD2: |-> validTime.timeInstant=T1

|-> cities={A,B,C}

PD3: |->
validTime.timeInstant=T2
|-> degrees=(45,10.2)

Example 4

1. The example shows the following:

a. The change of the attribute cities is anticipated from T1 to T0.

Edition: 27.0 6 629

Document Title: NM 27.0 - NM B2B Reference Manual

b. The change of the property degrees is postponed from T1 to T2.

T0 T1 T2
V1: <----------TS1----------><-------TS2-------><----------------
TS3----------- (...)
cities={A} cities={A,B} cities={A,B}
degrees=(45,10) degrees=(45,10) degrees=(45,10.2)

T0 T2
V2: <------------------------------------------
><------------------------------ (...)
cities={A,B} cities={A,B}
degrees=(45,10) degrees=(45,10.2)

PermDeltas:

PD1: |-> validTime.timeInstant=T0

|-> cities={A,B}

2. NOTE: It is not necessary to issue a second PERMDELTA to re-communicate the new value of
degrees because what was published with V1.TS3 is still valid (A PERMDELTA has effect only on
the properties it contains).

Edition: 27.0 6 630

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 18. FFICE

18.1. Context
18.1.1. Introduction

1. NM implements the FF-ICE Filing Service, Trial Service, Flight (plan) Data Request service, and
the Notification Service.

For more information about FF-ICE and FIXM 4.3, refer to the FIXM Website and
NOTE
the FIXM User Manual.

2. These services form the basis of implementing FF-ICE for the pre-departure phase.

3. NM extends the Flight Data Service to support processing of invalid flight plans. The state of the
flight plan within NM can be interrogated, i.e. is the Filing Service request still under manual
processing (MAN), or has since been rejected (REJ) or accepted (ACK).

4. The EUROCONTROL Network Manager (NM) extension of FIXM 4.3 introduces additional data
elements in support of flight plan filing and retrieval as per the IFPS Users Manual.

18.1.2. Units of Measurement

1. FIXM is extremely generous when it comes to expressing units of measurement, much more
generous than the PANS-ATM. Such a large spectrum of possibilities means that an implementer
has to make certain choices, at least for the output. NM has made several choices and the users
should be aware of these choices as provided further in this section.

2. NM preserves the unit of measurement submitted by operators in eFPL messages for the
following types of data elements: Cruising Level, Time/Duration, Geographical position and True
Air Speed (e.g when the submitted eFPL use FL for cruising level information, the IFPS feedback
will also provide FL). NM supports altitude level indication with a granularity to 1ft or 1m only
for the level in a 4D point. Although by definition Altitude and FL are using different
atmospheric pressure references, it should be noted that NM computation does not make use of
such atmospheric pressure information and provides just a simple units conversion.

3. There is no change induced by eFPL implementation with regard to the treatment of the
Cruising Levels by IFPS, in the sense that IFPS rejects any flight plans with Cruising Levels with
a granularity below 1000ft (e.g. FL351) and respects the same rule for the output. However, a
finer granularity is accepted and used for expressing flight levels in 4D trajectory points. This
effectively means that NM will neither accept nor output FL351 as Cruising Level, but it does it
for a 4D trajectory point.

4. Regarding the use of the flight level information, in order to ensure better alignment with
current operational practices established for the FPL and published in the National AIPs, NM
recommends and expects that eFPLs express this information in FL and not SM, unless the use
of SM is justified by an AIP requirement. This applies both to Cruising Levels and 4D points level
information.

Edition: 27.0 6 631

Document Title: NM 27.0 - NM B2B Reference Manual

18.1.3. Guidelines for Provision of Approach Portion of the Flight Route

(SID/STAR)

1. Pending on the outcome of the ongoing discussions within the ICAO Instrument Flight
Procedure Panel (IFPP) regarding the introduction of SID/STAR "transitions" within the ICAO
provisions, and in order to address the existing inconsistencies in the SID/STAR data, the
following guidelines are provided:

◦ SIDs and STARs should be included in eFPLs as published within the corresponding national
AIPs, including the SID/STAR designator and the list of points that compose the SID/STAR .

◦ Departure/arrival Transitions and approach procedures (including any corresponding

published points), should not be included in eFPLs.

◦ The trajectory segment between the Initial Approach Fix (or the last point of the STAR) and
the destination aerodrome may be included in an eFPL trajectory as the last segment of the
STAR. The Along Route Distance provided for the aerodrome of destination may include the
length of an approach procedure that is used internally for the flight trajectory calculation
by the eFPL originator system (sometimes named "virtual distance").

18.1.4. Error Reporting

1. On the one hand, the FF-ICE SubmissionResponse message contains a submissionStatus element
whose value indicates whether the received FF-ICE request was accepted, queued for manual
processing, or rejected. On the other hand, the Reply.status indicates whether the NM B2B
request was correctly processed or not and for which reason.

2. NM B2B reports FF-ICE service group request processing errors as follows:

a. Any NM B2B bug is reported, as usual, as a reply with status INTERNAL_ERROR

b. Any resource overload is reported, as usual, as a reply with status RESOURCE_OVERLOAD

c. Any service/resource access error is reported, as usual, as a reply with status

SERVICE_UNAVAILABLE or NOT_AUTHORISED

d. Any quotas exceeded error is reported, as usual, as a reply with status

REQUEST_COUNT_QUOTA_EXCEEDED, PARALLEL_REQUEST_COUNT_QUOTA_EXCEEDED,
REQUEST_OVERBOOKING_REJECTED or BANDWIDTH_QUOTAS_EXCEEDED

e. Any XML error is reported as a reply with status INVALID_INPUT

f. Any error detected in the NM B2B Request but not out of the FF-ICE input message, is
reported as a reply with status INVALID_INPUT

g. Any other error is reported as:

▪ a reply with status=OK

▪ an FF-ICE SubmissionResponse with submissionStatus.value=REJ

3. For example, the following reply should be expected in the case of a FlightDataRequest with
unknown flight keys:

Edition: 27.0 6 632

Document Title: NM 27.0 - NM B2B Reference Manual

<?xml version="1.0" encoding="UTF-8"?>

<ffice:FlightDataReply
xmlns:ffice="eurocontrol/cfmu/b2b/FficeServices"
xmlns:fixm="http://www.eurocontrol.int/nm/fixm/app/ffice/1.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<requestReceptionTime>2023-01-23 09:51:56</requestReceptionTime>
<requestId>B2B_CUR:3433134</requestId>
<sendTime>2023-01-23 09:51:56</sendTime>
<status>OK</status>
<data>
<nmSubmissionResponse_v1_1>
<fixm:referencedMessageIdentifier codeSpace="urn:uuid">
e795fd0c-c167-445f-8db8-f1afd15cae64
</fixm:referencedMessageIdentifier>
<fixm:submissionStatus xsi:type="fixm:Nm_FficeSR_SubmissionStatusType">
<fixm:explanation>OBJECT_NOT_FOUND</fixm:explanation>
<fixm:value>REJ</fixm:value>
</fixm:submissionStatus>
<fixm:type>SUBMISSION_RESPONSE</fixm:type>
</nmSubmissionResponse_v1_1>
</data>
</ffice:FlightDataReply>

18.1.5. Formats of Planned Trajectory

1. NM FF-ICE Services support the exchange of a Route, Trajectory, or Route Text, as defined below,
to represent the planned path of an aircraft. The provision of a Trajectory is highly
recommended in order to make possible all benefits for airline operations and ATM that are
expected to be enabled by the exchange of trajectory information.

◦ Route

2. A Route includes all the items described in Field 15 of the ICAO Doc 4444 Appendix 3 as well as
the departure and the destination aerodromes. It is represented as an ordered list of Route
Trajectory Elements. Each Route Trajectory Element corresponds to a significant point that
would be present in an FPL Field 15c. The Route Trajectory Elements are sequenced in the order
in which they will be flown from departure to destination. Additional optional data items (for
example a planned delay) may be provided for each Route Trajectory Element.

◦ Trajectory

3. In a Trajectory, each ATS route of a Route, as defined above, is expanded into its constituent
significant points, explicitly indicating each published point along that ATS route, as a new
Route Trajectory Element. Each Route Trajectory Element of the resulting expanded Route is
supplemented with a four-dimensional point as well as other optional data items (for example
Trajectory Point Property). Additional trajectory points that correspond to a predefined list of
Trajectory Point Properties shall also be added in between points in the expanded route, as new
Route Trajectory Elements, to more precisely reflect the expected location of the flight.

◦ Route Text

Edition: 27.0 6 633

Document Title: NM 27.0 - NM B2B Reference Manual

4. In addition, NM FF-ICE Services also support the provision of a Route with the content and
format (text) limited to what is defined for the Field 15 in the ICAO Doc 4444 Appendix 3 for use
in FPL messages. This facility is to be used only for mixed IFR/VFR and GAT/OAT flights that
contain within the Route free text location names, such as city, road or river names.

5. NM will include in reply, retrieval, or published messages the same type of information (Route,
Trajectory or Route Text) to describe the planned aircraft path as the one that was used by the
originator of the corresponding FF-ICE flight plan message. NM will also include in these
messages, a Route Text representing the Field 15 of the ICAO Doc 4444 Appendix 3 that NM
would distribute to ATS, showing how Route or Trajectory, or the Route Text will be
translated.

18.1.6. Manual Request Processing

1. Any FF-ICE reply contains a SubmissionResponse FF-ICE message.

2. The SubmissionResponse/submissionStatus exposes the result of the request submission:

◦ ACK - the request submission is acknowledged

◦ REJ - the request submission is rejected

◦ MAN - the request is processed "manually", by an operator

3. If the returned submission status is MAN, the SubmissionResponse FF-ICE message also contains a
FilingID. The client application shall retain it in order to get submission status updates,
subscribing to FFICE_FLIGHT_FILING (recommended) or using
SubmissionStatusRetrievalRequest/Reply.

18.1.7. Flight Set Definition (for FFICE_PUBLICATION subscriptions)

See section Flight Set Definition in Flight documentation.

18.1.8. Concerned Air Traffic Services (ATS) Units

See section Concerned Air Traffic Services (ATS) Units in Flight documentation.

18.2. PREOPS Testing

1. See Flight PREOPS Testing.

18.3. FilingService Port Type

18.3.1. Overview

1. The FilingService is intended to file flight plan messages:

a. P/S FFICE_FLIGHT_FILING

b. S-R/R FiledFlightPlanRequest/Reply (new 27.0)

c. S-R/R FlightPlanUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 634

Document Title: NM 27.0 - NM B2B Reference Manual

d. S-R/R FlightPlanCancellationRequest/Reply (new 27.0)

18.3.2. Publish/Subscribe Topics

18.3.2.1. FFICE_FLIGHT_FILING

MEP: P/S

Message: FficeFlightFilingMessage

Ordering policy:

Not Applicable: NM does not publish multiple Ffice Flight Filing messages with the same
Filing Id.

Message filter: FficeFlightFilingMessageFilter

Subscription management (topic specific):

• S-R/R FficeFlightFilingSubscriptionCreationRequest/Reply

• S-R/R FficeFlightFilingSubscriptionUpdateRequest/Reply

• S-R/R FficeFlightFilingSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify read access to /flights#performance_data

then FilingStatus message flight/routeTrajectoryGroup/agreed/climbProfile and

flight/routeTrajectoryGroup/agreed/descentProfile are published

• verify read access to /flights#take_off_weight

then FilingStatus message flight/routeTrajectoryGroup/agreed/takeOffMass is published

Notification about changes to flight plans.

The FF-ICE Flight (plan) Data Request Service should not be confused with the
Flight Data services exposed by the Flight service group. The scope of the FF-
NOTE
ICE Flight Data Request Service is for flight planning and not for updates made
in the tactical phase.

Edition: 27.0 6 635

Document Title: NM 27.0 - NM B2B Reference Manual

18.3.2.1.1. FficeFlightFilingMessage (new 27.0)

<<class>>

The business P/S message for topic FFICE_FLIGHT_FILING.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. FficeFS_FficeMessageType filingStatus_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 3

The filing status.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 3

The submission response.

18.3.2.1.2. FficeFlightFilingSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: FficeFlightFilingSubscriptionCreationRequest

Reply: FficeFlightFilingSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficeFlightFilingSubscriptionCreationReply
createFficeFlightFilingSubscription(FficeFlightFilingSubscriptionCreationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic FFICE_FLIGHT_FILING.

Edition: 27.0 6 636

Document Title: NM 27.0 - NM B2B Reference Manual

FficeFlightFilingSubscriptionCreationRequest (new 27.0)

<<class>>

It allows creating a new subscription for topic FFICE_FLIGHT_FILING.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. FficeFlightFilingMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

FficeFlightFilingSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to FficeFlightFilingSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FficeFlightFilingSubscriptionCreationReplyData data (Optional)

The reply payload.

18.3.2.1.3. FficeFlightFilingSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 637

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FficeFlightFilingSubscriptionUpdateRequest

Reply: FficeFlightFilingSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficeFlightFilingSubscriptionUpdateReply
updateFficeFlightFilingSubscription(FficeFlightFilingSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic FFICE_FLIGHT_FILING.

FficeFlightFilingSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic FFICE_FLIGHT_FILING.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. FficeFlightFilingMessageFilter messageFilter (Mandatory)

Edition: 27.0 6 638

Document Title: NM 27.0 - NM B2B Reference Manual

It defines how messages should be filtered.

FficeFlightFilingSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to FficeFlightFilingSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FficeFlightFilingSubscriptionUpdateReplyData data (Optional)

The reply payload.

18.3.2.1.4. FficeFlightFilingSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: FficeFlightFilingSubscriptionRetrievalRequest

Reply: FficeFlightFilingSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficeFlightFilingSubscriptionRetrievalReply
retrieveFficeFlightFilingSubscription(FficeFlightFilingSubscriptionRetrievalReques
t request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic FFICE_FLIGHT_FILING.

FficeFlightFilingSubscriptionRetrievalRequest (new 27.0)

Edition: 27.0 6 639

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription retrieval request for topic FFICE_FLIGHT_FILING.

1. Inherits from: SubscriptionRetrievalRequest

FficeFlightFilingSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to FficeFlightFilingSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. FficeFlightFilingSubscriptionRetrievalReplyData data (Optional)

The reply payload.

18.3.3. Requests/Replies

18.3.3.1. FiledFlightPlanRequest/Reply (new 27.0)

Edition: 27.0 6 640

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FiledFlightPlanRequest

Reply: FiledFlightPlanReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FiledFlightPlanReply submitFiledFlightPlanRequest(FiledFlightPlanRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then FilingStatus message flight/routeTrajectoryGroup/agreed/climbProfile and

flight/routeTrajectoryGroup/agreed/descentProfile are returned

• verify certificate read access to /flights#take_off_weight

then FilingStatus message flight/routeTrajectoryGroup/agreed/takeOffMass is returned

Documentation last updated: 27.0 - Edition 5

Submits a flight plan filing request.

The request is composed of:

• a FiledFlightPlan FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message

• an optional FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise

18.3.3.1.1. FiledFlightPlanRequest (new 27.0)

Edition: 27.0 6 641

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Supports the filing of a flight plan.

1. Inherits from: Request

2. Attributes:

a. FficeFFP_FficeMessageType filedFlightPlan_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 5

The FiledFlightPlan FF-ICE message.

i. Constraints:

▪ FiledFlightPlanRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Documentation last updated: 27.0 - Edition 5

Invalid FF-ICE message.

Constrained attributes: filedFlightPlan_v1_1

Constrained requests: any using request

18.3.3.1.2. FiledFlightPlanReply (new 27.0)

<<class>>

Returned in response to FiledFlightPlanRequest.

1. Inherits from: Reply

2. Attributes:

a. FiledFlightPlanReplyData data (Optional)

Edition: 27.0 6 642

Document Title: NM 27.0 - NM B2B Reference Manual

18.3.3.2. FlightPlanUpdateRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightPlanUpdateRequest

Reply: FlightPlanUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightPlanUpdateReply submitFlightPlanUpdateRequest(FlightPlanUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then FilingStatus message flight/routeTrajectoryGroup/agreed/climbProfile and

flight/routeTrajectoryGroup/agreed/descentProfile are returned

• verify certificate read access to /flights#take_off_weight

then FilingStatus message flight/routeTrajectoryGroup/agreed/takeOffMass is returned

Documentation last updated: 27.0 - Edition 5

Submits a flight plan update request.

The request is composed of:

• a FlightPlanUpdate FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message

• an optional FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise

Edition: 27.0 6 643

Document Title: NM 27.0 - NM B2B Reference Manual

18.3.3.2.1. FlightPlanUpdateRequest (new 27.0)

<<class>>

Supports the update of a flight plan.

1. Inherits from: Request

2. Attributes:

a. FficeFPU_FficeMessageType flightPlanUpdate_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 5

The FlightPlanUpdate FF-ICE message.

The GUFI is used as the sole means of associating an update of a filed flight plan.

The update of a flight plan, must include all elements of the filed
IMPORTANT
flight plan. No support is offered for a partial update.

i. Constraints:

▪ FlightPlanUpdateRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Documentation last updated: 27.0 - Edition 5

Invalid FF-ICE message.

Constrained attributes: flightPlanUpdate_v1_1

Constrained requests: any using request

18.3.3.2.2. FlightPlanUpdateReply (new 27.0)

<<class>>

Returned in response to FlightPlanUpdateRequest.

Edition: 27.0 6 644

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. FlightPlanUpdateReplyData data (Optional)

18.3.3.3. FlightPlanCancellationRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightPlanCancellationRequest

Reply: FlightPlanCancellationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightPlanCancellationReply
submitFlightPlanCancellationRequest(FlightPlanCancellationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 5

Submits a flight plan cancellation request.

The request is composed of:

• a FlightPlanCancellation FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message

18.3.3.3.1. FlightPlanCancellationRequest (new 27.0)

Edition: 27.0 6 645

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Supports the cancellation of a flight plan.

1. Inherits from: Request

2. Attributes:

a. FficeFC_FficeMessageType flightPlanCancellation_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 5

The FlightPlanCancellation FF-ICE message.

The GUFI is used as the sole means of associating a cancellation of a filed flight plan.

i. Constraints:

▪ FlightPlanCancellationRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Invalid ffice message.

Constrained attributes: flightPlanCancellation_v1_1

Constrained requests: any using request

18.3.3.3.2. FlightPlanCancellationReply (new 27.0)

<<class>>

Returned in response to FlightPlanCancellationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanCancellationReplyData data (Optional)

Edition: 27.0 6 646

Document Title: NM 27.0 - NM B2B Reference Manual

18.4. TrialService Port Type

18.4.1. Overview

1. The TrialService is intended to validate flight plan messages:

a. S-R/R TrialRequest/Reply

18.4.2. Requests/Replies

18.4.2.1. TrialRequest/Reply

MEP: S-R/R

Request: TrialRequest

Reply: TrialReply

Response time: 90 / 140 / 530 (ms)

Default settings: request count quotas

SOAP operation:

TrialReply submitTrialRequest(TrialRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then flight performance data is returned

• verify certificate read access to /flights#take_off_weight

then flight take of weight is returned

Documentation last updated: 27.0 - Edition 6

Edition: 27.0 6 647

Document Title: NM 27.0 - NM B2B Reference Manual

Submits a flight plan for trial.

The request is composed of:

• a TrialRequest FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message

• an optional TrialResponse FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise

A MAN SubmissionResponse/submissionStatus is never returned.

The possible SubmissionResponse/submissionStatus, TrialResponse/planningStatus,

TrialResponse/flight/routeTrajectoryGroup/negotiating combinations are:

• If no IFPS errors, no warnings or no PTR affecting the profile:

◦ SubmissionResponse/submissionStatus: ACK

◦ TrialResponse/planningStatus: CONCUR

◦ TrialResponse/flight/routeTrajectoryGroup/negotiating: none

• If no IFPS errors, but warnings 313, 323, etc, or with PTR that affect the profile:

◦ SubmissionResponse/submissionStatus: ACK

◦ TrialResponse/planningStatus: NEGOTIATE

◦ TrialResponse/flight/routeTrajectoryGroup/negotiating: the trajectory that IFPS would

show in a vertical view, possibly with PTR.

• If a trajectory could be built, but there are IFPS errors of ROUTE and/or PROFILE errors:

◦ SubmissionResponse/submissionStatus: ACK

◦ TrialResponse/planningStatus: NON-CONCUR

◦ TrialResponse/flight/routeTrajectoryGroup/negotiating: none

• If no trajectory could be built because of any other error:

◦ SubmissionResponse/submissionStatus: REJ

◦ TrialResponse/planningStatus: none (no TrialResponse)

◦ TrialResponse/flight/routeTrajectoryGroup/negotiating: none (no TrialResponse)

18.4.2.1.1. TrialRequest

Edition: 27.0 6 648

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to trial a flight plan - This is equivalent to the Flight Plan Validation or the NM B2B
preparation service.

1. Inherits from: Request

2. Attributes:

a. FficeTRQ_FficeMessageType trialRequest_v1_1 (Mandatory) (new 27.0)

Documentation last updated: 27.0 - Edition 5

The TrialRequest FF-ICE message.

i. Constraints:

▪ TrialRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Invalid ffice message.

Constrained attributes: trialRequest_v1_1

Constrained requests: any using request

18.4.2.1.2. TrialReply

<<class>>

Returned in response to TrialRequest.

1. Inherits from: Reply

2. Attributes:

a. TrialReplyData data (Optional)

Edition: 27.0 6 649

Document Title: NM 27.0 - NM B2B Reference Manual

18.5. FlightDataRequestService Port Type

18.5.1. Overview

1. The FlightDataRequestService is intended to retrieve flight plan and status information:

a. S-R/R FlightDataRequest/Reply

b. S-R/R SubmissionStatusRetrievalRequest/Reply (new 27.0)

18.5.2. Requests/Replies

18.5.2.1. FlightDataRequest/Reply

MEP: S-R/R

Request: FlightDataRequest

Reply: FlightDataReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightDataReply submitFlightDataRequest(FlightDataRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then flight performance data is returned

• verify certificate read access to /flights#take_off_weight

then flight take of weight is returned

Documentation last updated: 27.0 - Edition 6

Edition: 27.0 6 650

Document Title: NM 27.0 - NM B2B Reference Manual

Allows the client application to retrieve a flight plan.

The request is composed of:

• a FlightDataRequest FF-ICE message

The reply is composed of:

• A SubmissionResponse FF-ICE message

The returned SubmissionResponse/submissionStatus can be:

◦ ACK if either a flight matches the provided GUFI or if a flight matches the provided
departureAerodrome, estimatedOffBlockTime, aircraftIdentification and
destinationAerodrome
◦ REJ otherwise

• An optional FlightDataReply FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise

If present, the message contains on of:

◦ FLIGHT_PLAN if demanded by the FlightDataRequest

◦ SUPPLEMENTARY_FLIGHT_PLAN if demanded by the FlightDataRequest and if the flight has

supplementary flight plan data, otherwise an explanation is provided by the
SubmissionResponse
◦ FLIGHT_STATUS if demanded by the FlightDataRequest - the latest status is returned
indicating any possible change to the FilingStatusValue (ACCEPTABLE, NOT_ACCEPTABLE)

18.5.2.1.1. FlightDataRequest

<<class>>

FF-ICE Request to retrieve flight (plan) data.

1. Inherits from: Request

2. Attributes:

a. FficeFDRQ_FficeMessageType flightDataRequest_v1_1 (Mandatory) (new 27.0)

Edition: 27.0 6 651

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 5

The FlightDataRequest FF-ICE message. Three different types of FF-ICE Flight Data Request
are supported:

▪ FLIGHT_PLAN

▪ FLIGHT_STATUS

▪ SUPPLEMENTARY_FLIGHT_PLAN

i. Constraints:

▪ FlightDataRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Invalid ffice message.

Constrained attributes: flightDataRequest_v1_1

Constrained requests: any using request

18.5.2.1.2. FlightDataReply

<<class>>

Returned in response to FlightDataRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightDataReplyData data (Optional)

18.5.2.2. SubmissionStatusRetrievalRequest/Reply (new 27.0)

Edition: 27.0 6 652

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SubmissionStatusRetrievalRequest

Reply: SubmissionStatusRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SubmissionStatusRetrievalReply
submitSubmissionStatusRetrievalRequest(SubmissionStatusRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then flight performance data is returned

• verify certificate read access to /flights#take_off_weight

then flight take of weight is returned

Documentation last updated: 27.0 - Edition 6

Allows the client application to poll a flight plan submission status of which initial
SubmissionResponse/submissionStatus was MAN. See Manual Request Processing.

The request is composed of:

• a FilingId (the FilingId previously received in the MAN SubmissionResponse FF-ICE message
of a FiledFlightPlanReply or FlightPlanUpdateReply).

The reply is composed of:

• a SubmissionResponse FF-ICE message that indicates the current value of the submission
status

• An optional FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise

Edition: 27.0 6 653

Document Title: NM 27.0 - NM B2B Reference Manual

18.5.2.2.1. SubmissionStatusRetrievalRequest (new 27.0)

<<class>>

FF-ICE Request to retrieve flight (plan) data.

1. Inherits from: Request

2. Attributes:

a. FilingId submissionStatus (Mandatory)

Documentation last updated: 27.0 - Edition 6

The FilingID returned when the FiledFlightPlanReply orthe FlightPlanUpdateReply returns a

MAN Submission Status value.

Used to obtain the latest SubmissionResponse during and after manual processing.

18.5.2.2.2. SubmissionStatusRetrievalReply (new 27.0)

<<class>>

Returned in response to SubmissionStatusRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. SubmissionStatusRetrievalReplyData data (Optional)

18.6. NotificationService Port Type

18.6.1. Overview

1. The NotificationService is intended to submit flight departure or flight arrival messages:

a. S-R/R FlightDepartureRequest/Reply (new 27.0)

b. S-R/R FlightArrivalRequest/Reply (new 27.0)

Edition: 27.0 6 654

Document Title: NM 27.0 - NM B2B Reference Manual

18.6.2. Requests/Replies

18.6.2.1. FlightDepartureRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightDepartureRequest

Reply: FlightDepartureReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightDepartureReply submitFlightDepartureRequest(FlightDepartureRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then flight performance data is returned

• verify certificate read access to /flights#take_off_weight

then flight take of weight is returned

Documentation last updated: 27.0 - Edition 5

Notifies a flight departure.

The request is composed of:

• a FlightDeparture FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message.

18.6.2.1.1. FlightDepartureRequest (new 27.0)

<<class>>

Edition: 27.0 6 655

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Request

2. Attributes:

a. FficeFD_FficeMessageType flightDeparture_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 5

The FlightDeparture FF-ICE message.

i. Constraints:

▪ FlightDepartureRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Invalid ffice message.

Constrained attributes: flightDeparture_v1_1

Constrained requests: any using request

18.6.2.1.2. FlightDepartureReply (new 27.0)

<<class>>

Returned in response to FlightDepartureRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightDepartureReplyData data (Optional)

18.6.2.2. FlightArrivalRequest/Reply (new 27.0)

Edition: 27.0 6 656

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightArrivalRequest

Reply: FlightArrivalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightArrivalReply submitFlightArrivalRequest(FlightArrivalRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• verify certificate read access to /flights#performance_data

then flight performance data is returned

• verify certificate read access to /flights#take_off_weight

then flight take of weight is returned

Documentation last updated: 27.0 - Edition 5

Notifies a flight arrival.

The request is composed of:

• a FlightArrival FF-ICE message

The reply is composed of:

• a SubmissionResponse FF-ICE message

18.6.2.2.1. FlightArrivalRequest (new 27.0)

<<class>>

1. Inherits from: Request

2. Attributes:

a. FficeFA_FficeMessageType flightArrival_v1_1 (Mandatory)

Edition: 27.0 6 657

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 5

The FlightArrival FF-ICE message.

i. Constraints:

▪ FlightArrivalRequest.INVALID_FFICE_MESSAGE

3. Constraints:

a. INVALID_FFICE_MESSAGE

Invalid ffice message.

Constrained attributes: flightArrival_v1_1

Constrained requests: any using request

18.6.2.2.2. FlightArrivalReply (new 27.0)

<<class>>

Returned in response to FlightArrivalRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightArrivalReplyData data (Optional)

18.7. PublicationService Port Type

18.7.1. Overview

1. The PublicationService is intended to publish flight plan messages:

a. P/S FFICE_PUBLICATION

18.7.2. Publish/Subscribe Topics

18.7.2.1. FFICE_PUBLICATION (new 27.0)

Edition: 27.0 6 658

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: FficePublicationMessage

Ordering policy:

Messages referring to the same flight plan shall be ordered by numerically sorting on the size
of the field eventHistory (because every new message has a new event) or picking the highest
sequenceNumber.

Message filter: FficePublicationMessageFilter

Payload configuration: FficePublicationPayloadConfiguration

Subscription management (topic specific):

• S-R/R FficePublicationSubscriptionCreationRequest/Reply

• S-R/R FficePublicationSubscriptionUpdateRequest/Reply

• S-R/R FficePublicationSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify read access to /flights?sensitive=true

then messages relative to sensitive flights are published

Notification about changes to flight plans.

18.7.2.1.1. FficePublicationMessage (new 27.0)

<<class>>

The business P/S message for topic FFICE_PUBLICATION.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. FlightType flight_v4_3 (Mandatory)

The flight.

b. CountPositiveType operatorFlightPlanVersion_v4_3 (Optional)

Edition: 27.0 6 659

Document Title: NM 27.0 - NM B2B Reference Manual

The flight plan version provided by the operator.

c. list< FlightPlanEventHistoryItem > eventHistory (Mandatory)

The full list of events that affected the flight plan.

i. Constraints:

▪ list size range : [1, 1000]

d. set< AirNavigationUnitId > concernedUnits (Optional)

Concerned air navigation units.

e. RevalidationInformation revalidationInformation (Optional)

Flight Plan Revalidation information.

18.7.2.1.2. FficePublicationSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: FficePublicationSubscriptionCreationRequest

Reply: FficePublicationSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficePublicationSubscriptionCreationReply
createFficePublicationSubscription(FficePublicationSubscriptionCreationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic FFICE_PUBLICATION.

FficePublicationSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 660

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic FFICE_PUBLICATION.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. FficePublicationMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. FficePublicationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FficePublicationSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to FficePublicationSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FficePublicationSubscriptionCreationReplyData data (Optional)

The reply payload.

18.7.2.1.3. FficePublicationSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 661

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FficePublicationSubscriptionUpdateRequest

Reply: FficePublicationSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficePublicationSubscriptionUpdateReply
updateFficePublicationSubscription(FficePublicationSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic FFICE_PUBLICATION.

FficePublicationSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic FFICE_PUBLICATION.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. FficePublicationMessageFilter messageFilter (Mandatory)

Edition: 27.0 6 662

Document Title: NM 27.0 - NM B2B Reference Manual

It defines how messages should be filtered.

b. FficePublicationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FficePublicationSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to FficePublicationSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FficePublicationSubscriptionUpdateReplyData data (Optional)

The reply payload.

18.7.2.1.4. FficePublicationSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: FficePublicationSubscriptionRetrievalRequest

Reply: FficePublicationSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FficePublicationSubscriptionRetrievalReply
retrieveFficePublicationSubscription(FficePublicationSubscriptionRetrievalRequest
request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic FFICE_PUBLICATION.

FficePublicationSubscriptionRetrievalRequest (new 27.0)

Edition: 27.0 6 663

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription retrieval request for topic FFICE_PUBLICATION.

1. Inherits from: SubscriptionRetrievalRequest

FficePublicationSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to FficePublicationSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. FficePublicationSubscriptionRetrievalReplyData data (Optional)

The reply payload.

18.8. Data Types

18.8.1. AerodromeICAOIdWildcard (new 27.0)
<<typedef[string]>>

ICAO identifier of an aerodrome, or a simple wildcard for aerodrome identifiers (e.g. "EB*")

1. Pattern: (UALPHA){3,4}|(UALPHA){1,3}*

2. Used by: FlightSetDefinitionElement

18.8.2. AircraftOperatorFilter (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 2

This type provides a way of describing a selection of aircraft operators to be used for filtering flight
plan-related messages based on the ArcId (flight plan field 7b) and OPR/ subfield (field 18).

The type has three attributes, each acting as a selector or filter in its own way.

The following table, together with the textual explanation of each attribute below, should provide

Edition: 27.0 6 664

Document Title: NM 27.0 - NM B2B Reference Manual

sufficient information on how each of the three filtering attributes matches each possible
combination of ArcId and OPR/ fields.

• The upper part of the table shows all possible combinations of ArcId and OPR/ for a hypothetical
airline AAA. For example combination (1) means AAA is specified both in the ArcId and in the
OPR/ subfield; combination (2) means that the ArcId contains AAA but the OPR/ is either empty
or unrecognized; and so on.

• The lower part of the table shows how setting the value 'AAA' in each filtering attribute matches
the above combinations.

Table 35. FLIGHT_FILING_RESULT filtering by Aircraft Operator

(1) (2) (3) (4) (5)

ArcId and OPR/ A.O. in ArcId (field 7b) AAA AAA AAA BBB -
combinations in
flight plan A.O. in OPR/ (field 18) AAA - BBB AAA AAA

Subscription filters arcidAircraftOperatorDesignators_v4_3=[AAA] Y Y Y

by aircraft oprAircraftOperatorDesignators_v4_3=[AAA] Y Y Y
operators
operatingAircraftOperatorDesignators_v4_3=[A Y Y Y Y
AA]

1. Attributes:

a. set< AircraftOperatorDesignatorType > arcidAircraftOperatorDesignators_v4_3 (Optional)

A set of aircraft operators ICAO identifiers.

Each item in the set will be compared with the aircraft operator ICAO id derived from the
aircraft id (flight plan field 7b).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

b. set< AircraftOperatorDesignatorType > oprAircraftOperatorDesignators_v4_3 (Optional)

A set of aircraft operators ICAO identifiers.

Each item in the set will be compared with the aircraft operator ICAO id derived from the
OPR/ subfield (flight plan field 18).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

c. set< AircraftOperatorDesignatorType > operatingAircraftOperatorDesignators_v4_3 (Optional)

A set of aircraft operators ICAO identifiers.

Edition: 27.0 6 665

Document Title: NM 27.0 - NM B2B Reference Manual

Each item in the set will be compared with the aircraft operator ICAO id derived from the
OPR/ subfield (flight plan field 18).

In case the aircraft operator could not be derived from the OPR/ subfield, and only in such
case, the comparison is performed with the aircraft operator derived from the arcId (field
7b).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

At least one of arcidAircraftOperatorDesignators_v4_3 , oprAircraftOperatorDesignators_v4_3

and operatingAircraftOperatorDesignators_v4_3 must be present and not empty.

Constrained attributes: arcidAircraftOperatorDesignators_v4_3,

oprAircraftOperatorDesignators_v4_3, operatingAircraftOperatorDesignators_v4_3

Constrained requests: any using request

3. Used by: FficeFlightFilingMessageFilter

18.8.3. FficeFlightFilingMessageFilter (new 27.0)

<<class>>

A message filter for subscription topic SubscriptionTopic.FFICE_FLIGHT_FILING .

1. Attributes:

a. AircraftOperatorFilter aircraftOperators (Mandatory)

It filters the messages based on aircraft operators.

2. Used by: FficeFlightFilingSubscription, FficeFlightFilingSubscriptionCreationRequest,

FficeFlightFilingSubscriptionUpdateRequest

18.8.4. FficeFlightFilingSubscription (new 27.0)

Edition: 27.0 6 666

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic FFICE_FLIGHT_FILING.

1. Inherits from: Subscription

2. Attributes:

a. FficeFlightFilingMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

3. Used by: FficeFlightFilingSubscriptionUpdateReplyData,

FficeFlightFilingSubscriptionCreationReplyData,
FficeFlightFilingSubscriptionRetrievalReplyData

18.8.5. FficeFlightFilingSubscriptionCreationReplyData (new 27.0)

<<class>>

The FficeFlightFilingSubscriptionCreationReply payload.

1. Attributes:

a. FficeFlightFilingSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: FficeFlightFilingSubscriptionCreationReply

18.8.6. FficeFlightFilingSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The FficeFlightFilingSubscriptionRetrievalReply payload.

1. Attributes:

a. FficeFlightFilingSubscription subscription (Mandatory)

Edition: 27.0 6 667

Document Title: NM 27.0 - NM B2B Reference Manual

Instance of the requested subscription.

2. Used by: FficeFlightFilingSubscriptionRetrievalReply

18.8.7. FficeFlightFilingSubscriptionUpdateReplyData (new 27.0)

<<class>>

The FficeFlightFilingSubscriptionUpdateReply payload.

1. Attributes:

a. FficeFlightFilingSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: FficeFlightFilingSubscriptionUpdateReply

18.8.8. FficePublicationMessageFilter (new 27.0)

<<class>>

A message filter for subscription topic SubscriptionTopic.FFICE_PUBLICATION .

1. Attributes:

a. set< FlightPlanEventType > events (Optional)

Selects the types if events that should trigger the sending of a message (e.g., FPL , CHG , DLA ,
etc.).

Optional: by default, all events are considered.

i. Constraints:

▪ set size range : [1, 20]

b. set< FlightSetDefinitionElement > flightSet (Mandatory)

Selects which flights to filter.

The logical OR operator is meant between the items in the set.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FficePublicationMessageFilter.VALID_FLIGHT_SET

2. Constraints:

a. VALID_FLIGHT_SET

▪ flightSet size ≤ 10

The following constraints apply to the overall combination of FlightSetDefinitionElements

Edition: 27.0 6 668

Document Title: NM 27.0 - NM B2B Reference Manual

and not to the individual sets in each element. For example, if a subscription specifies a
filter on aircraft operators, the total number of aircraft operator identifiers across all
FlightSetDefinitionElements must be less or equal to 100, regardless of the number of
FlightSetDefinitionElements used.

▪ The sum of all FlightSetDefinitionElement.aircraftRegistrations sizes must be ≤ 10000

▪ The sum of all

FlightSetDefinitionElement.aerodromesOfDeparture|aerodromesOfArrival|alternateAerodr
omes sizes must be ≤ 1000

▪ The sum of all FlightSetDefinitionElement.anuIds sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.aircraftOperators sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.flightPlanOriginators sizes must be ≤ 250

Constrained attributes: flightSet

Constrained requests: any using request

3. Used by: FficePublicationSubscription, FficePublicationSubscriptionCreationRequest,

FficePublicationSubscriptionUpdateRequest

18.8.9. FficePublicationPayloadConfiguration (new 27.0)

<<class>>

This is the payload configuration class dedicated to the SubscriptionTopic.FFICE_PUBLICATION

subscription topic.

It allows the user to define the content of the FlightPlanMessages published by NM for such a
subscription.

1. Attributes:

a. boolean concernedUnits (Mandatory)

Indicates whether the message must contain the air navigation units concerned by the flight
plan.

2. Used by: FficePublicationSubscription, FficePublicationSubscriptionCreationRequest,

FficePublicationSubscriptionUpdateRequest

18.8.10. FficePublicationSubscription (new 27.0)

Edition: 27.0 6 669

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic FFICE_PUBLICATION.

1. Inherits from: Subscription

2. Attributes:

a. FficePublicationMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. FficePublicationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: FficePublicationSubscriptionRetrievalReplyData,

FficePublicationSubscriptionUpdateReplyData, FficePublicationSubscriptionCreationReplyData

18.8.11. FficePublicationSubscriptionCreationReplyData (new 27.0)

<<class>>

The FficePublicationSubscriptionCreationReply payload.

1. Attributes:

a. FficePublicationSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: FficePublicationSubscriptionCreationReply

18.8.12. FficePublicationSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The FficePublicationSubscriptionRetrievalReply payload.

Edition: 27.0 6 670

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. FficePublicationSubscription subscription (Mandatory)

Instance of the requested subscription.

b. SubscriptionSynchronisationSummary synchronisationSummary (Optional)

Summary information about any on-going subscription synchronisation.

2. Used by: FficePublicationSubscriptionRetrievalReply

18.8.13. FficePublicationSubscriptionUpdateReplyData (new 27.0)

<<class>>

The FficePublicationSubscriptionUpdateReply payload.

1. Attributes:

a. FficePublicationSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: FficePublicationSubscriptionUpdateReply

18.8.14. FiledFlightPlanReplyData (new 27.0)

<<class>>

The FiledFlightPlanReply payload.

1. Attributes:

a. FficeFS_FficeMessageType filingStatus_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 5

The FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight plan was successfully filed

▪ REJ - the flight plan was rejected

▪ MAN - see Manual Request Processing

2. Used by: FiledFlightPlanReply

Edition: 27.0 6 671

Document Title: NM 27.0 - NM B2B Reference Manual

18.8.15. FilingId
<<typedef[string]>>

Example
AA00953172BB00956485

1. Pattern: (UALPHA{2}DIGIT{8}){1,2}

2. Used by: SubmissionStatusRetrievalRequest

18.8.16. FlightArrivalReplyData (new 27.0)

<<class>>

The FlightArrivalReply payload.

1. Attributes:

a. FficeSR_FficeMessageType submissionResponse_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight arrival was successfully notified

▪ REJ - the flight arrival notification was rejected

▪ MAN - see Manual Request Processing

2. Used by: FlightArrivalReply

18.8.17. FlightDataReplyData
<<class>>

The FlightDataReply payload.

1. Attributes:

a. FficeFS_FficeMessageType filingStatus_v1_1 (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 5

The FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Mandatory) (new 27.0)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight plan was successfully retrieved

Edition: 27.0 6 672

Document Title: NM 27.0 - NM B2B Reference Manual

▪ REJ - the flight plan was not retrieved

c. FficeFDRP_FficeMessageType flightDataResponse_v1_1 (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 5

The FlightDataResponse FF-ICE message. Present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

2. Used by: FlightDataReply

18.8.18. FlightDepartureReplyData (new 27.0)

<<class>>

The FlightDepartureReply payload.

1. Attributes:

a. FficeSR_FficeMessageType submissionResponse_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight departure was successfully notified

▪ REJ - the flight departure notification was rejected

▪ MAN - see Manual Request Processing

2. Used by: FlightDepartureReply

18.8.19. FlightPlanCancellationReplyData (new 27.0)

<<class>>

The FlightPlanCancellationReply payload.

1. Attributes:

a. FficeSR_FficeMessageType submissionResponse_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight plan was successfully cancelled

▪ REJ - the flight plan cancellation was rejected

▪ MAN - see Manual Request Processing

2. Used by: FlightPlanCancellationReply

Edition: 27.0 6 673

Document Title: NM 27.0 - NM B2B Reference Manual

18.8.20. FlightPlanEvent (new 27.0)

<<class>>

The events that affected a flight plan.

1. Attributes:

a. FlightPlanEventType eventType (Mandatory)

The events that affected the flight plan.

b. DateTimeSecond timestamp (Mandatory)

The timestamp when the event has occurred.

c. AirNavigationUnitId originator (Optional) (new 27.0)

The originator that participates to the flight plan message change event.

2. Used by: FlightPlanEventHistoryItem

18.8.21. FlightPlanEventHistoryItem (new 27.0)

<<class>>

An event that affected a flight plan.

1. Attributes:

a. int sequenceNumber (Mandatory)

Sequence number of the flight plan event.

b. FlightPlanEvent event (Mandatory)

The flight plan event.

2. Used by: FficePublicationMessage

18.8.22. FlightPlanEventType (new 27.0)

<<enumeration>>

Documentation last updated: 27.0 - Edition 6

Lists all the events that may trigger a new flight publication message.

For use of the FF-ICE publication service in order to comply with CP1, only the following
FlightPlanEventTypes are required: FPL, CHG, DLA, CNL, ARR, and DEP. The following
FlightPlanEventTypes are not required to comply with CP1: AFP, MFS, FNM, and REVAL.

1. Values:

Edition: 27.0 6 674

Document Title: NM 27.0 - NM B2B Reference Manual

a. AFP

Airborne Flight Plan message

b. ARR

ARRival message

c. CHG

CHanGe message

d. CNL

CaNceL message

e. DEP

DEParture message

f. DLA

DeLAyed message

g. FNM

Flight Notification Message

h. FPL

Flight PLan message

i. MFS

Message From Shanwick

j. REVAL

Periodic Flight Plan IFPS Revalidation

2. Used by: FficePublicationMessageFilter, FlightPlanEvent

18.8.23. FlightPlanUpdateReplyData (new 27.0)

<<class>>

The FlightPlanUpdateReply payload.

1. Attributes:

a. FficeFS_FficeMessageType filingStatus_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 5

Edition: 27.0 6 675

Document Title: NM 27.0 - NM B2B Reference Manual

The FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - the flight plan was successfully updated

▪ REJ - the flight plan updated was rejected

▪ MAN - see Manual Request Processing

2. Used by: FlightPlanUpdateReply

18.8.24. FlightSetDefinitionElement (new 27.0)

<<class>>

A FlightSetDefinitionElement is designed to capture a set of flights based on the following

attributes.

All attributes within the same FlightSetDefinitionElement instance are combined with a logical AND
operator.

For a detailed description, see Flight Set Definition.

1. Attributes:

a. set< AircraftOperatorDesignatorType > aircraftOperatorDesignators_v4_3 (Optional)

Set of aircraft operators.

Optional: by default, any aircraft operator is considered.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

b. set< AircraftRegistrationType > aircraftRegistrations_v4_3 (Optional)

Set of aircraft registration marks.

Optional: by default, any aircraft registration mark is considered.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

c. set< AerodromeICAOIdWildcard > aerodromesOfDeparture (Optional)

Edition: 27.0 6 676

Document Title: NM 27.0 - NM B2B Reference Manual

The aerodromes of departure.

Optional: by default, there is no filtering based on ADEP.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

d. set< AerodromeICAOIdWildcard > aerodromesOfArrival (Optional)

The aerodromes of arrival.

Optional: by default, there is no filtering based on ADES.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

e. set< AerodromeICAOIdWildcard > alternateAerodromes (Optional)

The alternate aerodromes.

Optional: by default, there is no filtering based on alternate aerodromes.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

f. set< AirNavigationUnitId > anuIds (Optional)

Set of air navigation unit ids.

Specifying one or more ANU Id means subscribing to the flight plans that "concern" those air
navigation units.

Optional: by default, no filtering based on air navigation units.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

g. set< AirNavigationUnitId > flightPlanOriginators (Optional)

Set of flight plan originators.

Optional: by default, no filtering based on flight plan originators.

i. Constraints:

▪ set size range : [1, unbounded[

Edition: 27.0 6 677

Document Title: NM 27.0 - NM B2B Reference Manual

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

At least one attribute must be set.

Constrained attributes: aircraftOperatorDesignators_v4_3, aircraftRegistrations_v4_3,

aerodromesOfDeparture, aerodromesOfArrival, alternateAerodromes, anuIds,
flightPlanOriginators

Constrained requests: any using request

3. Used by: FficePublicationMessageFilter

18.8.25. RevalidationInformation (new 27.0)

<<class>>

This type contains the result of the periodic flight plan revalidation.

1. Attributes:

a. UUID gufi (Optional)

GUFI.

b. RevalidationStatus revalidationStatus (Mandatory)

The outcome of the flight plan revalidation.

c. string[] revalidationErrors (Optional)

The list of errors detected during the flight plan revalidation.

d. string proposedRoute (Optional)

When populated, this field contains a valid route that can be used as a valid alternative. It is
not always provided.

2. Used by: FficePublicationMessage

18.8.26. RevalidationStatus (new 27.0)

<<enumeration>>

Flight Plan Revalidation status

1. Values:

a. COMPLIANT

The flight plan is compliant with all active constraints.

Edition: 27.0 6 678

Document Title: NM 27.0 - NM B2B Reference Manual

b. ADVISORY

The flight plan violates some constraints and is no longer operationally acceptable.
However, due to the origin or the nature of the flight it cannot be suspended. This
information is for the flight plan originator and AOCC.

c. SUSPENDED

The flight plan violates some constraints and is no longer operationally acceptable and it
will be suspended. An FLS event will follow.

2. Used by: RevalidationInformation

18.8.27. SubmissionStatusRetrievalReplyData (new 27.0)

<<class>>

The SubmissionStatusRetrievalReply payload.

1. Attributes:

a. FficeFS_FficeMessageType filingStatus_v1_1 (Optional)

Documentation last updated: 27.0 - Edition 5

The FilingStatus FF-ICE message, present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Mandatory)

Documentation last updated: 27.0 - Edition 6

The SubmissionResponse FF-ICE message. The submissionStatus can be:

▪ ACK - a trajectory could be built - there might be IFPS errors of ROUTE and/or PROFILE
errors

▪ REJ - a trajectory could not be built

2. Used by: SubmissionStatusRetrievalReply

18.8.28. TrialReplyData
<<class>>

The TrialReply payload.

1. Attributes:

a. FficeTRP_FficeMessageType trialResponse_v1_1 (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 5

Edition: 27.0 6 679

Document Title: NM 27.0 - NM B2B Reference Manual

The TrialResponse FF-ICE message. Present if the submission response status

(SubmissionResponse/submissionStatus) is ACK, null otherwise.

b. FficeSR_FficeMessageType submissionResponse_v1_1 (Mandatory) (new 27.0)

Documentation last updated: 27.0 - Edition 5

The SubmissionResponse FF-ICE message.

2. Used by: TrialReply

Appendix H: AIRM Semantic Correspondence

• RevalidationInformation.gufi

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@globallyUniqueFlightIdentifier

Appendix I: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

18.I.1. Request / Reply Settings

Table 36. Compression settings

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

18.I.2. Time Window Request / Reply Count Quotas

Table 37. FilingService Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FiledFlightPlanRequest 5250 6300 600

/Reply

Edition: 27.0 6 680

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightPlanUpdateReques 5250 6300 600

t/Reply

FlightPlanCancellation 5250 6300 600

Request/Reply

FficeFlightFilingSubsc 30 36 60
riptionCreationRequest
/Reply

FficeFlightFilingSubsc 30 36 60
riptionUpdateRequest/R
eply

FficeFlightFilingSubsc 30 36 60
riptionRetrievalReques
t/Reply

Table 38. TrialService Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

TrialRequest/Reply 5250 6300 600

Table 39. FlightDataRequestService Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightDataRequest/Repl 5250 6300 600

y

SubmissionStatusRetrie 5250 6300 600

valRequest/Reply

Table 40. NotificationService Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightDepartureRequest 150 180 600

/Reply

FlightArrivalRequest/R 150 180 600

eply

Table 41. PublicationService Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FficePublicationSubscr 30 36 60
iptionCreationRequest/
Reply

Edition: 27.0 6 681

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FficePublicationSubscr 30 36 60
iptionUpdateRequest/Re
ply

FficePublicationSubscr 30 36 60
iptionRetrievalRequest
/Reply

18.I.3. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Table 42. FFICE_FLIGHT_FILING

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the filing submission
was processed by the NM IFPS or by the the NM
IFPS operator
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 43. FFICE_PUBLICATION

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the flight plan was
updated in the NM IFPS
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Appendix J: NM Extension
1. The NM extension captures the supplementary Flight and Messaging data elements required for
FF-ICE that are exchanged between NM and Users.

2. The NM extension documentation is available as:

a. UML reference model

Edition: 27.0 6 682

Document Title: NM 27.0 - NM B2B Reference Manual

b. XML schema documentation

Appendix K: FIXM Message Rules

18.K.1. Reader Guidelines

1. FIXM FF-ICE message templates offer message-specific guidance and validation rules while
remaining entirely compliant with the broader FIXM structures.

2. For each FF-ICE message, e.g. a FlightDataRequest message, a dedicated FIXM FF-ICE message
template is defined.

3. This appendix describes the additional rules that NM applies.

4. Unlike the FF-ICE message template rules, that are formally defined by means of XML types, the
NM rules are documented in a textual manner only.

5. The NM rules apply to the message template but also to its included types. Therefore, this
appendix is organised as follows:

◦ one section per message template

◦ one subsection per type included in the message template where an additional NM rule is
defined

◦ one subsection entry per type property for which an additional NM rule is defined

6. The NM type property rules are:

◦ mandatory

The supply of this input property is mandatory.

◦ ignored

This input property is ignored by NM.

If the property is declared as mandatory by the FIXM schema, the client

CAUTION
application shall provide a valid value (with respect to the schema).

◦ forbidden

The supply of this input property or of some input property values is forbidden.

◦ guidance

On an input message, it provides information about what to write in this input property
and/or how NM interprets it.

On an output message, it provides information on how to interpret / process the value

written by NM in this output property.

◦ not-available

Edition: 27.0 6 683

Document Title: NM 27.0 - NM B2B Reference Manual

This output property is never written by NM B2B.

18.K.2. FF-ICE FlightArrival Rules

The FIXM FF-ICE template (see FficeFA_FficeMessageType) offers message-specific guidance and
validation rules for the ICAO FF-ICE message FlightArrival.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.2.1. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. destinationAerodrome: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

18.K.2.2. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.2.3. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. departurePoint: ignored

Limitation Only departure aerodrome is supported

c. departurePointPrevious: ignored

d. estimatedOffBlockTime: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

Edition: 27.0 6 684

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.2.4. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. type: mandatory

j. uniqueMessageIdentifier: mandatory

18.K.2.5. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentification: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

b. gufiLegacy: guidance

Support of the gufi legacy is provided for eFPL supplied in the deprecated interface.

18.K.3. FF-ICE FlightCancellation Rules

The FIXM FF-ICE template (see FficeFC_FficeMessageType) offers message-specific guidance and
validation rules for the ICAO FF-ICE message FlightCancellation.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

Edition: 27.0 6 685

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.3.1. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. destinationAerodrome: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

18.K.3.2. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.3.3. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. departurePoint: ignored

Limitation Only departure aerodrome is supported

c. departurePointPrevious: ignored

d. estimatedOffBlockTime: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

18.K.3.4. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

Edition: 27.0 6 686

Document Title: NM 27.0 - NM B2B Reference Manual

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. translationRecipient: guidance

onlineContact(s) which supports AFTN address in linkage TextAddress and a NetworkChoice

of ATFN. This implements the (IFPS Users Manual) Re-addressing Function.

j. type: mandatory

k. uniqueMessageIdentifier: mandatory

18.K.3.5. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentification: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

b. gufiLegacy: guidance

Support of the gufi legacy is provided for eFPL supplied in the deprecated interface.

18.K.4. FF-ICE FlightDeparture Rules

The FIXM FF-ICE template (see FficeFD_FficeMessageType) offers message-specific guidance and
validation rules for the ICAO FF-ICE message FlightDeparture.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.4.1. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. destinationAerodrome: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

Edition: 27.0 6 687

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.4.2. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.4.3. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. departurePoint: ignored

Limitation Only departure aerodrome is supported

c. departurePointPrevious: ignored

d. estimatedOffBlockTime: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

18.K.4.4. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. type: mandatory

j. uniqueMessageIdentifier: mandatory

Edition: 27.0 6 688

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.4.5. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentification: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

b. gufiLegacy: guidance

Support of the gufi legacy is provided for eFPL supplied in the deprecated interface.

18.K.5. FF-ICE FlightDataResponse Rules

The FIXM FF-ICE template (see FficeFDRP_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message FlightDataResponse.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.5.1. AircraftOperatorType Rules

The AircraftOperatorType FF-ICE documentation is available here.

1. Property Rules

a. operatingOrganization: not-available

18.K.5.2. AircraftTypeType Rules

The AircraftTypeType FF-ICE documentation is available here.

1. Property Rules

a. otherAircraftType: guidance

In the case of multiple non ICAO Doc 8643 aircraft types are submitted to IFPS via
AFTN/TYPE or via NMB2B (but not via FF-ICE), the concatenation of the numberOfAircrafts
and otherAircraftTypes with be placed in otherAircraftType.

18.K.5.3. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 689

Document Title: NM 27.0 - NM B2B Reference Manual

a. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

b. arrivalAerodrome: guidance

Available when an Arrival Message has been processed by IFPS

c. runwayDirection: not-available

18.K.5.4. ContactInformationType Rules

The ContactInformationType FF-ICE documentation is available here.

1. Property Rules

a. address: not-available

18.K.5.5. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: not-available

b. level: not-available

c. speed: not-available

18.K.5.6. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.5.7. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.5.8. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 690

Document Title: NM 27.0 - NM B2B Reference Manual

a. grossWeight: not-available

b. netWeight: not-available

c. volume: not-available

18.K.5.9. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: not-available

18.K.5.10. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

1. Property Rules

a. allPackedInOne: not-available

b. shipmentDimensions: not-available

c. subsidiaryHazardClass: not-available

d. unNumber: not-available

18.K.5.11. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: not-available

b. aircraftLimitation: not-available

c. onboardLocation: not-available

d. packageGroup: not-available

e. shippingInformation: not-available

18.K.5.12. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airportSlotIdentification: guidance

Edition: 27.0 6 691

Document Title: NM 27.0 - NM B2B Reference Manual

See IFPS Users manual (ASL)

b. departurePoint: not-available

c. departurePointPrevious: not-available

d. runwayDirection: not-available

e. takeoffAlternateAerodrome: guidance

No input checks are made by NM on this field, and in practice, more than one TALT can be
received and processed by IFPS. As a result, only the first and second TALT that conform to
ICAO Location Indicator syntax (four alphabetic) will be found in the first or second location
indicators of the takeoffAlternateAerodrome element. Text that cannot be placed in the
location indicator field will be placed in the name element of AerodromeName.

18.K.5.13. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. type: mandatory

b. uniqueMessageIdentifier: mandatory

18.K.5.14. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: not-available

b. emergencyDescription: not-available

c. lastContact: not-available

d. originator: not-available

e. otherInformation: not-available

f. phase: not-available

18.K.5.15. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentificationPrevious: not-available

Edition: 27.0 6 692

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.5.16. FlightRouteInformationType Rules

The FlightRouteInformationType FF-ICE documentation is available here.

1. Property Rules

a. airacReference: not-available

18.K.5.17. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. dangerousGoods: not-available

b. flightConstraint: not-available

c. flightPlanSubmitter: not-available

d. flightType: guidance

Always present

e. operator: guidance

Only the designatorIcao property can be made available

18.K.5.18. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.5.19. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: not-available

b. windDirection: not-available

c. windSpeed: not-available

Edition: 27.0 6 693

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.5.20. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. aoWhatIfReRouteIndicator: guidance

AWR - IFPS Users Manual

b. ifpsIdentifier: guidance

IFPLID - IFPS Users Manual

c. replacementFlightPlanIndicator: guidance

RFP - Replacement Flight Plan Procedure - IFPS Users Manual

d. runwayVisualRange: guidance

RVR - IFPS Users Manual

e. stayInformation: guidance

STAYINFO - IFPS Users Manual

18.K.5.21. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

The ICAO 4444 item 15c that would be output by IFPS to ATS. It represents the translation of
the series of route trajectory elements provided in either a trajectory (point4D) or route
(series of route trajectory elements). If no series of route trajectory elements were supplied
to NM, then the route text is the sole representation of the agreed trajectory. Flight plans
that are supplied to NM via non FF-ICE mechanisms (contains no GUFI, i.e. via AFTN), or non
standard FF-ICE mechanisms (VFR/OAT) will only have a route text representation.

18.K.5.22. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: not-available

18.K.5.23. PersonOrOrganizationType Rules

The PersonOrOrganizationType FF-ICE documentation is available here.

Edition: 27.0 6 694

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. contact: not-available

b. identifierDomain: not-available

c. name: not-available

18.K.5.24. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReference: not-available

18.K.5.25. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: not-available

18.K.5.26. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: not-available

b. radioFailureRemarks: not-available

18.K.5.27. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: not-available

b. criticalSafetyIndex: not-available

c. transportIndex: not-available

18.K.5.28. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. cruiseClimbStart: not-available

Edition: 27.0 6 695

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.5.29. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: not-available

b. level: not-available

c. restrictionReference: guidance

The business identifier of the Profile Tuning Restriction (PTR).

d. speed: not-available

e. time: not-available

18.K.5.30. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. constraint: guidance

Represents Flight Profile Restrictions (Profile Tuning Restrictions or PTR) encountered by

the profile. These are marked on the level-off caused by the PTR, between where the PTR
enters and exits the reference location of the PTR on the trajectory. See CONSTRAINT_POINT.

b. modified: not-available

c. modifiedRouteItemReference: not-available

d. point4D: guidance

If the submitter supplied a desired trajectory, as a set of route trajectory elements (all) with
point 4D, then the agreed trajectory will be made available with point4D.

e. routeTruncationIndicator: not-available

18.K.5.31. RouteTrajectoryGroupContainerType Rules

The RouteTrajectoryGroupContainerType FF-ICE documentation is available here.

1. Property Rules

a. negotiating: guidance

If a route proposal is available for a flight has been found invalid by revalidation
(NOT_ACCEPTABLE), it is placed here in this property

Edition: 27.0 6 696

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.5.32. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. agreed: guidance

The format of the trajectory will be that of the request, either route, trajectory, or route text.
Route text will always be present even if route or trajectory are supplied.

b. climbProfile: guidance

Access control: get climbProfile requires read access to /flights#performance_data

c. climbSchedule: not-available

d. current: not-available

e. descentProfile: guidance

Access control: get descentProfile requires read access to /flights#performance_data

In line with ICAO guidance the descent profile will be provided in decreasing level and
increasing time and distance.

f. descentSchedule: not-available

g. desired: not-available

h. negotiating: guidance

The route text on output from NM reflects the item 15c that would be sent to ATS. Should a
valid proposal be found then the route reflects a valid item 15c.

i. takeoffMass: guidance

Will only be made available via B2B to clients that have read access to the element.

18.K.5.33. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: not-available

b. subsidiaryHazardClassAndDivision: not-available

18.K.5.34. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

Edition: 27.0 6 697

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.5.35. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: not-available

b. subsequentSpeed: not-available

18.K.5.36. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier can be made available.

b. supplementaryInformationSource: not-available

18.K.5.37. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: not-available

b. timeSpecification: not-available

18.K.5.38. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: not-available

b. metData: not-available

c. predictedAirspeed: not-available

d. predictedGroundspeed: not-available

e. verticalRange: not-available

Edition: 27.0 6 698

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.5.39. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: not-available

b. propertyType: guidance

CONSTRAINT_POINT will be marked at the beginning and end of the level-off caused by a
Profile Tuning Restriction

c. reference: not-available

18.K.6. FF-ICE FlightDataRequest Rules

The FIXM FF-ICE template (see FficeFDRQ_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message FlightDataRequest.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.6.1. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.6.2. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

Edition: 27.0 6 699

Document Title: NM 27.0 - NM B2B Reference Manual

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. type: mandatory

j. uniqueMessageIdentifier: mandatory

18.K.6.3. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. gufi: guidance

When the GUFI is not supplied to NM, all of arrival, and departure (including estimated off
block time) and aircraftIdentification must be supplied. If a flight without a GUFI is found,
then the mandatory GUFI uuid is returned with the null value 00000000-0000-4000-a000-
000000000000, along with the required flight data request response.

b. gufiLegacy: guidance

Support of the gufi legacy is provided for eFPL supplied in the deprecated interface.

18.K.6.4. NmSubmissionStatusExtensionType Rules

The NmSubmissionStatusExtensionType FF-ICE documentation is available here.

1. Property Rules

a. filingId: guidance

The Filing ID is returned in MAN Submission Response. The Filing ID may be used in the
FlightDataRequestService to obtain the current Submission Response, and if ACK, the Filing
Status

18.K.7. FF-ICE FiledFlightPlan Rules

The FIXM FF-ICE template (see FficeFFP_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message FiledFlightPlan.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

Edition: 27.0 6 700

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.1. AircraftOperatorType Rules

The AircraftOperatorType FF-ICE documentation is available here.

1. Property Rules

a. operatingOrganization: ignored

18.K.7.2. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

b. runwayDirection: ignored

18.K.7.3. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.7.4. ContactInformationType Rules

The ContactInformationType FF-ICE documentation is available here.

1. Property Rules

a. address: ignored

18.K.7.5. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: ignored

b. level: ignored

c. speed: ignored

Edition: 27.0 6 701

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.6. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

18.K.7.7. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

18.K.7.8. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

a. grossWeight: ignored

b. netWeight: ignored

c. volume: ignored

18.K.7.9. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: ignored

18.K.7.10. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

1. Property Rules

a. allPackedInOne: ignored

b. shipmentDimensions: ignored

c. subsidiaryHazardClass: ignored

d. unNumber: ignored

Edition: 27.0 6 702

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.11. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: ignored

b. aircraftLimitation: ignored

c. onboardLocation: ignored

d. packageGroup: ignored

e. shippingInformation: ignored

18.K.7.12. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

c. departurePoint: ignored

Limitation Only departure aerodrome is supported

d. departurePointPrevious: ignored

e. estimatedOffBlockTimePrevious: ignored

f. runwayDirection: ignored

18.K.7.13. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

Edition: 27.0 6 703

Document Title: NM 27.0 - NM B2B Reference Manual

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. translationRecipient: guidance

onlineContact(s) which supports AFTN address in linkage TextAddress and a NetworkChoice

of ATFN. This implements the (IFPS Users Manual) Re-addressing Function.

j. type: mandatory

k. uniqueMessageIdentifier: mandatory

18.K.7.14. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: ignored

b. emergencyDescription: ignored

c. lastContact: ignored

d. originator: ignored

e. otherInformation: ignored

f. phase: ignored

18.K.7.15. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentification: mandatory

b. aircraftIdentificationPrevious: ignored

c. gufiLegacy: forbidden

From NM 27.0 onwards, we only support the (new) GUFI.

18.K.7.16. FlightRouteInformationType Rules

The FlightRouteInformationType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 704

Document Title: NM 27.0 - NM B2B Reference Manual

a. airacReference: ignored

b. totalEstimatedElapsedTime: mandatory

18.K.7.17. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. dangerousGoods: ignored

b. flightConstraint: ignored

c. flightPlanOriginator: guidance

Used to populate the ORGN/ field in ATS messages. The first onlineContact with an address in
linkage TextAddress and a NetworkChoice of ATFN, or the AFTN address linked to the
certificate, and the voice TextPhone linked to ContactInformation, and flightPlanOriginator
name (PersonOrOrganisation). From the above, only the first 30 characters are taken. All
other information is ignored.

d. flightType: mandatory

e. operator: guidance

Only the designatorIcao property is stored, other element and properties are ignored

18.K.7.18. GeographicalPositionType Rules

The GeographicalPositionType FF-ICE documentation is available here.

Geographical position will be rounded to the nearest second.

18.K.7.19. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

b. condition: ignored

18.K.7.20. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: ignored

Edition: 27.0 6 705

Document Title: NM 27.0 - NM B2B Reference Manual

Not currently used by NM nor can it be made available.

b. windDirection: ignored

Not currently used by NM nor can it be made available.

c. windSpeed: ignored

Not currently used by NM nor can it be made available.

18.K.7.21. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. eurSpecialHandling: guidance

EUR/PROTECTED or EUR/OAT - see IFPS Users Manual

b. stayInformation: guidance

STAYINFO - IFPS Users Manual - To be used when a Route Text is supplied to NM, use
plannedDelay when Trajectory or Route supplied to NM. See Formats of Planned Trajectory

18.K.7.22. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

Non standard and not recommended means of filing a route to IFPS. Provided as a means to
support planning that cannot be supported by FIXM/FFICE such as VFR or OAT. Required to
submit two route trajectory elements as first and last, without point4D information.

18.K.7.23. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: guidance

weight evolution. Not currently used by NM.

18.K.7.24. PerformanceProfileType Rules

The PerformanceProfileType FF-ICE documentation is available here.

If provided, both the descentProfile and climbProfile must be present.

Edition: 27.0 6 706

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.25. PersonOrOrganizationType Rules

The PersonOrOrganizationType FF-ICE documentation is available here.

1. Property Rules

a. contact: ignored

b. identifierDomain: ignored

c. name: ignored

18.K.7.26. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReason: guidance

When inside the IFPZ, will represent the information inside a STAYINFO in ATS messages

b. delayReference: ignored

c. delayType: forbidden

These PlannedDelay types are forbidden and not supported by NM:

OPERATOR_REQUEST_AIRSPACE, OPERATOR_REQUEST_AERODROME,
OPERATOR_REQUEST_HOLDING and ATFM.

18.K.7.27. Point4DTimeChoiceType Rules

The Point4DTimeChoiceType FF-ICE documentation is available here.

1. Property Rules

a. absoluteTime: guidance

Mandatory on first Route Trajectory Element (departure aerodrome), forbidden in

subsequent Flight Route Elements. Must be greater than the estimatedOffBlockTime The
estimatedOffBlockTime will be subtracted from this time and used as a Taxi Time (duration)
within NM systems. Will be rounded to the nearest minute. Please refer to IFPS Users
Manual for more information on the use of provided TAXI times in NM.

b. relativeTimeFromInitialPredictionPoint: guidance

Mandatory on all elements after first element of RouteTrajectoryElement.

18.K.7.28. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

Edition: 27.0 6 707

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. airspeed: ignored

b. level: guidance

Within the PerformanceProfile only integer altitude Meter is supported. Other Units are
Forbidden

18.K.7.29. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: ignored

b. radioFailureRemarks: ignored

18.K.7.30. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: ignored

b. criticalSafetyIndex: ignored

c. transportIndex: ignored

18.K.7.31. RelativePointType Rules

The RelativePointType FF-ICE documentation is available here.

1. Property Rules

a. bearing: guidance

Bearing will be rounded to the nearest second before processing.

b. distance: guidance

Before processing rounding to integer will be performed in Nautical Miles, and conversion
to integer Nautical Miles will be performed should for other unit.

18.K.7.32. RequestedInformationChoiceType Rules

The RequestedInformationChoiceType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 708

Document Title: NM 27.0 - NM B2B Reference Manual

a. other: ignored

18.K.7.33. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. level: guidance

Within the route, the units of measure Flight Level in Hundreds of Feet, Tens of Meter are
preserved/kept. Translation to Flight Level will be performed should Altitude (Meter/Foot)
be supplied. Conversion to integer will be performed from the supplied double before
processing in NM.

18.K.7.34. RouteDesignatorToNextElementChoiceType Rules

The RouteDesignatorToNextElementChoiceType FF-ICE documentation is available here.

1. Property Rules

a. otherRouteDesignator: guidance

When PlannedDelay, UNSPECIFIED must be used in OtherRouteDesignator

18.K.7.35. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: ignored

b. level: ignored

c. speed: ignored

d. time: ignored

18.K.7.36. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. PlannedDelay: guidance

STAYINFO cannot be used with PlannedDelay.

b. alongRouteDistance: mandatory

c. constraint: forbidden

Edition: 27.0 6 709

Document Title: NM 27.0 - NM B2B Reference Manual

d. elementStartPoint: guidance

Must be LocationIndicator for the first and/or last point in the trajectory or structured route,
or if no AerodromeReference LocationIndicator then a reference point must be supplied
along with the AerodromeName.

e. modified: ignored

f. modifiedRouteItemReference: ignored

g. point4D: guidance

If a choice is made to supply a desired/negotiating trajectory then a point4D must be present

for every Route Trajectory Element. If the choice is made not to supply a trajectory, but only
a route, then only a series of route trajectory elements with no point4D may be supplied.

h. routeDesignatorToNextElement: guidance

When a routePoint is supplied,this must be supplied (a choice must be made).

i. routeTruncationIndicator: ignored

18.K.7.37. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. climbSchedule: ignored

b. descentSchedule: ignored

c. desired: guidance

Can be either route, a trajectory or a route text.

d. element: guidance

When present, at least two elements. NmExtension routeText is forbidden when

RouteTrajectoryElement are provided that are not first and last in the series of route
elements. Should no Point4D be provided for each route element, then the list of element
represents the ICAO 15 item c. \ Refer to NM extension routeText and Point4D for further
information.

e. takeoffMass: guidance

Advised if no PerformanceProfile provided. Will only be made available via FF-ICE services
to clients that have read access to the element.

Edition: 27.0 6 710

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.38. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: ignored

b. subsidiaryHazardClassAndDivision: ignored

18.K.7.39. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

b. condition: ignored

18.K.7.40. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: ignored

b. subsequentSpeed: ignored

18.K.7.41. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier is used to populate the C/ in item 19. No other

properties are stored.

b. supplementaryInformationSource: ignored

18.K.7.42. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: ignored

b. timeSpecification: ignored

Edition: 27.0 6 711

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.7.43. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: ignored

b. level: guidance

Within the trajectory, altitude in Meter (M),and FL (Hundreds of Feet or SM) are supported
and these units of measure are made available in Request,Replies and Publish Subscribe.
Float (double) are rounded to integer before processing. Usage of other vertical distance
units will be converted to Meter.

c. metData: mandatory

This data although mandatory, is not currently used, nor can it be made available.

d. predictedAirspeed: ignored

e. predictedGroundspeed: ignored

f. verticalRange: ignored

18.K.7.44. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: ignored

b. propertyType: guidance

INITIAL_PREDICTION_POINT given as first point in trajectory: Airport Reference Location at

ADEP

c. reference: ignored

18.K.7.45. TrajectoryPointReferenceType Rules

The TrajectoryPointReferenceType FF-ICE documentation is available here.

1. Property Rules

a. identifier: ignored

b. type: ignored

Edition: 27.0 6 712

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.8. FF-ICE FFICE_PUBLICATION P/S Message Rules

This section documents the additional validation / processing / interpretation rules that NM
applies to the FIXM types in the context of a FlightType wrapped in a FFICE_PUBLICATION P/S
Message.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.8.1. AircraftOperatorType Rules

The AircraftOperatorType FF-ICE documentation is available here.

1. Property Rules

a. operatingOrganization: not-available

18.K.8.2. AircraftTypeType Rules

The AircraftTypeType FF-ICE documentation is available here.

1. Property Rules

a. otherAircraftType: guidance

In the case of multiple non ICAO Doc 8643 aircraft types are submitted to IFPS via
AFTN/TYPE or via NMB2B (but not via FF-ICE), the concatenation of the numberOfAircrafts
and otherAircraftTypes with be placed in otherAircraftType.

18.K.8.3. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

b. arrivalAerodrome: guidance

Available when an Arrival Message has been processed by IFPS

c. runwayDirection: not-available

18.K.8.4. ContactInformationType Rules

The ContactInformationType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 713

Document Title: NM 27.0 - NM B2B Reference Manual

a. address: not-available

18.K.8.5. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: not-available

b. level: not-available

c. speed: not-available

18.K.8.6. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.8.7. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.8.8. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

a. grossWeight: not-available

b. netWeight: not-available

c. volume: not-available

18.K.8.9. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: not-available

Edition: 27.0 6 714

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.8.10. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

1. Property Rules

a. allPackedInOne: not-available

b. shipmentDimensions: not-available

c. subsidiaryHazardClass: not-available

d. unNumber: not-available

18.K.8.11. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: not-available

b. aircraftLimitation: not-available

c. onboardLocation: not-available

d. packageGroup: not-available

e. shippingInformation: not-available

18.K.8.12. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

b. departurePoint: not-available

c. departurePointPrevious: not-available

d. runwayDirection: not-available

e. takeoffAlternateAerodrome: guidance

No input checks are made by NM on this field, and in practice, more than one TALT can be
received and processed by IFPS. As a result, only the first and second TALT that conform to
ICAO Location Indicator syntax (four alphabetic) will be found in the first or second location
indicators of the takeoffAlternateAerodrome element. Text that cannot be placed in the
location indicator field will be placed in the name element of AerodromeName.

Edition: 27.0 6 715

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.8.13. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: not-available

b. emergencyDescription: not-available

c. lastContact: not-available

d. originator: not-available

e. otherInformation: not-available

f. phase: not-available

18.K.8.14. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentificationPrevious: not-available

18.K.8.15. FlightRouteInformationType Rules

The FlightRouteInformationType FF-ICE documentation is available here.

1. Property Rules

a. airacReference: not-available

b. totalEstimatedElapsedTime: guidance

Always present.

18.K.8.16. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. dangerousGoods: not-available

b. flightConstraint: not-available

c. flightPlanSubmitter: not-available

d. flightType: guidance

Always present

Edition: 27.0 6 716

Document Title: NM 27.0 - NM B2B Reference Manual

e. operator: guidance

Only the designatorIcao property can be made available

18.K.8.17. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.8.18. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: not-available

b. windDirection: not-available

c. windSpeed: not-available

18.K.8.19. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. aoWhatIfReRouteIndicator: guidance

AWR - IFPS Users Manual

b. ifpsIdentifier: guidance

IFPLID - IFPS Users Manual

c. replacementFlightPlanIndicator: guidance

RFP - Replacement Flight Plan Procedure - IFPS Users Manual

d. runwayVisualRange: guidance

RVR - IFPS Users Manual

e. stayInformation: guidance

STAYINFO - IFPS Users Manual

Edition: 27.0 6 717

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.8.20. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

The ICAO 4444 item 15c that would be output by IFPS to ATS. It represents the translation of
the series of route trajectory elements provided in either a trajectory (point4D) or route
(series of route trajectory elements). If no series of route trajectory elements were supplied
to NM, then the route text is the sole representation of the agreed trajectory. Flight plans
that are supplied to NM via non FF-ICE mechanisms (contains no GUFI, i.e. via AFTN), or non
standard FF-ICE mechanisms (VFR/OAT) will only have a route text representation.

18.K.8.21. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: not-available

18.K.8.22. NmSubmissionStatusExtensionType Rules

The NmSubmissionStatusExtensionType FF-ICE documentation is available here.

1. Property Rules

a. filingId: guidance

The Filing ID is returned in MAN Submission Response. The Filing ID may be used in the
FlightDataRequestService to obtain the current Submission Response, and if ACK, the Filing
Status

18.K.8.23. PersonOrOrganizationType Rules

The PersonOrOrganizationType FF-ICE documentation is available here.

1. Property Rules

a. contact: not-available

b. identifierDomain: not-available

c. name: not-available

18.K.8.24. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 718

Document Title: NM 27.0 - NM B2B Reference Manual

a. delayReference: not-available

18.K.8.25. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: not-available

18.K.8.26. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: not-available

b. radioFailureRemarks: not-available

18.K.8.27. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: not-available

b. criticalSafetyIndex: not-available

c. transportIndex: not-available

18.K.8.28. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. cruiseClimbStart: not-available

18.K.8.29. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: not-available

b. level: not-available

c. restrictionReference: guidance

Edition: 27.0 6 719

Document Title: NM 27.0 - NM B2B Reference Manual

The business identifier of the Profile Tuning Restriction (PTR).

d. speed: not-available

e. time: not-available

18.K.8.30. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. constraint: guidance

Represents Flight Profile Restrictions (Profile Tuning Restrictions or PTR) encountered by

the profile. These are marked on the level-off caused by the PTR, between where the PTR
enters and exits the reference location of the PTR on the trajectory. See CONSTRAINT_POINT.

b. modified: not-available

c. modifiedRouteItemReference: not-available

d. point4D: guidance

If the submitter supplied a desired trajectory, as a set of route trajectory elements (all) with
point 4D, then the agreed trajectory will be made available with point4D.

e. routeTruncationIndicator: not-available

18.K.8.31. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. agreed: guidance

The format of the trajectory will be that of the request, either route, trajectory, or route text.
Route text will always be present even if route or trajectory are supplied.

b. climbProfile: guidance

Access control: get climbProfile requires read access to /flights#performance_data

c. climbSchedule: not-available

d. current: not-available

e. descentProfile: guidance

Access control: get descentProfile requires read access to /flights#performance_data

Edition: 27.0 6 720

Document Title: NM 27.0 - NM B2B Reference Manual

In line with ICAO guidance the descent profile will be provided in decreasing level and
increasing time and distance.

f. descentSchedule: not-available

g. desired: not-available

h. negotiating: guidance

The route text on output from NM reflects the item 15c that would be sent to ATS. Should a
valid proposal be found then the route reflects a valid item 15c.

i. takeoffMass: guidance

Will only be made available via B2B to clients that have read access to the element.

18.K.8.32. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: not-available

b. subsidiaryHazardClassAndDivision: not-available

18.K.8.33. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.8.34. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: not-available

b. subsequentSpeed: not-available

18.K.8.35. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 721

Document Title: NM 27.0 - NM B2B Reference Manual

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier can be made available.

b. supplementaryInformationSource: not-available

18.K.8.36. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: not-available

b. timeSpecification: not-available

18.K.8.37. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: not-available

b. metData: not-available

c. predictedAirspeed: not-available

d. predictedGroundspeed: not-available

e. verticalRange: not-available

18.K.8.38. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: not-available

b. propertyType: guidance

CONSTRAINT_POINT will be marked at the beginning and end of the level-off caused by a
Profile Tuning Restriction

c. reference: not-available

18.K.9. FF-ICE FlightPlanUpdate Rules

Edition: 27.0 6 722

Document Title: NM 27.0 - NM B2B Reference Manual

The FIXM FF-ICE template (see FficeFPU_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message FlightPlanUpdate.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.9.1. AircraftOperatorType Rules

The AircraftOperatorType FF-ICE documentation is available here.

1. Property Rules

a. operatingOrganization: ignored

18.K.9.2. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

b. destinationAerodrome: guidance

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

c. runwayDirection: ignored

18.K.9.3. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.9.4. ContactInformationType Rules

The ContactInformationType FF-ICE documentation is available here.

1. Property Rules

a. address: ignored

Edition: 27.0 6 723

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.9.5. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: ignored

b. level: ignored

c. speed: ignored

18.K.9.6. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

18.K.9.7. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

18.K.9.8. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

a. grossWeight: ignored

b. netWeight: ignored

c. volume: ignored

18.K.9.9. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: ignored

18.K.9.10. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

Edition: 27.0 6 724

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. allPackedInOne: ignored

b. shipmentDimensions: ignored

c. subsidiaryHazardClass: ignored

d. unNumber: ignored

18.K.9.11. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: ignored

b. aircraftLimitation: ignored

c. onboardLocation: ignored

d. packageGroup: ignored

e. shippingInformation: ignored

18.K.9.12. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. airportSlotIdentification: guidance

See IFPS Users manual (ASL)

c. departurePoint: ignored

Limitation Only departure aerodrome is supported

d. departurePointPrevious: ignored

e. estimatedOffBlockTimePrevious: ignored

f. runwayDirection: ignored

18.K.9.13. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

Edition: 27.0 6 725

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. translationRecipient: guidance

onlineContact(s) which supports AFTN address in linkage TextAddress and a NetworkChoice

of ATFN. This implements the (IFPS Users Manual) Re-addressing Function.

j. type: mandatory

k. uniqueMessageIdentifier: mandatory

18.K.9.14. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: ignored

b. emergencyDescription: ignored

c. lastContact: ignored

d. originator: ignored

e. otherInformation: ignored

f. phase: ignored

18.K.9.15. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentification: guidance

Edition: 27.0 6 726

Document Title: NM 27.0 - NM B2B Reference Manual

Only the GUFI UUID is used to associate with the stored flight plan in IFPS

b. aircraftIdentificationPrevious: ignored

c. gufiLegacy: forbidden

From NM 27.0 onwards, we only support the (new) GUFI.

18.K.9.16. FlightRouteInformationType Rules

The FlightRouteInformationType FF-ICE documentation is available here.

1. Property Rules

a. airacReference: ignored

18.K.9.17. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. dangerousGoods: ignored

b. flightConstraint: ignored

c. flightPlanOriginator: guidance

Used to populate the ORGN/ field in ATS messages. The first onlineContact with an address in
linkage TextAddress and a NetworkChoice of ATFN, or the AFTN address linked to the
certificate, and the voice TextPhone linked to ContactInformation, and flightPlanOriginator
name (PersonOrOrganisation). From the above, only the first 30 characters are taken. All
other information is ignored.

d. operator: guidance

Only the designatorIcao property is stored, other element and properties are ignored

18.K.9.18. GeographicalPositionType Rules

The GeographicalPositionType FF-ICE documentation is available here.

Geographical position will be rounded to the nearest second.

18.K.9.19. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

Edition: 27.0 6 727

Document Title: NM 27.0 - NM B2B Reference Manual

b. condition: ignored

18.K.9.20. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: ignored

Not currently used by NM nor can it be made available.

b. windDirection: ignored

Not currently used by NM nor can it be made available.

c. windSpeed: ignored

Not currently used by NM nor can it be made available.

18.K.9.21. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. eurSpecialHandling: guidance

EUR/PROTECTED or EUR/OAT - see IFPS Users Manual

b. stayInformation: guidance

STAYINFO - IFPS Users Manual - To be used when a Route Text is supplied to NM, use
plannedDelay when Trajectory or Route supplied to NM. See Formats of Planned Trajectory

18.K.9.22. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

Non standard and not recommended means of filing a route to IFPS. Provided as a means to
support planning that cannot be supported by FIXM/FFICE such as VFR or OAT. Required to
submit two route trajectory elements as first and last, without point4D information.

18.K.9.23. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

Edition: 27.0 6 728

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. weight: guidance

weight evolution. Not currently used by NM.

18.K.9.24. PerformanceProfileType Rules

The PerformanceProfileType FF-ICE documentation is available here.

If provided, both the descentProfile and climbProfile must be present.

18.K.9.25. PersonOrOrganizationType Rules

The PersonOrOrganizationType FF-ICE documentation is available here.

1. Property Rules

a. contact: ignored

b. identifierDomain: ignored

c. name: ignored

18.K.9.26. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReason: guidance

When inside the IFPZ, will represent the information inside a STAYINFO in ATS messages

b. delayReference: ignored

c. delayType: forbidden

These PlannedDelay types are forbidden and not supported by NM:

OPERATOR_REQUEST_AIRSPACE, OPERATOR_REQUEST_AERODROME,
OPERATOR_REQUEST_HOLDING and ATFM.

18.K.9.27. Point4DTimeChoiceType Rules

The Point4DTimeChoiceType FF-ICE documentation is available here.

1. Property Rules

a. absoluteTime: guidance

Mandatory on first Route Trajectory Element (departure aerodrome), forbidden in

subsequent Flight Route Elements. Must be greater than the estimatedOffBlockTime The

Edition: 27.0 6 729

Document Title: NM 27.0 - NM B2B Reference Manual

estimatedOffBlockTime will be subtracted from this time and used as a Taxi Time (duration)
within NM systems. Will be rounded to the nearest minute. Please refer to IFPS Users
Manual for more information on the use of provided TAXI times in NM.

b. relativeTimeFromInitialPredictionPoint: guidance

Mandatory on all elements after first element of RouteTrajectoryElement.

18.K.9.28. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: ignored

b. level: guidance

Within the PerformanceProfile only integer altitude Meter is supported. Other Units are
Forbidden

18.K.9.29. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: ignored

b. radioFailureRemarks: ignored

18.K.9.30. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: ignored

b. criticalSafetyIndex: ignored

c. transportIndex: ignored

18.K.9.31. RelativePointType Rules

The RelativePointType FF-ICE documentation is available here.

1. Property Rules

a. bearing: guidance

Bearing will be rounded to the nearest second before processing.

Edition: 27.0 6 730

Document Title: NM 27.0 - NM B2B Reference Manual

b. distance: guidance

Before processing rounding to integer will be performed in Nautical Miles, and conversion
to integer Nautical Miles will be performed should for other unit.

18.K.9.32. RequestedInformationChoiceType Rules

The RequestedInformationChoiceType FF-ICE documentation is available here.

1. Property Rules

a. other: ignored

18.K.9.33. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. level: guidance

Within the route, the units of measure Flight Level in Hundreds of Feet, Tens of Meter are
preserved/kept. Translation to Flight Level will be performed should Altitude (Meter/Foot)
be supplied. Conversion to integer will be performed from the supplied double before
processing in NM.

18.K.9.34. RouteDesignatorToNextElementChoiceType Rules

The RouteDesignatorToNextElementChoiceType FF-ICE documentation is available here.

1. Property Rules

a. otherRouteDesignator: guidance

When PlannedDelay, UNSPECIFIED must be used in OtherRouteDesignator

18.K.9.35. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: ignored

b. level: ignored

c. speed: ignored

d. time: ignored

Edition: 27.0 6 731

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.9.36. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. PlannedDelay: guidance

STAYINFO cannot be used with PlannedDelay.

b. alongRouteDistance: mandatory

c. constraint: forbidden

d. elementStartPoint: guidance

Must be LocationIndicator for the first and/or last point in the trajectory or structured route,
or if no AerodromeReference LocationIndicator then a reference point must be supplied
along with the AerodromeName.

e. modified: ignored

f. modifiedRouteItemReference: ignored

g. point4D: guidance

If a choice is made to supply a desired/negotiating trajectory then a point4D must be present

for every Route Trajectory Element. If the choice is made not to supply a trajectory, but only
a route, then only a series of route trajectory elements with no point4D may be supplied.

h. routeDesignatorToNextElement: guidance

When a routePoint is supplied,this must be supplied (a choice must be made).

i. routeTruncationIndicator: ignored

18.K.9.37. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. climbSchedule: ignored

b. descentSchedule: ignored

c. desired: guidance

Can be either route, a trajectory or a route text.

d. element: guidance

When present, at least two elements. NmExtension routeText is forbidden when

Edition: 27.0 6 732

Document Title: NM 27.0 - NM B2B Reference Manual

RouteTrajectoryElement are provided that are not first and last in the series of route
elements. Should no Point4D be provided for each route element, then the list of element
represents the ICAO 15 item c. \ Refer to NM extension routeText and Point4D for further
information.

e. takeoffMass: guidance

Advised if no PerformanceProfile provided. Will only be made available via FF-ICE services
to clients that have read access to the element.

18.K.9.38. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: ignored

b. subsidiaryHazardClassAndDivision: ignored

18.K.9.39. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

b. condition: ignored

18.K.9.40. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: ignored

b. subsequentSpeed: ignored

18.K.9.41. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier is used to populate the C/ in item 19. No other

properties are stored.

b. supplementaryInformationSource: ignored

Edition: 27.0 6 733

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.9.42. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: ignored

b. timeSpecification: ignored

18.K.9.43. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: ignored

b. level: guidance

Within the trajectory, altitude in Meter (M),and FL (Hundreds of Feet or SM) are supported
and these units of measure are made available in Request,Replies and Publish Subscribe.
Float (double) are rounded to integer before processing. Usage of other vertical distance
units will be converted to Meter.

c. metData: mandatory

This data although mandatory, is not currently used, nor can it be made available.

d. predictedAirspeed: ignored

e. predictedGroundspeed: ignored

f. verticalRange: ignored

18.K.9.44. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: ignored

b. propertyType: guidance

INITIAL_PREDICTION_POINT given as first point in trajectory: Airport Reference Location at

ADEP

c. reference: ignored

Edition: 27.0 6 734

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.9.45. TrajectoryPointReferenceType Rules

The TrajectoryPointReferenceType FF-ICE documentation is available here.

1. Property Rules

a. identifier: ignored

b. type: ignored

18.K.10. FF-ICE FilingStatus Rules

The FIXM FF-ICE template (see FficeFS_FficeMessageType) offers message-specific guidance and
validation rules for the ICAO FF-ICE message FilingStatus.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.10.1. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. arrivalAerodrome: guidance

Available when an Arrival Message has been processed by IFPS

18.K.10.2. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: not-available

b. level: not-available

c. speed: not-available

18.K.10.3. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

Edition: 27.0 6 735

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.10.4. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.10.5. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

a. grossWeight: not-available

b. netWeight: not-available

c. volume: not-available

18.K.10.6. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: not-available

18.K.10.7. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

1. Property Rules

a. allPackedInOne: not-available

b. shipmentDimensions: not-available

c. subsidiaryHazardClass: not-available

d. unNumber: not-available

18.K.10.8. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: not-available

b. aircraftLimitation: not-available

c. onboardLocation: not-available

Edition: 27.0 6 736

Document Title: NM 27.0 - NM B2B Reference Manual

d. packageGroup: not-available

e. shippingInformation: not-available

18.K.10.9. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. type: mandatory

b. uniqueMessageIdentifier: mandatory

18.K.10.10. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: not-available

b. emergencyDescription: not-available

c. lastContact: not-available

d. originator: not-available

e. otherInformation: not-available

f. phase: not-available

18.K.10.11. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentificationPrevious: not-available

18.K.10.12. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. flightConstraint: not-available

b. flightType: guidance

Always present

Edition: 27.0 6 737

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.10.13. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.10.14. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: not-available

b. windDirection: not-available

c. windSpeed: not-available

18.K.10.15. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. aoWhatIfReRouteIndicator: guidance

AWR - IFPS Users Manual

b. ifpsIdentifier: guidance

IFPLID - IFPS Users Manual

c. replacementFlightPlanIndicator: guidance

RFP - Replacement Flight Plan Procedure - IFPS Users Manual

d. runwayVisualRange: guidance

RVR - IFPS Users Manual

e. stayInformation: guidance

STAYINFO - IFPS Users Manual

18.K.10.16. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 738

Document Title: NM 27.0 - NM B2B Reference Manual

a. routeText: guidance

The ICAO 4444 item 15c that would be output by IFPS to ATS. It represents the translation of
the series of route trajectory elements provided in either a trajectory (point4D) or route
(series of route trajectory elements). If no series of route trajectory elements were supplied
to NM, then the route text is the sole representation of the agreed trajectory. Flight plans
that are supplied to NM via non FF-ICE mechanisms (contains no GUFI, i.e. via AFTN), or non
standard FF-ICE mechanisms (VFR/OAT) will only have a route text representation.

18.K.10.17. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: not-available

18.K.10.18. NmRouteTrajectoryGroupContainerExtensionType Rules

The NmRouteTrajectoryGroupContainerExtensionType FF-ICE documentation is available here.

1. Property Rules

a. rejected: guidance

"The rejected trajectory represents the what NM constructed (when possible) from the
desired trajectory

18.K.10.19. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReference: not-available

18.K.10.20. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: not-available

18.K.10.21. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: not-available

Edition: 27.0 6 739

Document Title: NM 27.0 - NM B2B Reference Manual

b. radioFailureRemarks: not-available

18.K.10.22. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: not-available

b. criticalSafetyIndex: not-available

c. transportIndex: not-available

18.K.10.23. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. cruiseClimbStart: not-available

18.K.10.24. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: not-available

b. level: not-available

c. restrictionReference: guidance

The business identifier of the Profile Tuning Restriction (PTR).

d. speed: not-available

e. time: not-available

18.K.10.25. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. constraint: guidance

Represents Flight Profile Restrictions (Profile Tuning Restrictions or PTR) encountered by

the profile. These are marked on the level-off caused by the PTR, between where the PTR
enters and exits the reference location of the PTR on the trajectory. See CONSTRAINT_POINT.

Edition: 27.0 6 740

Document Title: NM 27.0 - NM B2B Reference Manual

b. modified: not-available

c. modifiedRouteItemReference: not-available

d. point4D: guidance

If the submitter supplied a desired trajectory, as a set of route trajectory elements (all) with
point 4D, then the agreed trajectory will be made available with point4D.

e. routeTruncationIndicator: not-available

18.K.10.26. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. agreed: guidance

The format of the trajectory will be that of the request, either route, trajectory, or route text.
Route text will always be present even if route or trajectory are supplied.

b. climbProfile: guidance

Access control: get climbProfile requires read access to /flights#performance_data

c. climbSchedule: not-available

d. descentProfile: guidance

Access control: get descentProfile requires read access to /flights#performance_data

In line with ICAO guidance the descent profile will be provided in decreasing level and
increasing time and distance.

e. descentSchedule: not-available

f. negotiating: guidance

The route text on output from NM reflects the item 15c that would be sent to ATS. Should a
valid proposal be found then the route reflects a valid item 15c.

g. takeoffMass: guidance

Will only be made available via B2B to clients that have read access to the element.

18.K.10.27. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 741

Document Title: NM 27.0 - NM B2B Reference Manual

a. shipmentAuthorizations: not-available

b. subsidiaryHazardClassAndDivision: not-available

18.K.10.28. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.10.29. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: not-available

b. subsequentSpeed: not-available

18.K.10.30. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier can be made available.

b. supplementaryInformationSource: not-available

18.K.10.31. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: not-available

b. timeSpecification: not-available

18.K.10.32. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 742

Document Title: NM 27.0 - NM B2B Reference Manual

a. altimeterSetting: not-available

b. predictedAirspeed: not-available

c. predictedGroundspeed: not-available

d. verticalRange: not-available

18.K.10.33. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: not-available

b. propertyType: guidance

CONSTRAINT_POINT will be marked at the beginning and end of the level-off caused by a
Profile Tuning Restriction

c. reference: not-available

18.K.11. FF-ICE SubmissionResponse Rules

The FIXM FF-ICE template (see FficeSR_FficeMessageType) offers message-specific guidance and
validation rules for the ICAO FF-ICE message SubmissionResponse.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.11.1. AircraftTypeType Rules

The AircraftTypeType FF-ICE documentation is available here.

1. Property Rules

a. otherAircraftType: guidance

In the case of multiple non ICAO Doc 8643 aircraft types are submitted to IFPS via
AFTN/TYPE or via NMB2B (but not via FF-ICE), the concatenation of the numberOfAircrafts
and otherAircraftTypes with be placed in otherAircraftType.

18.K.11.2. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

Edition: 27.0 6 743

Document Title: NM 27.0 - NM B2B Reference Manual

1. Property Rules

a. arrivalAerodrome: guidance

Available when an Arrival Message has been processed by IFPS

18.K.11.3. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. type: mandatory

b. uniqueMessageIdentifier: mandatory

18.K.11.4. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. flightType: guidance

Always present

18.K.11.5. NmSubmissionStatusExtensionType Rules

The NmSubmissionStatusExtensionType FF-ICE documentation is available here.

1. Property Rules

a. filingId: guidance

The Filing ID is returned in MAN Submission Response. The Filing ID may be used in the
FlightDataRequestService to obtain the current Submission Response, and if ACK, the Filing
Status

18.K.11.6. SubmissionStatusType Rules

The SubmissionStatusType FF-ICE documentation is available here.

1. Property Rules

a. explanation: guidance

When the SubmissionStatus.value=REJ, or for PlaningStatusValue NON_CONCUR each

explanation contains an IFPS error.

When ACK or NEGOTIATE or ACCEPTABLE , each explanation may contain a warning or an

automatically ignored IFPS error.

Edition: 27.0 6 744

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.12. FF-ICE TrialResponse Rules

The FIXM FF-ICE template (see FficeTRP_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message TrialResponse.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.12.1. CruiseClimbStartType Rules

The CruiseClimbStartType FF-ICE documentation is available here.

1. Property Rules

a. atOrAboveAltitude: not-available

b. level: not-available

c. speed: not-available

18.K.12.2. CruisingLevelChangeType Rules

The CruisingLevelChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.12.3. CruisingSpeedChangeType Rules

The CruisingSpeedChangeType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

18.K.12.4. DangerousGoodsDimensionsType Rules

The DangerousGoodsDimensionsType FF-ICE documentation is available here.

1. Property Rules

a. grossWeight: not-available

b. netWeight: not-available

c. volume: not-available

Edition: 27.0 6 745

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.12.5. DangerousGoodsPackageGroupType Rules

The DangerousGoodsPackageGroupType FF-ICE documentation is available here.

1. Property Rules

a. shipmentDimensions: not-available

18.K.12.6. DangerousGoodsPackageType Rules

The DangerousGoodsPackageType FF-ICE documentation is available here.

1. Property Rules

a. allPackedInOne: not-available

b. shipmentDimensions: not-available

c. subsidiaryHazardClass: not-available

d. unNumber: not-available

18.K.12.7. DangerousGoodsType Rules

The DangerousGoodsType FF-ICE documentation is available here.

1. Property Rules

a. airWaybillNumber: not-available

b. aircraftLimitation: not-available

c. onboardLocation: not-available

d. packageGroup: not-available

e. shippingInformation: not-available

18.K.12.8. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. type: mandatory

b. uniqueMessageIdentifier: mandatory

18.K.12.9. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 746

Document Title: NM 27.0 - NM B2B Reference Manual

a. actionTaken: not-available

b. emergencyDescription: not-available

c. lastContact: not-available

d. originator: not-available

e. otherInformation: not-available

f. phase: not-available

18.K.12.10. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentificationPrevious: not-available

18.K.12.11. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. flightConstraint: not-available

b. flightType: guidance

Always present

18.K.12.12. LevelConstraintType Rules

The LevelConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.12.13. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: not-available

b. windDirection: not-available

Edition: 27.0 6 747

Document Title: NM 27.0 - NM B2B Reference Manual

c. windSpeed: not-available

18.K.12.14. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

The ICAO 4444 item 15c that would be output by IFPS to ATS. It represents the translation of
the series of route trajectory elements provided in either a trajectory (point4D) or route
(series of route trajectory elements). If no series of route trajectory elements were supplied
to NM, then the route text is the sole representation of the agreed trajectory. Flight plans
that are supplied to NM via non FF-ICE mechanisms (contains no GUFI, i.e. via AFTN), or non
standard FF-ICE mechanisms (VFR/OAT) will only have a route text representation.

18.K.12.15. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: not-available

18.K.12.16. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReference: not-available

18.K.12.17. PlanningStatusType Rules

The PlanningStatusType FF-ICE documentation is available here.

1. Property Rules

a. value: guidance

Reasons for NON_CONCUR will be placed in the SubmissionResponse.explanation.

18.K.12.18. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: not-available

Edition: 27.0 6 748

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.12.19. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: not-available

b. radioFailureRemarks: not-available

18.K.12.20. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: not-available

b. criticalSafetyIndex: not-available

c. transportIndex: not-available

18.K.12.21. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. cruiseClimbStart: not-available

18.K.12.22. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: not-available

b. level: not-available

c. speed: not-available

d. time: not-available

18.K.12.23. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. modified: not-available

b. modifiedRouteItemReference: not-available

Edition: 27.0 6 749

Document Title: NM 27.0 - NM B2B Reference Manual

c. routeTruncationIndicator: not-available

18.K.12.24. RouteTrajectoryGroupContainerType Rules

The RouteTrajectoryGroupContainerType FF-ICE documentation is available here.

1. Property Rules

a. negotiating: guidance

If a route proposal is available for a flight has been found invalid by revalidation
(NOT_ACCEPTABLE), it is placed here in this property

18.K.12.25. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. climbSchedule: not-available

b. descentSchedule: not-available

c. takeoffMass: guidance

Will only be made available via B2B to clients that have read access to the element.

18.K.12.26. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: not-available

b. subsidiaryHazardClassAndDivision: not-available

18.K.12.27. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: not-available

b. condition: not-available

18.K.12.28. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

Edition: 27.0 6 750

Document Title: NM 27.0 - NM B2B Reference Manual

a. initialSpeed: not-available

b. subsequentSpeed: not-available

18.K.12.29. SupplementaryInformationType Rules

The SupplementaryInformationType FF-ICE documentation is available here.

1. Property Rules

a. pilotInCommand: guidance

Of PersonOrOrganisation only identifier can be made available.

b. supplementaryInformationSource: not-available

18.K.12.30. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: not-available

b. timeSpecification: not-available

18.K.12.31. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: not-available

b. predictedAirspeed: not-available

c. predictedGroundspeed: not-available

d. verticalRange: not-available

18.K.12.32. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: not-available

b. propertyType: guidance

CONSTRAINT_POINT will be marked at the beginning and end of the level-off caused by a
Profile Tuning Restriction

Edition: 27.0 6 751

Document Title: NM 27.0 - NM B2B Reference Manual

c. reference: not-available

18.K.13. FF-ICE TrialRequest Rules

The FIXM FF-ICE template (see FficeTRQ_FficeMessageType) offers message-specific guidance

and validation rules for the ICAO FF-ICE message TrialRequest.

This section documents the additional validation / processing / interpretation rules that NM
applies.

NOTE The Reader Guidelines section explains how to interpret these rules.

18.K.13.1. ArrivalType Rules

The ArrivalType FF-ICE documentation is available here.

1. Property Rules

a. runwayDirection: ignored

18.K.13.2. AtmServiceProviderType Rules

The AtmServiceProviderType FF-ICE documentation is available here.

1. Property Rules

a. provider: ignored

b. providerType: ignored

18.K.13.3. DepartureType Rules

The DepartureType FF-ICE documentation is available here.

1. Property Rules

a. airfileIndicator: ignored

b. departurePoint: ignored

Limitation Only departure aerodrome is supported

c. departurePointPrevious: ignored

d. estimatedOffBlockTimePrevious: ignored

e. runwayDirection: ignored

f. takeoffAlternateAerodrome: guidance

Edition: 27.0 6 752

Document Title: NM 27.0 - NM B2B Reference Manual

No input checks are made by NM on this field, and in practice, more than one TALT can be
received and processed by IFPS. As a result, only the first and second TALT that conform to
ICAO Location Indicator syntax (four alphabetic) will be found in the first or second location
indicators of the takeoffAlternateAerodrome element. Text that cannot be placed in the
location indicator field will be placed in the name element of AerodromeName.

18.K.13.4. FficeMessageType Rules

The FficeMessageType FF-ICE documentation is available here.

1. Property Rules

a. forwardingProvider: ignored

b. originator: ignored

c. recipient: ignored

d. referencedMessageIdentifier: ignored

e. relevantAtmServiceProvider: ignored

f. respondByLimit: ignored

g. timestamp: ignored

h. translationProvider: ignored

i. type: mandatory

j. uniqueMessageIdentifier: mandatory

18.K.13.5. FlightEmergencyType Rules

The FlightEmergencyType FF-ICE documentation is available here.

1. Property Rules

a. actionTaken: ignored

b. emergencyDescription: ignored

c. lastContact: ignored

d. originator: ignored

e. otherInformation: ignored

f. phase: ignored

Edition: 27.0 6 753

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.6. FlightIdentificationType Rules

The FlightIdentificationType FF-ICE documentation is available here.

1. Property Rules

a. aircraftIdentificationPrevious: ignored

18.K.13.7. FlightType Rules

The FlightType FF-ICE documentation is available here.

1. Property Rules

a. flightConstraint: ignored

b. flightType: mandatory

18.K.13.8. GeographicalPositionType Rules

The GeographicalPositionType FF-ICE documentation is available here.

Geographical position will be rounded to the nearest second.

18.K.13.9. MeteorologicalDataType Rules

The MeteorologicalDataType FF-ICE documentation is available here.

1. Property Rules

a. temperature: ignored

Not currently used by NM nor can it be made available.

b. windDirection: ignored

Not currently used by NM nor can it be made available.

c. windSpeed: ignored

Not currently used by NM nor can it be made available.

18.K.13.10. NmFficeMessageExtensionType Rules

The NmFficeMessageExtensionType FF-ICE documentation is available here.

1. Property Rules

a. isNegotiatingTrajectoryRequested: ignored

For future use. When true the trial service will attempt to produce a propose route and
populate in the negotiating trajectory.

Edition: 27.0 6 754

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.11. NmFlightExtensionType Rules

The NmFlightExtensionType FF-ICE documentation is available here.

1. Property Rules

a. stayInformation: guidance

STAYINFO - IFPS Users Manual - To be used when a Route Text is supplied to NM, use
plannedDelay when Trajectory or Route supplied to NM. See Formats of Planned Trajectory

18.K.13.12. NmFlightRouteInformationExtensionType Rules

The NmFlightRouteInformationExtensionType FF-ICE documentation is available here.

1. Property Rules

a. routeText: guidance

Non standard and not recommended means of filing a route to IFPS. Provided as a means to
support planning that cannot be supported by FIXM/FFICE such as VFR or OAT. Required to
submit two route trajectory elements as first and last, without point4D information.

18.K.13.13. NmRouteTrajectoryElementExtensionType Rules

The NmRouteTrajectoryElementExtensionType FF-ICE documentation is available here.

1. Property Rules

a. weight: guidance

weight evolution. Not currently used by NM.

18.K.13.14. PerformanceProfileType Rules

The PerformanceProfileType FF-ICE documentation is available here.

If provided, both the descentProfile and climbProfile must be present.

18.K.13.15. PlannedDelayType Rules

The PlannedDelayType FF-ICE documentation is available here.

1. Property Rules

a. delayReference: ignored

b. delayType: forbidden

These PlannedDelay types are forbidden and not supported by NM:

OPERATOR_REQUEST_AIRSPACE, OPERATOR_REQUEST_AERODROME,
OPERATOR_REQUEST_HOLDING and ATFM.

Edition: 27.0 6 755

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.16. Point4DTimeChoiceType Rules

The Point4DTimeChoiceType FF-ICE documentation is available here.

1. Property Rules

a. absoluteTime: guidance

Mandatory on first Route Trajectory Element (departure aerodrome), forbidden in

subsequent Flight Route Elements. Must be greater than the estimatedOffBlockTime The
estimatedOffBlockTime will be subtracted from this time and used as a Taxi Time (duration)
within NM systems. Will be rounded to the nearest minute. Please refer to IFPS Users
Manual for more information on the use of provided TAXI times in NM.

b. relativeTimeFromInitialPredictionPoint: guidance

Mandatory on all elements after first element of RouteTrajectoryElement.

18.K.13.17. ProfilePointType Rules

The ProfilePointType FF-ICE documentation is available here.

1. Property Rules

a. airspeed: ignored

b. level: guidance

Within the PerformanceProfile only integer altitude Meter is supported. Other Units are
Forbidden

18.K.13.18. RadioCommunicationFailureType Rules

The RadioCommunicationFailureType FF-ICE documentation is available here.

1. Property Rules

a. contact: ignored

b. radioFailureRemarks: ignored

18.K.13.19. RadioactiveMaterialType Rules

The RadioactiveMaterialType FF-ICE documentation is available here.

1. Property Rules

a. category: ignored

b. criticalSafetyIndex: ignored

c. transportIndex: ignored

Edition: 27.0 6 756

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.20. RelativePointType Rules

The RelativePointType FF-ICE documentation is available here.

1. Property Rules

a. bearing: guidance

Bearing will be rounded to the nearest second before processing.

b. distance: guidance

Before processing rounding to integer will be performed in Nautical Miles, and conversion
to integer Nautical Miles will be performed should for other unit.

18.K.13.21. RouteChangeType Rules

The RouteChangeType FF-ICE documentation is available here.

1. Property Rules

a. level: guidance

Within the route, the units of measure Flight Level in Hundreds of Feet, Tens of Meter are
preserved/kept. Translation to Flight Level will be performed should Altitude (Meter/Foot)
be supplied. Conversion to integer will be performed from the supplied double before
processing in NM.

18.K.13.22. RouteDesignatorToNextElementChoiceType Rules

The RouteDesignatorToNextElementChoiceType FF-ICE documentation is available here.

1. Property Rules

a. otherRouteDesignator: guidance

When PlannedDelay, UNSPECIFIED must be used in OtherRouteDesignator

18.K.13.23. RouteTrajectoryConstraintType Rules

The RouteTrajectoryConstraintType FF-ICE documentation is available here.

1. Property Rules

a. departureOrArrivalIndicator: ignored

b. level: ignored

c. speed: ignored

d. time: ignored

Edition: 27.0 6 757

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.24. RouteTrajectoryElementType Rules

The RouteTrajectoryElementType FF-ICE documentation is available here.

1. Property Rules

a. PlannedDelay: guidance

STAYINFO cannot be used with PlannedDelay.

b. alongRouteDistance: mandatory

c. elementStartPoint: guidance

Must be LocationIndicator for the first and/or last point in the trajectory or structured route,
or if no AerodromeReference LocationIndicator then a reference point must be supplied
along with the AerodromeName.

d. modified: ignored

e. modifiedRouteItemReference: ignored

f. point4D: guidance

If a choice is made to supply a desired/negotiating trajectory then a point4D must be present

for every Route Trajectory Element. If the choice is made not to supply a trajectory, but only
a route, then only a series of route trajectory elements with no point4D may be supplied.

g. routeDesignatorToNextElement: guidance

When a routePoint is supplied,this must be supplied (a choice must be made).

h. routeTruncationIndicator: ignored

18.K.13.25. RouteTrajectoryGroupType Rules

The RouteTrajectoryGroupType FF-ICE documentation is available here.

1. Property Rules

a. climbSchedule: ignored

b. descentSchedule: ignored

c. element: guidance

When present, at least two elements. NmExtension routeText is forbidden when

RouteTrajectoryElement are provided that are not first and last in the series of route
elements. Should no Point4D be provided for each route element, then the list of element
represents the ICAO 15 item c. \ Refer to NM extension routeText and Point4D for further
information.

Edition: 27.0 6 758

Document Title: NM 27.0 - NM B2B Reference Manual

d. negotiating: guidance

Can be either route, a trajectory or a route text.

e. takeoffMass: guidance

Advised if no PerformanceProfile provided. Will only be made available via FF-ICE services
to clients that have read access to the element.

18.K.13.26. ShippingInformationType Rules

The ShippingInformationType FF-ICE documentation is available here.

1. Property Rules

a. shipmentAuthorizations: ignored

b. subsidiaryHazardClassAndDivision: ignored

18.K.13.27. SpeedConstraintType Rules

The SpeedConstraintType FF-ICE documentation is available here.

1. Property Rules

a. activation: ignored

b. condition: ignored

18.K.13.28. SpeedScheduleType Rules

The SpeedScheduleType FF-ICE documentation is available here.

1. Property Rules

a. initialSpeed: ignored

b. subsequentSpeed: ignored

18.K.13.29. TimeConstraintType Rules

The TimeConstraintType FF-ICE documentation is available here.

1. Property Rules

a. condition: ignored

b. timeSpecification: ignored

Edition: 27.0 6 759

Document Title: NM 27.0 - NM B2B Reference Manual

18.K.13.30. TrajectoryPoint4DType Rules

The TrajectoryPoint4DType FF-ICE documentation is available here.

1. Property Rules

a. altimeterSetting: ignored

b. level: guidance

Within the trajectory, altitude in Meter (M),and FL (Hundreds of Feet or SM) are supported
and these units of measure are made available in Request,Replies and Publish Subscribe.
Float (double) are rounded to integer before processing. Usage of other vertical distance
units will be converted to Meter.

c. predictedAirspeed: ignored

d. predictedGroundspeed: ignored

e. verticalRange: ignored

18.K.13.31. TrajectoryPointPropertyType Rules

The TrajectoryPointPropertyType FF-ICE documentation is available here.

1. Property Rules

a. description: ignored

b. propertyType: guidance

INITIAL_PREDICTION_POINT given as first point in trajectory: Airport Reference Location at

ADEP

c. reference: ignored

18.K.13.32. TrajectoryPointReferenceType Rules

The TrajectoryPointReferenceType FF-ICE documentation is available here.

1. Property Rules

a. identifier: ignored

b. type: ignored

Edition: 27.0 6 760

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 19. Flight

19.1. Context
1. NM B2B provides essentially three flight services corresponding to the three stages of a flight:

a. Flight preparation: services used during the preparation of a flight plan, before filing it to
NM

b. Flight filing: services related to the flight plan filing activity, including creation, update and
cancellation

c. Flight management: services used to query and retrieve information on existing flight plans
and flights

2. Due to the very structure of the NM system, NM distinguishes between flight plan data (or
simply flight plan ) and flight data (or simply flight ).

◦ The flight plan is a well known concept as per ICAO Document 4444. Flight plans for flights
operated or crossing PAN European airspace must be filed to the NM IFPS system.

The IFPS system validates the flight plan against the relevant AIRAC data and RAD
restrictions and if valid distributes the flight plan to the relevant actors, including
concerned ATS units.

◦ The flight refers to the execution phase of the flight plan, i.e. the actual flight. Flights are
handled by a second NM system called ETFMS. A flight starts to exist in the ETFMS system
maximum 20 hours before EOBT. A flight contains many more properties than a flight plan
and may significantly evolve in time regardless of the flight plan as the take-off time
approaches or once airborne (for example due to A-CDM, CASA slot information, position
reports, etc).

As mentioned before, flight plans are transferred from IFPS to ETFMS 20 hours before EOBT.
So if a flight plan is filed 2 days in advance (with respect to its EOBT), it remains in IFPS and
only 20 hours before EOBT the flight plan is transferred to ETFMS and "becomes" a flight. If
a flight plan is filed less than 20 hours in advance, then it is immediately transferred to
ETFMS.

Once the flight plan has been transferred to ETFMS, flight data (i.e. the flight) becomes
available.

3. A fourth section of Flight services exists: Flight safety services.

19.1.1. Flight Set Definition (for FLIGHT_DATA and FLIGHT_PLANS and

FFICE_PUBLICATION subscriptions)

1. The FLIGHT_DATA, FLIGHT_PLANS and FFICE_PUBLICATION subscription topics require the

user to specify a message filter to reduce the amount of messages generated by the subscription.

2. This message filter allows the user to define a flight set that determines which flights shall be

Edition: 27.0 6 761

Document Title: NM 27.0 - NM B2B Reference Manual

"captured" by the subscriptions.

3. The flight set is provided as a set of FlightSetDefinitionElement objects.

Each FlightSetDefinitionElement in the set is designed to capture certain flights, based on the
following criteria:

◦ By Aircraft operator

Accepts a set of aircraft operator ICAO identifiers.

A flight matches the subscription if the aircraft operator (derived from the ICAO Field 7 or
provided via the OPR/ indicator in the ICAO Field 18) matches any of the ICAO identifiers
provided in this set.

◦ By Aircraft registration

Accepts a set of aircraft registration marks.

A flight matches the subscription if the aircraft registration (provided in the ICAO Field 7 or
the REG/ indicator in the ICAO Field 18) matches any of the aircraft registration marks
provided in this set.

◦ By Aerodrome of departure

Accepts a set of aerodromes.

Catches all the flights departing to any of the aerodromes provided in the set.

◦ By Aerodrome of arrival

Accepts a set of aerodromes.

Catches all flights arriving to any of the aerodromes provided in the set. The arrival
aerodrome can be either the filed aerodrome of destination (ADES) or the diverted
aerodrome in case the flight was diverted.

◦ By Alternate aerodrome

Accepts a set of aerodromes.

Catches all flights having as alternate aerodrome any of the aerodromes provided in the set.

◦ By Concerned Air Traffic Services (ATS) unit

Accepts a set of Air Navigation Unit identifiers that represent valid ATS units.

Catches all flights that "concern" any of the ATS units provided in the set.

For more information about concerned ATS units see below sub-section Concerned Air
Traffic Services (ATS) units

Edition: 27.0 6 762

Document Title: NM 27.0 - NM B2B Reference Manual

◦ By Flight plan originator

Accepts a set of Air Navigation Unit identifiers that represent valid flight plan originators,
such as an ARO, an AO or a CFSP.

Catches all flights filed by any of the units provided in the set. More precisely, NM will match
the provided units with the original flight plan originator, i.e. the originator of the first FPL
message (whether it was sent via AFTN/SITA, the NOP portal or B2B).

4. All the above criteria are optional, but at least one must be provided and not be empty.

5. All the above attributes are sets, meaning that (in each set) each element must be present
exactly once and the order is irrelevant.

6. All elements in each set are combined with a logical OR operator.

Example: aircraftOperators={A,B,C} means all flights operated by either A OR B OR C.

7. All attributes within the same FlightSetDefinitionElement are then combined with a logical AND
operator.

Example: aircraftOperators={A,B}, aerodromes={EBBR:Departure} means all flights operated by

either A or B AND departing from airport EBBR.

8. Finally all FlightSetDefinitionElement instances in the list are combined with a logical OR
operator.

9. The above mentioned combination rules are summarised in the following picture:

Figure 34. FlightSetDefinitionElement combinations

10. Examples

◦ Example 1: A user that is already a receiver of flight plan messages via AFTN wants to create
an equivalent subscription via B2B P/S.

Provide a single FlightSetDefinitionElement instance with:

anuIds=[The user's own ANUId]

Edition: 27.0 6 763

Document Title: NM 27.0 - NM B2B Reference Manual

◦ Example 2: Same as above but in addition the user wants to receive also flight plans that
concern a neighbouring unit.

Provide a single FlightSetDefinitionElement instance with:

anuIds=[The user's own ANUId, The neighbour's ANU Id]

◦ Example 3: Same as Example 1 but in addition the user wants to receive also flight plans
addressed to a neighbouring ANU but only if they are directed to airports XXXX or YYYY.

Provide two instances of FlightSetDefinitionElement as follows:

FlightSetDefinitionElement 1:
anuIds=[The user's ANU Id]
FlightSetDefinitionElement 2:
anuIds=[The neighbour's ANU Id]
aerodromes=[XXXX : Arrival, YYYY : Arrival]

◦ Example 4: A user wants to receive updates on flights operated by airlines AAA and BBB and
departing from airport XXXX.

Provide a single FlightSetDefinitionElement instance with:

aircraftOperators=[AAA, BBB]
aerodromes=[XXXX : Departure]

◦ Example 5: A user wants to receive all flight plans operated by airlines AAA and BBB plus all
flight plans operated by aircrafts AC1, AC2 and AC3.

Provide two instances of FlightSetDefinitionElement as follows:

FlightSetDefinitionElement 1:
aircraftOperators=[AAA, BBB]
FlightSetDefinitionElement 2:
aircraftRegistrations=[AC1, AC2, AC3]

Note that it is necessary to use two FlightSetDefinitionElement instances because the user
wants flight plans matching either the aircraft operators OR the registration marks.

19.1.2. Concerned Air Traffic Services (ATS) Units

Last updated: 27.0 - Edition 6

1. For each flight, NM computes a list of ATS units that are "concerned" by the flight. A unit is
considered "concerned" by a flight if it falls into one of the following cases:

Edition: 27.0 6 764

Document Title: NM 27.0 - NM B2B Reference Manual

a. The unit is the tower of the departure or destination airport and is located in the IFPZ (IFPS
Zone).

b. The unit is the ARO of the departure airport and is located in the IFPZ.

c. The unit controls a sector in the IFPZ that is traversed by the flight’s computed trajectory.
Note that this takes into account the "point-to-airspace" association, by which, some
waypoints that are not contained in an airspace (i.e. they are located below, above or aside
the airspace) are nevertheless considered as part of the airspace for ATM purposes.

d. The unit is in the so called "re-addressing" list. The re-addressing list is a list of additional
addresses specified in the flight plan that indicate units (inside or outside the IFPZ) to which
the flight plan shall be re-addressed/delivered by NM.

e. The unit is configured as a receiver of messages that are normally addressed to another
unit. This is a copy/move relationship maintained in CACD that defines forwarding rules for
some type of messages (e.g. all messages addressed to unit A shall also be sent to unit B, all
messages addressed to unit C shall instead be sent to unit D, etc).

In the P/S context, once a unit is considered "concerned" by a flight due to

airspace traversal, it will remain so even if after a change of route (e.g. due
IMPORTANT
to a CHG message or an airborne rerouting) the new route no longer
traverses it.

1. Example

◦ The following picture shows the route of a flight plan just being filed.

Figure 35. Computation of concerned ATS units (1)

In such case the concerned units are [A, B, I, D, G, F].

◦ Let’s now assume that a CHG message modifies the route. The following picture shows both
the original route and the new route after the CHG message.

Edition: 27.0 6 765

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 36. Computation of concerned ATS units (2)

Although the unit D is no longer traversed by the flight, in the context of P/S it will still be
considered concerned and therefore the new list of concerned ATS units after the CHG
message is [A, B, I, D, H, G, F]. Note the presence of both D (previously traversed) and H (new
traversal).

As a consequence of this, users who subscribed to flights that concern unit D will continue to
receive messages about this flight until its termination.

19.1.3. Flight Plan and Flight Data Distribution

1. As opposed to the AFTN/SITA implementation, the B2B Flight Plan and Flight Data distribution
does not use time parameters for publishing. On the contrary, flight plans flighty data are
published as soon as available.

19.2. PREOPS Testing

1. For the available airspace data on PREOPS platform, see Airspace PREOPS Testing.

2. The flight data in the PREOPS platform is composed of:

a. Flight data that the different B2B client applications input via NM B2B PREOPS

b. Live feed of the operational flight data received by NM

All the operational flight data received through the legacy means
(AFTN/SITA) which pass the automated validation are replicated in
IMPORTANT the PREOPS platform. However, due to actual technical limitation, the
operational flight data received through NM B2B services (Flight or
FFICE) are not replicated.

3. Flight data is cleaned up daily for terminated flights.

4. The PREOPS platform is not fed with Meteo data, so the flight profiles may be different from the
ones obtained from the OPS platform.

5. The regulation data used by the FlightManagementService in the PREOPS platform is fed daily
from the live systems.

6. Regulation data is cleaned up daily.

Edition: 27.0 6 766

Document Title: NM 27.0 - NM B2B Reference Manual

19.3. FlightPreparation Port Type

19.3.1. Overview

1. FlightPreparationService is intended to provide requests aimed at easing the preparation phase

of the flight plan (prior to its filing to NM):

a. S-R/R FlightPlanValidationRequest/Reply

b. S-R/R RoutingAssistanceRequest/Reply

c. S-R/R EvaluateFlowImpactRequest/Reply

d. S-R/R ReroutingApplyRequest/Reply

19.3.2. Requests/Replies

19.3.2.1. FlightPlanValidationRequest/Reply

MEP: S-R/R

Request: FlightPlanValidationRequest

Reply: FlightPlanValidationReply

Response time: 22 / 67 / 130 (ms)

Default settings: request count quotas

SOAP operation:

FlightPlanValidationReply validateFlightPlan(FlightPlanValidationRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Validates a flight plan according to the NM/IFPS validation rules.

19.3.2.1.1. FlightPlanValidationRequest

Edition: 27.0 6 767

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the validation of an FPL according to the NM/IFPS validation rules.

The request provides the input flight plan information via a choice: either in string format or via a
FlightPlan structure.

1. Inherits from: Request

2. Attributes:

a. FlightPlanInput flightPlan (Mandatory)

Flight plan to be validated.

19.3.2.1.2. FlightPlanValidationReply

<<class>>

Returned in response to FlightPlanValidationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanValidationReplyData data (Optional)

19.3.2.2. RoutingAssistanceRequest/Reply

Edition: 27.0 6 768

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RoutingAssistanceRequest

Reply: RoutingAssistanceReply

Response time: 350 / 15000 / 25000 (ms)

Default settings: request count quotas

SOAP operation:

RoutingAssistanceReply proposeRoutes(RoutingAssistanceRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Returns a list of NM/IFPS-compliant routes for a given flight plan and computes the flow
related what-if impact of the routes (e.g. new delay, suspension status).

19.3.2.2.1. RoutingAssistanceRequest

<<class>>

Request to query the generation of NM/IFPS-compliant routes for a given flight plan and compute

Edition: 27.0 6 769

Document Title: NM 27.0 - NM B2B Reference Manual

the flow related what-if impact of the routes (e.g., new delay, suspension status).

The request provides the input flight plan information via a choice: either in string format or via a
FlightPlan structure (FlightPlanInput.structured attribute).

The request provides also a set of constraints to apply to the route generation algorithm. These
constraints are all applied: they are interpreted as combined via the AND logical operator.

1. Inherits from: Request

2. Attributes:

a. FreezePoint adepFreezePoint (Optional)

Field15 information must be provided via the flightPlan attribute. The referenced point is a
point of the given field 15 (or on the point profile of the existing flight, in case no flightplan
was provided) from which the route generation will start.

The part of the route from the ADEP to that point is "frozen". The resulting routes will all
start with this "frozen" part of the field15.

b. FreezePoint adesFreezePoint (Optional)

Field15 information must be provided via the flightPlan attribute. The referenced point is a
point of the given field 15 (or on the point profile of the existing flight, in case no flightplan
was provided) where the route generation will stop. The part of the route from that point to
the ADES is "frozen". The resulting routes will all end with this "frozen" part of the field15.

c. FlightKeys forExistingFlight (Optional)

If the user wants to evaluate the what-if flow impact for an existing flight.

If not set, NM considers this is a request to find routes (and what-if) flow impact for a new
flight.

i. Constraints:

▪ RoutingAssistanceRequest.FOR_EXISTING_FLIGHT_OR_FLIGHT_PLAN_MUST_BE_SET

d. FlightPlanInput flightPlan (Optional)

Flight plan. When ommitted, the forExistingFlight has to be specified.

Note that flight plan has to be specified if it is earlier than 24 hours before the Off Block
Time.

i. Constraints:

▪ RoutingAssistanceRequest.FOR_EXISTING_FLIGHT_OR_FLIGHT_PLAN_MUST_BE_SET

e. ReroutingSourcesAndConstraints sourcesAndConstraints (Mandatory)

Describes the rerouting sources (horizontal/vertical) and the constraints.

Edition: 27.0 6 770

Document Title: NM 27.0 - NM B2B Reference Manual

NM rejects generation requests requiring more than 10 constraints.

i. Constraints:

▪ RoutingAssistanceRequest.SOURCES_AND_CONSTRAINTS

f. int nbRoutes (Optional)

Documentation last updated: 27.0 - Edition 2

Maximum number of returned routes.

Maximum value is 50. If greater than 50, the request is accepted and the service is realised
with a value of 50.

If not set, this number is set to 10 by default.

i. Constraints:

▪ range : [1, unbounded[

g. AllowedIFPSErrorViolations ifpsErrorsOff (Optional)

When set to ALL or ONLY_RAD , the corresponding errors detected by the validation are
ignored.

The proposed alternative routes may not be IFPS/RAD compliant. If this is the case, the
corresponding errors will be given together with the route.

Note that this can be used to understand the reason (e.g., a RAD) why a rerouting did not
find any alternatives.

When omitted, defaults to NONE .

3. Constraints:

a. FOR_EXISTING_FLIGHT_OR_FLIGHT_PLAN_MUST_BE_SET

At least one of forExistingFlight or flightPlan must be set.

Constrained attributes: forExistingFlight, flightPlan

Constrained requests: any using request

b. SOURCES_AND_CONSTRAINTS (altered 27.0)

Documentation last updated: 27.0 - Edition 1

sourcesAndConstraints.manualReroutingConstraints must be null.

NM rejects generation requests requiring more than 10 constraints (

sourcesAndConstraints.oredReroutingConstraints ).

Constrained attributes: sourcesAndConstraints

Edition: 27.0 6 771

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

19.3.2.2.2. RoutingAssistanceReply

<<class>>

Returned in response to RoutingAssistanceRequest.

The proposed routes (if any) are expressed as an array of RouteInfo structures.

1. Inherits from: Reply

2. Attributes:

a. RoutingAssistanceReplyData data (Optional)

19.3.2.3. EvaluateFlowImpactRequest/Reply

Edition: 27.0 6 772

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EvaluateFlowImpactRequest

Reply: EvaluateFlowImpactReply

Response time: 77 / 150 / 3400 (ms)

Default settings: request count quotas

SOAP operation:

EvaluateFlowImpactReply evaluateFlowImpact(EvaluateFlowImpactRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Evaluates the what-if impact of a new/updated flight plan.

19.3.2.3.1. EvaluateFlowImpactRequest

Edition: 27.0 6 773

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to compute the what-if impact of a new/updated flight plan (a.o, new delay, suspension
status).

The request provides the input flight plan information via a choice: either in string format or via a
FlightPlan structure (FlightPlanInput .flightPlan attribute).

This services is not to be called for each alternative route generated by a B2B client,
NOTE but rather to be called when the user asks for extra info or to evaluate the what-if
impact for e.g. the top 5 most interesting candidates.

1. Inherits from: Request

2. Attributes:

a. FlightKeys forExistingFlight (Optional)

If the user wants to evaluate the what-if flow impact for an existing flight.

If not set, NM considers this is a request to find routes (and what-if) flow impact for a new
flight.

b. FlightPlanInput flightPlan (Mandatory)

Edition: 27.0 6 774

Document Title: NM 27.0 - NM B2B Reference Manual

Flight plan to be validated and evaluated.

19.3.2.3.2. EvaluateFlowImpactReply

<<class>>

Returned in response to EvaluateFlowImpactRequest.

1. Inherits from: Reply

2. Attributes:

a. EvaluateFlowImpactReplyData data (Optional)

19.3.2.4. ReroutingApplyRequest/Reply

MEP: S-R/R

Request: ReroutingApplyRequest

Reply: ReroutingApplyReply

Response time: 200 / 780 / 4600 (ms)

Default settings: request count quotas

SOAP operation:

ReroutingApplyReply applyRerouting(ReroutingApplyRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Apply a proposed route rerouting.

19.3.2.4.1. ReroutingApplyRequest

Edition: 27.0 6 775

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

1. Request to apply a proposed route (e.g., generated by RoutingAssistanceRequest or

EvaluateFlowImpactRequest ) with 'guaranteed' CTOT (guaranteed under certain conditions: see
Chapter 70 from the IFPS Users Manual for more info).

This service provides the same functionalities as available in B2C flight management : "apply
file" and "apply book" .

2. So after obtaining a potential CTOT from RoutingAssistanceRequest or EvaluateFlowImpactRequest

, one can use this service to have NM systems create a proposal flight (RRP/RRN) with a
guaranteed CTOT. Once the new flightplan is processed and the new flightplan matches the
proposal flight, then the CTOT from the proposal flight is used as the new CTOT.

The new flightplan can either be submited by AO local tools or directly by NM systems (See
RoutingAssistanceApplyKind for more details). The maximum CTOT for this proposal flight is
passed to NM via the maxDelay attribute of the ReroutingApplyRequest . A B2B client will
typically set this to the delay/CTOT retrieved from the RoutingAssistanceReply .

Note that the resulting CTOT (from the apply) might not be the same obtained from the
RoutingAssistanceRequest (or EvaluateFlowImpactRequest ) as time has passed and flights or
regulations might have changed. If the maxDelay can not be respected anymore, then the service
returns with ReroutingProposalStatus : BAD_DELAY and no apply has been done (This allows the
AO to re-evaluate the different route options and maybe select a different route with less delay).

3. Note that the B2B client can simply refile/update the flightplan (via the FlightFiling services),
but a new CTOT will be (re-)computed at the time of refiling (which could be different than the
one returned by the RoutingAssistanceRequest or EvaluateFlowImpactRequest because time has
passed and the network situation or other flights could have changed)

1. Inherits from: Request

2. Attributes:

a. FlightKeys forExistingFlight (Mandatory)

The flight identification.

b. ReroutingRouteId routeId (Mandatory)

Edition: 27.0 6 776

Document Title: NM 27.0 - NM B2B Reference Manual

Route id. Retrieved from the proposeRoutes/evaluateFlowImpact preparing this apply

request.

c. FlightPlanInput flightPlan (Mandatory)

Contains the new Flight Plan to apply.

d. DurationHourMinute maxDelay (Mandatory)

The maximum delay to be considered.

If the route results in more delay, then no proposal nor refile is done.

e. RoutingAssistanceApplyKind applyKind (Mandatory)

Apply kind. Describes who will refile: NM systems or AO/B2B client himself.

i. Constraints:

▪ ReroutingApplyRequest.NOT_AUTHORIZED_REROUTING_ASSISTANCE_APPLY_KIND

f. NetworkAddress filedFrom (Optional) (new 27.0)

The AFTN address to consider as the originator of ICAO FPL/CHG message. If not provided,
the address is derived:

▪ from the onBehalfOfUnit associated if provided, or

▪ from the AirNavigationUnit of the user.

i. Constraints:

▪ ReroutingApplyRequest.INVALID_NETWORK_ADDRESS

3. Constraints:

a. INVALID_NETWORK_ADDRESS

Only AFTN or SITA network address allowed.

Constrained attributes: filedFrom

Constrained requests: any using request

b. NOT_AUTHORIZED_REROUTING_ASSISTANCE_APPLY_KIND

Documentation last updated: 27.0 - Edition 4

The CREATE_PROPOSAL_FLIGHT_ONLY value for the attribute applyKind not supported in

operation.

Constrained attributes: applyKind

Constrained requests: any using request

Edition: 27.0 6 777

Document Title: NM 27.0 - NM B2B Reference Manual

19.3.2.4.2. ReroutingApplyReply

<<class>>

Returned in response to ReroutingApplyRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingApplyReplyData data (Optional)

19.4. FlightFiling Port Type

19.4.1. Overview

1. FlightFilingService is intended to provide requests aimed at filing flight plan messages:

a. P/S FLIGHT_FILING_RESULT

b. S-R/R FlightPlanCreationRequest/Reply

c. S-R/R FlightPlanUpdateRequest/Reply

d. S-R/R FlightPlanCancellationRequest/Reply

e. S-R/R FlightDelayRequest/Reply

f. S-R/R FlightDepartureRequest/Reply

g. S-R/R FlightArrivalRequest/Reply

h. S-R/R FilingStatusRequest/Reply

19.4.2. Publish/Subscribe Topics

19.4.2.1. FLIGHT_FILING_RESULT

Edition: 27.0 6 778

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: FlightFilingResultMessage

Ordering policy:

Not Applicable: NM does not publish multiple Flight Filing Result messages with the same
Filing Id.

Message filter: FlightFilingResultMessageFilter

Subscription management (topic specific):

• S-R/R FlightFilingResultSubscriptionCreationRequest/Reply

• S-R/R FlightFilingResultSubscriptionUpdateRequest/Reply

• S-R/R FlightFilingResultSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 779

Document Title: NM 27.0 - NM B2B Reference Manual

Notification about automatic and manual processing of ATS messages (e.g. FPL, CHG, DLA, etc.)
that have been submitted to IFPS (via AFTN/SITA networks or via the equivalent B2B web
services).

This topic can be seen as an NM B2B equivalent of the Operational Reply Messages (ORM) sent
by NM IFPS over AFTN/SITA networks.

The AFTN/SITA ORMs inform about the processing result of an ATS message submission (such
as FPL,CHG,DLA, etc.), which can be one of the following:

• ACK - meaning it was automatically accepted;

• MAN - meaning it contains errors but it is queued for manual correction (i.e. it will be
handled by an NM IFPS operator);

• REJ - invalid and automatically rejected.

A MAN is always followed by either an ACK or REJ, depending on whether the NM IFPS operator
was able to correct the errors.

When a filing submission is performed via B2B, the processing result, i.e. the
NOTE equivalent of the ORM, is returned as part of the synchronous reply (see
FilingReplyData).

The typical use cases for this subscription topic are the following:

• Notification about manual treatment

As explained above, users that perform flight filing via NM B2B do not need to receive
ORMs because the outcome of the processing is already included in the NM B2B reply
which is returned in response to the NM B2B filing request. However, when the submission
has been queued for manual treatment, the NM B2B client may subscribe to this topic to
get notified about the outcome of the manual treatment, without having to regularly poll.

• Full ORM equivalent via B2B

Those users that are currently filing via AFTN/SITA networks but at the same time are
developing new software applications that are not connected to AFTN/SITA and therefore
only rely on NM B2B may choose to receive the equivalent of ORMs also via NM B2B to feed
the new application.

19.4.2.1.1. FlightFilingResultMessage (new 27.0)

<<class>>

The business P/S message for topic FLIGHT_FILING_RESULT.

1. Inherits from: BusinessPSMessage

2. Attributes:

Edition: 27.0 6 780

Document Title: NM 27.0 - NM B2B Reference Manual

a. FilingId filingId (Optional)

The filing id, i.e., the id associated to the flight plan submission.

b. FlightIdentificationOutput flightId (Optional)

This field contains the flight keys that could be extracted from the original ATS message.

Note that the whole field or some of its sub-fields (inner attributes) may be null, depending
on whether the extraction was successful, partially successful or not successful at all.

c. MessageOriginator filingOriginator (Mandatory)

The originating unit of the original ATS message.

d. DateTimeMinute filingTime (Mandatory)

Time when the ATS message was filed for transmission.

Equivalent of ADEXP field -FILTIM .

e. FilingStatusReplyData filingResult (Mandatory)

The result of the IFPS processing.

f. string originalMessage (Optional)

The complete original ATS message, exactly (and in the same format) as it was received.

Equivalent of ADEXP field -OLDMSG .

g. DateTimeMinute originalMessageReceptionTime (Mandatory)

Date and time of receipt of original ATS message by the IFPS.

Equivalent of ADEXP field -ORIGINDT . This is not the filing time of the message.

h. ATSMessageType originalMessageType (Mandatory)

The type of the original ATS message (e.g., CHG ).

When the message type cannot be extracted (because it is either not recognized or missing),
the attribute is set to OTHER .

Equivalent of ADEXP field -MSGTYP .

i. string displayMessage (Optional)

The message displayed to the IFPS operator (when applicable).

Equivalent of ADEXP field -MSGTXT .

j. list< string > comments (Optional)

Edition: 27.0 6 781

Document Title: NM 27.0 - NM B2B Reference Manual

List of comments.

Equivalent of ADEXP field -COMMENT .

k. AircraftRegistrationMark aircraftRegistration (Optional)

The aircraft registration ( REG/ subfield).

l. boolean isManualTreatment (Mandatory)

Indicates whether the original ATS message was treated by an IFPS operator (hence the
filing result is the outcome of a manual treatment).

19.4.2.1.2. FlightFilingResultSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightFilingResultSubscriptionCreationRequest

Reply: FlightFilingResultSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightFilingResultSubscriptionCreationReply
createFlightFilingResultSubscription(FlightFilingResultSubscriptionCreationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic FLIGHT_FILING_RESULT.

FlightFilingResultSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 782

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic FLIGHT_FILING_RESULT.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. FlightFilingResultMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

FlightFilingResultSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to FlightFilingResultSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightFilingResultSubscriptionCreationReplyData data (Optional)

The reply payload.

19.4.2.1.3. FlightFilingResultSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 783

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightFilingResultSubscriptionUpdateRequest

Reply: FlightFilingResultSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightFilingResultSubscriptionUpdateReply
updateFlightFilingResultSubscription(FlightFilingResultSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic FLIGHT_FILING_RESULT.

FlightFilingResultSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic FLIGHT_FILING_RESULT.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. FlightFilingResultMessageFilter messageFilter (Mandatory)

Edition: 27.0 6 784

Document Title: NM 27.0 - NM B2B Reference Manual

It defines how messages should be filtered.

FlightFilingResultSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to FlightFilingResultSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightFilingResultSubscriptionUpdateReplyData data (Optional)

The reply payload.

19.4.2.1.4. FlightFilingResultSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightFilingResultSubscriptionRetrievalRequest

Reply: FlightFilingResultSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightFilingResultSubscriptionRetrievalReply
retrieveFlightFilingResultSubscription(FlightFilingResultSubscriptionRetrievalRequ
est request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic FLIGHT_FILING_RESULT.

FlightFilingResultSubscriptionRetrievalRequest (new 27.0)

Edition: 27.0 6 785

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription retrieval request for topic FLIGHT_FILING_RESULT.

1. Inherits from: SubscriptionRetrievalRequest

FlightFilingResultSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to FlightFilingResultSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightFilingResultSubscriptionRetrievalReplyData data (Optional)

The reply payload.

19.4.3. Requests/Replies

19.4.3.1. FlightPlanCreationRequest/Reply

MEP: S-R/R

Request: FlightPlanCreationRequest

Reply: FlightPlanCreationReply

Response time: 57 / 240 / 1500 (ms)

Default settings: request count quotas

SOAP operation:

FlightPlanCreationReply fileNewFlightPlan(FlightPlanCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Edition: 27.0 6 786

Document Title: NM 27.0 - NM B2B Reference Manual

Submits (files) a new flight plan.

19.4.3.1.1. FlightPlanCreationRequest

<<class>>

Request the submission (or filing) of a new flight plan to the NM.

The same new flight plan cannot be created more than once: if NM detects that the submitted new
flight plan has the same flight keys as an existing flight plan, the request is rejected with an error.

1. Inherits from: FilingRequest

2. Attributes:

a. FlightPlanInput flightPlanInput (Mandatory)

Edition: 27.0 6 787

Document Title: NM 27.0 - NM B2B Reference Manual

The submitted flight plan.

i. Constraints:

▪ FlightPlanCreationRequest.TEXTUAL_FORMAT_NOT_ALLOWED

3. Constraints:

a. TEXTUAL_FORMAT_NOT_ALLOWED

The flightPlanInput cannot be expressed in textual format.

Constrained attributes: flightPlanInput

Constrained requests: FlightPlanCreationRequest

19.4.3.1.2. FlightPlanCreationReply

<<class>>

Returned in response to FlightPlanCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanCreationReplyData data (Optional)

19.4.3.2. FlightPlanUpdateRequest/Reply

MEP: S-R/R

Request: FlightPlanUpdateRequest

Reply: FlightPlanUpdateReply

Response time: 81 / 260 / 910 (ms)

Default settings: request count quotas

SOAP operation:

FlightPlanUpdateReply fileFlightPlanUpdate(FlightPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates an existing flight plan.

Edition: 27.0 6 788

Document Title: NM 27.0 - NM B2B Reference Manual

19.4.3.2.1. FlightPlanUpdateRequest

<<class>>

Documentation last updated: 27.0 - Edition 4

Request for the update of a flight plan.

The flightPlanUpdateRequest supports only the full update; all flight plan
IMPORTANT
fields shall be sent, whether updated or not.

1. Inherits from: FilingRequest

2. Attributes:

a. IFPLId ifplId (Mandatory)

Identification of the flight plan to be updated.

b. StructuredFlightPlanUpdate structuredFlightPlanUpdate (Mandatory) (new 27.0)

Update of selective fields in the existing flight plan.

Edition: 27.0 6 789

Document Title: NM 27.0 - NM B2B Reference Manual

19.4.3.2.2. FlightPlanUpdateReply

<<class>>

Returned in response to FlightPlanUpdateRequest.

If the given flight identification is unknown or ambiguous, the error is reported as a generic input
validation error (object not found), as described in the IFPS USERS MANUAL and Flight Plan Guide
and IFPS Errors Guide.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanUpdateReplyData data (Optional)

19.4.3.3. FlightPlanCancellationRequest/Reply

Edition: 27.0 6 790

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightPlanCancellationRequest

Reply: FlightPlanCancellationReply

Response time: 59 / 130 / 400 (ms)

Default settings: request count quotas

SOAP operation:

FlightPlanCancellationReply
fileFlightPlanCancellation(FlightPlanCancellationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Requests the cancellation of a flight plan.

19.4.3.3.1. FlightPlanCancellationRequest

<<class>>

Request for the cancellation of a flight plan.

1. Inherits from: FilingRequest

2. Attributes:

a. IFPLId ifplId (Mandatory)

Identification of the flight plan to be cancelled.

Edition: 27.0 6 791

Document Title: NM 27.0 - NM B2B Reference Manual

19.4.3.3.2. FlightPlanCancellationReply

<<class>>

Returned in response to FlightPlanCancellationRequest.

If the given flight identification is unknown or ambiguous, the error is reported as a generic
OBJECT_NOT_FOUND input validation error.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanCancellationReplyData data (Optional)

19.4.3.4. FlightDelayRequest/Reply

Edition: 27.0 6 792

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightDelayRequest

Reply: FlightDelayReply

Response time: 70 / 170 / 870 (ms)

Default settings: request count quotas

SOAP operation:

FlightDelayReply fileFlightDelay(FlightDelayRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Notifies a flight delay.

19.4.3.4.1. FlightDelayRequest

<<class>>

Request to notify the delay of a flight.

1. Inherits from: FilingRequest

2. Attributes:

a. IFPLId ifplId (Mandatory)

Identification of the flight plan to be updated.

b. DateTimeMinute newEstimatedOffBlockTime (Mandatory)

Edition: 27.0 6 793

Document Title: NM 27.0 - NM B2B Reference Manual

New estimated off-block date/time.

19.4.3.4.2. FlightDelayReply

<<class>>

Returned in response to FlightDelayRequest.

If the given flight identification is unknown or ambiguous, the error is reported as a generic
OBJECT_NOT_FOUND input validation error.

1. Inherits from: Reply

2. Attributes:

a. FlightDelayReplyData data (Optional)

19.4.3.5. FlightDepartureRequest/Reply

Edition: 27.0 6 794

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightDepartureRequest

Reply: FlightDepartureReply

Response time: 47 / 310 / 600 (ms)

Default settings: request count quotas

SOAP operation:

FlightDepartureReply fileFlightDeparture(FlightDepartureRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Notifies a flight departure.

19.4.3.5.1. FlightDepartureRequest

<<class>>

Request to notify the departure of a flight.

1. Inherits from: FilingRequest

2. Attributes:

a. IFPLId ifplId (Mandatory)

Edition: 27.0 6 795

Document Title: NM 27.0 - NM B2B Reference Manual

Identification of the flight to be updated.

b. DateTimeMinute actualTimeOfDeparture (Mandatory)

Actual date/time of departure.

19.4.3.5.2. FlightDepartureReply

<<class>>

Returned in response to FlightDepartureRequest.

If the given flight identification is unknown or ambiguous, the error is reported as a generic input
OBJECT_NOT_FOUND validation error (object not found).

Note that flight departure filing is always either accepted or rejected; it never results in queuing for
manual correction by an NM operator. In model terms, this means that the filingStatus associated
to the returned FilingReply never takes the INVALID_QUEUED_FOR_CORRECTION value, and therefore its
queuedFiling attribute is always null in the case of flight departure filing.

1. Inherits from: Reply

2. Attributes:

a. FlightDepartureReplyData data (Optional)

Edition: 27.0 6 796

Document Title: NM 27.0 - NM B2B Reference Manual

19.4.3.6. FlightArrivalRequest/Reply

MEP: S-R/R

Request: FlightArrivalRequest

Reply: FlightArrivalReply

Response time: 49 / 210 / 500 (ms)

Default settings: request count quotas

SOAP operation:

FlightArrivalReply fileFlightArrival(FlightArrivalRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Notifies a flight arrival.

19.4.3.6.1. FlightArrivalRequest

Edition: 27.0 6 797

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to notify the arrival of a flight.

1. Inherits from: FilingRequest

2. Attributes:

a. IFPLId ifplId (Mandatory)

Identification of the flight to be updated.

b. DateTimeMinute actualTimeOfArrival (Mandatory)

Actual date/time of arrival.

c. Aerodrome actualAerodromeOfArrival (Optional)

Actual aerodrome of arrival.

19.4.3.6.2. FlightArrivalReply

Edition: 27.0 6 798

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to FlightArrivalRequest.

If the given flight identification is unknown or ambiguous, the error is reported as a generic
OBJECT_NOT_FOUND input validation error.

Note that flight arrival filing is always either accepted or rejected; it never results in queuing for
manual correction by an NM operator. In model terms, this means that the filingStatus associated
to the returned FilingReply never takes the INVALID_QUEUED_FOR_CORRECTION value, and therefore its
queuedFiling attribute is always null in the case of flight arrival filing.

1. Inherits from: Reply

2. Attributes:

a. FlightArrivalReplyData data (Optional)

19.4.3.7. FilingStatusRequest/Reply

Edition: 27.0 6 799

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FilingStatusRequest

Reply: FilingStatusReply

Response time: 14 / 430 / 3600 (ms)

Default settings: request count quotas

SOAP operation:

FilingStatusReply retrieveFilingStatus(FilingStatusRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves the status of a file flight that was enqueued for manual correction by NM.

19.4.3.7.1. FilingStatusRequest

<<class>>

Request for the current status of a previous filing request that resulted into queuing for manual
correction by an NM operator, i.e. valid (after manual correction), still queued for manual
correction, or rejected (after manual correction).

1. Inherits from: Request

2. Attributes:

a. FilingId filingId (Mandatory)

Filing id that was returned by the filing reply via FilingResultQueued .

Edition: 27.0 6 800

Document Title: NM 27.0 - NM B2B Reference Manual

19.4.3.7.2. FilingStatusReply

<<class>>

Returned in response to FilingStatusRequest.

Note that this reply is a FilingReply, although the FilingStatusRequest is not a FilingRequest. This
conveys the fact that requesting a filing status is typically achieved asynchronously (in polling)
after a filing request, but still returns status information as if the filing reply has been returned
synchronously when the original request was filed.

1. Inherits from: Reply

2. Attributes:

a. FilingStatusReplyData data (Optional)

19.5. FlightManagement Port Type

19.5.1. Overview

1. FlightManagementService provides requests aimed at managing flight plans and flights:

a. P/S FLIGHT_PLANS

b. P/S FLIGHT_DATA

c. S-R/R FlightPlanListRequest/Reply

d. S-R/R FlightListByKeysRequest/Reply

Edition: 27.0 6 801

Document Title: NM 27.0 - NM B2B Reference Manual

e. S-R/R FlightListByAircraftOperatorRequest/Reply

f. S-R/R FlightListByAerodromeRequest/Reply

g. S-R/R FlightListByAerodromeSetRequest/Reply

h. S-R/R FlightListByAirspaceRequest/Reply

i. S-R/R FlightListByPointRequest/Reply

j. S-R/R FlightListByTrafficVolumeRequest/Reply

k. S-R/R FlightListByMeasureRequest/Reply

l. S-R/R FlightListByHotspotRequest/Reply

m. S-R/R FlightListByAircraftRegistrationMarkRequest/Reply

n. S-R/R FlightRetrievalRequest/Reply

o. S-R/R EarlyDPIRequest/Reply

p. S-R/R TargetDPITargetRequest/Reply

q. S-R/R TargetDPISequencedRequest/Reply

r. S-R/R ATCDPIRequest/Reply

s. S-R/R CancelDPIRequest/Reply

t. S-R/R PredictedDPIRequest/Reply

u. S-R/R FlightUpdateRequest/Reply

v. S-R/R ACDMAlertRequest/Reply (new 27.0)

w. S-R/R GeneralAPIRequest/Reply

x. S-R/R TargetTakeOffAPIRequest/Reply

y. S-R/R TargetTimeOverAPIRequest/Reply

z. S-R/R FlightConfirmationRequest/Reply

aa. S-R/R SlotMissedRequest/Reply

ab. S-R/R ReadyToDepartRequest/Reply

ac. S-R/R SlotImprovementModeRequest/Reply

ad. S-R/R ReroutingProposalRejectedRequest/Reply

ae. S-R/R SlotProposalFeedbackRequest/Reply

af. S-R/R FlightCriticalityRequest/Reply

ag. S-R/R ReroutingFeedbackRequest/Reply (new 27.0)

19.5.2. Concepts

19.5.2.1. Forecast and Operational Datasets

1. The forecast and operational datasets are concepts that the NM customers (ANSPs in particular)
are already familiar with.

Edition: 27.0 6 802

Document Title: NM 27.0 - NM B2B Reference Manual

In short, the NM system prepares the plan (containing regulations/tactical updates) between D-6
(6 days in advance) and D-1 (1 day in advance) within the forecast dataset.

2. To be able to do this accurately, also a traffic forecast is constructed/maintained.

So in this forecast dataset there are only predicted flights (CFMUFlightType:

PREDICTED_FLIGHT & RPL). NM takes into account wind and NAT traffic predictions, airport
slots, airline schedules, the traffic from a similar day in the past (typically the traffic from
exactly one week earlier) to build up this forecast dataset.

The plan (including the prepared regulations and other tactical updates), is transferred to the
operational dataset on D-1 around 16:00 UTC.

3. The plan (and associated forecast traffic) remains available in the forecast dataset after
transfer, until the end of D (day of operations), even though it does not evolve anymore in that
dataset.

4. To fix the ideas:

a. the forecast dataset can be accessed : in [ D-5 (5 days in the future), D 24:00 UTC ]

b. the operational dataset can be accessed : at any point in time on D-1 and D via B2B,

5. In parallel IFPS handles the FlightFilingServices and flight plans.

The user can file his flight plan up to several days into advance.

These flight plans are then fed into the operational FlightManagement (ETFMS) around 24 hours
before off-block-time.

Therefore the concept of operational/forecast does not apply to FlightFilingServices and flight
plans.

There exists only one operational dataset: supporting flight plan filing multiple days in advance.

On the other hand, the forecast FlightManagemnt dataset is really a forecast containing
predicted flights.

So even if a flight plan has been filed well in advance, in the forecast FlightManagement
services, one might not find exactly the same flight back (as it can be adapted according to NAT
predictions, closure of airspace predictions, etc).

As these flights are really predicted flights, they do not have an IFPL id.

6. So this operational/forecast DataSet concept is not related to the FlightDataset type

7. Note that access to forecast Dataset is subject to specific user authorisation: it is

enabled/authorized on test platforms, otherwise when specifically requested by the user.

19.5.2.2. Simulation Datasets

1. See Simulations.

Edition: 27.0 6 803

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.2.3. Proposal Flights

1. The NM systems (FlightManagement specifically) can have more than one version of a flight:

a. The normal flight (corresponding to what the airspace user has filed)

b. A proposal flight: a proposition from NM/ANSP to an airspace user/other ANSP.

There can be maximum one proposal flight for a given flight at a moment in time.

These proposal flights can be generated for example

i. in the context of regulations (when NM systems have a proposal to improve)

ii. in the context to avoid flight suspension

iii. in the context of rerouting/level caps (RRP/RRN):

Typically a rerouting proposal flight is used in the context of flight efficiency or ATFCM
(a proposal to for example reroute around a zero rate regulation) or STAM trials (ANSP
initiated) or Aircraft operator initiated (AO-What-if-Reroute (AOWIR))

c. A proposal flight also comes with a mechanism to try to commit to the proposed delay.

So if, during the time the proposal exists (limted), a proposal flight is accepted (depending on
the kind of proposal either by airspace users or by ANSP), then the proposed delay becomes
the real delay (nominal case but there are exceptions).

d. In flight list/flight details (flight management services) and counts (flow services) the user
can request to include proposals. If include proposal is requested, then if there exists a
proposal flight, then the proposal flight is returned otherwise the normal flight is returned.

This allows airspace users (AO) or ANSP to view/display/plot the proposal flight.

e. Note that access to proposal flights is subject to specific user authorisation: it is

enabled/authorized on test platforms, otherwise when specifically requested by the user.

19.5.2.4. Flight Visibility (a.k.a. Invisible Flights)

1. The Flight Visibility concept refers to whether or not a flight (or more correctly a "flight
crossing", see below) should be included or not in a flight list.

2. A flight (or a portion of it) is considered:

a. Visible when it is GAT and IFR.

b. Invisible when it is OAT, VFR, STAY or IFPSTOP.

3. Invisible flights are normally not interesting for flow management and are therefore excluded
from counts and corresponding flight lists.

4. However, there are cases when such flights need to be included in some flight lists (for example
if an airport needs to display all flights scheduled to land, they may need to include also OAT
and VFR flights).

5. For this reason, on some flight list operations it is possible to specify whether or not to include

Edition: 27.0 6 804

Document Title: NM 27.0 - NM B2B Reference Manual

the invisible flights via a query parameter includeInvisibleFlights=TRUE|FALSE.

6. When a flight list is requested on a point or an aerodrome, the result is that a flight is either
visible or invisible on that point or aerodrome. However, if the flight list is requested on an
airspace, the flight may change from visible to invisible and viceversa (even multiple times)
while traversing the airspace.

7. Furthermore, when a flight traverses an airspace it can exit and re-enter the airspace multiple
times, creating multiple crossings. Similarly, a flight that enters an airspace as visible, then
becomes invisible and then visible again before exiting the airspace (like flight E in the picture
below), generates two visible crossings, each with its own entry/exit times (corresponding to the
two visible portions within the airspace).

8. It is worth reminding that when performing a flight list on an airspace (or traffic volume with
an airspace as reference location) the query returns a sequence of crossings, so the reply may
contain multiple entries for the same flight, each corresponding to a crossing.

9. It becomes apparent that the changes of visibility of a flight may result in many different
combinations. The following picture shows some of these combinations.

Figure 37. Flight Visibility combinations

1. When requesting a flight list on a location, each returned entry (i.e. each crossing) contains a
visibility flag that aims to convey as much information as possible about the (most relevant)
visibility changes via the FlightVisibility enumeration.

2. The following table shows the behaviour of a hypothetical flight list request performed on the
airspace shown in the above picture with the includeInvisibleFlight parameter set to TRUE or
FALSE. In particular, the table shows the returned crossings and associated visibility values
for each of the depicted flights.

Edition: 27.0 6 805

Document Title: NM 27.0 - NM B2B Reference Manual

The notation [C1+C2] denotes a single crossing comprised of the two portions C1 and C2, having
the entry-time of C1 and the exit-time of C2.

Table 44. Crossings and FlightVisibility enumeration values

Flight includeInvisibleFlights = TRUE includeInvisibleFlights = FALSE

Crossing Visibility Crossing Visibility

A [A1] VISIBLE [A1] VISIBLE

B [B1] INVISIBLE - -
C [C1+C2] VISIBLE_BEFORE_INVISIBLE [C1] VISIBLE_BEFORE_INVISIBLE

D [D1+D2] INVISIBLE_BEFORE_VISIBLE [D2] VISIBLE_AFTER_INVISIBLE

[E1] VISIBLE_BEFORE_INVISIBLE
E [E1+E2+E3] VISIBLE_BEFORE_INVISIBLE
[E3] VISIBLE_AFTER_INVISIBLE

F [F1+F2+F3] INVISIBLE_BEFORE_VISIBLE [F2] VISIBLE_BETWEEN_INVISIBLE

[G2] VISIBLE_BETWEEN_INVISIBLE
[G1+G2+G3+
G INVISIBLE_BEFORE_VISIBLE
G4+G5] [G4] VISIBLE_BETWEEN_INVISIBLE

H [H1+H2+H3] VISIBLE_WITH_SKIPOUT [H1+H2+H3] VISIBLE_WITH_SKIPOUT

19.5.2.5. DPI - Departure Planning Information

19.5.2.5.1. Introduction

1. The exchange of dynamic CDM information between the NMOC and the airport is a two-way
process which consists in:

a. Sending DPI messages from the airport concerned to the NMOC. These messages contain the
latest information on, for example, estimated or target times for the take-off of a particular
flight, the aircraft type, taxi times, and the SID.

b. Sending Flight Update Messages (FUM) from the NMOC to the airports concerned, providing
the Airport CDM platform with the flight status, the estimated landing times, etc.

The main information to be received via the DPI message is:

i. An accurate estimate of the take-off time.

ii. The taxi time.

iii. The departure route (SID).

iv. The aircraft type and registration.

This allows the proactive sharing of real time data with the NMOC, therefore optimising
the ATFCM slot allocation process and achieving a more efficient use of the ATFCM
network capacity.

Edition: 27.0 6 806

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.2.5.2. General Overview

1.

Figure 38. Departure Planning Information - General Overview

The airport situational information is collected direct from the Airport CDM systems in order to
update the real-time flight situation, prior to take-off, in the Network Operations systems.

Thanks to this improved accuracy of flight information, DPI ultimately serves to improve
ATFCM traffic predictions and consequently, the effectiveness of the ATFM measures to be
taken.

Four phases have been identified which require coordination with ATFCM:

a. Planning phase: Airport schedule and flight plan estimates must be reconciled and
consistent information must be sent to the Network Manager. Ghost flights and duplicated
flights have to be deleted. A first evaluation of the realistic taxi-time and SID will be
indicated to the Network Manager Operations Centre in order to facilitate a more realistic
calculation of the ATFM slot.

b. Turn-around phase: Based on the flight connection, a more realistic estimate of the Off Block
time will be available, based on the arrival time of the inbound flight and turn around time.
It generally results in the creation and accurate maintenance of the Target Off-Block Time
(TOBT) by AOs and handlers.

c. Pre-sequencing: 30-40mins before the TOBT, the flight is included in the ATC pre-departure
sequence, which will result in a Target Start-up Approval Time (TSAT). For regulated flights,

Edition: 27.0 6 807

Document Title: NM 27.0 - NM B2B Reference Manual

the TSAT takes the ATFM slot into account.

d. ATC phase or pre-sequencing: At delivery of engine start-up clearance delivery, the flight is
handed over to the tower for push-back, taxiing and take-off. Local control units
(ATC/Apron) will ensure that the flight goes off-blocks and takes-off as close as possible to
the local target times (TSAT, TTOT).

At any time during these four phases a change in the Airport operating conditions may alter
the taxi-time and/or SID.

19.5.2.5.3. Extended DPI

Purpose

1. Currently, the collaboration between airports and the Network can be achieved either via A-
CDM or the Advanced ATC TWR Airport concept.

These types of airports are sending DPI (Departure Planning Information) messages to the
Network in a pre-determined time horizon which starts no earlier than EOBT - 3 hours.

The DPI messages inform NM on more accurate Target times for Off-block or Take-off, taxi
times, SID information, aircraft type or registration for individual flights.

2. A-CDM, although providing benefits for both NM and airports, only covers the exchange of a
limited set of data, in a limited time frame.

Building on A-CDM, the extension of the collaboration between airport operations and the
network operations in the pre-tactical and tactical timeframe as well as with regards to the
nature of the exchanged information is required and the overall processes need to be improved,
supported by appropriate extended data system interfaces.

This concept is called Extended DPI. The aim is to achieve a thorough AOP-NOP collaborative
process which ensures the exchange of common AOP-NOP data properly coordinated among the
different stakeholders and is a means of achieving the rolling NOP as required by the ATM
Masterplan.

3. The main elements of the Extended DPI concept are the extension of the time scope, and the
enrichment of departure information with a more detailed view on the different sources of
constraints impacting take-off time.

Link to A-CDM

1. The Extended DPI concept does not interfere with the existing A-CDM concept. On the other
hand no relevant departure information shall be lost due to the current definition of the A-CDM
concept.

Therefore the DPIs defined in the A-CDM context will be expanded with additional fields to
close the gap in departure capacity based information until submission of T-DPI-s.

2. A-CDM airports not participating to the AOP-NOP integration are not affected. The existing DPI

Edition: 27.0 6 808

Document Title: NM 27.0 - NM B2B Reference Manual

provision does not have to be changed.

3. A-CDM live exchange of DPI’s is a pre-requisite for moving towards Extended DPI concept.

Scope of extended DPI

1. Extended DPI consists of exchanging departure planning information:

a. Before the A-CDM horizon

b. Within the A-CDM horizon

2. Departure planning information before the A-CDM horizon is called P-DPI (Predicted DPI) and is
used until A-CDM Milestone 1.

3. In order to close the gap in predictability with respect to departure capacity information, it is
also necessary to extend the existing set of DPI messages with additional fields. The existing DPI
message names is not changed.

Time horizon of P-DPI

1. In the current setup of the NM system, the pre-tactical (FORECAST system) contains data up to
D-6.

Therefore it is proposed to allow sending of P-DPIs from D-6 onwards.

2. However, as reliable information will likely not be available before D-1 it is expected that P-DPI
submission in most cases will begin at D-1.

3. P-DPIs must stop to be sent at A-CDM Milestone 1 which is earliest at EOBT-3hrs.

From there onward the E-DPIs from the A-CDM concept can be sent.

4. However an E-DPI can only be sent for flights that have been filed, and in some cases the flight
plan arrives later than EOBT-3hrs.

Therefore, P-DPI sending shall be stopped when first E-DPI is sent (not at EOBT-3hrs).

P-DPI are not processed on predicted flights yet. This is postponed to a future
NOTE
release.

Transmission of a P-DPI

1. P-DPI is sent to NM by the airports using a new B2B service called submitPredictedDPI .

Edition: 27.0 6 809

Document Title: NM 27.0 - NM B2B Reference Manual

a. Transmission of a P-DPI via the AFTN network will NOT be authorized.

b. This statement has some implications:

i. as all the existing DPI messages can be sent today via AFTN

WARNING ii. and the address used is the same for all DPIs coming from a single
airport

iii. an explicit check is done in the Flow Management system to reject

any P-DPI sent via AFTN even if it originates from an address which
is known and valid for other types of DPI messages.

Provision of a rolling demand picture

1. The diagram below illustrates how the various types of DPI messages are used to update the
demand picture in a rolling manner.

The diagram reflects the desired final implementation but P-DPI on predicted
NOTE
flights is not implemented yet and postponed to a future release.

Figure 39. Departure Planning Information - General Overview

1. NM currently has Planned Flight Data compounding of Airport Slots, Schedule Airline data and
historic flight plan data updated with NAT Track information, generally referred to as PFDs.

2. The PFDs exist in the FORECAST system as of D-6.

These are used in the pre-tactical phase by the FORECAST system (D-1) before a flight plan is
filed but are currently not copied to OPERATIONAL system as traffic demand baseline for D-0.

Bringing back PFDs into the OPERATIONAL system must be considered in order to obtain a
stable rolling demand picture.

Edition: 27.0 6 810

Document Title: NM 27.0 - NM B2B Reference Manual

3. The demand in the FORECAST system is based on PFD data alone.

Any pre-tactical ATFCM measures considered by FMP or NMOC staff are derived on basis of the
demand formed by the PFDs.

All planned ATFCM measures (ATFCM Daily Plan) are transferred from the FORECAST to the
OPERATIONAL system in the late afternoon of D-1.

Normally this is done around 18:00 CET but it could be delayed until 20:00/21:00 if operations
require.

4. Flight data in the FORECAST system is currently not subject to any real time updates. Feeding
Extended DPIs into the FORECAST system to update the PFDs will improve the pre-tactical
demand picture.

5. When PFD data is transferred to the OPERATIONAL system any departure planning information
received updates the PFD contained within the OPERATIONAL system until the flight plan is
filed.

After that the FPL will be updated to maintain the best possible accuracy of demand in a rolling
manner.

6. A P-DPI will update a flight which can be present:

a. In the FORECAST system only, in the form of a PFD.

This is the case if the P-DPI is received before the PFD has been loaded into the
OPERATIONAL system, and no FPL has been received yet on the OPERATIONAL system.

b. In the OPERATIONAL system (and in the FORECAST system) in the form of a PFD.

c. In the OPERATIONAL system in the form of an FPL (and possibly also in the FORECAST
system) in the form of a PFD.

d. In none of the two systems, when no PFD exists for this flight and no FPL has been received
yet.

In this case, and under some circumstances, a PFD may be created, either on the FORECAST
system or on the OPERATIONAL system.

19.5.2.5.4. Documents

1. Detailed information on DPI messages can be found in the following documents:

a. DPI Implementation Guide - DPI Implementation Guide

b. Flight Progress Messages - Flight Progress Messages Document

c. DPI and FUM Implementation Road Map - DPI and FUM Implementation Road Map

d. Site of European Airport CDM - CDM

Edition: 27.0 6 811

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.2.6. API - Arrival Planning Information

19.5.2.6.1. Introduction

NOTE The APIs related services will be restricted to invited users.

1. The APIs related services will support Airport, ATFM, extended AMAN and XMAN process
evolutions.

2. There are three different API requests:

a. General API (see submitGeneralAPI)

AMAN tool can use this request to inform the network about general arrival information
like STAR, arrival taxi time, estimated or actual landing time, etc…

b. Target take-off API (submitTargetTakeOffAPI)

This request is intended to be sent while the aircraft is still on the ground (before
departure). The latest acceptable time for submission of this request can be retrieved as part
of the flight data (Flight.apiSubmissionRules.latestSubmissionTargetTakeOffAPI). AMAN tool
can use this request to delay the departure of the flight in order to meet the arrival
sequence, by exchanging target time information (time over a coordination fix point or the
aerodrome) in case of hotspots. ETFMS will use the received TTO over the fix point or
aerodrome to impose a constraint on take-off time (CTOT). This request can also be used to
remove any previously received target time information.

c. Target time over API (see submitTargetTimeOverAPI)

This request is intended to be sent after the aircraft has departed or will depart soon. The
earliest acceptable time for submission of this request can be retrieved as part of the flight
data (Flight.apiSubmissionRules.earliestSubmissionTargetTimeOverAPI). AMAN tool can use
this request to (slightly) change the speed of the aircraft in order to meet the arrival
sequence, without imposing any (additional) delay to the departure of the flight, by
exchanging target time information (time over a coordination fix point or the aerodrome) in
case of hotspots. ETFMS will use the received TTO over the fix point or aerodrome to fine-
tune the trajectory without changing the take-off time, provided that the new speed is
realistic. This request can also be used to remove any previously received target time
information.

19.5.2.6.2. Processing of submitTargetTakeOffAPI

Definitions

1. submitTargetTakeOffAPI will provide an Earliest_TTO and/or a Consolidated_TTO.

2. Earliest_TTO is the earliest possible target time over the coordination fix that the arrival tool
can accomodate in its arrival sequence, stemming from local capacity constraints, regardless of
the CTOT that could be allocated to this flight. This information will be used by NM as a
minimum calculated time over (min CTO): in case of a potential delay reduction for this flight,

Edition: 27.0 6 812

Document Title: NM 27.0 - NM B2B Reference Manual

the CTO will always be equal or later than Earliest_TTO. When no Earliest_TTO is provided, the
mininimum CTO is the estimated time over from the flight plan possibly amended by minimum
take-off times from departure airport.

3. When a departure or en-route regulation is more penalizing than the arrival regulation, the
Consolidated_TTO allows fine-adjustment of the CTO by the arrival tool, in a window around the
CTO which is known as "slot zone". The slot zone is a [ -5 min, +10 min ] window around the
initial CTO when it has been recalculated by NM. The slot zone is NOT shifted when the CTO is
adjusted by a Consolidated_TTO or when the CTO is slightly changed by a DLA or CHG message.
The current value of the slot zone can be retrieved as part of the flight data (Flight.slotZone).

Checking the coordination fix

1. The coordination fix will only be considered valid if it is along the current trajectory of the
flight, including ADES but excluding ADEP (in order to avoid ambiguities with flights with ADEP
= ADES). If the coordination fix is invalid, the API will be rejected.

Changing the TOT

1. Modifying the TOT of a flight will be done by ETFMS via issuance of CTOT (so that departure
aerodrome will be informed by SAM/SRM messages). To achieve this, the flights arriving at the
airport must be regulated. In this implementation, a process workaround is needed. NMOC will
not create cherry-pick manually. The ADES will have to submit a regulation proposal via B2B,
and then NMOC has to accept it. Coordination is done by phone. The naming of this regulation
must be known by the XMAN, Extended AMAN or airport (ADES) too. API messages must
therefore include the regulation id. On reception of an API message containing the regulation
id, NM will automatically include the concerned flight in the cherry-pick regulation.

2. The cherry-pick regulation shall have a rate large enough (e.g. 120 slots/hour) so that CASA will
be able to place the flights into optimal slots, depending on TTOs and other regulations (i.e. the
rate of the cherry-pick regulation shall not generate additional delay other than the delay
induced by TTOs and other regulations).

3. Alternatively, the arrival regulation may be a normal regulation (not cherry-pick) with a rate
corresponding to the actual arrival capacity. In this case the arrival regulation will smooth the
traffic and APIs can be sent only for some flights to push them further in the sequence and
leave some slots available to higher priority flights.

4. It is expected that there might be other regulations impacting flights.

5. Flights may depart from CDM airports and for these flights NM has to negociate the take-off
time to accommodate the departure sequence.

6. If the flight crosses other regulations and the CTOT has been manually forced by a flow
controller (including slot swap or slot extension on behalf of AO), then the TTO constraints will
be ignored.

Interaction with T-DPI-s messages

1. For flights subject to both CDM departures and Arrival Planning there will be two constraints:
one corresponding to the TTOT of T-DPI-s messages and one corresponding to the Earliest_TTO

Edition: 27.0 6 813

Document Title: NM 27.0 - NM B2B Reference Manual

from API messages. In such a case, the minimum CTO over the coordination fix will be derived
from the most penalizing of the two constraints.

2. This can have some impact on the status of a flight. E.g. a regulated flight gets TACT_Activated
on reception of a T-DPI-s message with TTOT inside Slot Tolerance Window (STW). Then NM
receives an Earliest_TTO which is after the end of STW. The consequence is that the ETFMS
Flight status will be de-activated.

Example of CTO-TTO rolling exchange

1. Initial situation: CTOT = ETOT = 10:00, CTO (over coordination fix) = ETO = 12:00.

2. 1st API: Earliest_TTO = 12:07, no Consolidated_TTO provided.

◦ Earliest_TTO inside slot zone [11:55, 12:10]

◦ CTO updated = 12:07, CTOT = 10:07

◦ The STW for departure airport is shifted to [10:02, 10:17], but the slot zone for API’s TTO
remains the same ([11:55, 12:10] at coordination fix)

3. T-DPI-s: TTOT = 10:12

◦ TTOT inside STW [10:02, 10:17]

◦ ETFMS Flight status becomes TACT_Activated

◦ CTOT and CTO are unchanged: CTOT = 10:07, CTO = 12:07

4. 2nd API: Earliest_TTO = 12:10, no Consolidated_TTO provided

◦ Earliest_TTO outside slot zone [11:55, 12:10]

◦ NM searches a new slot: CTOT = 10:30, CTO = 12:30

◦ Earliest_TTO outside slot zone [12:25, 12:40]

◦ CTO is not adjusted and remains 12:30

5. 3rd API: Earliest_TTO = 12:10, Consolidated_TTO = 12:28

◦ Consolidated_TTO inside slot zone [12:25, 12:40]

◦ CTO is adjusted, CTO = TTO = 12:28

◦ slot zone remains [12:25, 12:40]

6. Later on, NM finds a better slot for the flight (respecting the Earliest_TTO constraint)

◦ CTOT = 10:17, CTO = 12:17

◦ slot zone is updated to [12:12, 12:27]

◦ Consolidated_TTO from previous API is not inside the new slot zone

◦ CTO is not adjusted and remains 12:17

7. Etc…

19.5.3. Publish/Subscribe Topics

Edition: 27.0 6 814

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.3.1. FLIGHT_PLANS

MEP: P/S

Message: FlightPlanMessage

Ordering policy:

Messages referring to the same flight plan shall be ordered by numerically sorting on the size
of the field eventHistory (because every new message has a new event) or picking the highest
sequenceNumber.

Message filter: FlightPlanMessageFilter

Payload configuration: FlightPlanPayloadConfiguration

Subscription management (topic specific):

• S-R/R FlightPlanSubscriptionCreationRequest/Reply

• S-R/R FlightPlanSubscriptionUpdateRequest/Reply

• S-R/R FlightPlanSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify read access to /flights?sensitive=true

then messages relative to sensitive flights are published

Notification about changes to flight plans.

19.5.3.1.1. FlightPlanMessage (new 27.0)

<<class>>

The business P/S message for topic FLIGHT_PLANS.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. StructuredFlightPlanData flightPlan (Mandatory)

The flight plan.

Edition: 27.0 6 815

Document Title: NM 27.0 - NM B2B Reference Manual

b. list< FlightPlanEventHistoryItem > eventHistory (Mandatory)

The full list of events that affected the flight plan.

i. Constraints:

▪ list size range : [1, 1000]

c. set< AirNavigationUnitId > concernedUnits (Optional)

Concerned air navigation units.

d. RevalidationInformation revalidationInformation (Optional)

Flight Plan Revalidation information.

19.5.3.1.2. FlightPlanSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightPlanSubscriptionCreationRequest

Reply: FlightPlanSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightPlanSubscriptionCreationReply
createFlightPlanSubscription(FlightPlanSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Creates a subscription for topic FLIGHT_PLANS.

FlightPlanSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 816

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic FLIGHT_PLANS.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. FlightPlanMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. FlightPlanPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FlightPlanSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to FlightPlanSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanSubscriptionCreationReplyData data (Optional)

The reply payload.

19.5.3.1.3. FlightPlanSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 817

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightPlanSubscriptionUpdateRequest

Reply: FlightPlanSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightPlanSubscriptionUpdateReply
updateFlightPlanSubscription(FlightPlanSubscriptionUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates a subscription for topic FLIGHT_PLANS.

FlightPlanSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic FLIGHT_PLANS.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. FlightPlanMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

Edition: 27.0 6 818

Document Title: NM 27.0 - NM B2B Reference Manual

b. FlightPlanPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FlightPlanSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to FlightPlanSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanSubscriptionUpdateReplyData data (Optional)

The reply payload.

19.5.3.1.4. FlightPlanSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightPlanSubscriptionRetrievalRequest

Reply: FlightPlanSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightPlanSubscriptionRetrievalReply
retrieveFlightPlanSubscription(FlightPlanSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic FLIGHT_PLANS.

FlightPlanSubscriptionRetrievalRequest (new 27.0)

Edition: 27.0 6 819

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription retrieval request for topic FLIGHT_PLANS.

1. Inherits from: SubscriptionRetrievalRequest

FlightPlanSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to FlightPlanSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanSubscriptionRetrievalReplyData data (Optional)

The reply payload.

19.5.3.2. FLIGHT_DATA

Edition: 27.0 6 820

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: FlightDataMessage

Ordering policy:

Messages referring to the same flight shall be ordered by numerically sorting on the field
flightData.flightDataVersionNr.

Message filter: FlightDataMessageFilter

Payload configuration: FlightDataPayloadConfiguration

Subscription management (topic specific):

• S-R/R FlightDataSubscriptionCreationRequest/Reply

• S-R/R FlightDataSubscriptionUpdateRequest/Reply

• S-R/R FlightDataSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• verify read access to /flights?sensitive=true

then messages relative to sensitive flights are published

• assert read access to /flights#traffic_volume_profile

if PSFlightField.highestModelTrafficVolumeProfile is requested

Edition: 27.0 6 821

Document Title: NM 27.0 - NM B2B Reference Manual

Notification about flight updates (e.g. trajectory, times, status, etc.).

The Flight Set Definition section documents the flight filtering capabilities of the
FlightDataMessageFilter.

Although the FlightDataMessage reuses the same Flight type returned by the flight list and
flight retrieval operations, only a subset of the Flight fields are populated in a
FlightDataMessage. The Flight fields that may be populated via the Publish/Subscribe service
are the flightId (which is always present) plus the ones listed in PSFlightField (which must
be explicitly requested by the user).

Some of the requested fields may be null in the message. For example, the
divertedAerodromeOfDestination is only set in case of diversion.

All the Flight fields that are NOT listed in the PSFlightField enumeration type are never set by
the Publish/Subscribe service (i.e. they are left null).

Only one of the three point profiles (FTFM, RTFM and CTFM) will be present in the message.

19.5.3.2.1. FlightDataMessage (new 27.0)

<<class>>

The business P/S message for topic FLIGHT_DATA.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. Flight flightData (Mandatory)

The flight data.

b. FlightEventType eventType (Mandatory)

The flight event type.

c. set< AirNavigationUnitId > concernedUnits (Optional)

Concerned air navigation units.

19.5.3.2.2. FlightDataSubscriptionCreationRequest/Reply (new 27.0)

Edition: 27.0 6 822

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightDataSubscriptionCreationRequest

Reply: FlightDataSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightDataSubscriptionCreationReply
createFlightDataSubscription(FlightDataSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /subscriptions/flightData?filter=null

if request.messageFilter=null

Creates a subscription for topic FLIGHT_DATA.

FlightDataSubscriptionCreationRequest (new 27.0)

<<class>>

It allows creating a new subscription for topic FLIGHT_DATA.

Edition: 27.0 6 823

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. FlightDataMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. FlightDataPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FlightDataSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to FlightDataSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightDataSubscriptionCreationReplyData data (Optional)

The reply payload.

19.5.3.2.3. FlightDataSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 824

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightDataSubscriptionUpdateRequest

Reply: FlightDataSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightDataSubscriptionUpdateReply
updateFlightDataSubscription(FlightDataSubscriptionUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /subscriptions/flightData?filter=null

if request.messageFilter=null

Updates a subscription for topic FLIGHT_DATA.

FlightDataSubscriptionUpdateRequest (new 27.0)

<<class>>

It allows updating an existing subscription for topic FLIGHT_DATA.

Edition: 27.0 6 825

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. FlightDataMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. FlightDataPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

FlightDataSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to FlightDataSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightDataSubscriptionUpdateReplyData data (Optional)

The reply payload.

19.5.3.2.4. FlightDataSubscriptionRetrievalRequest/Reply (new 27.0)

MEP: S-R/R

Request: FlightDataSubscriptionRetrievalRequest

Reply: FlightDataSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightDataSubscriptionRetrievalReply
retrieveFlightDataSubscription(FlightDataSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic FLIGHT_DATA.

Edition: 27.0 6 826

Document Title: NM 27.0 - NM B2B Reference Manual

FlightDataSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic FLIGHT_DATA.

1. Inherits from: SubscriptionRetrievalRequest

FlightDataSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to FlightDataSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightDataSubscriptionRetrievalReplyData data (Optional)

The reply payload.

19.5.4. Requests/Replies

19.5.4.1. FlightPlanListRequest/Reply

Edition: 27.0 6 827

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightPlanListRequest

Reply: FlightPlanListReply

Response time: 24 / 1000 / 6200 (ms)

Default settings: request count quotas

SOAP operation:

FlightPlanListReply queryFlightPlans(FlightPlanListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries flight plans.

19.5.4.1.1. FlightPlanListRequest

<<class>>

Request to query a flight plan list. Each item in the flight plan list is made of:

1. The summary of the last valid flight plan, if it exists.

2. The list of invalid filing summaries that are currently under manual correction by an NM
operator.

In order to get the full flight plan and/or the full flight plan history, the caller must use the
FlightRetrievalRequest .

Edition: 27.0 6 828

Document Title: NM 27.0 - NM B2B Reference Manual

The logical AND operator applies between all the query fields described below.

The query supports wildcards, but is limited to some combinations of these wildcards in the sense
that at least:

1. The aircraft id, or

2. The aerodrome of departure, or

3. The aerodrome of destination

must be fully specified. This is further detailed in the attribute definitions.

1. Inherits from: Request

2. Attributes:

a. string aircraftId (Optional)

ICAO aircraft id, with basic wildcard support ("*" is supported at the end of the field).

Optional: default value is "*".

NM accepts a wildcard in this field if either:

1. aerodromeOfDeparture is fully specified, or

2. nonICAOAerodromeOfDeparture is true, or

3. airFiled is set to true, or

4. aerodromeOfDestination is fully specified, or

5. nonICAOAerodromeOfDestination is true

i. Constraints:

▪ Pattern: ((UALPHA|DIGIT){0,6}*|(UALPHA|DIGIT){2,7})

▪ FlightPlanListRequest.NONE_FULLY_SPECIFIED

b. string aerodromeOfDeparture (Optional)

ICAO id of the aerodrome of departure, with basic wildcard support ("*" is supported at the
end of the field).

Optional: default value is "*".

This query field must be null if nonICAOAerodromeOfDeparture is set to true or if airFiled is set
to true.

NM accepts a wildcard in this field if either:

1. aircraftId is fully specified, or

2. aerodromeOfDestination is fully specified, or

3. nonICAOAerodromeOfDestination is true

Edition: 27.0 6 829

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ Pattern: (UALPHA{0,3}*|UALPHA{4})

▪ FlightPlanListRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightPlanListRequest.AIRFILED_ICAOADEP_NOT_ALLOWED

▪ FlightPlanListRequest.NONE_FULLY_SPECIFIED

c. boolean nonICAOAerodromeOfDeparture (Mandatory)

True if the query concerns non ICAO aerodromes of departure; there is no way at the
moment to specify what non ICAO aerodrome of departure is queried.

Cannot be true if airFiled is true.

i. Constraints:

▪ FlightPlanListRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightPlanListRequest.AIRFILED_NONICAOADEP_NOT_ALLOWED

d. boolean airFiled (Mandatory)

True if the query concerns flight plans that were filed airborne.

Cannot be true if nonICAOAerodromeOfDeparture is true.

i. Constraints:

▪ FlightPlanListRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightPlanListRequest.AIRFILED_ICAOADEP_NOT_ALLOWED

▪ FlightPlanListRequest.AIRFILED_NONICAOADEP_NOT_ALLOWED

e. string aerodromeOfDestination (Optional)

ICAO id of the aerodrome of destination, with basic wildcard support ("*" is supported at the
end of the field).

Optional: default value is "*".

This query field must be null if nonICAOAerodromeOfDestination is set to true.

NM accepts a wildcard in this field if either:

1. aircraftId is fully specified, or

2. aerodromeOfDeparture is fully specified, or

3. nonICAOAerodromeOfDeparture is true, or

4. airFiled is true

i. Constraints:

▪ Pattern: (UALPHA{0,3}*|UALPHA{4})

Edition: 27.0 6 830

Document Title: NM 27.0 - NM B2B Reference Manual

▪ FlightPlanListRequest.NONE_FULLY_SPECIFIED

f. boolean nonICAOAerodromeOfDestination (Mandatory)

True if the query concerns non ICAO aerodromes of destination; there is no way at the
moment to specify what non ICAO aerodrome of destination is queried.

g. DateTimeMinutePeriod estimatedOffBlockTime (Mandatory)

Period in which the estimated off-block date/time of the matching flight plans must belong.

i. Constraints:

▪ FlightPlanListRequest.PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

3. Constraints:

a. ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

aerodromeOfDeparture must be null or * if airFiled is true and nonICAOAerodromeOfDeparture is

true

Constrained attributes: airFiled, aerodromeOfDeparture, nonICAOAerodromeOfDeparture

Constrained requests: any using request

b. NONE_FULLY_SPECIFIED

At least one of aircraftId , aerodromeOfDeparture , aerodromeOfDestination should be fully

specified

Constrained attributes: aircraftId, aerodromeOfDeparture, aerodromeOfDestination

Constrained requests: any using request

c. AIRFILED_NONICAOADEP_NOT_ALLOWED

nonICAOAerodromeOfDeparture and airFiled cannot both be true

Constrained attributes: airFiled, nonICAOAerodromeOfDeparture

Constrained requests: any using request

d. AIRFILED_ICAOADEP_NOT_ALLOWED

airFiled cannot be true if aerodromeOfDeparture has been specified

Constrained attributes: airFiled, aerodromeOfDeparture

Constrained requests: any using request

e. PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

The period cannot extend more than 24 hours.

Edition: 27.0 6 831

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained attributes: estimatedOffBlockTime

Constrained requests: any using request

19.5.4.1.2. FlightPlanListReply

<<class>>

Returned in response to FlightPlanListRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightPlanListReplyData data (Optional)

19.5.4.2. FlightListByKeysRequest/Reply

Edition: 27.0 6 832

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByKeysRequest

Reply: FlightListByKeysReply

Response time: 7 / 57 / 120 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByKeysReply queryFlightsByKeys(FlightListByKeysRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

if FlightField.mcdmInfo is requested

Edition: 27.0 6 833

Document Title: NM 27.0 - NM B2B Reference Manual

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by flight keys.

19.5.4.2.1. FlightListByKeysRequest

<<class>>

Request to query a flight list from flight keys.

If the request attribute returnInvalidFilingSummaries is true, the flights array contains flight plans
or invalid filing summary information in addition to the Flight data.

The logical AND operator applies between all the query fields described below and the query fields
of its ancestor request.

The query supports wildcards, but is limited to some combinations of these wildcards in the sense
that at least:

1. The aircraft id, or

2. The aerodrome of departure, or

3. The aerodrome of destination

must be fully specified. This is further detailed in the attribute definitions.

Edition: 27.0 6 834

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: FlightListRequest

2. Attributes:

a. string aircraftId (Optional)

ICAO aircraft id, with basic wildcard support ("*" is supported at the end of the field).

Optional: default value is "*".

The aircraft identifier may include special characters ("$", "#") for flights created by NM
during prediction and simulation exercises.

NM accepts a wildcard in this field if either:

1. aerodromeOfDeparture is fully specified, or

2. aerodromeOfDestination is fully specified

i. Constraints:

▪ Pattern: (ALPHA|DIGIT|$|#){2,7}|(ALPHA|DIGIT|$|#){0,6}*

▪ FlightListByKeysRequest.NONE_FULLY_SPECIFIED

b. string aerodromeOfDeparture (Optional)

ICAO id of the aerodrome of departure, with basic wildcard support ("*" is supported at the
end of the field).

Optional: default value is "*".

This query field must be null if nonICAOAerodromeOfDeparture is set to true or if airFiled is

set to true.

NM accepts a wildcard in this field if either:

1. aircraftId is fully specified, or

2. aerodromeOfDestination is fully specified

i. Constraints:

▪ Pattern: ALPHA{4}|ALPHA{0,3}*

▪ FlightListByKeysRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightListByKeysRequest.AIRFILED_ICAOADEP_NOT_ALLOWED

▪ FlightListByKeysRequest.NONE_FULLY_SPECIFIED

c. boolean nonICAOAerodromeOfDeparture (Mandatory)

True if the query concerns non ICAO aerodromes of departure; there is no way at the
moment to specify what non ICAO aerodrome of departure is queried.

Cannot be true if airFiled is true.

Edition: 27.0 6 835

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ FlightListByKeysRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightListByKeysRequest.AIRFILED_NONICAOADEP_NOT_ALLOWED

d. boolean airFiled (Mandatory)

True if the query concerns flight plans that were filed airborne.

Cannot be true if nonICAOAerodromeOfDeparture is true.

i. Constraints:

▪ FlightListByKeysRequest.ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

▪ FlightListByKeysRequest.AIRFILED_ICAOADEP_NOT_ALLOWED

▪ FlightListByKeysRequest.AIRFILED_NONICAOADEP_NOT_ALLOWED

e. string aerodromeOfDestination (Optional)

ICAO id of the aerodrome of destination, with basic wildcard support ("*" is supported at the
end of the field).

Optional: default value is "*".

This query field must be null if nonICAOAerodromeOfDestination is set to true.

NM accepts a wildcard in this field if either:

1. aircraftId is fully specified, or

2. aerodromeOfDeparture is fully specified

i. Constraints:

▪ Pattern: ALPHA{4}|ALPHA{0,3}*

▪ FlightListByKeysRequest.NONE_FULLY_SPECIFIED

f. boolean nonICAOAerodromeOfDestination (Optional)

True if the query concerns non ICAO aerodromes of destination; there is no way at the
moment to specify what non ICAO aerodrome of destination is queried.

i. Constraints:

▪ FlightListByKeysRequest.NONICAOADES_CANNOT_BE_NULL

g. boolean returnInvalidFilingSummaries (Optional)

Indicates that the flight plan filing summary is to be returned.

If true, the objects returned in the flights array contain a summary of the flight plan filing
information.

i. Constraints:

Edition: 27.0 6 836

Document Title: NM 27.0 - NM B2B Reference Manual

▪ FlightListByKeysRequest.NONICAOADES_CANNOT_BE_NULL

▪ FlightListByKeysRequest.RETURN_INVALID_FILING_SUMMARIES_NEEDS_TO_BE_SET_TO_FALSE

3. Constraints:

a. ADEP_AIRFILED_NONICAOADEP_NOT_ALLOWED

aerodromeOfDeparture must be null or * if airFiled is true and nonICAOAerodromeOfDeparture is

true

Constrained attributes: airFiled, aerodromeOfDeparture, nonICAOAerodromeOfDeparture

Constrained requests: any using request

b. NONE_FULLY_SPECIFIED

Documentation last updated: 27.0 - Edition 1

At least one of aircraftId, aerodromeOfDeparture, aerodromeOfDestination should be fully

specified

Constrained attributes: aircraftId, aerodromeOfDeparture, aerodromeOfDestination

Constrained requests: any using request

c. AIRFILED_NONICAOADEP_NOT_ALLOWED

nonICAOAerodromeOfDeparture and airFiled cannot both be true

Constrained attributes: airFiled, nonICAOAerodromeOfDeparture

Constrained requests: any using request

d. AIRFILED_ICAOADEP_NOT_ALLOWED

airFiled cannot be true if aerodromeOfDeparture has been specified

Constrained attributes: airFiled, aerodromeOfDeparture

Constrained requests: any using request

e. RETURN_INVALID_FILING_SUMMARIES_NEEDS_TO_BE_SET_TO_FALSE

returnInvalidFilingSummaries needs to be false if FlightListRequest.dataset is FORECAST or

SIMULATION

Constrained attributes: returnInvalidFilingSummaries

Constrained requests: any using request

f. NONICAOADES_CANNOT_BE_NULL

nonICAOAerodromeOfDestination cannot be null if returnInvalidFilingSummaries is true

Edition: 27.0 6 837

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained attributes: nonICAOAerodromeOfDestination, returnInvalidFilingSummaries

Constrained requests: any using request

19.5.4.2.2. FlightListByKeysReply

<<class>>

Returned in response to FlightListByKeysRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByKeysReplyData data (Optional)

19.5.4.3. FlightListByAircraftOperatorRequest/Reply

Edition: 27.0 6 838

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByAircraftOperatorRequest

Reply: FlightListByAircraftOperatorReply

Response time: 6 / 87 / 330 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByAircraftOperatorReply
queryFlightsByAircraftOperator(FlightListByAircraftOperatorRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 839

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by aircraft operator.

19.5.4.3.1. FlightListByAircraftOperatorRequest

<<class>>

Request to query a flight list by aircraft operator only.

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. CountsCalculationType calculationType (Optional)

Indicates what is the calculation type of the count (entry or occupancy).

By default, calculationType is ENTRY .

Edition: 27.0 6 840

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.3.2. FlightListByAircraftOperatorReply

<<class>>

Returned in response to FlightListByAircraftOperatorRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByAircraftOperatorReplyData data (Optional)

19.5.4.4. FlightListByAerodromeRequest/Reply

Edition: 27.0 6 841

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByAerodromeRequest

Reply: FlightListByAerodromeReply

Response time: 10 / 100 / 500 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByAerodromeReply queryFlightsByAerodrome(FlightListByAerodromeRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 842

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by aerodrome.

19.5.4.4.1. FlightListByAerodromeRequest

<<class>>

Request to query a flight list by aerodrome.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. AerodromeICAOId aerodrome (Mandatory)

Edition: 27.0 6 843

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO id of the aerodrome.

b. AerodromeRole aerodromeRole (Mandatory)

Documentation last updated: 27.0 - Edition 1

Specifies whether the aerodrome is meant to be departure, arrival or both.

If aerodromeRole is set to AerodromeRole.DEPARTURE, the traffic window specifies that only those
flights taking off in the time window are requested.

If aerodromeRole is set to AerodromeRole.ARRIVAL, the traffic window specifies that only those
flights arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.GLOBAL, the traffic window specifies that only those
flights taking off or arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.ALTERNATE, the traffic window specifies that only those
flights of which arrival time belongs to this time window are requested.

i. Constraints:

▪ FlightListByAerodromeRequest.INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERODRO
ME
3. Constraints:

a. INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERODROME (new 27.0)

FlightListByLocationRequest.includeInvisibleFlights must be set to false if aerodromeRole

=ALTERNATE.

Constrained attributes: aerodromeRole

Constrained requests: any using request

19.5.4.4.2. FlightListByAerodromeReply

Edition: 27.0 6 844

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to FlightListByAerodromeRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByAerodromeReplyData data (Optional)

19.5.4.5. FlightListByAerodromeSetRequest/Reply

Edition: 27.0 6 845

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByAerodromeSetRequest

Reply: FlightListByAerodromeSetReply

Response time: 16 / 620 / 790 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByAerodromeSetReply
queryFlightsByAerodromeSet(FlightListByAerodromeSetRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 846

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by aerodrome set.

19.5.4.5.1. FlightListByAerodromeSetRequest

<<class>>

Request to query a flight list by aerodrome set.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. AerodromeSetId aerodromeSet (Mandatory)

Edition: 27.0 6 847

Document Title: NM 27.0 - NM B2B Reference Manual

Id of the aerodrome set.

b. AerodromeRole aerodromeRole (Mandatory)

Documentation last updated: 27.0 - Edition 1

Specifies whether the aerodrome is meant to be departure, arrival or both.

If aerodromeRole is set to AerodromeRole.DEPARTURE, the traffic window specifies that only those
flights taking off in the time window are requested.

If aerodromeRole is set to AerodromeRole.ARRIVAL, the traffic window specifies that only those
flights arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.GLOBAL, the traffic window specifies that only those
flights taking off or arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.ALTERNATE, the traffic window specifies that only those
flights of which arrival time belongs to this time window are requested.

i. Constraints:

▪ FlightListByAerodromeSetRequest.INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERO
DROME
3. Constraints:

a. INVISIBLE_FLIGHTS_NOT_AVAILABLE_ON_ALTERNATE_AERODROME (new 27.0)

FlightListByLocationRequest.includeInvisibleFlights must be set to false if aerodromeRole

=ALTERNATE.

Constrained attributes: aerodromeRole

Constrained requests: any using request

19.5.4.5.2. FlightListByAerodromeSetReply

Edition: 27.0 6 848

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to FlightListByAerodromeSetRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByAerodromeSetReplyData data (Optional)

19.5.4.6. FlightListByAirspaceRequest/Reply

Edition: 27.0 6 849

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByAirspaceRequest

Reply: FlightListByAirspaceReply

Response time: 26 / 610 / 2800 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByAirspaceReply queryFlightsByAirspace(FlightListByAirspaceRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 850

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by airspace.

19.5.4.6.1. FlightListByAirspaceRequest

<<class>>

Request to query a flight list by airspace, i.e. returns all flights occupying the given airspace during
the given traffic window.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. CountsCalculationType calculationType (Optional)

Indicates what is the calculation type of the count (entry or occupancy).

Edition: 27.0 6 851

Document Title: NM 27.0 - NM B2B Reference Manual

By default, calculationType is ENTRY .

b. AirspaceId airspace (Mandatory)

Id of the airspace.

19.5.4.6.2. FlightListByAirspaceReply

<<class>>

Returned in response to FlightListByAirspaceRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByAirspaceReplyData data (Optional)

19.5.4.7. FlightListByPointRequest/Reply

Edition: 27.0 6 852

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByPointRequest

Reply: FlightListByPointReply

Response time: 6 / 28 / 74 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByPointReply queryFlightsByPoint(FlightListByPointRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

if FlightField.mcdmInfo is requested

Edition: 27.0 6 853

Document Title: NM 27.0 - NM B2B Reference Manual

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by point.

19.5.4.7.1. FlightListByPointRequest

<<class>>

Request to query a flight list by point, i.e. returns flights being over that point at a time included in
the given traffic window.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. PublishedPointId point (Mandatory)

Id of the published point.

Edition: 27.0 6 854

Document Title: NM 27.0 - NM B2B Reference Manual

b. FlightLevelRange flightLevelRange (Mandatory)

The range in which the flight level should be over the point.

19.5.4.7.2. FlightListByPointReply

<<class>>

Returned in response to FlightListByPointRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByPointReplyData data (Optional)

19.5.4.8. FlightListByTrafficVolumeRequest/Reply

Edition: 27.0 6 855

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByTrafficVolumeRequest

Reply: FlightListByTrafficVolumeReply

Response time: 28 / 170 / 400 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByTrafficVolumeReply
queryFlightsByTrafficVolume(FlightListByTrafficVolumeRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 856

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by traffic volume.

19.5.4.8.1. FlightListByTrafficVolumeRequest

<<class>>

Request to query a flight list by traffic volume.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. CountsCalculationType calculationType (Optional)

Indicates what is the calculation type of the count (entry or occupancy).

Edition: 27.0 6 857

Document Title: NM 27.0 - NM B2B Reference Manual

Note: Occupancy counts for traffic volumes are only supported for traffic volumes defined
on an airspace.

b. TrafficVolumeId trafficVolume (Mandatory)

Id of the traffic volume.

c. FlowId flow (Optional)

Id of the traffic flow.

19.5.4.8.2. FlightListByTrafficVolumeReply

<<class>>

Returned in response to FlightListByTrafficVolumeRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByTrafficVolumeReplyData data (Optional)

19.5.4.9. FlightListByMeasureRequest/Reply

Edition: 27.0 6 858

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByMeasureRequest

Reply: FlightListByMeasureReply

Response time: 160 / 360 / 500 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByMeasureReply queryFlightsByMeasure(FlightListByMeasureRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /regulations

if target measure is a regulation

• assert certificate read access to /reroutings

if target measure is a rerouting

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

Edition: 27.0 6 859

Document Title: NM 27.0 - NM B2B Reference Manual

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by measure.

19.5.4.9.1. FlightListByMeasureRequest

<<class>>

Edition: 27.0 6 860

Document Title: NM 27.0 - NM B2B Reference Manual

Request to query a flight list by measure (regulation/rerouting/MCDM-only measure). The reply

only contains the flights that are concerned by that measure or alternatively only the flights that
the measure has impacted. Note that the FlightListByLocationRequest.traficWindow is used to find
the concerned regulation. Note that FlightListByMeasureRequest is subject to specific user
authorization: it is enabled/authorized on test platforms, otherwise when specifically requested by
the user.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

a. MeasureId measure (Mandatory)

Measure id.

b. FlightListByMeasureMode mode (Mandatory)

Documentation last updated: 27.0 - Edition 6

Indicates if the reply must contain the flights that are concerned by the given measure or
the flights that the measure has impacted (measure activated).

For a regulation the concerned flights are those flights that use a regulation slot. However
not all of them have an actual delay/have received a slot allocation message (typically
exempted flights do not get regulated in a normal regulation (non-exceptional-conditions
regulation). For a regulation, the flights that the measure has impacted (measure activated),
are a subset of those flights: only those flights that did get a delay (can be 0 minutes) and
have/will receive a SAM (Slot Allocation Message).

For a rerouting/MCDM-only measure, the concerned flights are those flights that cross the
location/traffic volume during the period on the optional flow, while the the flights that the
measure has impacted (measure activated), are a subset of those flights: only those flights
that have been cherry picked for the rerouting/MCDM-only measure. Note that even if a
flight has been cherry picked for a rerouting, it does not mean that the rerouting could find
an alternate route/improvement (the result can be found inside the flight field
FlightAtfcmMeasureLocation).

19.5.4.9.2. FlightListByMeasureReply

Edition: 27.0 6 861

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to FlightListByMeasureRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByMeasureReplyData data (Optional)

19.5.4.10. FlightListByHotspotRequest/Reply

Edition: 27.0 6 862

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByHotspotRequest

Reply: FlightListByHotspotReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightListByHotspotReply queryFlightsByHotspot(FlightListByHotspotRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

if FlightField.mcdmInfo is requested

Edition: 27.0 6 863

Document Title: NM 27.0 - NM B2B Reference Manual

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by hotspot.

19.5.4.10.1. FlightListByHotspotRequest

<<class>>

Request to query a flight list by hotspot. Note that hotspot related fields/services are trial related
(STAM) fields : they are only accessible (authorized) during specific trials or on test platforms.

A flight list by hotspot is always done on occupancy (as it is linked to a hotspot which is inherently
linked to occupancy counts).

The logical AND operator applies between all the query fields described below and those inherited
from FlightListByLocationRequest .

1. Inherits from: FlightListByLocationRequest

2. Attributes:

Edition: 27.0 6 864

Document Title: NM 27.0 - NM B2B Reference Manual

a. HotspotId hotspot (Mandatory)

Hotspot id.

b. FlowId flow (Optional)

Id of the traffic flow.This allows to list only the flights for a specific flow.

c. DurationHourMinute periodExtension (Mandatory)

Documentation last updated: 27.0 - Edition 6

Period extension: For a hotspot flightlist, the FlightListRequest: trafficWindow is used to find
the hotspot. However the HotspotId:applicabilityPeriod is used to query the flights. In some
cases, the user wants to see a the flights around the real hotspot (typically to be able to
choose to what time over to cherry pick delay a flight). The periodExtension does exactly
that: the effectiveTrafficWindow is the extended HotspotId.applicabilityPeriod (using the
duration of the hotspot) and then extended some more (earlier and later) by the
periodExtension.

Period extension: For a hotspot flightlist, the FlightListRequest: trafficWindow is not used.
Instead the HotspotId:applicabilityPeriod is used to query the flights. In some cases, the user
wants to see the flights around the real hotspot (typically to be able to choose to what time
over to cherry pick delay a flight). The periodExtension does exactly that: the
effectiveTrafficWindow is the extended HotspotId.applicabilityPeriod (using the duration
of the hotspot) and then extended some more (earlier and later) by the periodExtension. For
example: for a hotspot applicabilityPeriod = [10:20, 10:50[ and hotspot duration=10
minutes and periodExtension=2 minutes (and for all OTMV/hotspot : step=1 minute), the
effectiveTrafficWindow for the occupancy flightlist is [10:18,11:01[.

19.5.4.10.2. FlightListByHotspotReply

<<class>>

Returned in response to FlightListByHotspotRequest.

Edition: 27.0 6 865

Document Title: NM 27.0 - NM B2B Reference Manual

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByHotspotReplyData data (Optional)

19.5.4.11. FlightListByAircraftRegistrationMarkRequest/Reply

Edition: 27.0 6 866

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightListByAircraftRegistrationMarkRequest

Reply: FlightListByAircraftRegistrationMarkReply

Response time: 7 / 18 / 96 (ms)

Default settings: request count quotas

SOAP operation:

FlightListByAircraftRegistrationMarkReply
queryFlightsByAircraftRegistrationMark(FlightListByAircraftRegistrationMarkRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

Edition: 27.0 6 867

Document Title: NM 27.0 - NM B2B Reference Manual

if FlightField.mcdmInfo is requested

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Queries flights by aircraft registration mark.

19.5.4.11.1. FlightListByAircraftRegistrationMarkRequest

<<class>>

Request to query a flight list by aircraft registration mark.

The logical AND operator applies between all the query fields described below and those inherited
from FlightListRequest.

1. Inherits from: FlightListRequest

2. Attributes:

a. AircraftRegistrationMark registrationMark (Mandatory)

Aircraft registration mark.

19.5.4.11.2. FlightListByAircraftRegistrationMarkReply

Edition: 27.0 6 868

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to FlightListByAircraftRegistrationMarkRequest.

See FlightListReplyData.

1. Inherits from: Reply

2. Attributes:

a. FlightListByAircraftRegistrationMarkReplyData data (Optional)

19.5.4.12. FlightRetrievalRequest/Reply

Edition: 27.0 6 869

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightRetrievalRequest

Reply: FlightRetrievalReply

Response time: 10 / 64 / 160 (ms)

Default settings: request count quotas

SOAP operation:

FlightRetrievalReply retrieveFlight(FlightRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /flights

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• verify certificate read access to /flights?sensitive=true

then sensitive flights are returned

• assert certificate read access to /flights#avoided_regulations

if FlightField.avoidedRegulations is requested

• assert certificate read access to /flights#ccams_ssr_code

if FlightField.ccamsSSRCode is requested

• assert certificate read access to /flights#target_time_over_fix

if FlightField.targetTimeOverFix is requested

• assert certificate read access to /counts

if FlightField.worstLoadStateAtReferenceLocation is requested

• assert certificate read access to /hotspots?kind=PROBLEM

if FlightField.hotspots or FlightField.caughtInHotspots is requested

• assert certificate read access to /mcdmTopics

if FlightField.mcdmInfo is requested

Edition: 27.0 6 870

Document Title: NM 27.0 - NM B2B Reference Manual

• assert certificate read access to /scenarios

if FlightField.applicableScenarios is requested

Retrieves a flight.

19.5.4.12.1. FlightRetrievalRequest

<<class>>

Request to selectively retrieve all or part of the information regarding a single flight, i.e.:

1. The flight plan (FlightPlan ), and/or

2. The flight plan history (FlightPlanHistory), and/or

3. The flight (Flight )

These are specified using the requestedFlightDatasets request field.

In addition, the flight fields (i.e. the attributes in Flight) are also selectively returned based on the
caller’s selection, expressed via requestedFlightFields , if they are available at NM.

Note that the flight keys are always returned.

Remarks
1. It is possible that according to the data set selected, a FlightPlan is returned and not a Flight
. This can be for a temporary situation or for flight created with an EOBT in a far future
(when EOBT-now > 22h).

2. For a CANCELLED FlightPlan NM returns:

Edition: 27.0 6 871

Document Title: NM 27.0 - NM B2B Reference Manual

a. A FlightPlan object when the flightId.id and a FlightPlan data set is specified and that
until the FlightPlan object is archived.

b. OBJECT_NOT_FOUND if the flightId.keys and a FlightPlan data set is specified.

c. OBJECT_NOT_FOUND if the flightId.keys and a Flight data set is specified.

3. For a TERMINATED Flight NM returns:

a. A FlightPlan object when the flightId.id or flightId.keys and a FlightPlan data set is
specified and that until the FlightPlan object is archived.

b. A Flight object if the flightId.keys and a Flight data set is specified and that until the
Flight object is archived.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset from which the flight list is requested.

i. Constraints:

▪ FlightRetrievalRequest.REQUESTED_FLIGHT_DATASETS_CAN_ONLY_CONTAIN_FLIGHT

b. boolean includeProposalFlights (Mandatory)

If specified, the result will include also proposal flights.

i. Access control:

▪ set includeProposalFlights=true requires read access to /flights?proposal=true

c. FlightIdentificationInput flightId (Mandatory)

Identification of the requested flight plan.

The flightId.id or the flightId.keys can be used to retrieve flightPlan and

flightPlanHistory data sets

Only flightId.keys can be used to retrieve flight data set.

i. Constraints:

▪ FlightRetrievalRequest.ADES_OR_NONICAOADES_KEYS_MUST_BE_SET_FOR_FLIGHTPLAN_DATASE
T
▪ FlightRetrievalRequest.FLIGHT_PLAN_HISTORY_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS

▪ FlightRetrievalRequest.FLIGHT_PLAN_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS

▪ FlightRetrievalRequest.KEYS_OR_IATA_KEYS_MUST_BE_PRESENT_IF_FLIGHT_IS_SPECIFIED_A
S_REQUESTED_DATASET
d. FlightDataset[] requestedFlightDatasets (Mandatory)

The reply returns only the requested datasets, and only if the requested datasets are
available at NM. It can be for example that a flight plan is available but not the

Edition: 27.0 6 872

Document Title: NM 27.0 - NM B2B Reference Manual

corresponding flight, or conversely.

i. Constraints:

▪ array size range : [1, unbounded[

▪ FlightRetrievalRequest.ADES_OR_NONICAOADES_KEYS_MUST_BE_SET_FOR_FLIGHTPLAN_DATASE
T
▪ FlightRetrievalRequest.CANNOT_CONTAIN_DUPLICATE_REQUESTED_DATASETS

▪ FlightRetrievalRequest.FLIGHT_PLAN_HISTORY_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS

▪ FlightRetrievalRequest.FLIGHT_PLAN_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS

▪ FlightRetrievalRequest.KEYS_OR_IATA_KEYS_MUST_BE_PRESENT_IF_FLIGHT_IS_SPECIFIED_A
S_REQUESTED_DATASET
e. FlightField[] requestedFlightFields (Optional)

The reply returns only the requested attributes of the returned Flight , and only if the
values of these requested fields are available at NM.

Cannot be null or empty or contain duplicates if the flight dataset is requested; must be null
otherwise.

i. Constraints:

▪ FlightRetrievalRequest.CANNOT_CONTAIN_DUPLICATE_REQUESTED_FIELDS

▪ FlightRetrievalRequest.REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION

3. Constraints:

a. KEYS_OR_IATA_KEYS_MUST_BE_PRESENT_IF_FLIGHT_IS_SPECIFIED_AS_REQUESTED_DATASET (altered
27.0)

If flight is specified in requestedFlightDatasets then either keys or iataKeys shall be defined.

Constrained attributes: flightId, requestedFlightDatasets

Constrained requests: any using request

b. CANNOT_CONTAIN_DUPLICATE_REQUESTED_DATASETS

Cannot contain duplicates.

Constrained attributes: requestedFlightDatasets

Constrained requests: any using request

c. CANNOT_CONTAIN_DUPLICATE_REQUESTED_FIELDS

Cannot contain duplicates.

Constrained attributes: requestedFlightFields

Constrained requests: any using request

Edition: 27.0 6 873

Document Title: NM 27.0 - NM B2B Reference Manual

d. REQUESTED_FLIGHT_DATASETS_CAN_ONLY_CONTAIN_FLIGHT

if the dataset type is set as FORECAST or SIMULATION , then returnInvalidFilingSummaries needs

to be set to false (otherwise an error is returned).

Constrained attributes: dataset

Constrained requests: any using request

e. REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION

The fields worstLoadStateAtReferenceLocation , compareWithOtherTrafficType are not valid in

the FlightRetrievalRequest .

Constrained attributes: requestedFlightFields

Constrained requests: any using request

f. ADES_OR_NONICAOADES_KEYS_MUST_BE_SET_FOR_FLIGHTPLAN_DATASET

If requestedFlightDatasets contains FlightDataset.flightPlan or

FlightDataset.flightPlanHistory , and if flightId 's choice is keys , then the attributes
flightId.keys.aerodromeOfDestination and/or flightId.keys.nonICAOAerodromeOfDestination
must be set.

Constrained attributes: flightId, requestedFlightDatasets

Constrained requests: any using request

g. FLIGHT_PLAN_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS (new 27.0)

flightPlan not allowed in requestedFlightDatasets when flightId is specified by IATA keys

Constrained attributes: flightId, requestedFlightDatasets

Constrained requests: any using request

h. FLIGHT_PLAN_HISTORY_NOT_AVAILABLE_FROM_IATA_FLIGHT_KEYS (new 27.0)

flightPlanHistory not allowed in requestedFlightDatasets when flightId is specified by IATA

keys

Constrained attributes: flightId, requestedFlightDatasets

Constrained requests: any using request

19.5.4.12.2. FlightRetrievalReply

<<class>>

Returned in response to FlightRetrievalRequest.

Edition: 27.0 6 874

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. FlightRetrievalReplyData data (Optional)

19.5.4.13. EarlyDPIRequest/Reply

MEP: S-R/R

Request: EarlyDPIRequest

Reply: EarlyDPIReply

Response time: 27 / 96 / 330 (ms)

Default settings: request count quotas

SOAP operation:

EarlyDPIReply submitEarlyDPI(EarlyDPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits an Early DPI message.

19.5.4.13.1. EarlyDPIRequest

<<class>>

The Airport confirms to NMOC that an airport slot and flight plan for a particular flight have been
correlated in accordance with local rules at the airport (A-CDM Mile stone 1).

Edition: 27.0 6 875

Document Title: NM 27.0 - NM B2B Reference Manual

Detailed information regarding Early DPI messages can be found in the document DPI
Implementation Guide - section E-DPI section.

1. Inherits from: UpdateDPIRequest

2. Attributes:

a. DateTimeMinute scheduledOffBlockTime (Optional)

Documentation last updated: 27.0 - Edition 3

IATA schedule time of departure.

The prime originator is the Airline. It is the time that an aircraft is scheduled to depart.

For example, for passenger flights it is the time the passenger has on his ticket.

Acronym
SOBT.

Note
This attribute is used only for post-ops analysis.

19.5.4.13.2. EarlyDPIReply

<<class>>

Returned in response to EarlyDPIRequest.

1. Inherits from: Reply

2. Attributes:

a. EarlyDPIReplyData data (Optional)

The reply payload.

19.5.4.14. TargetDPITargetRequest/Reply

Edition: 27.0 6 876

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TargetDPITargetRequest

Reply: TargetDPITargetReply

Response time: 20 / 110 / 980 (ms)

Default settings: request count quotas

SOAP operation:

TargetDPITargetReply submitTargetDPITarget(TargetDPITargetRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits a Target DPI Target message.

19.5.4.14.1. TargetDPITargetRequest

<<class>>

T-DPI-t - The T-DPI-t message must contain the Target Take-Off Time (TTOT) that takes into account
all constraints from an AO and Handling Agent perspective.

Detailed information regarding Target DPI target can be found in the document DPI
Implementation Guide - section T-DPI-t.

1. Inherits from: TargetDPIRequest

Edition: 27.0 6 877

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.14.2. TargetDPITargetReply

<<class>>

Returned in response to TargetDPITargetRequest.

1. Inherits from: Reply

2. Attributes:

a. TargetDPITargetReplyData data (Optional)

The reply payload.

19.5.4.15. TargetDPISequencedRequest/Reply

MEP: S-R/R

Request: TargetDPISequencedRequest

Reply: TargetDPISequencedReply

Response time: 25 / 100 / 420 (ms)

Default settings: request count quotas

SOAP operation:

TargetDPISequencedReply submitTargetDPISequenced(TargetDPISequencedRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits a Target DPI Sequenced message.

19.5.4.15.1. TargetDPISequencedRequest

Edition: 27.0 6 878

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

T-DPI-s - The T-DPI-s contains the Take-Off-Time as calculated by the Pre-Departure Sequence. This
Take-Off-Time (target take-off-time) is included in the TTOT-field.

Detailed information regarding Target DPI sequenced messages can be found in the document DPI
Implementation Guide - section T-DPI-s.

1. Inherits from: TargetDPIRequest

19.5.4.15.2. TargetDPISequencedReply

<<class>>

Returned in response to TargetDPISequencedRequest.

1. Inherits from: Reply

2. Attributes:

a. TargetDPISequencedReplyData data (Optional)

The reply payload.

19.5.4.16. ATCDPIRequest/Reply

Edition: 27.0 6 879

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ATCDPIRequest

Reply: ATCDPIReply

Response time: 29 / 81 / 290 (ms)

Default settings: request count quotas

SOAP operation:

ATCDPIReply submitATCDPI(ATCDPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits an ATC DPI message.

19.5.4.16.1. ATCDPIRequest

<<class>>

The purpose of the A-DPI is to inform NM that the flight has off-blocked, i.e. the flight is "under ATC
(or Apron) control" and taxiing to take-off.

Detailed information regarding ATC DPI messages can be found in the document DPI
Implementation Guide - section A-DPI .

1. Inherits from: UpdateDPIRequest

2. Attributes:

Edition: 27.0 6 880

Document Title: NM 27.0 - NM B2B Reference Manual

a. DateTimeMinute actualOffBlockTime (Optional)

Actual Off Block Time.

Prime originator is tower ATC. The actual date and time the aircraft has vacated the parking
position (pushed back or on its own power).

Acronym
AOBT.

b. boolean depstatusTwrUpdate (Optional)

If true, the TTOT will be accepted even if after the Slot Tolerance Window of a regulated
flight, in which case the CTOT will be extended by 10 minutes or recalculated. False by
default.

19.5.4.16.2. ATCDPIReply

<<class>>

Returned in response to ATCDPIRequest.

1. Inherits from: Reply

2. Attributes:

a. ATCDPIReplyData data (Optional)

The reply payload.

19.5.4.17. CancelDPIRequest/Reply

Edition: 27.0 6 881

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: CancelDPIRequest

Reply: CancelDPIReply

Response time: 34 / 220 / 1300 (ms)

Default settings: request count quotas

SOAP operation:

CancelDPIReply submitCancelDPI(CancelDPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits a Cancel DPI message.

19.5.4.17.1. CancelDPIRequest

Edition: 27.0 6 882

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

The Airport informs NMOC that previously sent DPI information is no longer valid.

Detailed information regarding Cancel DPI messages can be found in the document DPI
Implementation Guide - section C-DPI.

1. Inherits from: DeparturePlanningInformationRequest

2. Attributes:

a. ReasonForDPICancellation reason (Mandatory)

Reason for requesting a cancelDPI .

Acronym
REASON.

i. Constraints:

▪ CancelDPIRequest.INVALID_REASON

3. Constraints:

a. INVALID_REASON

The reason cannot be UNDEFINED .

Constrained attributes: reason

Constrained requests: any using request

19.5.4.17.2. CancelDPIReply

<<class>>

Returned in response to CancelDPIRequest.

1. Inherits from: Reply

2. Attributes:

a. CancelDPIReplyData data (Optional)

The reply payload.

19.5.4.18. PredictedDPIRequest/Reply

Edition: 27.0 6 883

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: PredictedDPIRequest

Reply: PredictedDPIReply

Response time: 23 / 89 / 380 (ms)

Default settings: request count quotas

SOAP operation:

PredictedDPIReply submitPredictedDPI(PredictedDPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits a Predicted DPI message.

19.5.4.18.1. PredictedDPIRequest

<<class>>

The P-DPI (Predicted DPI) is used to communicate target take-off time changes to the NOP before
the time at which the data is sent in the A-CDM context. Its purpose is a timely update of the
expected traffic load.

P-DPI can be sent to create or update scheduled flights for which no flight plan has been filed yet,
but also to update flights that have been filed. P-DPI sending shall be stopped at A-CDM Milestone 1

Edition: 27.0 6 884

Document Title: NM 27.0 - NM B2B Reference Manual

when first E-DPI is sent which is earliest at EOBT - 3 hours.

P-DPI are also used for cancellation of scheduled flights (when attribute flightStatusOutbound
contains the value CNX ). If a P-DPI is sent for an existing flight plan, the CNX has no effect. Flight plan
cancellations are to be handled in established manner.

1. Inherits from: UpdateDPIRequest

2. Attributes:

a. DateTimeMinute scheduledOffBlockTime (Mandatory)

IATA schedule time and date of departure.

The prime originator is the Airline. It is the time that an aircraft is scheduled to depart.

Acronym: SOBT.

b. DateTimeMinute airportSlotDeparture (Optional)

The airport departure slot date and time in case the flight departs from a coordinated
airport.

c. AircraftIATAId aircraftIATAId (Optional)

Documentation last updated: 27.0 - Edition 1

The IATA flight designator (see Flight.iataFlightDesignator).

i. Constraints:

▪ PredictedDPIRequest.MISSING_AIRCRAFT_ID

d. AerodromeIATAId aerodromeOfDepartureIATA (Optional)

Departure airport IATA.

i. Constraints:

▪ PredictedDPIRequest.MISSING_AERODROME_OF_DEPARTURE

e. AerodromeIATAId aerodromeOfDestinationIATA (Optional)

Destination airport IATA.

i. Constraints:

▪ PredictedDPIRequest.MISSING_AERODROME_OF_DESTINATION

3. Constraints:

a. MISSING_AIRCRAFT_ID

If aircraftId (ICAO) is null then aircraftIATAId must not be null.

Constrained attributes: aircraftIATAId

Edition: 27.0 6 885

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

b. MISSING_AERODROME_OF_DEPARTURE

If aerodromeOfDeparture (ICAO) is null then aerodromeOfDepatureIATA must not be null.

Constrained attributes: aerodromeOfDepartureIATA

Constrained requests: any using request

c. MISSING_AERODROME_OF_DESTINATION

If aerodromeOfDestination (ICAO) is null then aerodromeOfDestinationIATA must not be null.

Constrained attributes: aerodromeOfDestinationIATA

Constrained requests: any using request

19.5.4.18.2. PredictedDPIReply

<<class>>

Returned in response to PredictedDPIRequest.

1. Inherits from: Reply

2. Attributes:

a. PredictedDPIReplyData data (Optional)

The reply payload.

19.5.4.19. FlightUpdateRequest/Reply

Edition: 27.0 6 886

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightUpdateRequest

Reply: FlightUpdateReply

Response time: 17 / 120 / 380 (ms)

Default settings: request count quotas

SOAP operation:

FlightUpdateReply submitFlightUpdate(FlightUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /flights

• assert certificate, anu write access to /flights#aircraft_position_report

if request.flightUpdate is AircraftPositionReport

• assert certificate, anu write access to /flights#departure_info

if request.flightUpdate is DepartureInformation

• assert certificate write access to /flights#en_route_info

if request.flightUpdate is EnRouteInformation

• assert certificate, anu write access to /flights#landing_info

if request.flightUpdate is LandingInformation

• assert certificate write access to /flights#fnm_oceanic_info

if request.flightUpdate is OceanicInformation and OceanicInformation.source=GANDER

• assert certificate write access to /flights#mfs_oceanic_info

if request.flightUpdate is OceanicInformation and

OceanicInformation.source=SHANWICK|SANTA_MARIA

Updates flight information such as departure information or en-route information.

Edition: 27.0 6 887

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.19.1. FlightUpdateRequest

<<class>>

This request allows the provision to NM of flight update information such as departure information
or en-route information.

This request requires special authorization.

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. AircraftTypeICAOId aircraftType (Optional)

The actual aircraft type used for the flight.

b. ICAOAircraftAddress aircraftAddress (Optional)

The aircraft address.

c. AircraftRegistrationMark aircraftRegistrationMark (Optional)

The aircraft registration mark.

d. int numberOfAircraft (Optional)

The number of aircraft.

i. Constraints:

▪ range : [0, unbounded[

e. WakeTurbulenceCategory wakeTurbulenceCategory (Optional)

Wake turbulence category.

Edition: 27.0 6 888

Document Title: NM 27.0 - NM B2B Reference Manual

f. FlightUpdateChoice flightUpdate (Mandatory)

Either an update of departure information or en-route data.

i. Access control:

▪ set flightUpdate.aircraftPositionReport requires write access to

/flights#aircraft_position_report
▪ set flightUpdate.departureInformation requires write access to
/flights#departure_info
▪ set flightUpdate.enRouteInformation requires write access to /flights#en_route_info

▪ set flightUpdate.landingInformation requires write access to /flights#landing_info

▪ set flightUpdate.oceanicInformation and

flightUpdate.oceanicInformation.source=GANDER requires write access to
/flights#fnm_oceanic_info
▪ set flightUpdate.oceanicInformation and
flightUpdate.oceanicInformation.source=SHANWICK|SANTA_MARIA requires write access
to /flights#mfs_oceanic_info

19.5.4.19.2. FlightUpdateReply

<<class>>

Returned in response to FlightUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightUpdateReplyData data (Optional)

The reply payload.

19.5.4.20. ACDMAlertRequest/Reply (new 27.0)

Edition: 27.0 6 889

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ACDMAlertRequest

Reply: ACDMAlertReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ACDMAlertReply submitACDMAlert(ACDMAlertRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#departure_info?aerodrome_of_departure={request.aerodromeOfDeparture}

Submits or cancels an A-CDM alert (one at a time).

19.5.4.20.1. ACDMAlertRequest (new 27.0)

Edition: 27.0 6 890

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to submit or cancel an A-CDM alert (one at a time).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. AircraftIATAId aircraftIATAId (Optional)

Aircraft IATA identifier.

i. Constraints:

▪ ACDMAlertRequest.MISSING_IATA_KEY

b. AerodromeIATAId aerodromeOfDepartureIATA (Optional)

Departure aerodrome IATA.

i. Constraints:

▪ ACDMAlertRequest.MISSING_IATA_KEY

c. AerodromeIATAId aerodromeOfDestinationIATA (Optional)

Destination aerodrome IATA.

i. Constraints:

▪ ACDMAlertRequest.MISSING_IATA_KEY

Edition: 27.0 6 891

Document Title: NM 27.0 - NM B2B Reference Manual

d. DateTimeMinute scheduledOffBlockTime (Optional)

IATA schedule date and time of departure.

i. Constraints:

▪ ACDMAlertRequest.MISSING_IATA_KEY

e. ACDMAlertCode alertCode (Mandatory)

The code of the A-CDM alert.

f. boolean active (Mandatory)

true to set or update an active alert. false to cancel an alert.

i. Constraints:

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

g. DateTimeMinute timestamp (Optional)

The time at which the alert has become active. Mandatory if active = true, otherwise must
be null.

i. Constraints:

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

h. string inconsistencyDetected (Optional)

Mandatory if active = true, otherwise must be null.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

i. string actionToTake (Optional)

Mandatory if active = true, otherwise must be null.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

j. string consequencesNote (Optional)

Optional if active = true, otherwise must be null.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

Edition: 27.0 6 892

Document Title: NM 27.0 - NM B2B Reference Manual

k. ACDMAlertSeverity severity (Optional)

Optional if active = true, otherwise must be null.

i. Constraints:

▪ ACDMAlertRequest.ACTIVE_ACDM_ALERT

3. Constraints:

a. MISSING_IATA_KEY

If aircraftId (ICAO) and ifplId are both null then aircraftIATAId, aerodromeOfDepartureIATA,
aerodromeOfDestinationIATA and scheduledOffBlockTime must not be null.

Remark: In the current release, an ACDMAlertRequest must provide an aircraftId (ICAO),

otherwise it will be rejected.

Constrained attributes: aircraftIATAId, aerodromeOfDepartureIATA,

aerodromeOfDestinationIATA, scheduledOffBlockTime

Constrained requests: any using request

b. ACTIVE_ACDM_ALERT

If active = true, the attributes timestamp, inconsistencyDetected, actionToTake are mandatory

and the attributes consequencesNote and severity are optional. Otherwise if active = false, all
those attributes must be null.

Constrained attributes: active, timestamp, inconsistencyDetected, actionToTake,

consequencesNote, severity

Constrained requests: any using request

19.5.4.20.2. ACDMAlertReply (new 27.0)

<<class>>

Returned in response to ACDMAlertRequest.

1. Inherits from: Reply

2. Attributes:

a. ACDMAlertReplyData data (Optional)

The reply payload.

19.5.4.21. GeneralAPIRequest/Reply

Edition: 27.0 6 893

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: GeneralAPIRequest

Reply: GeneralAPIReply

Response time: 16 / 55 / 240 (ms)

Default settings: request count quotas

SOAP operation:

GeneralAPIReply submitGeneralAPI(GeneralAPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#landing_info?aerodrome_of_arrival={request.aerodromeOfDestination}

Informs NMOC about arrival information like SLDT, STAR, arrival taxi time, etc.

19.5.4.21.1. GeneralAPIRequest

Edition: 27.0 6 894

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 6

The airport informs NMOC about arrival information like SLDT, STAR, arrival taxi time, etc.

1. Inherits from: ArrivalPlanningInformationRequest

2. Attributes:

a. AircraftRegistrationMark registrationMark (Optional)

Aircraft registration mark. It is the unique alphanumeric string that identifies a civil
aircraft.

ADEXP:
-REG

b. AircraftTypeICAOId aircraftType (Optional)

ICAO Aircraft type.

ADEXP:
-ARCTYP

Edition: 27.0 6 895

Document Title: NM 27.0 - NM B2B Reference Manual

c. AircraftIATAId aircraftIATAId (Optional)

Documentation last updated: 27.0 - Edition 1

The IATA flight designator (see Flight.iataFlightDesignator).

d. DurationHourMinute arrivalTaxiTime (Optional)

Estimated or actual taxi time from landing to gate.

Acronym:
EXIT.

e. RunwayId arrivalRunway (Optional)

Identifier of the assigned arrival runway.

f. TerminalOrApronStandName arrivalTerminal (Optional)

Identifier of the arrival terminal.

g. TerminalOrApronStandName arrivalApronStand (Optional)

Identifier of the arrival apron stand.

h. DurationHourMinute minimumTurnaroundTime (Optional)

Minimum turn-around time.

Acronym:
MTTT.

i. DateTimeMinute landingTime (Optional)

The time the aircraft is expected to land (when ATV flightStatusInbound is not yet TXI) or the
time the aircraft has landed (when ATV flightStatusInbound is TXI, IBK, DBR or DBC). NMOC
uses actual landing time to update the CTFM profile of the flight. NMOC will collect the
estimated landing time during the OPS trials and will evaluate its quality, then assess the
possibility to use this information to improve the traffic load picture in a future release.

Acronym:
ELDT/ALDT

i. Constraints:

▪ GeneralAPIRequest.INVALID_LANDING_TIME

j. DateTimeMinute scheduledInBlockTime (Optional)

IATA Scheduled In-Block Time.

Prime originator is the airline.

Edition: 27.0 6 896

Document Title: NM 27.0 - NM B2B Reference Manual

Acronym:
SIBT

k. DateTimeMinute inBlockTime (Optional)

The time the aircraft is expected to arrive at stand/gate (when ATV flightStatusInbound is
not yet IBK) or the time the aircraft has arrived at the stand/gate (when ATV
flightStatusInbound is IBK, DBR or DBC).

Acronym:
EIBT/AIBT

l. DateTimeMinute airportSlotArrival (Optional)

The airport arrival slot date and time in case the flight arrives at a coordinated airport.

m. ImpactSeverityIndicator impactSeverityIndicator (Optional)

Impact assessment of non-punctual arrival upon the airport planning and AUs business
needs.

3. Constraints:

a. INVALID_LANDING_TIME

The actual landingTime (when flightStatusInbound is either TXI or IBK or DBR or DBC ) is not
later than current time + 10 minutes.

Constrained attributes: landingTime

Constrained requests: any using request

19.5.4.21.2. GeneralAPIReply

<<class>>

Returned in response to GeneralAPIRequest.

1. Inherits from: Reply

2. Attributes:

a. GeneralAPIReplyData data (Optional)

The reply payload.

19.5.4.22. TargetTakeOffAPIRequest/Reply

Edition: 27.0 6 897

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TargetTakeOffAPIRequest

Reply: TargetTakeOffAPIReply

Response time: 13 / 160 / 930 (ms)

Default settings: request count quotas

SOAP operation:

TargetTakeOffAPIReply submitTargetTakeOffAPI(TargetTakeOffAPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#landing_info?aerodrome_of_arrival={request.aerodromeOfDestination}

Provides to NMOC the target time over the AOP-NOP coordination fix point, to negotiate a new
CTOT (when TargetAPIRequest.targetAPIUseCase = Update), or removes previous target time
information (when TargetAPIRequest.targetAPIUseCase = Remove).

19.5.4.22.1. TargetTakeOffAPIRequest

<<class>>

The airport provides to NMOC the target time over the AOP-NOP coordination fix point, to negotiate
a new CTOT (when TargetAPIRequest.targetAPIUseCase = Update), or removes previous target time
information (when TargetAPIRequest.targetAPIUseCase = Remove).

Edition: 27.0 6 898

Document Title: NM 27.0 - NM B2B Reference Manual

Note
The APIs related services are OPS trial related: it is only accessible (authorized) during specific OPS
trials.

The use will be restricted to invited users.

1. Inherits from: TargetAPIRequest

2. Attributes:

a. RegulationId regulationId (Optional)

The arrival related regulation that was created in coordination with NMOC to regulate all
the flights subject to API, and used in the communication of the CTOT to the ADEP.

i. Constraints:

▪ TargetTakeOffAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

▪ TargetTakeOffAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

b. DateTimeMinute earliestTargetTimeOver (Optional)

The earliest possible time over the AOP-NOP coordination fix that the AMAN tool could
accommodate in its arrival sequence, stemming from local capacity constraints, regardless
of the CTOT that could be allocated by NM to this flight.

This information will be used by NM as a minimum calculated time over (min CTO): in case
of a potential delay reduction for this flight, the CTO will always be equal or later than
earliestTargetTimeOver.

When earliestTargetTimeOver is null, there will be no minimum value (other than the flight
plan and possibly departure constraints) for the calculated time over, and in case of delay
reduction opportunities NM may reduce the delay down to zero.

i. Constraints:

▪ TargetTakeOffAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

▪ TargetTakeOffAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

c. DateTimeMinute consolidatedTargetTimeOver (Optional)

When a departure or en-route regulation is more penalizing than the arrival regulation, this
field allows fine adjustment of the CTO by the AMAN tool, in a window around the CTO
which is known as "slot zone".

The slot zone is a [ -5 min, +10 min ] window around the initial CTO when it has been
recalculated by NM.

The slot zone is not shifted when the CTO is adjusted by a consolidatedTargetTimeOver or
when the CTOT is slightly changed by a DLA or CHG message.

The current value of the slot zone can be retrieved as part of the flight data (Flight.slotZone).

Edition: 27.0 6 899

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ TargetTakeOffAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

▪ TargetTakeOffAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

3. Constraints:

a. ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

When targetAPIUseCase = Update, regulationId, and at least one of the two attributes
earliestTargetTimeOver and/or consolidatedTargetTimeOver must not be null.

Constrained attributes: targetAPIUseCase, regulationId, earliestTargetTimeOver,

consolidatedTargetTimeOver

Constrained requests: any using request

b. ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

When targetAPIUseCase = Remove, all other attributes must be null.

Constrained attributes: targetAPIUseCase, regulationId, earliestTargetTimeOver,

consolidatedTargetTimeOver

Constrained requests: any using request

19.5.4.22.2. TargetTakeOffAPIReply

<<class>>

Returned in response to TargetTakeOffAPIRequest.

1. Inherits from: Reply

2. Attributes:

a. TargetTakeOffAPIReplyData data (Optional)

The reply payload.

19.5.4.23. TargetTimeOverAPIRequest/Reply

Edition: 27.0 6 900

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TargetTimeOverAPIRequest

Reply: TargetTimeOverAPIReply

Response time: not available

Default settings: request count quotas

SOAP operation:

TargetTimeOverAPIReply submitTargetTimeOverAPI(TargetTimeOverAPIRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to

/flights#landing_info?aerodrome_of_arrival={request.aerodromeOfDestination}

Provides to NMOC the target time over the AOP-NOP coordination fix point, in order to allow
fine-tuning of the 4D trajectory by NM without changing the take-off time.

19.5.4.23.1. TargetTimeOverAPIRequest

<<class>>

The airport provides to NMOC the target time over the AOP-NOP coordination fix point, in order to
allow fine-tuning of the 4D trajectory by NM without changing the take-off time.

Note
The APIs related services are OPS trial related: it is only accessible (authorized) during specific OPS
trials.

The use will be restricted to invited users.

Edition: 27.0 6 901

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: TargetAPIRequest

2. Attributes:

a. DateTimeMinute targetTimeOver (Optional)

The target time over the coordinationFix given by the airport.

Used by NM to fine-tune the 4D trajectory and accommodate the target time without
changing the take-off time.

i. Constraints:

▪ TargetTimeOverAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

▪ TargetTimeOverAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

3. Constraints:

a. ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

When targetAPIUseCase = Update, targetTimeOver must not be null.

Constrained attributes: targetTimeOver

Constrained requests: any using request

b. ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

When targetAPIUseCase = Remove, targetTimeOver must be null.

Constrained attributes: targetTimeOver

Constrained requests: any using request

19.5.4.23.2. TargetTimeOverAPIReply

<<class>>

Returned in response to TargetTimeOverAPIRequest.

1. Inherits from: Reply

2. Attributes:

a. TargetTimeOverAPIReplyData data (Optional)

The reply payload.

19.5.4.24. FlightConfirmationRequest/Reply

Edition: 27.0 6 902

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: FlightConfirmationRequest

Reply: FlightConfirmationReply

Response time: 16 / 460 / 1200 (ms)

Default settings: request count quotas

SOAP operation:

FlightConfirmationReply submitFlightConfirmation(FlightConfirmationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits a flight confirmation request (FCM).

19.5.4.24.1. FlightConfirmationRequest

<<class>>

Flight Confirmation Request ( FCM ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. DistanceM runwayVisualRange (Optional)

Runway visual range.

b. list< RegulationId > regulations (Optional)

Regulations.

Edition: 27.0 6 903

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.24.2. FlightConfirmationReply

<<class>>

Returned in response to FlightConfirmationRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightConfirmationReplyData data (Optional)

The reply payload.

19.5.4.25. SlotMissedRequest/Reply

MEP: S-R/R

Request: SlotMissedRequest

Reply: SlotMissedReply

Response time: 300 / 300 / 300 (ms)

Default settings: request count quotas

SOAP operation:

SlotMissedReply submitSlotMissed(SlotMissedRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits a slot missed request (SMM).

19.5.4.25.1. SlotMissedRequest

<<class>>

Edition: 27.0 6 904

Document Title: NM 27.0 - NM B2B Reference Manual

Slot Missed Request ( SMM ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. DateTimeMinute calculatedTakeOffTime (Mandatory)

Calculated take off time.

19.5.4.25.2. SlotMissedReply

<<class>>

Returned in response to SlotMissedRequest.

1. Inherits from: Reply

2. Attributes:

a. SlotMissedReplyData data (Optional)

The reply payload.

19.5.4.26. ReadyToDepartRequest/Reply

MEP: S-R/R

Request: ReadyToDepartRequest

Reply: ReadyToDepartReply

Response time: 22 / 200 / 550 (ms)

Default settings: request count quotas

SOAP operation:

ReadyToDepartReply submitReadyToDepart(ReadyToDepartRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert anu write access to /flights/messages/rea

Submits a ready to depart request (REA).

Edition: 27.0 6 905

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.26.1. ReadyToDepartRequest

<<class>>

Ready To Depart Request ( REA ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. DurationMinute minLineup (Optional)

The minimum line-up time in a REA message. The ATC may modify the relevant taxi time by
specifying a minimum line-up time (MINLINEUP). If no time is specified in the message, the
system will use the default taxi time of the relevant aerodrome.

19.5.4.26.2. ReadyToDepartReply

<<class>>

Returned in response to ReadyToDepartRequest.

1. Inherits from: Reply

2. Attributes:

a. ReadyToDepartReplyData data (Optional)

The reply payload.

19.5.4.27. SlotImprovementModeRequest/Reply

Edition: 27.0 6 906

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SlotImprovementModeRequest

Reply: SlotImprovementModeReply

Response time: 13 / 140 / 690 (ms)

Default settings: request count quotas

SOAP operation:

SlotImprovementModeReply submitSlotImprovementMode(SlotImprovementModeRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits a slot improvement mode request (RFI or SIM).

19.5.4.27.1. SlotImprovementModeRequest

<<class>>

Slot Improvement Mode Request ( RFI or SWM ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. SlotImprovementStrategy slotImprovementStrategy (Mandatory)

Edition: 27.0 6 907

Document Title: NM 27.0 - NM B2B Reference Manual

Slot improvement strategy.

19.5.4.27.2. SlotImprovementModeReply

<<class>>

Returned in response to SlotImprovementModeRequest.

1. Inherits from: Reply

2. Attributes:

a. SlotImprovementModeReplyData data (Optional)

The reply payload.

19.5.4.28. ReroutingProposalRejectedRequest/Reply

MEP: S-R/R

Request: ReroutingProposalRejectedRequest

Reply: ReroutingProposalRejectedReply

Response time: 25 / 160 / 190 (ms)

Default settings: request count quotas

SOAP operation:

ReroutingProposalRejectedReply
submitReroutingProposalRejected(ReroutingProposalRejectedRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits a rerouting proposal rejected request request (RJT).

19.5.4.28.1. ReroutingProposalRejectedRequest

Edition: 27.0 6 908

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Rerouting Proposal Rejected Request ( RJT ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. ReroutingRouteId reroutingReference (Mandatory)

Rerouting reference.

19.5.4.28.2. ReroutingProposalRejectedReply

<<class>>

Returned in response to ReroutingProposalRejectedRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingProposalRejectedReplyData data (Optional)

The reply payload.

19.5.4.29. SlotProposalFeedbackRequest/Reply

Edition: 27.0 6 909

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SlotProposalFeedbackRequest

Reply: SlotProposalFeedbackReply

Response time: 380 / 500 / 510 (ms)

Default settings: request count quotas

SOAP operation:

SlotProposalFeedbackReply submitSlotProposalFeedback(SlotProposalFeedbackRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits a slot proposal feedback request (SPA or SJR).

19.5.4.29.1. SlotProposalFeedbackRequest

<<class>>

Slot Proposal Feedback Request ( SPA or SJR ).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. boolean slotProposalAccepted (Mandatory)

Flag indicating whether the slot proposal has been accepted or not.

b. TimeHourMinute proposalCalculatedTakeOffTime (Mandatory)

Proposal calculated take off time.

Edition: 27.0 6 910

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.29.2. SlotProposalFeedbackReply

<<class>>

Returned in response to SlotProposalFeedbackRequest.

1. Inherits from: Reply

2. Attributes:

a. SlotProposalFeedbackReplyData data (Optional)

The reply payload.

19.5.4.30. FlightCriticalityRequest/Reply

MEP: S-R/R

Request: FlightCriticalityRequest

Reply: FlightCriticalityReply

Response time: not available

Default settings: request count quotas

SOAP operation:

FlightCriticalityReply submitFlightCriticality(FlightCriticalityRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Sets or updates the criticality of a flight.

19.5.4.30.1. FlightCriticalityRequest

Edition: 27.0 6 911

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to set or update the criticality of a flight.

Note that this service is subject to authorization as it is trial related (e.g. SESAR/NMVP). So it is only
available during specific trials or on specific test platforms. In order to set the flight criticiality in
an non-trial related context, please use EhelpDeskTicketCreationRequest or
EhelpDeskTicketUpdateRequest (those services allow to set the flight criticality).

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. FlightCriticalityIndicator flightCriticality (Mandatory)

Flight criticality to set or update.

19.5.4.30.2. FlightCriticalityReply

<<class>>

Edition: 27.0 6 912

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to FlightCriticalityRequest.

1. Inherits from: Reply

2. Attributes:

a. FlightCriticalityReplyData data (Optional)

19.5.4.31. ReroutingFeedbackRequest/Reply (new 27.0)

MEP: S-R/R

Request: ReroutingFeedbackRequest

Reply: ReroutingFeedbackReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingFeedbackReply submitReroutingFeedback(ReroutingFeedbackRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Submits flight rerouting feedback.

19.5.4.31.1. ReroutingFeedbackRequest (new 27.0)

Edition: 27.0 6 913

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to submit a flight rerouting feedback.

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. ReroutingFeedbackAction feedbackAction (Mandatory)

The feedback action.

b. ReroutingFeedback feedback (Mandatory)

The rerouting feedback to submit.

Edition: 27.0 6 914

Document Title: NM 27.0 - NM B2B Reference Manual

19.5.4.31.2. ReroutingFeedbackReply (new 27.0)

<<class>>

Returned in response to ReroutingFeedbackRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingFeedbackReplyData data (Optional)

19.6. FlightSafety Port Type

19.6.1. Overview

1. The EC maintains a list of "green" third countries (understand, not in the EU territory). All
aircraft operators that are SAFA-compliant may fly from all airports of these green countries.
For airports that are not in the green country list neither in the EU territory, aircraft operators
must get accreditations for their departure airports. So an ACC3 accreditation applies to a (AO,
AD) pair. The EC requests Eurocontrol to operate an alerting service when a flight plan is
submitted by a non-accredited (AO, AD) pair - also in case of diversion (airborne). In this
context, the FlightSafety service is limited to setting the full accreditation list, typically sent to us
once a day:

a. S-R/R ACC3AccreditationListReplacementRequest/Reply

b. S-R/R TCOAuthorisationListReplacementRequest/Reply

c. S-R/R TCOAuthorisationListUpdateRequest/Reply

19.6.2. Requests/Replies

19.6.2.1. ACC3AccreditationListReplacementRequest/Reply

Edition: 27.0 6 915

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ACC3AccreditationListReplacementRequest

Reply: ACC3AccreditationListReplacementReply

Response time: 1500 / 2000 / 2500 (ms)

Default settings: request count quotas

SOAP operation:

ACC3AccreditationListReplacementReply
replaceACC3AccreditationList(ACC3AccreditationListReplacementRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Replaces the ACC3 Accreditation List.

19.6.2.1.1. ACC3AccreditationListReplacementRequest

<<class>>

An ACC3 accreditation list replacement request.

1. Inherits from: Request

2. Attributes:

a. ACC3Accreditation[] accreditations (Mandatory)

Edition: 27.0 6 916

Document Title: NM 27.0 - NM B2B Reference Manual

The accreditations.

19.6.2.1.2. ACC3AccreditationListReplacementReply

<<class>>

Returned in response to ACC3AccreditationListReplacementRequest.

1. Inherits from: Reply

2. Attributes:

a. ACC3AccreditationListReplacementReplyData data (Optional)

The data.

19.6.2.2. TCOAuthorisationListReplacementRequest/Reply

MEP: S-R/R

Request: TCOAuthorisationListReplacementRequest

Reply: TCOAuthorisationListReplacementReply

Response time: 11000 / 13000 / 13000 (ms)

Default settings: request count quotas

SOAP operation:

TCOAuthorisationListReplacementReply
replaceTCOAuthorisationList(TCOAuthorisationListReplacementRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Replaces the TCO Authorisation List.

19.6.2.2.1. TCOAuthorisationListReplacementRequest

Edition: 27.0 6 917

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

A TCO authorisation list replacement request.

1. Inherits from: Request

2. Attributes:

a. set< TCOAuthorisation > authorisations (Mandatory)

The authorisations.

19.6.2.2.2. TCOAuthorisationListReplacementReply

<<class>>

Returned in response to TCOAuthorisationListReplacementRequest.

A TCO authorisation list replacement reply.

1. Inherits from: Reply

Edition: 27.0 6 918

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. TCOAuthorisationListReplacementReplyData data (Optional)

The data.

19.6.2.3. TCOAuthorisationListUpdateRequest/Reply

MEP: S-R/R

Request: TCOAuthorisationListUpdateRequest

Reply: TCOAuthorisationListUpdateReply

Response time: 6700 / 7400 / 7900 (ms)

Default settings: request count quotas

SOAP operation:

TCOAuthorisationListUpdateReply
updateTCOAuthorisationList(TCOAuthorisationListUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Updates the TCO Authorisation List.

19.6.2.3.1. TCOAuthorisationListUpdateRequest

Edition: 27.0 6 919

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

A TCO authorisation list update request.

1. Inherits from: Request

2. Attributes:

a. set< TCOAuthorisationUpdate > authorisations (Mandatory)

The authorisations.

19.6.2.3.2. TCOAuthorisationListUpdateReply

<<class>>

Returned in response to TCOAuthorisationListUpdateRequest.

A TCO authorisation list update reply.

1. Inherits from: Reply

2. Attributes:

a. TCOAuthorisationListUpdateReplyData data (Optional)

The data.

19.7. Data Types

19.7.1. ACC3Accreditation
<<class>>

An ACC3 accreditation applies to an aircraft operator departing from an aerodrome. The whole
accreditation list replacement is a single transaction: it fully succeeds or fully fails.

1. Attributes:

Edition: 27.0 6 920

Document Title: NM 27.0 - NM B2B Reference Manual

a. ACC3AccreditationId id (Mandatory)

Unique id of the accreditation — unique within the accreditation list that applies at any
point in time.

b. AerodromeIATAOrICAOId adId (Mandatory)

Contains either the IATA id or the ICAO id of the departure aerodrome to which the
accreditation applies.

c. AircraftOperatorIATAOrICAOId aoId (Mandatory)

Contains either the IATA id or the ICAO id of the aircraft operator to which the accreditation
applies.

2. Used by: ACC3AccreditationListReplacementRequest

19.7.2. ACC3AccreditationId
<<typedef[string]>>

Uniquely identifies an ACC3 accreditation.

1. Pattern: (ALPHA|DIGIT|/|_|*|-){0,100}

2. Used by: ACC3Accreditation

19.7.3. ACC3AccreditationListReplacementReplyData
<<class>>

The ACC3AccreditationListReplacementReply payload.

1. Used by: ACC3AccreditationListReplacementReply

19.7.4. ACDMAlertCode (new 27.0)

<<typedef[string]>>

Code of an A-CDM alert.

1. Pattern: UALPHA{3}DIGIT{2}LALPHA{0,1}

2. Used by: ACDMAlertData, ACDMAlertReplyData, ACDMAlertRequest

19.7.5. ACDMAlertData (new 27.0)

<<class>>

An active A-CDM alert.

1. Attributes:

Edition: 27.0 6 921

Document Title: NM 27.0 - NM B2B Reference Manual

a. ACDMAlertCode alertCode (Mandatory)

The code of the A-CDM alert.

b. DateTimeMinute timestamp (Mandatory)

The time at which the alert has become active.

c. string inconsistencyDetected (Mandatory)

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

d. string actionToTake (Mandatory)

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

e. string consequencesNote (Optional)

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,100}

f. ACDMAlertSeverity severity (Optional)

2. Used by: Flight

19.7.6. ACDMAlertReplyData (new 27.0)

<<class>>

The ACDMAlertReply payload.

1. Attributes:

a. ACDMAlertCode alertCode (Mandatory)

The code of the A-CDM alert.

b. boolean active (Mandatory)

true if the alert is active. false if the alert is cancelled.

2. Used by: ACDMAlertReply

19.7.7. ACDMAlertSeverity (new 27.0)

<<enumeration>>

Enumeration of possible severity levels for an A-CDM alert.

1. Values:

Edition: 27.0 6 922

Document Title: NM 27.0 - NM B2B Reference Manual

a. HIGH

b. MEDIUM

c. LOW

2. Used by: ACDMAlertData, ACDMAlertRequest

19.7.8. ActualTimeAtTarget
<<class>>

1. Attributes:

a. DateTimeMinute estimatedActualTimeAtTarget (Mandatory)

The actual time over (estimated according to the CTFM point profile)

b. IntervalPosition targetTimeCompliance (Mandatory)

Indicates if the actualTimeOver is compliant or outside of the target time window (target
time +/- 3 minutes)

2. Used by: TargetTime

19.7.9. Aerodrome
<<union>>

Describes an aerodrome in the flight plan context.

1. Choices:

a. AerodromeICAOId icaoId

The ICAO id of this aerodrome.

b. OtherAerodromeDesignation otherDesignation

Name and location of the aerodrome if the ICAO id is not provided for this aerodrome. ICAO
DEP/ or DEST/

2. Used by: FlightArrivalRequest, AerodromesOfDestination, FlightPlanUpdate, FlightPlan

19.7.10. AerodromeDAL
<<class>>

Aerodrome id and its cumulative ground projected distance along the trajectory.

1. Attributes:

a. AerodromeICAOId aerodrome (Mandatory)

Edition: 27.0 6 923

Document Title: NM 27.0 - NM B2B Reference Manual

Aerodrome ICAO id.

b. DistanceM cumulativeDistance (Mandatory)

Cumulative ground projected distance along the trajectory.

2. Used by: DistanceAtLocation

19.7.11. AerodromeName_DataType
<<typedef[string]>>

The name of the aerodrome.

1. Pattern: ANY{1,50}

2. Used by: OtherAerodromeDesignation

19.7.12. AerodromeNameLocationDescription_DataType
<<typedef[string]>>

Description of name and location of the aerodrome.

1. Pattern: ANY{1,100}

2. Used by: AlternateAerodrome

19.7.13. AerodromeRole
<<enumeration>>

Documentation last updated: 27.0 - Edition 4

Specifies the role of an aerodrome in a flight.

1. Values:

a. DEPARTURE

Documentation last updated: 27.0 - Edition 4

The aerodrome is meant as departure.

b. ARRIVAL

Documentation last updated: 27.0 - Edition 4

The aerodrome is meant as arrival.

c. GLOBAL (new 27.0)

Documentation last updated: 27.0 - Edition 4

Edition: 27.0 6 924

Document Title: NM 27.0 - NM B2B Reference Manual

The aerodrome is meant as departure or arrival.

d. ALTERNATE (new 27.0)

Documentation last updated: 27.0 - Edition 4

The aerodrome is meant as alternate.

2. Used by: FlightListByAerodromeRequest, TrafficCountsByAerodromeRequest,

TrafficCountsByAerodromeSetRequest, FlightListByAerodromeSetRequest

19.7.14. AerodromesOfDestination
<<class>>

Represents an aerodrome of destination in a flight plan, together with its alternates.

1. Attributes:

a. Aerodrome aerodromeOfDestination (Mandatory)

Aerodrome of destination.

b. AlternateAerodrome alternate1 (Optional)

First alternate aerodrome of destination.

i. Constraints:

▪ AerodromesOfDestination.ALTERNATE2_MUST_BE_NULL_IF_ALTERNATE1_IS_NULL

c. AlternateAerodrome alternate2 (Optional)

Second alternate aerodrome of destination.

i. Constraints:

▪ AerodromesOfDestination.ALTERNATE2_MUST_BE_NULL_IF_ALTERNATE1_IS_NULL

2. Constraints:

a. ALTERNATE2_MUST_BE_NULL_IF_ALTERNATE1_IS_NULL

alternate2 must be null if alternate1 is null.

Constrained attributes: alternate1, alternate2

Constrained requests: any using request

3. Used by: FlightPlanUpdate, FlightPlan

19.7.15. AirborneFilingReplyData
<<class>>

Edition: 27.0 6 925

Document Title: NM 27.0 - NM B2B Reference Manual

Details about the processing of FNM/MFS requests.

1. Inherits from: FilingReplyData

2. Used by: FlightUpdateReplyData

19.7.16. AircraftIATAId
<<typedef[string]>>

Concatenation of the carrierIdentification , the iataFlightNumber and optionally a suffix .

1. carrierIdentification - Code of the Aircraft Operator of the identified flight as defined in the
Schedule [AIDX, UFI].

Examples: - BA

2. iataFlightNumber - IATA flight number of the identified flight as defined in the Schedule [AIDX,
UFI].

Examples: - 066

3. suffix - Suffix of the IATA flight number as defined in the Schedule [AIDX, UFI].

Examples: - Z

1. Pattern: ((UALPHA{3}|UALPHA{2})|((DIGIT)(UALPHA))|((UALPHA)(DIGIT)))DIGIT{1,4}ALPHA{0,1}

2. Used by: GeneralAPIRequest, AircraftIATAIdFromDataSource, ArrivalInformation,

PredictedDPIRequest, CDMInfo, ACDMAlertRequest, FlightPlanUpdate, IATAFlightKeys, FlightPlan

19.7.17. AircraftIATAIdFromDataSource (new 27.0)

<<class>>

A IATA flight designator and the data source it comes from: FPM if available, else DPI if available, else
API if available, else DDR.

1. Attributes:

a. AircraftIATAId id (Mandatory)

The IATA flight designator from the data source.

b. AircraftIdDataSource dataSource (Mandatory)

The data source.

2. Used by: Flight

Edition: 27.0 6 926

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.18. AircraftICAOId
<<typedef[string]>>

ICAO aircraft identification as defined in ICAO doc 4444 Appendix 2, section 2.

1. Pattern: (ALPHA|DIGIT){2,7}

2. Used by: CDMInfo, AircraftIdentification, FlightInformationUpdateRequest, UpdateDPIRequest

19.7.19. AircraftIdDataSource (new 27.0)

<<enumeration>>

An aircraft id data source.

1. Values:

a. DDR

The DDR data source - see Data Demand Repository.

b. API

The API data source - see API Implementation Guide.

c. DPI

The DPI data source - see European Airport CDM.

d. FPM

The FPM data source - see IFPS Users Manual.

2. Used by: AircraftIATAIdFromDataSource

19.7.20. AircraftIdentification
<<class>>

Aircraft identification: groups the ICAO aircraft id (designator of the aircraft operator followed by
the flight identifier) possibly completed with other related data, e.g. registration mark and ICAO
aircraft address.

1. Attributes:

a. AircraftICAOId aircraftId (Contextual)

Aircraft id. ICAO Item 7.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest

Edition: 27.0 6 927

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Mandatory otherwise

b. AircraftRegistrationMark registrationMark (Optional)

Registration mark of the aircraft. ICAO Item 18 REG/.

c. ICAOAircraftAddress aircraftAddress (Contextual)

ICAO address of the aircraft, formerly known as mode S address. ICAO item 18 CODE/.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

d. SSRInfo ssrInfo (Contextual)

SSR code assigned to the aircraft by the ATS and its transmission mode. ICAO Item 7.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

2. Used by: FlightPlan

19.7.21. AircraftIdentificationUpdate
<<class>>

See AircraftIdentification.

1. Attributes:

a. AircraftRegistrationMark registrationMark (Optional)

Registration mark of the aircraft. ICAO Item 18 REG/.

b. ICAOAircraftAddress aircraftAddress (Optional)

Address of the aircraft. ICAO item 18 CODE/.

c. SSRInfo ssrInfo (Optional)

SSR code assigned to the aircraft by the ATS and its transmission mode. ICAO item 7.

2. Used by: FlightPlanUpdate

19.7.22. AircraftOperatorFilter (new 27.0)

<<class>>

This type provides a way of describing a selection of aircraft operators to be used for filtering flight

Edition: 27.0 6 928

Document Title: NM 27.0 - NM B2B Reference Manual

plan-related messages based on the ArcId (flight plan field 7b) and OPR/ subfield (field 18).

The type has three attributes, each acting as a selector or filter in its own way.

The following table, together with the textual explanation of each attribute below, should provide
sufficient information on how each of the three filtering attributes matches each possible
combination of ArcId and OPR/ fields.

• The upper part of the table shows all possible combinations of ArcId and OPR/ for a hypothetical
airline AAA. For example combination (1) means AAA is specified both in the ArcId and in the
OPR/ subfield; combination (2) means that the ArcId contains AAA but the OPR/ is either empty
or unrecognized; and so on.

• The lower part of the table shows how setting the value 'AAA' in each filtering attribute matches
the above combinations.

Table 45. FLIGHT_FILING_RESULT filtering by Aircraft Operator

(1) (2) (3) (4) (5)

ArcId and OPR/ A.O. in ArcId (field 7b) AAA AAA AAA BBB -
combinations in
flight plan A.O. in OPR/ (field 18) AAA - BBB AAA AAA

Subscription filters aircraftOperatorsARCID=[AAA] Y Y Y

by aircraft aircraftOperatorsOPR=[AAA] Y Y Y
operators
operatingAircraftOperators=[AAA] Y Y Y Y

1. Attributes:

a. set< AircraftOperatorICAOId > aircraftOperatorsARCID (Optional)

A set of aircraft operators ICAO identifiers.

Each item in the set will be compared with the aircraft operator ICAO id derived from the
aircraft id (flight plan field 7b).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

b. set< AircraftOperatorICAOId > aircraftOperatorsOPR (Optional)

A set of aircraft operators ICAO identifiers.

Each item in the set will be compared with the aircraft operator ICAO id derived from the
OPR/ subfield (flight plan field 18).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

Edition: 27.0 6 929

Document Title: NM 27.0 - NM B2B Reference Manual

c. set< AircraftOperatorICAOId > operatingAircraftOperators (Optional)

A set of aircraft operators ICAO identifiers.

Each item in the set will be compared with the aircraft operator ICAO id derived from the
OPR/ subfield (flight plan field 18).

In case the aircraft operator could not be derived from the OPR/ subfield, and only in such
case, the comparison is performed with the aircraft operator derived from the arcId (field
7b).

i. Constraints:

▪ set size range : [1, 20]

▪ AircraftOperatorFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

At least one of aircraftOperatorsARCID , aircraftOperatorsOPR and

operatingAircraftOperators must be present and not empty.

Constrained attributes: aircraftOperatorsARCID, aircraftOperatorsOPR,

operatingAircraftOperators

Constrained requests: any using request

3. Used by: FlightFilingResultMessageFilter

19.7.23. AircraftOperatorIATAOrICAOId
<<typedef[string]>>

IATA or ICAO id of an aircraft operator.

1. Pattern: UALPHA{3}|(UALPHA|DIGIT){2}(UALPHA|DIGIT|*){0,1}

2. Used by: ACC3Accreditation

19.7.24. AircraftOperatorICAOId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

Examples
AFR, BAW, TAP, …

1. Pattern: ALPHA{3}

2. Used by: FlightSetDefinitionElement, FlightListByLocationRequest,

TrafficCountsByAircraftOperatorRequest, AircraftOperatorFilter, Flight,
StructuredFlightPlanData

Edition: 27.0 6 930

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.25. AircraftOperatorName_DataType
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

Examples
XJC XCLUSIVE JET CHARTER AND MANAGEMENT 442380696992, ZENITH AVIATION, TURKISH
AIR FORCE, …

1. Pattern: (UALPHA|DIGIT|'|\(|\)|+|,|=|?|.|/|:|WHITESPACE){0,50}

2. Used by: OtherInformation

19.7.26. AircraftPerformanceCategory
<<enumeration>>

Aircraft performance categories as defined in the Procedures for Air Navigation Services - Aircraft
Operations (PANS-OPS, Doc 8168).

1. Values:

a. CAT_A

less than 169 km/h indicated airspeed (IAS)

b. CAT_B

169 km/h or more but less than 224 km/h IAS

c. CAT_C

224 km/h or more but less than 261 km/h IAS

d. CAT_D

261 km/h or more but less than 307 km/h IAS

e. CAT_E

307 km/h or more but less than 391 km/h IAS

f. CAT_H

Helicopters

2. Used by: OtherInformation

19.7.27. AircraftPositionReport
<<class>>

Edition: 27.0 6 931

Document Title: NM 27.0 - NM B2B Reference Manual

This type is used to provide aircraft position report.

1. Attributes:

a. FourDFlightPoint position (Mandatory)

The position.

2. Used by: FlightUpdateChoice

19.7.28. AircraftRegistrationMark
<<typedef[string]>>

Examples
011, 0216, GEUYC, Z BAM, YV2726, QH3023T, HT21A 1 …

1. Pattern: (ALPHA|DIGIT|SPECIAL_CHARACTER){1,50}

2. Used by: FlightUpdateRequest, GeneralAPIRequest, FlightFilingResultMessage,

FlightSetDefinitionElement, ArrivalInformation, FlightListByAircraftRegistrationMarkRequest,
AircraftIdentificationUpdate, TCOAuthorisation, CDMInfo, Flight, AircraftIdentification,
UpdateDPIRequest

19.7.29. AircraftType
<<union>>

Describes an aircraft type in the flight plan context.

1. Choices:

a. AircraftTypeICAOId icaoId

The ICAO id of this aircraft type. ICAO Item 9.

b. OtherAircraftTypeDesignation_DataType otherDesignation

Name of the aircraft type if no ICAO id exists for this aircraft type, or the Number and
Names of multiple different (ICAO, or non ICAO) aircraft types. ICAO item 18 TYP/

2. Used by: CDMInfo, FlightPlanUpdate, FlightPlan

19.7.30. AircraftTypeIATAId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

IATA identifier of an aircraft type.

Examples
320, 744, D20, …

Edition: 27.0 6 932

Document Title: NM 27.0 - NM B2B Reference Manual

1. Pattern: (UALPHA|DIGIT){3}

2. Used by: CDMInfo, UpdateDPIRequest

19.7.31. AircraftTypeICAOId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

ICAO identifier of an aircraft type.

Examples
A7, A50, A310, A30B, AA1, AC5A, …

1. Pattern: ALPHA{1}(ALPHA|DIGIT){1,3}

2. Used by: FlightUpdateRequest, GeneralAPIRequest, ReroutingApplyReplyDataResult, AircraftType,

ArrivalInformation, RoutingAssistanceReplyDataResult, Flight, UpdateDPIRequest

19.7.32. AirFiledData
<<class>>

Estimate data for an air-filed (AFIL) flight plan, i.e. a point, the joining flight level and the estimate
date/time at this point. Note that the flight level indicated is the level at which the flight has been
cleared to join controlled airspace over the point indicated: it does not have to be the same as the
requested flight level.

1. Attributes:

a. AtsUnitId_DataType atsUnitId (Optional)

ICAO id of the ATS unit from which supplementary flight plan data can be obtained.

b. ICAOPoint startingPoint (Mandatory)

Starting point.

c. FlightLevel clearedLevel (Mandatory)

Level at which the aircraft has been cleared to join controlled airspace over the given point.

d. DateTimeSecond estimatedTimeOver (Mandatory)

Estimated date/time over the given point.

2. Used by: FlightPlan

19.7.33. AirportSlot
<<typedef[string]>>

Edition: 27.0 6 933

Document Title: NM 27.0 - NM B2B Reference Manual

1. Pattern: TEXT{1,10}

2. Used by: FlightPlanUpdate, FlightPlan

19.7.34. AllowedIFPSErrorViolations
<<enumeration>>

Enumeration of possible allowed IFPS error violations ( RoutingAssistanceRequest ).

1. Values:

a. NONE

No errors allowed. The alternative routes proposed will be fully IFPS compliant.

b. RAD_ONLY

The alternative routes proposed might not all be IFPS compliant: they might have RAD
errors.

c. ALL

The alternative routes proposed might not all be IFPS compliant: they might have IFPS
errors (a.o., RAD errors, CDR route availability problems, DCT related problems).

2. Used by: RoutingAssistanceRequest

19.7.35. AlternateAerodrome
<<union>>

An alternate aerodrome. It is represented as either an ICAO aerodrome code or a free text

description of the aerodrome if no ICAO code exist (ZZZZ in ICAO 4444 item 16).

1. Choices:

a. AerodromeICAOId icaoId

The ICAO id of this aerodrome.

b. AerodromeNameLocationDescription_DataType nameLocationDescription

Description of name and location of the aerodrome if the ICAO id is not provided for this
aerodrome. ICAO ALTN/

2. Used by: AerodromesOfDestination

19.7.36. AlternateAerodrome_DataType
<<typedef[string]>>

Aerodromes where the aircraft may land in case of emergency along the route.

Edition: 27.0 6 934

Document Title: NM 27.0 - NM B2B Reference Manual

1. Pattern: ANY{1,100}

2. Used by: FlightPlanUpdate, FlightPlan

19.7.37. AlternativeRouteInfo (new 27.0)

<<class>>

Description of a route (and related info) in the context of a rerouting opportunity.

1. Attributes:

a. ReroutingRouteId routeId (Mandatory)

The alternative route generated identifier.

This identifier includes the source that generated this particular route (route
NOTE
generator, route catalogue, etc.).

b. string icaoRoute (Mandatory)

The complete field 15 that can be used as the alternative route.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

c. DurationHourMinute duration (Optional)

Duration of the alternative route.

d. SignedDurationHourMinute deltaDuration (Optional)

The duration difference between the current and the alternative route. A negative value
indicates a shorter duration.

e. DistanceNM length (Optional)

Length of the alternative route from ADEP to ADES.

f. SignedDistanceNM deltaLength (Optional)

The length difference between the current and the alternative route. A negative value
indicates a shorter length.

g. SignedDurationHourMinute delay (Optional)

The delay associated to the alternative route (i.e., new CTOT - ETOT).

Not present if no CTOT.

h. SignedDurationHourMinute deltaDelay (Optional)

The delay difference between the current and the alternative route. A negative value

Edition: 27.0 6 935

Document Title: NM 27.0 - NM B2B Reference Manual

indicates a shorter delay.

i. Cost routeChargeIndicator (Optional)

Gives an indication about the route charges corresponding to the alternative route.

j. Cost deltaRouteChargeIndicator (Optional)

The route charges difference between the current and the alternative route. A negative
value indicates lower route charges.

k. WeightKg consumedFuelIndicator (Optional)

Gives an indication about the fuel consumed for the alternative route.

l. SignedWeightKg deltaConsumedFuelIndicator (Optional)

The consumed fuel difference between the current and the alternative route. A negative
value indicates less consumed fuel.

m. Cost totalCost (Mandatory)

The total cost of the alternative route, computed from the cost criteria specified in the
rerouting (length, duration, delay, route charges, fuel consumption, etc.). This total cost is
used to sort the alternatives.

2. Used by: ReroutingOpportunities

19.7.38. APISubmissionRules
<<class>>

Identifies the API (Arrival Planning Information) service(s) that can be used to submit TTA (Target
Time of Arrival) requests for this flight.

The general rule is that TargetTakeOffAPIRequest should be used for pre-departure flights, and
TargetTimeOverAPIRequest should be used for flights in execution phase, with an overlapping time
period before off-block when any of the two services can be used.

1. Attributes:

a. DateTimeMinute latestSubmissionTargetTakeOffAPI (Optional)

The deadline for submission of a TTA request using TargetTakeOffAPIRequest service.

Usually the deadline is OBT - TRS but other rules may apply.

If the field is not present, it means that TargetTakeOffAPIRequest cannot be used, because
the deadline has already expired, or any other reason (e.g. the flight status doesn’t allow it,
or the CTOT has been forced in an en-route regulation).

b. DateTimeMinute earliestSubmissionTargetTimeOverAPI (Optional)

Edition: 27.0 6 936

Document Title: NM 27.0 - NM B2B Reference Manual

The starting time for submission of a TTA request using TargetTimeOverAPIRequest service.

If the field is not present, it means that TargetTimeOverAPIRequest cannot be used (e.g.
because the flight status doesn’t allow it).

2. Used by: Flight

19.7.39. ArrivalInformation
<<class>>

1. Attributes:

a. ATVFlightStatusInbound flightStatusInbound (Optional)

The last ATV flight status inbound provided by a valid API.

b. AircraftRegistrationMark registrationMark (Optional)

The last aircraft registration mark provided by a valid GeneralAPI.

c. AircraftTypeICAOId aircraftType (Optional)

The last ICAO Aircraft type provided by a valid GeneralAPI.

d. AircraftIATAId aircraftIATAId (Optional)

The last aircraft IATA identifier provided by a valid GeneralAPI.

e. DurationHourMinute arrivalTaxiTime (Optional)

The last estimated or actual taxi time from landing to gate provided by a valid GeneralAPI.

f. TerminalProcedure apiArrivalProcedure (Optional)

The last Standard Instrument Arrival Route identifier provided by a valid GeneralAPI and
known by NMOC.

g. TerminalProcedure nmArrivalProcedure (Optional)

The identifier of the Standard Instrument Arrival Route currently selected by NMOC. It may
differ from apiArrivalProcedure (if any) e.g. in case the apiArrivalProcedure violates a
restriction.

h. PublishedPointId initialApproachFix (Optional)

The initial approach fix.

i. RunwayId arrivalRunway (Optional)

The identifier of the last assigned arrival runway provided by a valid GeneralAPI.

j. TerminalOrApronStandName arrivalTerminal (Optional)

Edition: 27.0 6 937

Document Title: NM 27.0 - NM B2B Reference Manual

The identifier of the last arrival terminal provided by a valid GeneralAPI.

k. TerminalOrApronStandName arrivalApronStand (Optional)

The identifier of the last arrival apron stand provided by a valid GeneralAPI.

l. DurationHourMinute minimumTurnaroundTime (Optional)

The last minimum turn-around time provided by a valid GeneralAPI.

m. DateTimeMinute landingTime (Optional)

The last estimated or actual landing time provided by a valid GeneralAPI.

n. DateTimeMinute scheduledInBlockTime (Optional)

The last scheduled in-block time provided by a valid GeneralAPI.

o. DateTimeMinute inBlockTime (Optional)

The last estimated or actual in-block time provided by a valid GeneralAPI.

p. DateTimeMinute airportSlotArrival (Optional)

The last airport arrival slot provided by a valid GeneralAPI.

q. ImpactSeverityIndicator impactSeverityIndicator (Optional)

The last impact assessment of a non-punctual arrival provided by a valid GeneralAPI.

r. AerodromeOrPublishedPointId coordinationFix (Optional)

The coordination fix for the target time(s) provided by the last valid TargetTakeOffAPI or
TargetTimeOverAPI.

s. DateTimeMinute targetTimeOver (Optional)

The target time over the coordination fix provided by the last valid TargetTimeOverAPI.

Reset to null on reception of a TargetTakeOffAPI.

t. DateTimeMinute earliestTargetTimeOver (Optional)

The earliest target time over the coordination fix provided by the last valid
TargetTakeOffAPI. Reset to null on reception of a TargetTimeOverAPI.

u. DateTimeMinute consolidatedTargetTimeOver (Optional)

The consolidated target time over the coordination fix provided by the last valid
TargetTakeOffAPI.

Reset to null on reception of a TargetTimeOverAPI.

Edition: 27.0 6 938

Document Title: NM 27.0 - NM B2B Reference Manual

v. DateTimeMinute calculatedTimeOver (Optional)

The calculated (by NMOC) time over the coordination fix in response to the last valid
TargetTakeOffAPI.

w. RegulationId regulationId (Optional)

The identifier of the arrival-related regulation indicated by the last valid TargetTakeOffAPI.
Reset to null on reception of a TargetTimeOverAPI.

x. DateTimeMinute minCalculatedTimeOver (Optional)

The minimum possible calculated time over the coordination fix that could be returned in
calculatedTimeOver if there were no regulation more penalising than regulationId. This
value depends on the flight plan time over and the target take-off times from departure
airport (if A-CDM).

It is null if the flight no longer crosses the coordination fix or is no longer subject to
regulationId .

y. DateTimeMinute maxCalculatedTimeOver (Optional)

The maximum possible calculated time over the coordination fix that can be returned in
calculatedTimeOver. This value corresponds to the end of the period of regulationId,
adjusted by the duration between entry time into regulationId and time over the
coordination fix.

It is null if the flight no longer crosses the coordination fix or is no longer subject to
regulationId .

z. DateTimeMinute estimatedOrActualTimeOver (Optional)

The most accurate time over the coordination fix known by NMOC.

It is null if the flight no longer crosses the coordination fix.

2. Used by: Flight

19.7.40. ArrivalPlanningInformationRequest

Edition: 27.0 6 939

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Base class of all Arrival Planning Information requests.

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. ATVFlightStatusInbound flightStatusInbound (Mandatory)

Flight Status as known by the airport, for an inbound flight.

b. TerminalProcedure arrivalProcedure (Optional)

Standard Instrument Arrival Route identifier.

Acronym: STAR.

19.7.41. ATCDPIReplyData
<<class>>

The ATCDPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: ATCDPIReply

19.7.42. ATFMError (new 27.0)

<<enumeration>>

Represents a comment returned by the ETFMS system in a reply to some operations (e.g. API, DPI

Edition: 27.0 6 940

Document Title: NM 27.0 - NM B2B Reference Manual

submission).

The comment may represent an error that prevented an operation from being executed or a
warning in case the operation could still be executed (or partially executed).

1. Values:

a. RVR_CRITERIA_NOT_MET

RVR CRITERIA NOT MET

b. RVR_UNKNOWN

UNKNOWN RVR

c. AD_AS_PT_NOT_AVAILABLE

AERODROME OR AIRSPACE OR POINT NOT AVAILABLE

d. EOBT_BEFORE_LAST_OBT

THE NEW EOBT IS BEFORE THE LAST RECEIVED OBT

e. DO_NOT_CONFIRM_NON_SUSPENDED_FLIGHT

NO NEED TO CONFIRM NON SUSPENDED FLIGHT

f. TIME_OUT_OF_RANGE

A TIME FIELD IS OUTSIDE ACCEPTABLE RANGE

g. TOO_EARLY_OR_TOO_LATE

MESSAGE RECEIVED TOO EARLY OR TOO LATE

h. TAKE_OFF_TIME_OUT_OF_BOUNDS

PROVIDED TAKE OFF TIME OUT OF BOUNDS

i. TTOT_OUSIDE_TOLERANCE_WINDOW

TTOT OUTSIDE SLOT TOLERANCE WINDOW

j. SPA_BUT_NO_SIP

SPA MESSAGE WHILE NO ON GOING SIP

k. CTOT_OUTSIDE_RANGE

THE NEW CTOT OF SPA/SRJ MESSAGE IS OUTSIDE ACCEPTABLE RANGE AROUND THE NEW
CTOT OF SIP MESSAGE

l. SMM_FOR_SUSPENDED_FLIGHT

Edition: 27.0 6 941

Document Title: NM 27.0 - NM B2B Reference Manual

SLOT MISSED MESSAGE RECEIVED FOR A SUSPENDED FLIGHT

m. NO_SLOT_ISSUED

MESSAGE RECEIVED BUT NO SLOT HAS BEEN ISSUED

n. FLIGHT_ALREADY_ACTIVATED

FLIGHT ALREADY ACTIVATED

o. FLIGHT_ALREADY_TERMINATED

FLIGHT ALREADY TERMINATED

p. FLIGHT_IS_CANCELLED

FLIGHT IS CANCELLED

q. FLIGHT_REROUTED_BY_AO

FLIGHT REROUTED BY AO

r. FLIGHT_REROUTED_FPL_CANCELED

FLIGHT REROUTED BY AO FPL CANCELLED

s. REROUTE_TIMEOUT

REROUTE TIMEOUT

t. REROUTE_CONDITION_CHANGED

REROUTE CONDITION CHANGED

u. FLIGHT_ALREADY_READY

FLIGHT ALREADY READY TO DEPART

v. NOT_IN_VALID_PERIOD

NOT IN VALID PERIOD

w. NOT_REPORTED_AIRBORNE

NOT REPORTED AS AIRBORNE

x. NOT_EXISTING_FLIGHT

NOT EXISTING FLIGHT

y. METEO_UPDATE

METEO UPDATE

Edition: 27.0 6 942

Document Title: NM 27.0 - NM B2B Reference Manual

z. SMM_RECEIVED

SMM RECEIVED

aa. EOBT_DLA_EXPECTED

PLEASE UPDATE EOBT WITH A DLA MSG

ab. FCM_IGNORED_FOR_FAM_SUSPENDED

CONFIRMATION MSG IGNORED FOR FLIGHT SUSPENDED BY FAM PLEASE USE DLA OR CHG
INSTEAD

ac. FCM_IGNORED_FOR_PAST_TOT

CONFIRMATION MSG IGNORED FOR FLIGHT WITH TAKE OFF TIME IN THE PAST PLEASE
USE DLA OR CHG INSTEAD

ad. FLIGHT_IS_SUPPOSED_AIRBORNE

FLIGHT IS SUPPOSED AIRBORNE

ae. TAXI_TIME_OUT_OF_RANGE

TAXI TIME OUT OF RANGE

af. FLIGHT_IS_SUSPENDED

FLIGHT IS SUSPENDED

ag. FLIGHT_SUSPENDED_BY_IFPS_REVAL

FLIGHT IS SUSPENDED BY IFPS REVALIDATION

ah. DPI_MSGS_INCORRECT_SEQUENCE

DPI MESSAGES NOT IN CORRECT SEQUENCE

ai. MISSING_RVR_OR_REGUL

MESSAGE REJECTED BECAUSE RVR AND/OR REGULATION MUST BE PROVIDED

aj. IRRELEVANT_REGULATIONS

MESSAGE CONTAINS IRRELEVANT REGULATIONS

ak. INVALID_ROUTE_BY_IFPS_REVAL

INVALID ROUTE BY IFPS REVALIDATION

al. ATFM_MSGS_AT_EOBT_MINUS_2_HOURS

NEW ATFM MESSAGES MAY POSSIBLY BE PUBLISHED AT 2 HOURS BEFORE THE EOBT

Edition: 27.0 6 943

Document Title: NM 27.0 - NM B2B Reference Manual

am. NO_MORE_SSR_CODES

NO MORE SSR CODES AVAILABLE FOR THIS FLIGHT

an. FLIGHT_NOT_YET_CONFIRMED_BY_FPL

MESSAGE RECEIVED BUT FLIGHT NOT YET CONFIRMED BY FLIGHT PLAN

ao. FLIGHT_HAS_RECEIVED_ARR_MSG

MESSAGE IGNORED FOR FLIGHT THAT HAS RECEIVED ARR MESSAGE

ap. CCACS_NO_CODE_YET

MESSAGE RECEIVED BUT CCAMS DID NOT SELECT A CODE YET

aq. UNIT_DIFFERENT_THAN_ASSIGNING_UNIT

MESSAGE RECEIVED FROM UNIT OTHER THAN THE ASSIGNING UNIT

ar. MINLINEUP_OUTSIDE_RANGE

PROVIDED MINLINEUP OUTSIDE ACCEPTED RANGE

[<MIN_MINLINEUP>,<MAX_MINLINEUP>]

as. FLIGHT_ALREADY_UNDER_ATC_CONTROL

FLIGHT ALREADY UNDER ATC CONTROL

at. FLIGHT_ALREADY_IN_THAT_STATE

FLIGHT ALREADY IN THAT STATE

au. UNDER_CDM_AT_DEP_AIRPORT

FLIGHT MANAGED BY CDM PROCESS AT DEPARTURE AIRPORT

av. SPA_BUT_RRP_ONGOING

SPA MESSAGE WHILE AN RRP IS ON GOING

aw. FLIGHT_IS_MANUALLY_SUSPENDED

FLIGHT IS MANUALLY SUSPENDED

ax. SUSPENDED_BY_DEP_AIRPORT

SUSPENDED BY DEPARTURE AIRPORT

ay. TOO_EARLY

MESSAGE RECEIVED TOO EARLY

Edition: 27.0 6 944

Document Title: NM 27.0 - NM B2B Reference Manual

az. SUSPENDED_DELAY_EXCEEDING_THRESHOLD

SUSPENDED DUE TO DELAY EXCEEDING THRESHOLD VALUE.

SEND FCM BEFORE RESPBY TO SECURE PTOT. ALTERNATIVELY, REROUTE, OR UPDATE EOBT
WITH A DLA MSG, OR CNL

ba. FCM_CONFIRMING_DELAY_ONLY_AFTER_SIT1

FCM CONFIRMING DELAY ONLY ALLOWED AFTER SIT1

bb. INCONSISTENT_IFPLID

IFPLID IN MESSAGE DOES NOT MATCH IFPLID OF FOUND FLIGHT

bc. FLIGHT_IS_SUSPENDED_DUE_TO_INVALID_ROUTE

FLIGHT IS SUSPENDED, ROUTE INVALID DUE TO DELAY, SEE ERROR(S),

PLEASE SEND DLA/CHG OR REROUTE THE FLIGHT

bd. REJECTED_DUE_TO_FORCED_CTOT

REJECTED DUE TO FORCED CTOT

be. FIX_NOT_ON_ROUTE

COORDINATION FIX NOT ON ROUTE

bf. FIX_UNKNOWN

COORDINATION FIX UNKNOWN

bg. GENERALLY_EXEMPTED

FLIGHT IS GENERALLY EXEMPTED FROM REGULATIONS

bh. TOO_LATE

MESSAGE RECEIVED TOO LATE

bi. NOT_SUBJECT_TO_REGUL

NOT SUBJECT TO REGULATION

bj. TTO_OUTSIDE_REGUL

TTO OUTSIDE REGULATION PERIOD

bk. UNREALISTIC_TTO

UNREALISTIC TTO

Edition: 27.0 6 945

Document Title: NM 27.0 - NM B2B Reference Manual

bl. INVALID_ROUTE_DUE_TO_TTOT_OR_SID_CHANGE

INVALID ROUTE DUE TO TTOT OR SID CHANGE

bm. NOT_REPORTED_OFF_BLOCK

NOT REPORTED OFF BLOCK

bn. NO_MATCHING_FPL_AND_SAME_ADEP_ADES

NO MATCHING FPL AND SAME ADEP ADES

bo. NO_MATCHING_FPL_AND_AERODROMES_UNDEFINED

NO MATCHING FPL AND AERODROMES UNDEFINED

bp. NO_MATCHING_FPL_AND_AERODROMES_UNKNOWN

NO MATCHING FPL AND AERODROMES UNKNOWN

19.7.43. ATFMMessageType
<<enumeration>>

Enumerates ATFM message types.

1. Values:

a. DES

DE-Suspension message

NM sends a DES when a flight not subject to ATFCM restrictions is de-suspended.

b. ERR

ERRor message

NM sends an ERR message when a message is received where:

1. Its syntax is incorrect and, therefore, cannot be processed or

2. The message or a part of the message is not relevant.

c. FCM

Flight Confirmation Message.

when:

1. An AO indicates to ETFMS the RVR capability of a flight with an EOBT in the future.Flight
Confirmation Message.

2. An AO indicates to ETFMS that a flight with an EOBT in the future is now confirmed for

Edition: 27.0 6 946

Document Title: NM 27.0 - NM B2B Reference Manual

the regulation(s) provided in this FCM.

3. An AO indicates to ETFMS that a flight with an EOBT in the future is now confirmed for
the regulation(s) provided in this FCM.

d. FUM

Documentation last updated: 27.0 - Edition 6

Flight Update Message.

The FUM provides the airport of destination with the estimated landing time (ELDT). It also
informs about the status of the flight (e.g. received a-DPI, Airborne, ATFM status…).

e. FLS

FLight Suspension message

Flight suspension until further notice. In case of:

1. Aerodrome closure.

2. Runway Visual Range (RVR) unknown.

3. Reception of an SMM message.

4. Not reported as airborne.

5. Suspended by departure airport (cancel DPI message).

f. REA

REAdy message.

The REA message can only be sent by ATC following a request from AO.

AO may ask ATC to send REA in 2 situations:

1. The flight is ready to depart before the EOBT (maximum 30 minutes before).

2. The flight is ready to depart before its CTOT.

g. RFI

Ready For Improvement message.

The RFI message can be sent by the AO in order to receive improvements directly with an
SRM.

h. RJT

Rerouteing reJecTion (RJT) message

An RJT is a negative response to a Rerouteing Proposal (RRP) message.

Edition: 27.0 6 947

Document Title: NM 27.0 - NM B2B Reference Manual

i. RRN

ReRouteing Notification message

The RRN message is issued in case of an acceptance of the rerouteing with option 'CNL
original FPL', book slot and flight plan refile by the AO via SITA/AFTN.

j. RRP

ReRouteing Proposal message

A sudden deterioration across the network would certainly be noticed when one of the ACCs
reduces capacity resulting in excessive delays for example. ATFCM staff shall assess the
situation before any decision is made. Assessment would include the best and worst case
scenarios with alternatives to both. RRP will be one of the solutions to mitigate potential
delays.ReRouteing Proposal message

k. SAM

Slot Allocation Message.

A SAM is sent to AOs/ATS any time a flight becomes regulated (new flight entering the
system, new period of regulation in the system, in response to an FCM or CHG providing
new RVR after a suspension) but at the earliest 2 hours before the last received EOBT.

l. SIP

Slot Improvement Proposal message.

A SIP message is sent to the AO by NM for a flight not being in an RFI status to propose a
new take-off time if it is possible to improve the existing CTOT by a significant amount.

m. SLC

SLot requirement Cancellation message

An SLC is sent to AOs/ATS to advise that a flight which has received a CTOT is no longer
subject to an ATFCM restriction. It may be due to the change in parameters of an existing
restriction or its cancellation, or to the reception of a message from AOs such as DLA, CHG,
and FCM.

n. SMM

Slot Missed Message.

An SMM is sent when the last received CTOT issued cannot be met and a new EOBT is NOT
known.

o. SPA

Slot improvement Proposal Acceptance (SPA) message

Edition: 27.0 6 948

Document Title: NM 27.0 - NM B2B Reference Manual

An SPA is a positive response to a SIP which is received from NM. The AO will send an SPA if
the proposed NEWCTOT in the SIP is acceptable.

p. SRJ

Slot improvement proposal ReJection (SRJ) message.

An SRJ is a negative response to a SIP received from NM. The AO will send an SRJ if they are
unable to accept the proposed improvement.

q. SRM

Slot Revision Message.

An SRM may be sent by NM:

1. To notify all concerned of either a significant change (>5') to the original CTOT or a
modification of the most penalising regulation or both.

Such changes are due to circumstances unrelated to the flight e.g. the introduction of a
new restriction or a change to the parameters of an existing restriction.

By default, only flights in an RFI status or in a Ready (REA) status are considered for
improvement but if the situation requires it, the NM Flow Controllers are able to let all
flights, including those in SWM status, be considered for improvement.

2. In response to a DLA or CHG when the current CTOT is no longer compliant with the new
information.

3. To notify all concerned of a routine improvement of the CTOT by the revision process for
a flight in an RFI status or in a Ready (REA) situation.

4. In response to a valid SPA to notify all concerned of the improvement of the CTOT.

r. SWM

SIP Wanted Message.

The SWM allows the flight to receive a SIP when there is a possibility to improve the flight.

s. UNK

Unknown message.

2. Used by: Flight

19.7.44. ATSMessageType (new 27.0)

<<enumeration>>

ATS message type.

1. Values:

Edition: 27.0 6 949

Document Title: NM 27.0 - NM B2B Reference Manual

a. AFP

ATC Flight plan Proposal message.

Notification by an ATS unit about new or revised information concerning an aircraft filed as
IFR/GAT within the IFPZ that is already in flight.

Revision can be done:

▪ For missing flight plan.

▪ For a change of route

▪ For a change of requested cruising level.

▪ For a change of Aircraft type.

▪ For a change of flight rules.

▪ For a change of flight type.

▪ For a change of destination.

▪ For a change of aircraft equipment.

b. ARR

Flight plan arrival.

Notify the arrival of a previously submitted flight plan for an IFR/GAT flight or part thereof
operating within the IFPZ.

c. CHG

Flight plan change.

Request of changes to a previously submitted flight plan for an IFR/GAT flight or part thereof
operating within the IFPZ.

d. CNL

Flight plan cancelation.

Request the cancel of a previously submitted flight plan for an IFR/GAT flight or part thereof
operating within the IFPZ.

e. DEP

Flight plan departure.

Notify the departure of a previously submitted flight plan for an IFR/GAT flight or part
thereof operating within the IFPZ.

f. DLA

Edition: 27.0 6 950

Document Title: NM 27.0 - NM B2B Reference Manual

Flight plan delay.

Notify the delay of a previously submitted flight plan for an IFR/GAT flight or part thereof
operating within the IFPZ.

g. FNM

Flight Notification Message.

Estimation provided by Gander OACC for those flights entering the North Atlantic airspace
via Gander.

h. FPL

Flight plan submission.

Submission of flight plans for IFR/GAT flights or parts thereof intending to operate within
the IFPZ.

i. MFS

Message From SHANWICK/SANTA MARIA.

Estimation provided by Shanwick OACC or Santa Maria OACC for those eastbound flights
entering the Shanwick or Santa Maria airspaces.

j. RQP

ReQuest flight Plan.

Request a flight plan data for an IFR/GAT flight or part thereof operating within the IFPZ.

k. RQS

ReQuest Supplementary flight plan.

Request from ATS unit wishes to obtain supplementary flight plan data for an IFR/GAT flight
or part thereof operating within the IFPZ.

l. OTHER

Shall be used to specify any message not explicitly enumerated and any unknown message
type.

2. Used by: FlightFilingResultMessage, FlightFilingResultMessageFilter

19.7.45. AtsUnitId_DataType
<<typedef[string]>>

ICAO id of the ATS unit from which supplementary flight plan data can be obtained.

Edition: 27.0 6 951

Document Title: NM 27.0 - NM B2B Reference Manual

1. Pattern: ANY{1,50}

2. Used by: AirFiledData

19.7.46. ATVFlightStatusInbound
<<enumeration>>

Documentation last updated: 27.0 - Edition 6

Flight Status as known by the airport, for an inbound flight.

The Flight Status will be shared with operational stakeholders such as AOs, airports, … via e.g. NOP
portal, B2B web services, P/S…

The Flight Status is defined in OFA 05.01.01 appendix E.

1. Values:

a. AIR

Airborne - The aircraft has just taken off from the origin airport.

b. CNX

Cancelled - Flight has been cancelled.

c. DBC

De-Boarding Completed - The aircraft is on stand and all passengers disembarked the
aircraft.

d. DBR

De-Boarding - The de-boarding of passenger has started.

e. DIV

Diverted - Flight has been diverted.

f. FIR

Within FIR boundary - The aircraft has entered local FIR of destination airport.

g. FNL

On final approach - The aircraft has got to the FAF or FAP (Final Approach Fix point) and
proceeds to fly the final approach segment towards the airport.

h. GOA

Go Around - Going around not yet landed.

Edition: 27.0 6 952

Document Title: NM 27.0 - NM B2B Reference Manual

i. IBK

In block at the stand.

j. IDH

In definitive hold - The aircraft is airborne, normally in a stack, and unable to continue
approach.

k. INI

Initiated - The aircraft operation has been confirmed (ICAO FPL filed/activated in airport
system).

This status has the equivalent objective as the 'Initial' status in CDM.

l. SCH

Schedule data - Flight is scheduled.

m. TMA

Terminal Area - The aircraft has entered local TMA of destination airport.

n. TXI

Landed / Taxi-ing - The aircraft is on ground and rolling to the stand.

2. Used by: ArrivalInformation, ArrivalPlanningInformationRequest

19.7.47. ATVFlightStatusOutbound
<<enumeration>>

Flight Status as known by the airport, for an outbound flight.

FlightStatus is defined in OFA 05.01.01 appendix E.

1. Values:

a. SCH

Schedule data - The flight is scheduled.

b. INI

Initiated - The aircraft operation has been confirmed (ICAO FPL filed/activated in airport
system).

c. BRD

Boarding - The aircraft is on the stand and passengers are boarding.

Edition: 27.0 6 953

Document Title: NM 27.0 - NM B2B Reference Manual

d. BRC

Boarding Completed - The aircraft is on the stand and all passengers are on board.

e. RDY

Ready - Aircraft is ready to depart immediately upon reception of TWR instructions.

f. OBK

Off Block - Off block/taxi-out. The aircraft is taxiing to the departure runway (either from the
stand or from the de-icing pad).

g. DEP

Departure - The aircraft has taken off from the origin airport.

h. CNX

Cancelled - The IATA Flight has been cancelled by the airline.

i. RTN

Returning on Ground - The aircraft is returning to the stand before taking off.

j. RET

Returning - The aircraft is returning after take-off.

k. RPO

Repositioning or Towing - Aircraft is being towed or is taxiing from another stand (e.g.
maintenance, engine test).

l. RDI

Ready for De-icing - The aircraft is on the de-icing position (either on its stand or on the de-
icing pad).

m. DEI

De-icing in Progress - The aircraft is being de-iced (either on its stand or on the de-icing pad).

n. TXD

De-icing Taxi - The aircraft is taxiing to a remote de-icing position.

2. Used by: CDMInfo, DeparturePlanningInformationRequest

19.7.48. BasicTrajectoryData
<<class>>

Edition: 27.0 6 954

Document Title: NM 27.0 - NM B2B Reference Manual

The BasicTrajectoryData groups together information helping NM calculating the trajectory as close
as possible to the trajectory calculated by the AO’s. This is an alternative to the exchange of the full
4D Trajectory between AO’s and NM. This full 4D trajectory exchange is currently (2012-2013)
under validation within SESAR projects.

1. Attributes:

a. WeightKg takeOffWeight (Optional)

The weight of the aircraft at take-off.

b. Relative4DPoint[] topOfClimb (Optional)

4D points where the requested level (RFL’s) are estimated to be reached. These topOfClimb
can only be given at RFL’s being present in the flight plan route description to indicate the
end of a climb to reach these RFL’s.

c. Relative4DPoint[] topOfDescent (Optional)

4D points where the requested level (RFL’s) are estimated to be left in order to descent either
to the next RFL or to the destination. These topOfDescent can only be given at RFL’s being
present in the flight plan route description.

d. Relative4DPoint[] bottomOfClimb (Optional)

Transition 4D point from cruise phase to climb phase.

e. Relative4DPoint[] bottomOfDescent (Optional)

Transition 4D point from descent phase to cruise phase.

f. DistanceAtLocation distanceAtLocationInfo (Optional)

List of locations with their respective distance along the trajectory.

2. Used by: StructuredFlightPlanUpdate, StructuredFlightPlan

19.7.49. CancelDPIReplyData
<<class>>

The CancelDPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: CancelDPIReply

19.7.50. CDM

Edition: 27.0 6 955

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

CDM (Collaborative Decision Making) systems located at airports provide DPI (Departure Planning
Information) messages. Those DPI messages provide the NM system with more accurate
information regarding the progression of the flights towards their take-off (taxi-time, target take-off
time and departure procedure).

Detailed information regarding CDM and DPI can be found in the documents DPI Implementation
Guide and European Airport CDM.

1. Attributes:

a. CDMStatus status (Mandatory)

Last known CDM status.

b. DepartureAirportType airportType (Mandatory) (new 27.0)

Departure Airport Type.

c. CDMInfo info (Optional)

CDM information, if available.

2. Used by: Flight

19.7.51. CDMInfo

Edition: 27.0 6 956

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

CDM information regarding the progression of the flights towards their take-off (taxi-time, target
take-off time and departure procedure).

Detailed information regarding CDM and DPI can be found in the documents DPI Implementation
Guide and European Airport CDM.

1. Attributes:

a. DateTimeMinute turnaroundTargetTakeOffTime (Optional)

Corresponds to the turnaround target take-off time provided in an extended DPI, or to the
(single) take-off time provided in an Early DPI (E-DPI) or Target DPI (T-DPI-t).

b. DateTimeMinute earliestTargetTakeOffTime (Optional)

Corresponds to the earliest target take-off time provided in an extended DPI, or to the
(single) take-off time provided in a Sequence DPI (T-DPI-s).

c. DateTimeMinute consolidatedTargetTakeOffTime (Optional)

Corresponds to the consolidated target take-off time provided in an extended DPI.

d. DateTimeMinute atcTargetTakeOffTime (Optional)

Corresponds to the ATC take-off time provided in an ATC DPI message (A-DPI).

Edition: 27.0 6 957

Document Title: NM 27.0 - NM B2B Reference Manual

e. DurationHourMinuteSecond taxiTime (Optional)

Corresponds to the latest taxi time received in a DPI message.

Note that this might not be the same as the taxi time of any of the FTFM and RTFM and
CTFM flight profile.

f. boolean offBlockTimeDiscrepancy (Mandatory)

Indicates if there exists a significant difference between the filed off-block time and the off-
block time that NM possibly received through DPI messages.

g. ATVFlightStatusOutbound flightStatusOutbound (Optional)

Corresponds to the latest ATV flight status outbound received in an extended DPI.

h. TerminalProcedure departureProc (Optional)

Corresponds to the latest departure procedure received in a DPI message.

i. RunwayId departureRunway (Optional)

Corresponds to the latest departure runway received in an extended DPI.

j. TerminalOrApronStandName departureTerminal (Optional)

Corresponds to the latest departure terminal received in an extended DPI.

k. TerminalOrApronStandName departureApronStand (Optional)

Corresponds to the latest departure apron stand received in an extended DPI.

l. boolean aircraftTypeDiscrepancy (Optional)

Indicates if there exists a difference between the filed aircraft type and the aircraft type that
NM possibly received through DPI messages.

Optional: not present if aircraftType is null.

m. AircraftType aircraftType (Optional)

Corresponds to the latest aircraft type received in a DPI message.

Cannot be null if aircraftTypeDiscrepancy is true.

n. AircraftTypeIATAId aircraftTypeIATA (Optional)

Corresponds to the latest aircraft type IATA code received in an extended DPI.

o. AircraftRegistrationMark registrationMark (Optional)

Corresponds to the latest registration mark received in a DPI message. It will not exceed 7

Edition: 27.0 6 958

Document Title: NM 27.0 - NM B2B Reference Manual

characters length as only one registration mark is passed (max length of the type is 50).

p. boolean registrationMarkDiscrepancy (Optional)

Indicates if there exists a difference between the filed registration mark and the registration
mark that NM possibly received through DPI messages.

Optional: not present if registrationMark is null.

q. DepartureStatus departureStatus (Mandatory)

Indicates the currently known departing status of the flight.

r. DateTimeMinute targetOffBlockTime (Optional)

Target Off-Block Time (TOBT) that is received from the CDM Airport.

s. DateTimeMinute targetStartupApprovalTime (Optional)

Target Start-up Approval Time (TSAT) that is received from the CDM Airport.

t. AircraftICAOId aircraftIdInbound (Optional)

Corresponds to the latest aircraft ICAO id of preceding leg received in an extended DPI.

u. IFPLId ifplIdInbound (Optional)

Corresponds to the latest unique IFPL identifier of preceding leg received in an extended
DPI.

v. AircraftRegistrationMark registrationMarkInbound (Optional)

Corresponds to the latest aircraft registration mark of preceding leg received in an extended
DPI.

w. ReasonForDPICancellation cancelReason (Optional)

Corresponds to the reason provided with the last CancelDPI message (C-DPI) if any.

Available only when a C-DPI message has been received, and has not been followed by any
other kind of DPI message.

x. AircraftIATAId iataFlightDesignator (Optional) (new 27.0)

The latest IATA flight designator of preceding leg received in an extended DPI. Cannot be
null if iataFlightDesignatorDiscrepancy is true.

y. boolean iataFlightDesignatorDiscrepancy (Optional) (new 27.0)

Indicates if there exists a difference between the filed IATA flight designator and the IATA
flight designator that NM possibly received through DPI messages.

Edition: 27.0 6 959

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: CDM

19.7.52. CDMStatus
<<enumeration>>

Enumerates the possible CDM status values.

1. Values:

a. DEPARTING_FROM_STANDARD_AIRPORT

The flight is departing from an airport which is neither CDM nor an advanced ATC/TWR.

b. DEPARTING_FROM_CDM_AIRPORT

The flight is departing from a CDM airport or from an advanced ATC/TWR, but no DPI has
been received yet for this flight.

c. ESTIMATED

Early DPI (E-DPI) received from a CDM airport or from an advanced ATC/TWR.

d. TARGETED

Target DPI (T-DPI-t) received from a CDM airport.

e. PRE_SEQUENCED

Sequenced DPI (T-DPI-s) received from a CDM airport.

f. ACTUAL_OFFBLOCK

ATC DPI (A-DPI) received from a CDM airport or from an advanced ATC/TWR.

g. PREDICTED

Predicted DPI (P-DPI) received from a CDM airport.

2. Used by: CDM

19.7.53. CfmuFlightType
<<enumeration>>

Indicates state and/or origin of flight in the NM system.

1. Values:

a. MFD

Mini-flight created for the usage of CCAMS when the flight is unknown to NM.

Edition: 27.0 6 960

Document Title: NM 27.0 - NM B2B Reference Manual

b. IFPL

Flight created from a flight plan filed to IFPS.

c. ACT

Flight is ATC activated.

d. TACT_ACTIVATED

Flight activated by NM.

e. TERMINATED

Flight is terminated.

f. PREDICTED_FLIGHT

Predicted flight data.

2. Used by: Flight

19.7.54. CTOTLimitReason
<<enumeration>>

Possible exceptional reasons that may affect the CTOT allocation of a flight.

When a flight is regulated, its CTOT may delay the flight into one or more Flight Plan time
dependent constraints (e.g. RAD restrictions, CDR2), therefore violating route and/or airspace
restrictions.

NM takes into account the route and airspace restrictions when a CTOT is allocated so that
violations are avoided. The CASA algorithm takes into account the maximum delay to which the
flight could be subject before it violates a route or an airspace restriction. When a slot is allocated
by CASA ctotLimitReason attribute of the flight will be set to indicate if the delay was limited by the
Last Valid EOBT . The Last Valid EOBT is the last valid EOBT acceptable for a flight before triggering
Flight Plan processing errors.

The following cases are foreseen:

1. There is no Last Valid EOBT for the flight so the slot time has not been limited.

2. The flight’s CTOT has been forced.

3. The delay of the flight is limited to the Last Valid EOBT .

4. The delay of the flight was limited firstly by the Last Valid EOBT but also by a yet more
restrictive zero-rate or suspending regulation measure.

1. Values:

a. SLOT_TIME_NOT_LIMITED

Edition: 27.0 6 961

Document Title: NM 27.0 - NM B2B Reference Manual

There is no forced CTOT neither limitations by the Last Valid EOBT for the flight so the slot
time has not been limited.

b. FORCED_BY_TOWER

The CTOT has been forced by the tower.

c. FORCED_BY_NMOC

The CTOT has been forced by NMOC.

d. WAS_FORCED_BY_NMOC

The CTOT was manually forced by NMOC but is no longer forced.

e. FORCED_BY_CHAMAN

The CTOT has been forced by Chaman.

f. FORCED_BY_STAM_MEASURE

The CTOT has been forced by a STAM measure.

g. LIMITED_BY_VIOLATION

CASA has based the CTOT on the Last Valid EOBT to avoid violations.

h. LIMITED_BY_VIOLATION_THEN_ZERO_RATE_OR_RVR

The same as for the LIMITED_BY_VIOLATION but, because this CTOT would give overlap with a
(non-suspending) zero-rate or RVR subperiod, CASA has limited the CTOT further to the start
time of the zero-rate or RVR subperiod.

i. SLOT_EXTENSION

The CTOT has been forced by NMOC on request from Aircraft Operator or departure tower
(Slot Extension)

2. Used by: Flight

19.7.55. DatalinkCapabilities
<<class>>

Describes the data-link applications or capabilities of an aircraft.

1. Attributes:

a. DataLinkCapabilities_DataType value (Optional)

Documentation last updated: 27.0 - Edition 2

The description of the data-link applications or capabilities of the aircraft.

Edition: 27.0 6 962

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: OtherInformation

19.7.56. DataLinkCapabilities_DataType
<<typedef[string]>>

Describes the data-link applications or capabilities of an aircraft.

1. Pattern: ANY{1,50}

2. Used by: DatalinkCapabilities

19.7.57. DelayCharacteristics
<<enumeration>>

Identifies the characteristics of the delay value associated to the flight.

1. Values:

a. EXCEEDS_DELAY_CONFIRMATION

Set when the delay value calculated for the flight is exceeding the delay confirmation
threshold of a regulation affecting the flight.

b. ADJUSTED_TO_CLOCK

Set when the delay value of the flight is adjusted to the clock.

2. Used by: Flight

19.7.58. DeltaEntry
<<class>>

Reports on flight deviation and intrusion by comparing the flight list for traffic type with demand
or regulated demand or load.

The result indicates:

1. If the flight is an intruder versus the compared traffic type and if so, what kind of deviation
causes the intrusion.

2. The airspace origin of the deviation for an intruder, if applicable and identified.

3. The difference between the times, flight levels and geographical positions of the flight’s entry
point in the flight list and the flight list that is compared with.

1. Attributes:

a. IntruderKind intruderKind (Mandatory)

Indicates if the flight in the other traffic type is an intruder and if so, what kind of deviation
causes the intrusion.

Edition: 27.0 6 963

Document Title: NM 27.0 - NM B2B Reference Manual

b. AirspaceId originOfIntruder (Optional)

The origin of an airspace intruder is defined as the active ATC sector in which the deviation
that caused the intrusion was initiated.

c. int deltaMinutes (Mandatory)

The difference between the first entry time in the flight list (FlightListRequest.trafficType)
and the flight list that is compared with (FlightListRequest.compareWithOtherTrafficType).

deltaMinutes returned by NM are always truncated to 999 minutes.

i. Constraints:

▪ range : [-999, 999]

d. int deltaFlightLevel (Mandatory)

The difference between the first level at first entry in the flight list
(FlightListRequest.trafficType) and the flight list that is compared with
(FlightListRequest.compareWithOtherTrafficType ).

i. Constraints:

▪ range : [-999, 999]

e. DistanceNM deltaPosition (Mandatory)

The distance in nautical miles between the geographical positions of the flight’s entry point
in the flight list (FlightListRequest.trafficType) and the flight list that is compared with
(FlightListRequest] ).

deltaPosition returned by NM are always truncated to 999 nautical miles.

2. Used by: Flight

19.7.59. DepartureAirportType
<<enumeration>>

Enumerates the possible Departure Airport Type values from which DPI messages could be
received.

1. Values:

a. STANDARD

Standard airport.

b. ADVANCED_ATC_TWR

Advanced ATC TWR Airport.

c. CDM

Edition: 27.0 6 964

Document Title: NM 27.0 - NM B2B Reference Manual

CDM airport.

2. Used by: CDM

19.7.60. DepartureData
<<class>>

Provide information related to the departure of the aircraft before it takes-off, so from off block to
take-off.

1. Attributes:

a. DurationMinute taxiTime (Mandatory)

The duration of the taxi time. This will be used by NM to calculate the take-off time by
adding the taxiTime to the off-block time given for the flight plan. The taxiTime is provided in
number of minutes that corresponds to what can be provided in an ICAO flight plan by using
the RMK/TAXI:mi or in an ADEXP flight plan by using the field -TAXI mi ; where mi is a number
of minutes on 2 digits.

i. Constraints:

▪ DepartureData.INVALID_TAXI_TIME

2. Constraints:

a. INVALID_TAXI_TIME

The taxi time is limited to 90 minutes

Constrained attributes: taxiTime

Constrained requests: any using request

3. Used by: StructuredFlightPlanUpdate, StructuredFlightPlan

19.7.61. DepartureInformation
<<class>>

This type is used to provide information about a departing flight. For example it can be used by an
airport ATC Tower to provide the actual take-off time (like in an FSA message), or to provide up-to-
date information about the aircraft type and terminal procedure used.

1. Attributes:

a. TerminalProcedure departureProcedure (Optional)

The actual departure procedure used for the flight.

b. DateTimeMinute takeOffTime (Mandatory)

The take-off time. It can be either estimated or actual (see takeOffTimeQualifier).

Edition: 27.0 6 965

Document Title: NM 27.0 - NM B2B Reference Manual

c. EstimateQualifier takeOffTimeQualifier (Mandatory)

Whether the provided takeOffTime is an estimate or an actual value.

i. Constraints:

▪ DepartureInformation.TAKE_OFF_TIME_QUALIFIER_MUST_BE_ACTUAL

d. list< ICAOPoint > furtherRoute (Optional)

The list of points that will be flown after the provided position. The provided position must
be the first point at which the route changes.

i. Constraints:

▪ list size range : [1, unbounded[

e. TerminalProcedure arrivalProcedure (Optional)

The actual arrival procedure used for the flight.

2. Constraints:

a. TAKE_OFF_TIME_QUALIFIER_MUST_BE_ACTUAL

takeOffTimeQualifier must be ACTUAL .

Constrained attributes: takeOffTimeQualifier

Constrained requests: any using request

3. Used by: FlightUpdateChoice

19.7.62. DeparturePlanningInformationRequest

Edition: 27.0 6 966

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Base class of all Departure Planning Information requests.

1. Inherits from: FlightInformationUpdateRequest

2. Attributes:

a. ATVFlightStatusOutbound flightStatusOutbound (Contextual)

Flight status as known by the airport, for an outbound flight.

CNX status is used for cancelling a schedule.

Other values are currently used for information sharing only.

i. Presence:

▪ Mandatory in PredictedDPIRequest

▪ Optional otherwise

19.7.63. DepartureStatus
<<enumeration>>

Enumerates the possible departure status values.

1. Values:

a. OK

No de-icing planned or in progress or completed.

Edition: 27.0 6 967

Document Title: NM 27.0 - NM B2B Reference Manual

b. DEICING

De-icing planned or in progress or completed.

2. Used by: CDMInfo

19.7.64. DepartureTolerance
<<class>>

Indicates the departure tolerance of a flight.

1. Attributes:

a. TimeHourMinutePeriod toleranceWindow (Mandatory)

The departure tolerance window.

b. boolean extended (Mandatory)

True if this tolerance window differs from the default departure tolerance window.

2. Used by: Flight

19.7.65. Dinghies
<<class>>

Information on the dinghies carried by an aircraft.

1. Attributes:

a. NumberOfDinghies_DataType numberOfDinghies (Optional)

The number of dinghies carried by the aircraft.

If specified, must be in [ 0, 99 ].

b. TotalCapacity_DataType totalCapacity (Optional)

The total capacity, in persons, of all dinghies carried by the aircraft. If specified, must be in [
0, 999 ].

c. boolean areCovered (Optional)

Specifies if the dinghies carried by the aircraft are covered.

d. Colours colours (Optional) (new 27.0)

Colours of the dinghies carried by the aircraft.

2. Used by: SupplementaryInformation

Edition: 27.0 6 968

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.66. DistanceAtLocation
<<class>>

List of locations with their respective distance along the trajectory.

1. Attributes:

a. AerodromeDAL adesDAL (Optional)

Aerodrome of arrival with its cumulative ground projected distance along the trajectory.

b. PointDAL[] dalPoints (Optional)

Traversed point with its cumulative ground projected distance along the trajectory.

2. Used by: BasicTrajectoryData

19.7.67. EarlyDPIReplyData
<<class>>

The EarlyDPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: EarlyDPIReply

19.7.68. EnrouteDelay
<<class>>

Specifies the point on the route where a delay is planned to occur together with the duration of
such delay.

1. Attributes:

a. DurationHourMinute delay (Optional)

The delay.

b. ICAOPoint point (Optional)

The point where the delay is planned to occur.

2. Used by: EnRouteInformation, FlightPlan

19.7.69. EnRouteInformation
<<class>>

This type is used to provide NM with up-to-date en-route information. For example it can be used
by an ATC center to provide an estimated (or actual) 4D position of where and when the flight
enters the FDPA, inform NM about significant changes to the route or provide NM with information

Edition: 27.0 6 969

Document Title: NM 27.0 - NM B2B Reference Manual

about a holding.

It allows providing the same en-route information as in an FSA (First System Activation) message.

1. Attributes:

a. FourDFlightPoint position (Mandatory)

The estimated or actual 4D position (lat, long, time and flight level).

b. EstimateQualifier positionQualifier (Mandatory)

Whether the position is estimated or actual.

c. list< ICAOPoint > furtherRoute (Optional)

The list of points that will be flown after the provided position. The provided position must
be the first point at which the route changes.

i. Constraints:

▪ list size range : [1, unbounded[

d. list< EnrouteDelay > hold (Optional)

Used to inform NM that the flight is holding and give information about the holding.

i. Constraints:

▪ list size range : [1, unbounded[

e. TerminalProcedure arrivalProcedure (Optional)

The actual arrival procedure used for the flight.

2. Used by: FlightUpdateChoice

19.7.70. EntryExit
<<enumeration>>

Indication on whether a flight is entering or exiting a volume.

1. Values:

a. ENTRY

The flight is entering a volume (e.g. an airspace protected by a restriction).

b. EXIT

The flight is exiting a volume.

2. Used by: FlightRestriction

Edition: 27.0 6 970

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.71. EquipmentCapabilityAndStatus
<<class>>

Indicates the radio communication, navigation and approach aid equipment and capabilities of an
aircraft.

ICAO item 10.

1. Attributes:

a. EquipmentStatus gbas (Optional)

GBAS Landing System.

ICAO code is "A".

b. EquipmentStatus lpv (Optional)

LPV.

ICAO code is "B".

c. EquipmentStatus loranC (Optional)

LORAN-C provides coverage for maritime navigation in U.S. coastal areas. It provides
navigation, location, and timing services for both civil and military air, land and marine
users. LORAN-C is approved as an en-route supplemental air navigation system for both
Instrument Flight Rule (IFR) and Visual Flight Rule (VFR) operations.

ICAO code is "C".

d. EquipmentStatus dme (Optional)

Distance Measuring Equipment.

ICAO code is "D".

e. EquipmentStatus fmcWprAcars (Optional)

FMC WPR ACARS.

ICAO code is "E1".

f. EquipmentStatus dFisAcars (Optional)

D-FIS ACARS.

ICAO code is "E2".

g. EquipmentStatus pdcAcars (Optional)

PDC ACARS. ICAO code is "E3".

Edition: 27.0 6 971

Document Title: NM 27.0 - NM B2B Reference Manual

h. EquipmentStatus adf (Optional)

Automatic Direction Finder.

ICAO code is "F".

i. EquipmentStatus gnss (Optional)

Global Navigation Satellite Systems: a satellite assisted positioning system.

ICAO code is "G".

j. EquipmentStatus hfRtf (Optional)

High Frequency Radio Transmission Frequency.

ICAO code is "H".

k. EquipmentStatus inertialNavigation (Optional)

An inertial navigation system measures the position and altitude of a vehicle by measuring
the accelerations and rotations applied to the system’s inertial frame.

ICAO code is "I".

l. EquipmentStatus cpdlcAtnVdlMode2 (Optional)

CPDLC ATN VHF Data Link Mode 2.

ICAO code is "J1".

m. EquipmentStatus cpdlcFans1AHFDL (Optional)

CPDLC FANS 1/A HF Data Link.

ICAO code is "J2".

n. EquipmentStatus cpdlcFans1AVdlModeA (Optional)

CPDLC FANS 1/A VHF Data Link Mode A.

ICAO code is "J3".

o. EquipmentStatus cpdlcFans1AVdlMode2 (Optional)

CPDLC FANS 1/A VHF Data Link Mode 2.

ICAO code is "J4".

p. EquipmentStatus cpdlcFans1ASatcomInmarsat (Optional)

CPDLC FANS 1/A Satellite Communication INMARSAT.

Edition: 27.0 6 972

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO code is "J5".

q. EquipmentStatus cpdlcFans1ASatcomMtsat (Optional)

CPDLC FANS 1/A Satellite Communication MTSAT.

ICAO code is "J6".

r. EquipmentStatus cpdlcFans1ASatcomIridium (Optional)

CPDLC FANS 1/A Satellite Communication Iridium.

ICAO code is "J7".

s. EquipmentStatus mls (Optional)

Microwave Landing System.

ICAO code is "K".

t. EquipmentStatus ils (Optional)

Instrument Landing System.

ICAO code is "L".

u. EquipmentStatus atcRtfSatcomInmarsat (Optional)

ATC Radio Telephony by Satellite Communication INMARSAT.

ICAO code is "M1".

v. EquipmentStatus atcRtfSatcomMtsat (Optional)

ATC Radio Telephony by Satellite Communication MTSAT.

ICAO code is "M2"

w. EquipmentStatus atcRtfSatcomIridium (Optional)

ATC Radio Telephony by Satellite Communication Iridium.

ICAO code is "M3".

x. EquipmentStatus vor (Optional)

VHF omni-directional radio range.

ICAO code is "O".

y. EquipmentStatus rcp1 (Optional)

Reserved for RCP.

Edition: 27.0 6 973

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO code is "P1".

z. EquipmentStatus rcp2 (Optional)

Reserved for RCP.

ICAO code is "P2".

aa. EquipmentStatus rcp3 (Optional)

Reserved for RCP.

ICAO code is "P3".

ab. EquipmentStatus rcp4 (Optional)

Reserved for RCP.

ICAO code is "P4".

ac. EquipmentStatus rcp5 (Optional)

Reserved for RCP.

ICAO code is "P5".

ad. EquipmentStatus rcp6 (Optional)

Reserved for RCP.

ICAO code is "P6".

ae. EquipmentStatus rcp7 (Optional)

Reserved for RCP.

ICAO code is "P7".

af. EquipmentStatus rcp8 (Optional)

Reserved for RCP.

ICAO code is "P8".

ag. EquipmentStatus rcp9 (Optional)

Reserved for RCP.

ICAO code is "P9".

ah. EquipmentStatus pbnApproved (Optional)

Indicates that the aircraft meets the Performance-based Navigation type.

Edition: 27.0 6 974

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO code is "R".

ai. EquipmentStatus standard (Optional)

Standard equipment.

ICAO code is "S".

aj. EquipmentStatus tacan (Optional)

TACtical Air Navigation.

ICAO code is "T".

ak. EquipmentStatus uhfRtf (Optional)

Ultra High Frequency Radio Transmission Frequency.

ICAO code is "U".

al. EquipmentStatus vhfRtf (Optional)

VHF Radio Telephony.

ICAO code is "V".

am. EquipmentStatus rvsm (Optional)

Aircraft equipped to navigate in airspace where the "Reduced Vertical Separation Minima" is
applicable.

ICAO code is "W".

an. EquipmentStatus mnps (Optional)

"Minimum Navigation Performance Specifications" approved aircraft.

"ICAO code is "X".

ao. EquipmentStatus khz833 (Optional)

Equipped with VHF with a 8.33KHz channel spacing radio equipment.

ICAO code is "Y".

ap. EquipmentStatus other (Optional)

Other equipment as specified in OtherInformation ( communicationEquipment ,

navigationEquipment , datalinkCapabilities ).

ICAO code is "Z".

2. Used by: Flight, FlightPlanUpdate, FlightPlan

Edition: 27.0 6 975

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.72. EquipmentStatus
<<enumeration>>

Describes the status of any kind of navigation equipment.

1. Values:

a. EQUIPPED

The aircraft is equipped with the specified equipment.

b. NOT_EQUIPPED

The aircraft is not equipped with the specified equipment.

2. Used by: EquipmentCapabilityAndStatus, ModeSCapabilities, SurveillanceEquipment

19.7.73. ErrorCategory (new 27.0)

<<enumeration>>

Error categories for this service group.

1. Values:

a. ATFM

For all input validation errors related to ATFM information.

19.7.74. EstimatedElapsedTimeAtLocation
<<class>>

Association of a location and an elapsed time. ICAO item 18 EET/.

1. Attributes:

a. DurationHourMinute elapsedTime (Mandatory)

The elapsed time.

b. FIRICAOId fir (Optional)

A FIR.

i. Constraints:

▪ EstimatedElapsedTimeAtLocation.AT_LEAST_ONE_LOCATION_SHOULD_BE_DEFINED

▪ EstimatedElapsedTimeAtLocation.LOCATIONS_ARE_MUTUALLY_EXCLUSIVE

c. ICAOPoint point (Optional)

A point.

Edition: 27.0 6 976

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ EstimatedElapsedTimeAtLocation.AT_LEAST_ONE_LOCATION_SHOULD_BE_DEFINED

▪ EstimatedElapsedTimeAtLocation.LOCATIONS_ARE_MUTUALLY_EXCLUSIVE

d. Latitude latitude (Optional)

A latitude.

i. Constraints:

▪ EstimatedElapsedTimeAtLocation.AT_LEAST_ONE_LOCATION_SHOULD_BE_DEFINED

▪ EstimatedElapsedTimeAtLocation.LOCATIONS_ARE_MUTUALLY_EXCLUSIVE

e. Longitude longitude (Optional)

A longitude.

i. Constraints:

▪ EstimatedElapsedTimeAtLocation.AT_LEAST_ONE_LOCATION_SHOULD_BE_DEFINED

▪ EstimatedElapsedTimeAtLocation.LOCATIONS_ARE_MUTUALLY_EXCLUSIVE

2. Constraints:

a. AT_LEAST_ONE_LOCATION_SHOULD_BE_DEFINED

Exactly one location (fir, point, latitude and/or longitude) must be not null.

i.e. either FIR or POINT or LATITUDE or LONGITUDE or LATITUDE/LONGITUDE

Constrained attributes: fir, point, latitude, longitude

Constrained requests: any using request

b. LOCATIONS_ARE_MUTUALLY_EXCLUSIVE

The locations (fir, point, latitude and/or longitude) are mutually exclusive.

i.e. either FIR or POINT or LATITUDE or LONGITUDE or LATITUDE/LONGITUDE

Constrained attributes: fir, point, latitude, longitude

Constrained requests: any using request

3. Used by: FlightPlanUpdate, FlightPlan

19.7.75. EURSTSIndicator
<<enumeration>>

Enumerates the non-ICAO STS indicators in use in the EUR region.

1. Values:

Edition: 27.0 6 977

Document Title: NM 27.0 - NM B2B Reference Manual

a. EXM833

Exempted from the carriage of the 8.33kHz radios.

b. PROTECTED

Sensitive flights.

c. RNAVX

Aircraft not equipped with RNAV.

d. RNAVINOP

Failure or degradation results in aircraft being unable to meet B-RNAV functionality and
accuracy requirements.

e. CPDLCX

Flights conducted wholly or partly in EUR CPDLC airspace, and not equipped with CPDLC
capabilities but which have been granted an exemption.

f. OAT (new 27.0)

Operational Air Traffic.

2. Used by: SpecialHandlingIndicators

19.7.76. EvaluateFlowImpactReplyData
<<union>>

1. Choices:

a. RouteInfo originalRoute

Contains the original route related info.

b. IFPSError[] ifpsErrors

Array of NM/IFPS errors in response to the flight plan validation.

2. Used by: EvaluateFlowImpactReply

19.7.77. ExclusionFromRegulations
<<class>>

Provides data regarding the possible exclusion of a flights from regulations.

1. Attributes:

a. boolean onTrafficVolume (Optional)

Edition: 27.0 6 978

Document Title: NM 27.0 - NM B2B Reference Manual

Used only in flights that have been queried by traffic volume.

True if the flight is excluded from one or more regulations defined on the traffic volume.

b. int count (Optional)

The total count of regulations from which the flight is excluded.

Must be null if is all is true; cannot be null otherwise.

i. Constraints:

▪ range : [0, unbounded[

c. boolean all (Optional)

True if the flight is excluded from all regulations.

Must be null if is count is not null; cannot be null otherwise.

d. boolean hasBeenExcluded (Mandatory)

True if the flight has been excluded from one or more regulations in the past but is no
longer.

2. Used by: Flight

19.7.78. ExtendedAircraftICAOId
<<typedef[string]>>

ICAO aircraft identification as defined in ICAO doc 4444 extended with characters '$' and '#'. These
special characters are used by NM in the context of prediction and simulation exercises.

1. Pattern: (ALPHA|DIGIT|$|#){2,7}

2. Used by: ReroutingApplyReplyDataResult, RoutingAssistanceReplyDataResult, FlightKeys

19.7.79. FAMStatus
<<enumeration>>

Describes a flight FAM (Flight Activation Message) status.

1. Values:

a. AIRBORNE_WHEN_SUSPENDED_BY_FAM

was suspended by FAM, airborne data received when suspended.

b. AIRBORNE_WHEN_SHIFTED_BY_FAM

was shifted by FAM, airborne data received when shifted.

Edition: 27.0 6 979

Document Title: NM 27.0 - NM B2B Reference Manual

c. SUBJECT_TO_FAM

currently subject to FAM, if no data received, flight will be shifted soon.

d. WAS_SUBJECT_TO_FAM

was subject to FAM but airborne data received before first shift.

e. NOT_UNDER_FAM

not under FAM yet or never under FAM.

f. SHIFTED_BY_FAM

currently shifted by FAM.

g. WAS_SHIFTED_BY_FAM

was shifted by FAM, FPL data received when shifted.

h. SUSPENDED_BY_FAM

currently suspended by FAM.

i. WAS_SUSPENDED_BY_FAM

was suspended by FAM, FPL data received when suspended.

2. Used by: Flight

19.7.80. FilingId
<<typedef[string]>>

Examples
AA00953172BB00956485

1. Pattern: (UALPHA{2}DIGIT{8}){1,2}

2. Used by: FlightFilingResultMessage, FilingResultQueued, FilingStatusRequest

19.7.81. FilingReplyData

Edition: 27.0 6 980

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

The content of the FilingReplyData structure depends on whether the filing request was evaluated
by NM as:

1. VALID

2. INVALID_QUEUED_FOR_CORRECTION

3. INVALID_REJECTED

This is expressed via a FilingStatus enumeration value that discriminates three attributes in the
choice described below.

1. Attributes:

a. FilingStatus filingStatus (Mandatory)

Indicates whether the filing request was evaluated by NM as valid, or was rejected, or
queued for manual correction by an NM operator.

b. FilingResultValid validFiling (Optional)

Contains information regarding the processing of the filing request when it was valid.

Cannot be null if filingStatus is VALID ; must be null otherwise.

c. FilingResultQueued queuedFiling (Optional)

Edition: 27.0 6 981

Document Title: NM 27.0 - NM B2B Reference Manual

Contains information regarding the processing of the filing request when it was queued for
manual correction by an NM operator.

Cannot be null if filingStatus is INVALID_QUEUED_FOR_CORRECTION ; must be null otherwise.

d. FilingResultRejected rejectedFiling (Optional)

Contains information regarding the processing of the filing request when it was rejected.

Cannot be null if filingStatus is INVALID_REJECTED ; must be null otherwise.

19.7.82. FilingRequest

<<abstract class>>

Abstract ancestor request for all concrete requests that file flight plan related data to NM.

The corresponding replies to FilingRequest requests all inherit from the abstract FilingReplyData.

1. Inherits from: Request

2. Attributes:

a. string[] additionalAddresses (Optional)

AFTN addresses to which NM shall distribute the message after being accepted.

19.7.83. FilingResultQueued
<<class>>

Returned when the filing request is queued for manual correction by an NM operator.

1. Attributes:

a. FilingId filingId (Mandatory)

Id of the received filing request when it results in queuing for manual correction by an NM
operator. This id is to be used when subsequently retrieving the status of this filing.

2. Used by: FilingReplyData

19.7.84. FilingResultRejected
<<class>>

Edition: 27.0 6 982

Document Title: NM 27.0 - NM B2B Reference Manual

Returned when the filed flight plan is rejected.

1. Attributes:

a. IFPSError[] ifpsErrors (Mandatory)

The list of errors that caused the rejection.

2. Used by: FilingReplyData

19.7.85. FilingResultValid
<<class>>

Returned when the filed flight plan is valid.

1. Attributes:

a. IFPLId ifplId (Optional)

Cannot be null.

b. boolean cfmuChange (Mandatory)

True if NM has modified the filed data (routes); false otherwise.

c. IFPIndicator[] ifpIndicators (Optional)

Indications of errors that have been found in a flight plan and either ignored or
automatically or manually corrected during the processing of the filing request.

d. string[] comments (Optional)

Comment produced by NM during the processing of the filing request.

2. Used by: FilingReplyData

19.7.86. FilingRule
<<enumeration>>

Describes the filing rule applying to a flight.

1. Values:

a. NOT_AUTHORISED

Filing not authorised.

b. OPERATOR_MUST_REFILE

Filing authorised for the aircraft operator only.

c. FILING_ALLOWED_BY_AO_CFMU

Edition: 27.0 6 983

Document Title: NM 27.0 - NM B2B Reference Manual

Filing authorised for the aircraft operator or NM (in a re-routing context).

2. Used by: Flight

19.7.87. FilingStatus
<<enumeration>>

Describes the status of a filing reply, resulting from the processing of a filing request.

1. Values:

a. VALID

NM has evaluated that the filed flight plan is valid.

b. INVALID_QUEUED_FOR_CORRECTION

NM has evaluated that the filed flight plan is invalid but candidate for manual correction by
an NM operator.

c. INVALID_REJECTED

NM has evaluated that the filed flight plan is invalid and is not candidate for manual
correction by an NM operator.

2. Used by: FilingReplyData, FilingStatusFilter

19.7.88. FilingStatusFilter (new 27.0)

<<class>>

Filing status filter.

1. Attributes:

a. set< FilingStatus > automaticStatus (Optional)

The set of automatic outcomes to be notified about.

This allows being notified about ACK , REJ or MAN processing results automatically set by IFPS.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FilingStatusFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

b. set< ManualProcessingFilingStatus > manualStatus (Optional)

The set of manual outcomes to be notified about.

This allows being notified about manual corrections ( ACK ) or rejections ( REJ ) performed by
an IFPS operator on messages that had been previously queued for manual processing.

Edition: 27.0 6 984

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ set size range : [1, unbounded[

▪ FilingStatusFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

At least one of automaticStatus and manualStatus must be present and not empty.

Constrained attributes: automaticStatus, manualStatus

Constrained requests: any using request

3. Used by: FlightFilingResultMessageFilter

19.7.89. FilingStatusReplyData
<<class>>

The FilingStatusReply payload.

1. Inherits from: FilingReplyData

2. Used by: FlightFilingResultMessage, FilingStatusReply

19.7.90. Flight

<<class>>

Documentation last updated: 27.0 - Edition 2

Description of a flight as it exists in the NM system.

Apart from the flight keys (that are always returned), all attributes are optional. They are set when
requested by the caller and available in the NM system.

Flight attributes are categorised according to their weight:

• "Light" field consume few NM resources

• "Heavy" field computing consumes more NM resources

In general, a client application should demand the fields that it needs. It shall
CAUTION
only demand the strictly necessary heavy fields.

The weight of each field is documented by the FlightField enumeration.

Edition: 27.0 6 985

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. FlightIdentificationOutput flightId (Mandatory)

IFPL id and flight keys associated to the flight. This attribute is always returned.

b. AerodromeICAOId divertedAerodromeOfDestination (Optional)

Diverted aerodrome of destination, if the flight was diverted. Null if the flight was not
diverted.

c. AircraftTypeICAOId aircraftType (Optional)

ICAO id of the aircraft type.

d. DateTimeMinute readyEstimatedOffBlockTime (Optional)

Last flight plan related estimated off-block time, but amended by NM OPS room or READY
message (filing time).

Present if different from the latest flight plan related estimated off-block time in
flightId.keys; null otherwise.

Note that readyEstimatedOffBlockTime can be different than the FTFM flight profile off-block
time (in case cdmEstimatedOffBlockTime is also set).

e. DateTimeMinute cdmEstimatedOffBlockTime (Optional)

Documentation last updated: 27.0 - Edition 1

The last ready estimated off-block time amended by E-DPI, T-DPI-t (target take-off time) or
REA message.

Present if different from the latest flight plan related estimated off-block time in
flightId.keys; null otherwise.

The cdmEstimatedOffBlockTime corresponds to the off-block time in the FTFM flight profile. So
in case DPIs have been received (not cancelled by a C-DPI), then cdmEstimatedOffBlockTime =
DPI TTOT - DPI taxi-time, except if it concerns a DPI that creates a CTFM flight profile (ATC-
DPI or T-DPI-s that is conform with the slot window), then the TTOT is stored in the
actualTakeOffTime.

f. DateTimeMinute calculatedOffBlockTime (Optional)

The calculatedOffBlockTime corresponds to the off-block time in the RTFM flight profile.

g. DateTimeMinute actualOffBlockTime (Optional)

The actualOffBlockTime corresponds to the off-block time in the CTFM flight profile.

h. RevisionTimes revisionTimes (Optional)

Edition: 27.0 6 986

Document Title: NM 27.0 - NM B2B Reference Manual

Revision times, i.e. times to insert an aircraft in sequence and remove an aircraft from
sequence at the aerodrome of departure.

i. DateTimeMinute estimatedTakeOffTime (Optional)

Estimated take-off time: the take-off time corresponding to the FTFM flight profile.

The corresponding estimated off-block time of the FTFM flight profile is the
flight.estimatedTakeOffTime - flight.taxiTime (Note that this can be different than the latest
flight plan related estimated off-block time in flightId.keys).

j. DateTimeMinute calculatedTakeOffTime (Optional)

Calculated take-off time: the take-off time corresponding to the RTFM flight profile.

The corresponding calculated off-block time is the flight.calculatedTakeOffTime -

flight.taxiTime (except in some cases in FORECAST dataset).

k. DateTimeMinute actualTakeOffTime (Optional)

Estimated Actual take-off time: the take-off time corresponding to the CTFM flight profile.

The corresponding estimated actual off-block time is the flight.actualTakeOffTime -

flight.currentDepartureTaxiTimeAndProcedure .

l. ShiftHourMinute ctotShiftAlreadyAppliedByTower (Optional)

Shift of calculated take-off time already applied by tower.

m. FlightLevel requestedFlightLevel (Optional)

This field is only returned in concrete FlightListByLocationReplyData types. It is ignored (and

therefore not returned) if requested in other flight request types.

In FlightListByAerodromeReply, FlightListByAerodromeSetReply and

FlightListByAircraftOperatorReply, the field is the highest requested flight level.

In other concrete FlightListByLocationReplyData types, it represents the requested flight

level applicable on the portion of the flight route that penetrates the location.

n. DurationHourMinute taxiTime (Optional)

Departure taxi time used by NM in the FTFM flight model. Usually, it has the same value as
Flight.currentTaxiTimeAndProcedure.taxiTime, except after reception of an ATC DPI
message with a taxi time value different from the one contained in previous DPI messages
for this flight.

Note: The taxi time from an ATC DPI message may only update Flight.taxiTime when the
ATC DPI is a special request for CTOT extension or recalculation (tower update).

o. TaxiTimeAndProcedure currentDepartureTaxiTimeAndProcedure (Optional)

Edition: 27.0 6 987

Document Title: NM 27.0 - NM B2B Reference Manual

Most accurate departure taxi time and terminal procedure (SID) as known by NM and used
in the highest available TFM flight model (CTFM if it exists, otherwise RTFM if it exists,
otherwise FTFM).

The departure taxi time and terminal procedure may originate from various sources (CACD,
flight plan, local runway configuration, REA and DPI messages). The departure information
received from CDM airports via DPI and REA messages always take precedence over any
other source.

p. DateTimeMinute estimatedTimeOfArrival (Optional)

Estimated time of arrival: time of arrival according to the FTFM flight profile.

q. DateTimeMinute calculatedTimeOfArrival (Optional)

Calculated time of arrival: time of arrival accorting to the RTFM flight profile.

r. DateTimeMinute actualTimeOfArrival (Optional)

Estimated Actual time of arrival: time of arrival according to the CTFM flight profile.

s. boolean lateFiler (Optional)

True if the status of the flight is "Late Filer".

t. boolean lateUpdater (Optional)

True if the status of the flight is "Late Updater".

u. SuspensionStatus suspensionStatus (Optional)

Suspension status.

v. string suspensionInfo (Optional)

Documentation last updated: 27.0 - Edition 1

The suspension details. See table below.

Table 46. Suspension info texts retrieved from the FLS comment

Reason Suspension info text

NO_AIRPORT_SLOT NO AIRPORT SLOT OR EOBT DOES NOT

MATCH WITH AIRPORT SLOT. REQUEST AN
AIRPORT SLOT OR UPDATE THE EOBT.

TOBT_UNKNOWN_OR_EXPIRED TOBT UNKNOWN OR EXPIRED. UPDATE THE

TOBT/EOBT.

TSAT_EXPIRED TSAT EXPIRED. UPDATE THE TOBT/EOBT.

Edition: 27.0 6 988

Document Title: NM 27.0 - NM B2B Reference Manual

Reason Suspension info text

RETURN_TO_STAND A/C RETURN TO STAND. UPDATE THE

TOBT/EOBT WHEN KNOWN, OR CNL THE
FPL.

FLIGHT_PLAN_INVALID ALIGN EOBT AND TOBT.

FLIGHT_CANCEL_IN_AODB FLIGHT CANCELLED IN AODB. CNL THE FPL.

UNDEFINED/OTHER

w. FAMStatus famStatus (Optional)

FAM (Flight Activation Monitoring) status.

x. ReadyStatus readyStatus (Optional)

Ready status.

y. AircraftOperatorICAOId aircraftOperator (Optional)

Aircraft operator.

z. AircraftOperatorICAOId operatingAircraftOperator (Optional)

Operating aircraft operator.

aa. ReroutingIndicator reroutingIndicator (Optional)

Indicates if the flight was rerouted, why, and the resulting rerouting state.

ab. DurationHourMinute newRouteMinShiftDelayImprovement (Optional)

Minimum improvement needed (by reducing either the shift or the delay of the flight) to
allow an Aircraft Operator What-If-Reroute. In the current implementation, this value is a
system parameter: the returned value is always the same for all flights.

ac. ReroutableStatus reroutable (Optional)

Indicates if the flight is reroutable and under what conditions.

ad. CDM cdm (Optional)

CDM (Collaborative Design Making) information.

ae. boolean slotIssued (Optional)

Indicates that the flight is in state slot-issued or was in that state prior to
activation/termination.

af. ProposalInformation proposalInformation (Optional)

General information about the proposal for the flight. This attribute is only present (not

Edition: 27.0 6 989

Document Title: NM 27.0 - NM B2B Reference Manual

null) if requested and there is an ongoing SIP, RVR, rerouting (RRP), STAM or delay
confirmation proposal.

ag. GroupReroutingSummary bestReroutingIndicator (Optional)

The rerouting indicator of the best group rerouting affecting the flight and that did not
produce a rerouting proposal. The purpose of this attribute is to allow the AOs to better
prioritise the evaluation of the flight reroutings.

ah. TimeAndModel timeAtReferenceLocationEntry (Optional)

Indicates the entry time at the reference location.

ai. TimeAndModel timeAtReferenceLocationExit (Optional)

Indicates the exit time at the reference location.

aj. FlightLevel flightLevelAtReferenceLocationEntry (Optional)

Indicates the flight level when entering the reference location.

ak. FlightLevel flightLevelAtReferenceLocationExit (Optional)

Indicates the flight level when exiting the reference location.

al. FlightTrend trendAtReferenceLocationEntry (Optional)

This field is only returned in FlightListByAirspaceReply and FlightListByTrafficVolumeReply.

It is ignored (and therefore not returned) if requested in other flight request types.

Flight trend at the entry point of the location, i.e. cruising, climbing or descending.

am. FlightTrend trendAtReferenceLocationExit (Optional)

This field is only returned in FlightListByAirspaceReply and FlightListByTrafficVolumeReply

. It is ignored (and therefore not returned) if requested in other flight request types.

Flight trend at the exit point of the location, i.e. cruising, climbing or descending.

an. FlightTrend trendAtReferenceLocationMiddle (Optional)

Flight trend at the middle point of the location, i.e cruising, climbing or descending.

ao. boolean exemptedFromRegulations (Optional)

True if the flight is exempted from regulations.

ap. DurationHourMinute delay (Optional)

The ATFM delay. This is computed as the calculated take-off time (excluding slot extensions
requested by the AO) minus the take-off time requested by the AO (therefore excluding the
effect of t-DPI-s, REA messages and OBT changes by flow controllers). Hence it does not

Edition: 27.0 6 990

Document Title: NM 27.0 - NM B2B Reference Manual

always correspond to calculatedTakeOffTime - estimatedTakeOffTime .

aq. DelayCharacteristics delayCharacteristics (Optional)

Identifies the characteristics of the delay value associated to the flight.

ar. RegulationId mostPenalisingRegulation (Optional)

Most penalising regulation impacting this flight.

as. boolean hasOtherRegulations (Optional)

Indicates if this flight is impacted by other regulations than the most penalising one.

at. FlightRegulationLocation[] regulationLocations (Optional)

Locations of the regulations impacting this flight.

au. set< FlightAtfcmMeasureLocation > atfcmMeasureLocations (Optional)

Locations of the ATFCM measures impacting this flight.

av. ATFMMessageType lastATFMMessageType (Optional)

Indicates the type of the last exchanged ATFM message.

aw. ReceivedOrSent lastATFMMessageReceivedOrSent (Optional)

Indicates whether the last ATFM message was received or sent by NM.

ax. DistanceM runwayVisualRange (Optional)

Minimum visible range in meters for a flight to land.

Must be in [ 0, 999 ].

ay. DistanceM minimumRequestedRVR (Optional)

The minimum Runway Visual Range requested by the associated regulation.

Equivalent to -RVR in SAM , SRM , FLS messages.

az. DistanceNM confirmedCTFM (Optional)

Describes the distance on the CTFM (Current Tactical Flight Model) route that has been
confirmed by CPR’s.

ba. ExclusionFromRegulations exclusionFromRegulations (Optional)

Quantitative information regarding the regulations from which this flight is possibly
excluded.

bb. FlightLevel requestedInitialFlightLevel (Optional)

Edition: 27.0 6 991

Document Title: NM 27.0 - NM B2B Reference Manual

The first flight level requested for this flight after departure.

bc. AirSpeed requestedInitialSpeed (Optional)

The first true airspeed requested for this flight after departure.

bd. DurationHourMinute estimatedElapsedTime (Optional)

Estimated elapsed time.

be. FilingRule filingRule (Optional)

Filing rule.

bf. MessageOriginator initialFPLMessageOriginator (Optional)

Originator of the very first FPL message.

bg. MessageOriginator lastFPLMessageOriginator (Optional)

Originator of the last flight plan related message.

bh. string icaoRoute (Optional)

Complete ICAO 4444 item 15 information comprising of initial requested speed and flight
level and route.

Contains corrected flight plan route information sent from NM to addressees outside NM.
Note that the route is not always available, e.g. for flights that are full VFR.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

bi. DistanceNM routeLength (Optional)

Length of the route.

bj. FlightLevel defaultReroutingRequestedFlightLevel (Optional)

When rerouting, suggested flight level to be used for generating an alternate route.

bk. AirSpeed defaultReroutingRequestedSpeed (Optional)

When rerouting, suggested air speed to be used for generating an alternate route.

bl. DepartureTolerance departureTolerance (Optional)

The time window around the FTFM take-off time (for non-regulated flight) or the RTFM take-
off time (for regulated flight) within which the actual take-off time (or TTOT from T-DPI-s
messages) must be set to be considered as compliant.

bm. RegulationCause mostPenalisingRegulationCause (Optional)

Edition: 27.0 6 992

Document Title: NM 27.0 - NM B2B Reference Manual

Cause of the most penalising regulation impacting this flight.

bn. MessageOriginator lastATFMMessageOriginator (Optional)

If the last ATFM message exchanged was received by NM, indicates its originator.

bo. FlightPoint[] ftfmPointProfile (Optional)

FTFM (Filed Tactical Flight Model) point profile.

The FTFM flight profile corresponds to the trafficType DEMAND. So in the operational
dataset, it reflects the latest AO flightplan: i.e. the latest filed flightplan but updated (shifted)
with the latest CDM related info and READY messages or amended by NM OPS room. Note
that the FTFM off-block time does not necessarily corresponds to the
FlightKeys.estimatedOffBlockTime.

bp. FlightPoint[] rtfmPointProfile (Optional)

RTFM (Regulated Tactical Flight Model) point profile. If a flight has an RTFM, then it is the
RTFM flight profile that is used for trafficType REGULATED_DEMAND.

bq. FlightPoint[] ctfmPointProfile (Optional)

CTFM (Current Tactical Flight Model) point profile.

If a flight has an CTFM, then it is the CTFM flight profile that is used for trafficType LOAD.
Typically a flight has a CTFM point profile once it is off-block. However if the flight is
involved in airport CDM, then the flight can have a CTFM point profile even if its CTFM off-
block time is still relatively far in the future (e.g. 40 minutes) due to T-DPI-s.

br. FlightAirspace[] ftfmAirspaceProfile (Optional)

Documentation last updated: 27.0 - Edition 1

FTFM airspace profile.

Note that when part of a P/S FlightDataMessage the airspace profile contains only Elementary
Sectors.

bs. FlightAirspace[] rtfmAirspaceProfile (Optional)

Documentation last updated: 27.0 - Edition 1

RTFM airspace profile.

Note that when part of a P/S FlightDataMessage the airspace profile contains only Elementary
Sectors.

bt. FlightAirspace[] ctfmAirspaceProfile (Optional)

Documentation last updated: 27.0 - Edition 1

Edition: 27.0 6 993

Document Title: NM 27.0 - NM B2B Reference Manual

CTFM airspace profile.

Note that when part of a P/S FlightDataMessage the airspace profile contains only Elementary
Sectors.

bu. FlightTrafficVolume[] ftfmTrafficVolumeProfile (Optional)

FTFM (Filed Tactical Flight Model) traffic volume profile.

i. Access control:

▪ get ftfmTrafficVolumeProfile requires read access to

/flights#traffic_volume_profile
bv. FlightTrafficVolume[] rtfmTrafficVolumeProfile (Optional)

RTFM (Regulated Tactical Flight Model) traffic volume profile.

i. Access control:

▪ get rtfmTrafficVolumeProfile requires read access to

/flights#traffic_volume_profile
bw. FlightTrafficVolume[] ctfmTrafficVolumeProfile (Optional)

CTFM (Current Tactical Flight Model) traffic volume profile.

i. Access control:

▪ get ctfmTrafficVolumeProfile requires read access to

/flights#traffic_volume_profile
bx. RequestedFlightLevel[] ftfmRequestedFlightLevels (Optional)

FTFM requested flight levels.

by. RequestedFlightLevel[] rtfmRequestedFlightLevels (Optional)

RTFM requested flight levels.

bz. RequestedFlightLevel[] ctfmRequestedFlightLevels (Optional)

CTFM requested flight levels.

ca. FlightEvent[] flightHistory (Optional)

Ordered (time) list of events that make up the flight history.

cb. FlightOperationalLogEntry[] operationalLog (Optional)

This attribute can only be retrieved in a retrieval context, not in a list context (i.e. it can only
be retrieved for a single flight via FlightRetrievalRequest ). Ordered (time) list of entries that
make up the flight operational log.

cc. list< ReroutingOpportunities > reroutingOpportunities (Optional) (new 27.0)

Edition: 27.0 6 994

Document Title: NM 27.0 - NM B2B Reference Manual

The most recent rerouting opportunities. This attribute is null if not demanded or if no
opportunities are found.

This attribute can only be retrieved in a retrieval context, not in a list context (i.e. it can only
be retrieved for a single flight via FlightRetrievalRequest ).

cd. EquipmentCapabilityAndStatus equipmentCapabilityAndStatus (Optional)

Indicates the radio communication, navigation and approach aid equipment and
capabilities of an aircraft.

ce. FlightRestriction[] ftfmRestrictionProfile (Optional)

FTFM restriction profile.

cf. FlightRestriction[] rtfmRestrictionProfile (Optional)

RTFM restriction profile.

cg. FlightRestriction[] ctfmRestrictionProfile (Optional)

CTFM restriction profile.

ch. CfmuFlightType cfmuFlightType (Optional)

Indicates state and/or origin of the flight in the NM system.

ci. SSRCode ccamsSSRCode (Optional)

SSR code as assigned by CCAMS.

i. Access control:

▪ get ccamsSSRCode requires read access to /flights#ccams_ssr_code

cj. AircraftRegistrationMark filedRegistrationMark (Optional)

Aircraft registration mark as it was filed via flight plan messages.

Note that the registration mark can be provided or updated later, via DPI messages - see
Flight.cdm attribute.

ck. boolean isProposalFlight (Optional)

Indicates if this flight is a proposal flight or not (see Proposal Flights).

cl. boolean hasBeenForced (Optional)

Indicates if for this flights, the delay is or has been forced.

cm. int caughtInHotspots (Optional)

Indicates this flight in how many problem hotspots has been caught.

Edition: 27.0 6 995

Document Title: NM 27.0 - NM B2B Reference Manual

Note that the problem hotspot related fields are trial related (STAM) fields : they are only
accessible (authorized) during specific trials or on test platforms.

i. Constraints:

▪ range : [0, unbounded[

ii. Access control:

▪ get caughtInHotspots requires read access to /hotspots?kind=PROBLEM

cn. set< FlightHotspotLocation > hotspots (Optional)

Locations of all problem hotspots that are impacting this flight.

Note that the problem hotspot related fields are trial related (STAM) fields : they are only
accessible (authorized) during specific trials or on test platforms.

i. Access control:

▪ get hotspots requires read access to /hotspots?kind=PROBLEM

co. FlightMCDMInfo mcdmInfo (Optional)

Measure Collaborative Decision Making Info associated with to this flight: the most relevant
M-CDM measure and its M-CDM state and indications if other M-CDM measures are
impacting the flight.

Note that M-CDM related fields/services are trial related fields (a.o. STAM trials): they are
only accessible (authorized) during specific trials or on test platforms.

i. Access control:

▪ get mcdmInfo requires read access to /mcdmTopics

cp. LoadStateAtReferenceLocation worstLoadStateAtReferenceLocation (Optional)

Indicates what is the worst monitored (entry or OTMV) load state in which this flight is
involved.

Note that the worstLoadStateAtReferenceLocation flight field is only authorized for a user if
he is also authorized to use the TrafficCounts.

See FlightListRequest.worstLoadStateAtReferenceLocationType.

i. Access control:

▪ get worstLoadStateAtReferenceLocation requires read access to /counts

cq. DeltaEntry compareWithOtherTrafficType (Optional)

Comparison between this flight in FlightListRequest.trafficType and the same flight in

FlightListRequest.compareWithOtherTrafficType.

Remark
This attribute is subject to the validation rules

Edition: 27.0 6 996

Document Title: NM 27.0 - NM B2B Reference Manual

FlightListRequest.REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION and
FlightRetrievalRequest.REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION .

cr. CTOTLimitReason ctotLimitReason (Optional)

Possible exceptional reasons that may affect the CTOT allocation of a flight. See
CTOTLimitReason class documentation for more details.

cs. ProfileValidity profileValidity (Optional)

Contains data relating to the validity of the RTFM, or else the FTFM with respect to Flight
Plan violation errors.

ct. TargetTime targetTimeOverFix (Optional)

The target time over the relevant flight profile point for the most penalizing regulation of
the flight and the actual time over (according to the CTFM point profile)

Note: the TargetTime related fields will be restricted to invited users.

i. Access control:

▪ get targetTimeOverFix requires read access to /flights#target_time_over_fix

cu. FlightState flightState (Optional)

Flight state.

cv. FourDPosition lastKnownPosition (Optional)

Last known position of the aircraft expressed as geo-location, flight level and time over.

It corresponds to either the last Correlated Position Report (CPR) or last Aircraft Position
Report (APR) received by the ETFMS system.

this field is updated ONLY in the following circumstances: * When

any airborne report deviates significantly from the computed Current
IMPORTANT Tactical Flight Model (CTFM) profile and therefore the CTFM is
recomputed (in this case the lastKnownPosition corresponds to the
latest CPR or APR received);

▪ When a CPR does not deviate significantly from the computed CTFM profile but the
CTFM was not updated during the 10 minutes prior to the reception of the CPR. Hence
submitting many frequent B2B R/R requests to obtain an updated value of this field
would typically return the same value. The user is therefore strongly discouraged from
requesting this field with unnecessarily high frequency. Using the Flight Data
Publish/Subscribe is definetely the recommended way to consume this field in order for
the caller to avoid the R/R thresholds (see Essentials).

cw. SlotSwapCounter slotSwapCounter (Optional)

Edition: 27.0 6 997

Document Title: NM 27.0 - NM B2B Reference Manual

Slot Swap counter.

cx. list< SlotSwapCandidate > slotSwapCandidateList (Optional)

Documentation last updated: 27.0 - Edition 1

Slot Swap candidate list.

cy. ICAOAircraftAddress aircraftAddress (Optional)

Documentation last updated: 27.0 - Edition 1

The 24 bit aircraft address.

cz. ArrivalInformation arrivalInformation (Optional)

Arrival information from API messages and exchange of times over the coordination fix
point.

da. SlotZone slotZone (Optional)

Slot zone around the CTO of the first en-route regulation.

db. FlightDataVersionNumber flightDataVersionNr (Optional)

The version number of the flight data: the version number increases as the flight data
changes over time.

Over P/S the values of this attribute may not be contigous (i.e. there may be
NOTE "holes"). This is because not every flight event is translated into a P/S
message (e.g. for events related to CCAMS).

dc. list< TrafficVolumeScenarios > applicableScenarios (Optional)

The applicable Scenarios (from the scenario repository) for this flight.

Note that the heavy applicableScenario related field is subject to specific authorization.

i. Access control:

▪ get applicableScenarios requires read access to /scenarios

dd. APISubmissionRules apiSubmissionRules (Optional)

Identifies the API (Arrival Planning Information) service(s) that can be used to submit TTA
(Target Time of Arrival) requests for this flight.

de. set< RegulationId > avoidedRegulations (Optional)

All the regulations that have been avoided by the different flight plan changes for this flight
(via flight plan update or via cancel-refile).

Edition: 27.0 6 998

Document Title: NM 27.0 - NM B2B Reference Manual

Note that this fields allows to identify why a flight might have a "special" route and it allows
to identify, if a regulation is cancelled, which flights might be interested in going back to
their original route (e.g. for flights that had to reroute due to a 0-rate suspending
regulations).

i. Constraints:

▪ set size range : [1, unbounded[

ii. Access control:

▪ get avoidedRegulations requires read access to /flights#avoided_regulations

df. int routeChargeIndicator (Optional)

Documentation last updated: 27.0 - Edition 1

The route charge indicator. In the context of a P/S FlightDataMessage, the indicator is
computed on the basis of the highest model (CTFM if it exists, otherwise the RTFM if it exists
otherwise the FTFM). In a flight list or flight retrieval context, it is computed on the basis of
the RTFM if it exists otherwise the FTFM. This shall not be taken as an accurate value for the
actual charges but as a cost indicator to be able to compare different routes.

i. Constraints:

▪ range : [0, unbounded[

dg. int fuelConsumptionIndicator (Optional)

Documentation last updated: 27.0 - Edition 1

The fuel consumption indicator. In the context of a P/S FlightDataMessage, the indicator is
computed on the basis of the highest model (CTFM if it exists, otherwise the RTFM if it exists
otherwise the FTFM). In a flight list or flight retrieval context, it is computed on the basis of
the RTFM if it exists otherwise the FTFM. This shall not be taken as an accurate value but
simply as an indicator to be used for comparing different routes.

i. Constraints:

▪ range : [0, unbounded[

dh. set< RegulationId > excludedRegulations (Optional)

All the regulations that have been excluded for the flight.

i. Constraints:

▪ set size range : [1, unbounded[

di. YoYoFlightForLocation yoyoFlightForLocation (Optional)

Indicates the presence or not of a YoYo portion on the queried model and/or queried
location.

dj. TurnFlightForLocation turnFlightForLocation (Optional)

Edition: 27.0 6 999

Document Title: NM 27.0 - NM B2B Reference Manual

Indicates the presence or not of a Sharp Turn Angle portion on the queried model and/or
queried location.

dk. WakeTurbulenceCategory wakeTurbulenceCategory (Optional)

Wake turbulence category.

dl. list< AerodromeICAOId > alternateAerodromes (Optional)

ICAO identifiers of the alternate aerodromes provided in the last received FPL.

i. Constraints:

▪ list size range : [0, 2]

dm. FlightCriticalityIndicator flightCriticality (Optional)

If a flight is critical (and the field is requested) then flightCriticality contains that
criticality information.

dn. boolean oceanicReroute (Optional)

Flag indicating whether the 2D route has been changed by FNM/MFS.

do. FlightVisibility visibility (Optional)

The flight visibility indicator.

dp. AircraftIATAIdFromDataSource iataFlightDesignator (Optional) (new 27.0)

The IATA flight designator and the data source it comes from.

dq. list< ACDMAlertData > activeACDMAlerts (Optional) (new 27.0)

The list of active A-CDM alerts for the flight.

i. Constraints:

▪ list size range : [1, unbounded[

dr. list< ReroutingFeedback > aoReroutingFeedbacks (Optional) (new 27.0)

AO feedback to GRRT alternative route proposals.

i. Constraints:

▪ list size range : [1, unbounded[

ds. boolean atcCoordinatedRoute (Optional) (new 27.0)

Indicates that the route is coordinated by ATC.

2. Used by: FlightDataMessage, FlightRetrievalReplyData, FlightOrFlightPlan

Edition: 27.0 6 1000

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.91. FlightAirspace
<<class>>

Describes an airspace in a flight airspace profile.

1. Attributes:

a. AirspaceId airspaceId (Mandatory)

Airspace id.

b. AirspaceType airspaceType (Mandatory)

Airspace type.

c. DateTimeSecond firstEntryTime (Mandatory)

Time of first entry of the flight in the airspace.

d. FlightLevel firstEntryFlightLevel (Mandatory)

The flight level at the first entry in the airspace.

e. FlightLevel lastExitFlightLevel (Mandatory)

The flight level at the last exit from the airspace.

f. FlightTrend firstEntryTrend (Mandatory)

The flight trend at the first entry in the airspace.

g. FlightTrend middleTrend (Mandatory)

The flight trend at the middle of the airspace.

h. DistanceNM firstEntryDistance (Mandatory)

Distance flown at the first entry of the flight in the airspace.

i. DateTimeSecond lastExitTime (Mandatory)

Time of last exit of the flight from the airspace.

j. FlightTrend lastExitTrend (Mandatory)

The flight trend at the last exit from the airspace.

k. DistanceNM lastExitDistance (Mandatory)

Distance flown at the last exit of the flight from the airspace.

l. DurationHourMinuteSecond occupancyDuration (Mandatory)

Edition: 27.0 6 1001

Document Title: NM 27.0 - NM B2B Reference Manual

Elapsed time flown in the airspace.

m. DistanceNM occupancyDistance (Mandatory)

Distance flown in the airspace.

n. boolean activated (Mandatory)

True if the airspace is a sector and the sector is activated at the moment of the flight.

2. Used by: Flight

19.7.92. FlightArrivalReplyData
<<class>>

The FlightArrivalReply payload.

1. Inherits from: FilingReplyData

2. Used by: FlightArrivalReply

19.7.93. FlightConfirmationReplyData
<<class>>

The FlightConfirmationReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: FlightConfirmationReply

19.7.94. FlightCriticalityIndicator
<<class>>

Contains the criticality information related to a flight.

1. Attributes:

a. FlightCriticalityKind kind (Mandatory)

The reason why a flight is flagged critical.

b. string comment (Optional)

Additional context info like : for an airport closure : before what time (UTC) does the flight
need to land. For more info about what should typically be provided for each kind of
criticality : see FlightCriticalityKind.

2. Used by: EhelpDeskTicketUpdateRequest, EhelpDeskTicketCreationRequest, Flight,

FlightCriticalityRequest, FlightCriticalityReplyData

Edition: 27.0 6 1002

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.95. FlightCriticalityKind
<<enumeration>>

The reason why a flight is flagged critical.

1. Values:

a. CRITICAL_DUE_TO_AIRPORT_CLOSURE

The flight is flagged critical because it needs to land before a given time due to
airport_closure/curfew. The latest Take Off Time (UTC) needs to be given inside
FlightCriticalityIndicator.comment.

b. CRITICAL_DUE_TO_NOISE_ABATEMENT

The flight is flagged critical because it needs to land before a given time due to noise
abatement at destination. The latest Take Off Time time (UTC), needs to be given inside
FlightCriticalityIndicator.comment.

c. CRITICAL_DUE_TO_CREW_TIME

The flight is flagged critical because it needs to land before a given time due to crew
time/rotation issues. The latest Take Off Time time (UTC), needs to be given inside
FlightCriticalityIndicator.comment. In addition the crew time issues can be furter detailed.

d. CRITICAL_DUE_TO_PASSENGER_CONNECTIONS

The flight is flagged critical because it needs to land before a given time due to passenger
connection issues (with other flights). The latest Take Off Time time (UTC), needs to be given
inside FlightCriticalityIndicator.comment.

e. CRITICAL_DUE_TO_TURNAROUND_CRITICAL

The flight is flagged critical because it needs to land before a given time because the return
leg needs to land/depart on time. The latest Take Off Time time (UTC), needs to be given
inside FlightCriticalityIndicator.comment. In addition the return flight and it’s latest Take
Off Time time need to be detailed as well.

f. CRITICAL_DUE_TO_AIRFRAME_UTILISATION

The flight is flagged critical because it needs to land before a given time because the
airframe/aircraft needs to be used for another flight. The latest Take Off Time time (UTC),
needs to be given inside FlightCriticalityIndicator.comment. In addition the other flight and
it’s latest Take Off Time time need to be detailed as well.

g. CRITICAL_DUE_TO_PASSENGER_DELAY_COMPENSATION

The flight is flagged critical because it needs to depart before a gven time or otherwise
passengers can claim recompensation (EU261 Limit). The latest Take Off Time time (UTC),
needs to be given inside FlightCriticalityIndicator.comment.

Edition: 27.0 6 1003

Document Title: NM 27.0 - NM B2B Reference Manual

h. CRITICAL_DUE_TO_OTHER_REASONS

The flight is flagged critical because of other reasons (e.g. medical reasons). The latest Take
Off Time time (UTC), needs to be given inside FlightCriticalityIndicator.comment. In
addition the reason needs to be detailed in the comment.

2. Used by: FlightCriticalityIndicator

19.7.96. FlightCriticalityReplyData
<<class>>

The FlightCriticalityReply payload.

1. Attributes:

a. FlightCriticalityIndicator updatedFlightCriticality (Mandatory)

Updated flight criticality.

2. Used by: FlightCriticalityReply

19.7.97. FlightDataMessageFilter (new 27.0)

<<class>>

The message filter of the SubscriptionTopic.FLIGHT_DATA P/S topic subscription.

1. Attributes:

a. boolean includeProposalFlights (Mandatory) (new 27.0)

Determines if the selected flights must include the proposal flights, or only the "real" flights.

b. set< FlightSetDefinitionElement > flightSet (Mandatory)

Selects which flights to filter.

The logical OR operator is meant between the items in the set.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightDataMessageFilter.VALID_FLIGHT_SET

2. Constraints:

a. VALID_FLIGHT_SET (altered 27.0)

▪ flightSet size ≤ 10

The following constraints apply to the overall combination of FlightSetDefinitionElements

and not to the individual sets in each element. For example, if a subscription specifies a
filter on aircraft operators, the total number of aircraft operator identifiers across all

Edition: 27.0 6 1004

Document Title: NM 27.0 - NM B2B Reference Manual

FlightSetDefinitionElements must be less or equal to 100, regardless of the number of

FlightSetDefinitionElements used.

▪ The sum of all FlightSetDefinitionElement.aircraftRegistrations sizes must be ≤ 10000

▪ The sum of all

FlightSetDefinitionElement.aerodromesOfDeparture|aerodromesOfArrival|alternateAerodr
omes sizes must be ≤ 1000

▪ The sum of all FlightSetDefinitionElement.anuIds sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.aircraftOperators sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.flightPlanOriginators sizes must be ≤ 250

Constrained attributes: flightSet

Constrained requests: any using request

3. Used by: FlightDataSubscription, FlightDataSubscriptionCreationRequest,

FlightDataSubscriptionUpdateRequest

19.7.98. FlightDataPayloadConfiguration (new 27.0)

<<class>>

This is the payload configuration class dedicated to the SubscriptionTopic.FLIGHT_DATA subscription

topic.

It allows the user to define the content of the FlightDataMessages published by NM for such a
subscription.

1. Attributes:

a. set< PSFlightField > flightFields (Mandatory)

This is the set of flight fields that will be included in the FlightDataMessage’s payload. The
FlightDataMessage will contain only those flight fields provided via this attribute (and only
if the values of these requested fields are available at NM).

Note that the flight id is always returned.

i. Constraints:

▪ FlightDataPayloadConfiguration.TRAFFIC_VOLUME_SELECTION_REQUIRED

b. boolean concernedUnits (Mandatory)

Indicates whether the message must contain the air navigation units concerned by the flight
plan.

c. TrafficVolumeSelection trafficVolumeSelection (Optional) (new 27.0)

The set of traffic volume sets of which traffic volumes have to be included.

Edition: 27.0 6 1005

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ FlightDataPayloadConfiguration.TRAFFIC_VOLUME_SELECTION_REQUIRED

2. Constraints:

a. TRAFFIC_VOLUME_SELECTION_REQUIRED

The attribute trafficVolumeSelection is mandatory when flightFields contains

highestModelTrafficVolumeProfile.

Constrained attributes: trafficVolumeSelection, flightFields

Constrained requests: any using request

3. Used by: FlightDataSubscription, FlightDataSubscriptionCreationRequest,

FlightDataSubscriptionUpdateRequest

19.7.99. FlightDataset
<<enumeration>>

Describes the flight-related datasets that one can request when retrieving detailed flight data.

1. Values:

a. flightPlan

the reply will return the FlightPlan.

b. flightPlanHistory

the reply will return the FlightPlanHistory.

c. flight

the reply will return the Flight.

2. Used by: FlightRetrievalRequest

19.7.100. FlightDataSubscription (new 27.0)

Edition: 27.0 6 1006

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic FLIGHT_DATA.

1. Inherits from: Subscription

2. Attributes:

a. FlightDataMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. FlightDataPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: FlightDataSubscriptionRetrievalReplyData, FlightDataSubscriptionUpdateReplyData,

FlightDataSubscriptionCreationReplyData

19.7.101. FlightDataSubscriptionCreationReplyData (new 27.0)

<<class>>

The FlightDataSubscriptionCreationReply payload.

1. Attributes:

a. FlightDataSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: FlightDataSubscriptionCreationReply

19.7.102. FlightDataSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The FlightDataSubscriptionRetrievalReply payload.

Edition: 27.0 6 1007

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. FlightDataSubscription subscription (Mandatory)

Instance of the requested subscription.

b. SubscriptionSynchronisationSummary synchronisationSummary (Optional)

Summary information about any on-going subscription synchronisation.

2. Used by: FlightDataSubscriptionRetrievalReply

19.7.103. FlightDataSubscriptionUpdateReplyData (new 27.0)

<<class>>

The FlightDataSubscriptionUpdateReply payload.

1. Attributes:

a. FlightDataSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: FlightDataSubscriptionUpdateReply

19.7.104. FlightDataVersionNumber
<<typedef[int]>>

Flight data version number.

The Flight data Version Number provides a way to easily and unambiguously identify the latest
(most up-to-date) version of the flight data for each flight. This is especially useful in the presence of
flight data received both via R/R and via P/S messages. Please note that this number can only
increase (and not decrease) over time.

1. range : [0, 99999]

2. Used by: Flight

19.7.105. FlightDelayReplyData
<<class>>

The FlightDelayReply payload.

1. Inherits from: FilingReplyData

2. Attributes:

a. FlightPlan flightPlan (Optional)

The updated flight plan.

Edition: 27.0 6 1008

Document Title: NM 27.0 - NM B2B Reference Manual

3. Used by: FlightDelayReply

19.7.106. FlightDepartureReplyData
<<class>>

The FlightDepartureReply payload.

1. Inherits from: FilingReplyData

2. Used by: FlightDepartureReply

19.7.107. FlightEvent
<<class>>

Describes an event acting on a flight and corresponding to an input message or an output message.
All other events are filtered out.

1. Attributes:

a. DateTimeSecond timestamp (Mandatory)

Event occurrence timestamp.

b. FlightEventType type (Mandatory)

Type of the flight event.

c. FlightState resultingState (Mandatory)

Flight state resulting from the event.

d. DateTimeMinute resultingOffBlockTime (Mandatory)

Off-block time resulting from the event.

e. boolean efdSent (Mandatory)

Indicates if an EFD was sent.

f. boolean fumSent (Mandatory)

Indicates if a FUM was sent.

2. Used by: Flight

19.7.108. FlightEventType
<<enumeration>>

Describes the type of an event in a flight history.

Edition: 27.0 6 1009

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. ACH

ATC flight plan CHange. The ATC flight plan change (ACH) is that change message type
distributed by the IFPS upon receipt and successful processing of an FNM, MFS, and AFP for
which a valid associated flight plan exists in the IFPS.

b. ADI

Anticipated DPI message

c. ADT

Automatic DLA transmission.

d. AFI

AIR-FILED flight plans. Air Filed Flight plans (AFIL) represent flight plans submitted by an
ATS unit to the IFPS for processing on behalf of an aircraft already in flight.

e. APL

ATC flight PLan. The ATC flight plan (APL) is that flight plan message type distributed by the
IFPS upon receipt and successful processing of an FNM, MFS, and AFP for which no valid
associated flight plan exists in the IFPS.

f. APR

AO Position Reports message. For some flights departing from outside the ECAC area, AOs
provide information on their estimated time of arrival.

g. ATT

Take-off from.

h. AXT

Taxi from.

i. CAL

Operator Runway Update.

j. CDI

Cancel DPI message.

k. CEO

EOBT Change for simulation or predict reason.

l. CMC

Edition: 27.0 6 1010

Document Title: NM 27.0 - NM B2B Reference Manual

CCAMS Monitoring: Predicted Conflict.

m. CMN

CCAMS Monitoring: No Conflict Predicted.

n. CNC

CASA slot allocation/update.

o. CPR

Correlated Position Report message. CPRs are extracted from surveillance data (radar
derived positions).

p. CPT

Placed on time over by CASA.

q. CRL

CCAMS Code Release Message.

r. CRQ

CCAMS Code Request Message

s. CSC

CASA Slot Cancellation.

t. CSU

CCAMS Ssr Info assignment/update.

u. DAU

Operator Dynamic Airspace Update.

v. EDI

Early DPI message.

w. EMR

Error Message.

x. FCM

Flight Confirmation Message when:

1. An AO indicates to ETFMS the RVR capability of a flight with an EOBT in the future.Flight
Confirmation Message.

Edition: 27.0 6 1011

Document Title: NM 27.0 - NM B2B Reference Manual

2. An AO indicates to ETFMS that a flight with an EOBT in the future is now confirmed for
the regulation(s) provided in this FCM.

3. An AO indicates to ETFMS that a flight with an EOBT in the future is now confirmed for
the regulation(s) provided in this FCM.

y. FDI

FAA ASDI Departure Information message.

z. FLS

CASA FLight Suspension message with booking. Flight suspension until further notice. In
case of:

1. Aerodrome closure.

2. Runway Visual Range (RVR) unknown.

3. Reception of an SMM message.

4. Not reported as airborne.

5. Suspended by departure airport (cancel DPI message).

aa. FSA

First System Activation message. FSA is a message designed to enable ATC systems to
automatically inform NM of significant events affecting a flight. The FSA message can only
be sent by ATC and is normally generated automatically by an ATC system.

ab. FUM

Flight Update Message. The flight status information sent to the IFPS by the ETFMS.

ac. GAI

General API.

ad. IAR

IFPS ARrival message. Indicates the arrival of a flight plan.

ae. ICA

IFPS CAncel message. Indicates the cancel of a flight plan by IFPS.

af. ICH

IFPS CHange message. Updates certain items of a flight plan by IFPS.

ag. IDE

IFPS DEparture message. Indicates the departure of a flight plan by IFPS.

Edition: 27.0 6 1012

Document Title: NM 27.0 - NM B2B Reference Manual

ah. IDL

IFPS DeLay message. Indicates a delay for the departure of a flight plan by IFPS.

ai. IFP

IFPS Flight Plan message. Indicates the creation of a flight plan by IFPS.

aj. MET

Meteo update.

ak. MSG

Output of ATFM message(s).

al. NEV

No event.

am. OAI

Target Time-Over API.

an. OAR

ATFM Rerouting.

ao. OCA

Operator Cancellation.

ap. OCM

Operator Change Manual suspension.

aq. ODA

Operator De-Activation.

ar. OEX

Exempt / de-exempt from regulation.

as. OIC

Operator Confirmation.

at. ORX

Exclude from / re-include in regulation

au. PDI

Edition: 27.0 6 1013

Document Title: NM 27.0 - NM B2B Reference Manual

Predicted DPI.

av. PFI

PFD injection via ADEXP message.

aw. PTX

Documentation last updated: 27.0 - Edition 4

EFD Message Periodic Transmission.

Although there is no periodic transmission for Publish Subscribe Flight Data

(PSFD), the PTX event may appear in very particular cases, when a slight
NOTE
modification to the flight has been postponed until the next EFD periodic
transmission.

ax. REA

Update Readiness message.

ay. RFR

Re-route after reroute cancellation.

az. RJT

Rerouteing reJecTion (RJT) message. An RJT is a negative response to a Rerouteing Proposal

(RRP) message.

ba. RPU (new 27.0)

Republish event.

bb. RRF (new 27.0)

Rerouting Feedback from AO.

bc. RRM

Rerouting Proposal Creation.

bd. RSF

Reset Simulation Flight to its initial simulation state (as it was at start simulation).

be. RSI

CASA Revoke slot proposal.

bf. RSU

Edition: 27.0 6 1014

Document Title: NM 27.0 - NM B2B Reference Manual

Restriction Update.

bg. SCA

Strat Cancel.

bh. SCM

CCAMS Sync CCM.

bi. SIP

CASA SIP booking.

bj. SIT

CASA SIT time out.

bk. SMM

Slot Missed Message. An SMM is sent when the last received CTOT issued cannot be met and
a new EOBT is NOT known.

bl. SPA

Slot improvement Proposal Acceptance (SPA) message. An SPA is a positive response to a SIP
which is received from NM. The AO will send an SPA if the proposed NEWCTOT in the SIP is
acceptable.

bm. SRJ

Slot improvement proposal ReJection (SRJ) message. An SRJ is a negative response to a SIP
received from NM. The AO will send an SRJ if they are unable to accept the proposed
improvement.

bn. SSC

CCAMS Sync SLC.

bo. SSM

CCAMS Sync SAM.

bp. SSP

CASA Stam Proposal

bq. SSR

CCAMS Sync SRM.

br. SUS

Edition: 27.0 6 1015

Document Title: NM 27.0 - NM B2B Reference Manual

CASA Suspension without booking.

bs. TAC

Assign Ssr Code time out.

bt. TAI

Target Take-Off API.

bu. TAM

Activation monitoring time out.

bv. TDE

Departure time out.

bw. TDI

Target DPI message.

bx. TPF

PFD cancellation time out.

by. TRC

Release Ssr Code time out.

bz. TRE (new 27.0)

Pre-sequenced flights become ready at TOBT/EOBT - 5 minutes.

ca. TRM

Resend Last Message time out.

cb. TSA

Sequenced DPI message.

cc. TSC

Simulate SSR Code time out.

cd. TTE

Termination time out.

ce. UAA (new 27.0)

Updated (new or cancelled) A-CDM alert.

Edition: 27.0 6 1016

Document Title: NM 27.0 - NM B2B Reference Manual

cf. UCD

Update MCDM Data

cg. UFA

Undo Flight Activation Monitoring.

ch. UFC (new 27.0)

Updated Flight Criticality.

ci. UXC

Undo XCD Effect (suspension/shift).

cj. XCR

Created for simulation or predict reason.

2. Used by: FlightDataMessage, FlightEvent

19.7.109. FlightField
<<enumeration>>

Enumerates the fields that the caller may request to be returned in Flight objects.

The NM system associates a weight to flight fields: a flight field is either "light" or "heavy", in the
sense that heavy flight fields are significantly more demanding to return than light ones. NM kindly
requests its customers to apply the following strategy:

1. As a rule, client applications should never request flight fields that they do not need, regardless
to their weight.

2. Client applications typically implement a query/retrieve pattern:

a. Query the small number of most relevant flight fields to display to the end user.

b. Retrieve more details for a given flight (using the FlightRetrievalRequest ) when the end
user has selected a flight from the list.

3. In particular, the client application should avoid requesting heavy fields in a flight list if not
strictly necessary.

4. However, in case one or more heavy fields are strictly necessary in the flight list, the customer
is invited to request indeed the heavy fields in the flight list rather than querying first a "light"
flight list and then iterating on the flight list and retrieving each individual flight to get the
heavy ones.

For a description of each field, please refer to the Flight type.

1. Values:

Edition: 27.0 6 1017

Document Title: NM 27.0 - NM B2B Reference Manual

a. divertedAerodromeOfDestination

Light field. See Flight.divertedAerodromeOfDestination.

b. readyEstimatedOffBlockTime

Light field. See Flight.readyEstimatedOffBlockTime.

c. cdmEstimatedOffBlockTime

Light field. See Flight.cdmEstimatedOffBlockTime.

d. calculatedOffBlockTime

Light field. See Flight.calculatedOffBlockTime.

e. actualOffBlockTime

Light field. See Flight.actualOffBlockTime.

f. aircraftType

Light field. See Flight.aircraftType.

g. estimatedTakeOffTime

Light field. See Flight.estimatedTakeOffTime.

h. calculatedTakeOffTime

Light field. See Flight.calculatedTakeOffTime.

i. actualTakeOffTime

Light field. See Flight.actualTakeOffTime.

j. ctotShiftAlreadyAppliedByTower

Light field. See Flight.ctotShiftAlreadyAppliedByTower.

k. taxiTime

Light field. See Flight.taxiTime.

l. currentDepartureTaxiTimeAndProcedure

Light field. See Flight.currentDepartureTaxiTimeAndProcedure.

m. revisionTimes

Light field. See Flight.revisionTimes.

n. estimatedTimeOfArrival

Edition: 27.0 6 1018

Document Title: NM 27.0 - NM B2B Reference Manual

Light field. See Flight.estimatedTimeOfArrival.

o. calculatedTimeOfArrival

Light field. See Flight.calculatedTimeOfArrival.

p. actualTimeOfArrival

Light field. See Flight.actualTimeOfArrival.

q. requestedFlightLevel

Light field. See Flight.requestedFlightLevel.

r. timeAtReferenceLocationEntry

Light field. See Flight.timeAtReferenceLocationEntry.

s. timeAtReferenceLocationExit

Light field. See Flight.timeAtReferenceLocationExit.

t. flightLevelAtReferenceLocationEntry

Light field. See Flight.flightLevelAtReferenceLocationEntry.

u. flightLevelAtReferenceLocationExit

Light field. See Flight.flightLevelAtReferenceLocationExit.

v. trendAtReferenceLocationEntry

Light field. See Flight.trendAtReferenceLocationEntry.

w. trendAtReferenceLocationExit

Light field. See Flight.trendAtReferenceLocationExit.

x. trendAtReferenceLocationMiddle

Light field. See Flight.trendAtReferenceLocationMiddle.

y. lateFiler

Light field. See Flight.lateFiler.

z. lateUpdater

Light field. See Flight.lateUpdater.

aa. suspensionStatus

Light field. See Flight.suspensionStatus.

Edition: 27.0 6 1019

Document Title: NM 27.0 - NM B2B Reference Manual

ab. suspensionInfo

Heavy field. See Flight.suspensionInfo.

ac. exclusionFromRegulations

Light field. See Flight.exclusionFromRegulations.

ad. famStatus

Light field. See Flight.famStatus.

ae. readyStatus

Light field. See Flight.readyStatus.

af. aircraftOperator

Light field. See Flight.aircraftOperator.

ag. operatingAircraftOperator

Light field. See Flight.operatingAircraftOperator.

ah. reroutingIndicator

Light field. See Flight.reroutingIndicator.

ai. newRouteMinShiftDelayImprovement

Light field. See Flight.newRouteMinShiftDelayImprovement.

aj. reroutable

Light field. See Flight.reroutable.

ak. cdm

Light field. See Flight.cdm.

al. slotIssued

Light field. See Flight.slotIssued.

am. proposalInformation

Light field. See Flight.proposalInformation.

an. bestReroutingIndicator

Light field. See Flight.bestReroutingIndicator.

ao. exemptedFromRegulations

Edition: 27.0 6 1020

Document Title: NM 27.0 - NM B2B Reference Manual

Light field. See Flight.exemptedFromRegulations.

ap. delay

Light field. See Flight.delay.

aq. delayCharacteristics

Light field. See Flight.delayCharacteristics.

ar. mostPenalisingRegulation

Light field. See Flight.mostPenalisingRegulation.

as. hasOtherRegulations

Light field. See Flight.hasOtherRegulations.

at. regulationLocations

Light field. See Flight.regulationLocations.

au. atfcmMeasureLocations

Heavy field. See Flight.atfcmMeasureLocations.

av. lastATFMMessageType

Light field. See Flight.lastATFMMessageType.

aw. lastATFMMessageReceivedOrSent

Light field. See Flight.lastATFMMessageReceivedOrSent.

ax. runwayVisualRange

Heavy field. See Flight.runwayVisualRange.

ay. confirmedCTFM

Heavy field. See Flight.confirmedCTFM.

az. requestedInitialFlightLevel

Heavy field. See Flight.requestedInitialFlightLevel.

ba. requestedInitialSpeed

Heavy field. See Flight.requestedInitialSpeed.

bb. estimatedElapsedTime

Heavy field. See Flight.estimatedElapsedTime.

Edition: 27.0 6 1021

Document Title: NM 27.0 - NM B2B Reference Manual

bc. filingRule

Heavy field. See Flight.filingRule.

bd. initialFPLMessageOriginator

Heavy field. See Flight.initialFPLMessageOriginator.

be. lastFPLMessageOriginator

Heavy field. See Flight.lastFPLMessageOriginator.

bf. icaoRoute

Heavy field. See Flight.icaoRoute.

bg. routeLength

Heavy field. See Flight.routeLength.

bh. defaultReroutingRequestedFlightLevel

Heavy field. See Flight.defaultReroutingRequestedFlightLevel.

bi. defaultReroutingRequestedSpeed

Heavy field. See Flight.defaultReroutingRequestedSpeed.

bj. departureTolerance

Heavy field. See Flight.departureTolerance.

bk. mostPenalisingRegulationCause

Heavy field. See Flight.mostPenalisingRegulationCause.

bl. lastATFMMessageOriginator

Heavy field. See Flight.lastATFMMessageOriginator.

bm. ftfmPointProfile

Heavy field. See Flight.ftfmPointProfile.

bn. rtfmPointProfile

Heavy field. See Flight.rtfmPointProfile.

bo. ctfmPointProfile

Heavy field. See Flight.ctfmPointProfile.

bp. ftfmAirspaceProfile

Edition: 27.0 6 1022

Document Title: NM 27.0 - NM B2B Reference Manual

Heavy field. See Flight.ftfmAirspaceProfile.

bq. rtfmAirspaceProfile

Heavy field. See Flight.rtfmAirspaceProfile.

br. ctfmAirspaceProfile

Heavy field. See Flight.ctfmAirspaceProfile.

bs. ftfmRequestedFlightLevels

Heavy field. See Flight.ftfmRequestedFlightLevels.

bt. rtfmRequestedFlightLevels

Heavy field. See Flight.rtfmRequestedFlightLevels.

bu. ctfmRequestedFlightLevels

Heavy field. See Flight.ctfmRequestedFlightLevels.

bv. flightHistory

Heavy field. See Flight.flightHistory.

bw. operationalLog

Heavy field. See Flight.operationalLog.

bx. reroutingOpportunities (new 27.0)

Heavy field. See Flight.reroutingOpportunities.

by. equipmentCapabilityAndStatus

Heavy field. See Flight.equipmentCapabilityAndStatus.

bz. ftfmRestrictionProfile

Heavy field. See Flight.ftfmRestrictionProfile.

ca. rtfmRestrictionProfile

Heavy field. See Flight.rtfmRestrictionProfile.

cb. ctfmRestrictionProfile

Heavy field. See Flight.ctfmRestrictionProfile.

cc. cfmuFlightType

Light field. See Flight.cfmuFlightType.

Edition: 27.0 6 1023

Document Title: NM 27.0 - NM B2B Reference Manual

cd. ccamsSSRCode

Light field. See Flight.ccamsSSRCode.

ce. filedRegistrationMark

Light field. See Flight.filedRegistrationMark.

cf. isProposalFlight

Light field. See Flight.isProposalFlight.

cg. hasBeenForced

Light field. See Flight.hasBeenForced.

ch. caughtInHotspots

Light field. See Flight.caughtInHotspots.

ci. hotspots

Heavy field. See Flight.hotspots.

cj. mcdmInfo

Light field. See Flight.mcdmInfo.

ck. worstLoadStateAtReferenceLocation

Light field. See Flight.worstLoadStateAtReferenceLocation.

cl. compareWithOtherTrafficType

Light field. See Flight.compareWithOtherTrafficType.

cm. ctotLimitReason

Light field. See Flight.ctotLimitReason.

cn. profileValidity

Light field. See Flight.profileValidity.

co. targetTimeOverFix

Heavy field. See Flight.targetTimeOverFix.

cp. flightState

Light field. See Flight.flightState.

cq. lastKnownPosition

Edition: 27.0 6 1024

Document Title: NM 27.0 - NM B2B Reference Manual

Light field. See Flight.lastKnownPosition.

cr. highestModelPointProfile

Heavy field.

The CTFM point profile if it exists, otherwise the RTFM point profile if it exists, otherwise the
FTFM point profile.

cs. highestModelAirspaceProfile

Heavy field.

The CTFM airspace profile if it exists, otherwise the RTFM airspace profile if it exists,
otherwise the FTFM airspace profile.

ct. highestModelRestrictionProfile

Heavy field.

The CTFM restriction profile if it exists, otherwise the RTFM restriction profile if it exists,
otherwise the FTFM restriction profile.

cu. slotSwapCounter

Light field. See Flight.slotSwapCounter.

cv. slotSwapCandidateList

Light field. See Flight.slotSwapCandidateList.

cw. aircraftAddress

Light field. See Flight.aircraftAddress.

cx. arrivalInformation

Light field. See Flight.arrivalInformation.

cy. slotZone

Light field. See Flight.slotZone.

cz. flightDataVersionNr

Light field. See Flight.flightDataVersionNr.

da. applicableScenarios

Heavy field. See Flight.applicableScenarios.

db. apiSubmissionRules

Edition: 27.0 6 1025

Document Title: NM 27.0 - NM B2B Reference Manual

Light field. See Flight.apiSubmissionRules.

dc. avoidedRegulations

Light field. See Flight.avoidedRegulations.

dd. routeChargeIndicator

Heavy field. See Flight.routeChargeIndicator.

de. fuelConsumptionIndicator

Heavy field. See Flight.fuelConsumptionIndicator.

df. excludedRegulations

Heavy field. See Flight.excludedRegulations.

dg. yoyoFlightForLocation

Light field. See Flight.yoyoFlightForLocation.

dh. turnFlightForLocation

Light field. See Flight.turnFlightForLocation.

di. minimumRequestedRVR

Light field. See Flight.minimumRequestedRVR.

dj. wakeTurbulenceCategory

Light field. See Flight.wakeTurbulenceCategory.

dk. alternateAerodromes

Light field. See Flight.alternateAerodromes.

dl. flightCriticality

Light field. See Flight.flightCriticality.

dm. oceanicReroute

Light field. See Flight.oceanicReroute.

dn. visibility

Light field. See Flight.visibility.

do. iataFlightDesignator (new 27.0)

Light field. See Flight.iataFlightDesignator attribute.

Edition: 27.0 6 1026

Document Title: NM 27.0 - NM B2B Reference Manual

dp. activeACDMAlerts (new 27.0)

Light field. See Flight.activeACDMAlerts attribute.

dq. aoReroutingFeedbacks (new 27.0)

Heavy field. See Flight.aoReroutingFeedbacks attribute.

dr. atcCoordinatedRoute (new 27.0)

Light field. See Flight.atcCoordinatedRoute.

2. Used by: FlightRetrievalRequest, FlightListRequest

19.7.110. FlightFilingResultMessageFilter (new 27.0)

<<class>>

The message filter for subscription topic SubscriptionTopic.FLIGHT_FILING_RESULT .

It must be provided within a FLIGHT_FILING_RESULT subscription to specify which notifications to

receive.

1. Attributes:

a. set< AirNavigationUnitId > messageOriginators (Optional)

A set of ATS message originators: when provided, only notifications related to filing
submissions received by IFPS from those originators are captured by the subscription.

i. Constraints:

▪ set size range : [1, 20]

b. AircraftOperatorFilter aircraftOperators (Optional)

When provided, it filters the messages based on aircraft operators.

c. set< ATSMessageType > messageTypes (Optional)

This specifies the set of ATS message types whose processing the user wants to be notified
about.

For example, setting this field to [ FPL , CHG , DLA , CNL ] will generate notifications about the
processing of those message types only. So:

▪ if a DLA message is processed by IFPS, it will trigger a FlightFilingResultMessage with the

result of the processing

▪ if an AFP message is sent to IFPS, this will not trigger a FlightFilingResultMessage because
AFP is not listed in the set.

Note that the enumerator OTHER shall be used to specify any message not explicitly
enumerated and any unknown message type.

Edition: 27.0 6 1027

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ set size range : [1, unbounded[

d. FilingStatusFilter filingStatus (Optional)

When provided, it filters the messages based on filing processing status.

2. Used by: FlightFilingResultSubscriptionUpdateRequest, FlightFilingResultSubscription,

FlightFilingResultSubscriptionCreationRequest

19.7.111. FlightFilingResultSubscription (new 27.0)

<<class>>

Subscription of topic FLIGHT_FILING_RESULT.

1. Inherits from: Subscription

2. Attributes:

a. FlightFilingResultMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

3. Used by: FlightFilingResultSubscriptionRetrievalReplyData,

FlightFilingResultSubscriptionUpdateReplyData,
FlightFilingResultSubscriptionCreationReplyData

19.7.112. FlightFilingResultSubscriptionCreationReplyData (new 27.0)

<<class>>

The FlightFilingResultSubscriptionCreationReply payload.

1. Attributes:

a. FlightFilingResultSubscription subscription (Mandatory)

Edition: 27.0 6 1028

Document Title: NM 27.0 - NM B2B Reference Manual

Instance of the newly created subscription.

2. Used by: FlightFilingResultSubscriptionCreationReply

19.7.113. FlightFilingResultSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The FlightFilingResultSubscriptionRetrievalReply payload.

1. Attributes:

a. FlightFilingResultSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: FlightFilingResultSubscriptionRetrievalReply

19.7.114. FlightFilingResultSubscriptionUpdateReplyData (new 27.0)

<<class>>

The FlightFilingResultSubscriptionUpdateReply payload.

1. Attributes:

a. FlightFilingResultSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: FlightFilingResultSubscriptionUpdateReply

19.7.115. FlightIdentificationInput
<<union>>

Identification of a flight, assumed to be unique.

1. Choices:

a. IFPLId id

Unique IFPL id.

b. FlightKeys keys

Flight keys.

c. IATAFlightKeys iataKeys (new 27.0)

IATA flight keys.

2. Used by: FlightRetrievalRequest

Edition: 27.0 6 1029

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.116. FlightIdentificationOutput
<<class>>

Identification of a flight, assumed to be unique.

1. Attributes:

a. IFPLId id (Optional)

Unique IFPL id.

b. FlightKeys keys (Optional)

Flight keys.

2. Used by: FlightFilingResultMessage, Flight, FlightPlanSummary

19.7.117. FlightInformationUpdateReplyData
<<abstract class>>

1. Attributes:

a. string additionalInfo (Optional)

Details about the processing of flight information update requests.

19.7.118. FlightInformationUpdateRequest

<<abstract class>>

Base class of all Airport Planning Information requests.

1. Inherits from: Request

2. Attributes:

a. AircraftICAOId aircraftId (Optional)

Aircraft ICAO id.

Edition: 27.0 6 1030

Document Title: NM 27.0 - NM B2B Reference Manual

ADEXP:
-ARCID

i. Constraints:

▪ FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

b. AerodromeICAOId aerodromeOfDeparture (Optional)

ICAO id of the aerodrome of departure.

ADEXP:
-ADEP

i. Constraints:

▪ FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

c. AerodromeICAOId aerodromeOfDestination (Optional)

ICAO id of the aerodrome of destination.

ADEXP:
-ADES

i. Constraints:

▪ FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

d. DateTimeMinute estimatedOffBlockTime (Optional)

Estimated off-block date/time.

ADEXP:
-EOBD + -EOBT

i. Constraints:

▪ FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

e. IFPLId ifplId (Optional)

Unique IFPL identifier as assigned by IFPS. Example: AA12345678.

ADEXP:
-IFPLID

i. Constraints:

▪ FlightInformationUpdateRequest.MISSING_FLIGHT_IDENTIFICATION_FIELDS

3. Constraints:

a. MISSING_FLIGHT_IDENTIFICATION_FIELDS (altered 27.0)

Documentation last updated: 27.0 - Edition 1

Edition: 27.0 6 1031

Document Title: NM 27.0 - NM B2B Reference Manual

Attribute ifplId must be null in a FlightCriticalityRequest or ReroutingFeedbackRequest.

Attributes aircraftId , aerodromeOfDeparture , aerodromeOfDestination and

estimatedOffBlockTime can only be null in a PredictedDPIRequest or ACDMAlertRequest without
presence of attribute ifplId .

In all other cases, these fields must not be null.

Remark
In the current release, a PredictedDPIRequest or ACDMAlertRequest without aircraftId ,
aerodromeOfDeparture , aerodromeOfDestination and estimatedOffBlockTime will be rejected.

Constrained attributes: aircraftId, aerodromeOfDeparture, aerodromeOfDestination,

estimatedOffBlockTime, ifplId

Constrained requests: any using request

19.7.119. FlightKeys
<<class>>

Represents the keys that uniquely identify a flight in the absence of an IFPL id.

1. Attributes:

a. ExtendedAircraftICAOId aircraftId (Mandatory)

Aircraft id, can be an ICAO aircraft id or a special aircraft id containing '$' or '#' characters
used by NM in the context of prediction and simulation exercises.

b. AerodromeICAOId aerodromeOfDeparture (Optional)

ICAO id of the aerodrome of departure.

i. Constraints:

▪ FlightKeys.ADEP_NONICAOADEP_AND_AIRFILED_ARE_MUTUALLY_EXCLUSIVE

▪ FlightKeys.ONE_OF_ADEP_NONICAOADEP_OR_AIRFILED_IS_MANDATORY

c. boolean nonICAOAerodromeOfDeparture (Optional)

True if the aerodrome of departure is not an ICAO one.

i. Constraints:

▪ FlightKeys.ADEP_NONICAOADEP_AND_AIRFILED_ARE_MUTUALLY_EXCLUSIVE

▪ FlightKeys.ONE_OF_ADEP_NONICAOADEP_OR_AIRFILED_IS_MANDATORY

d. boolean airFiled (Mandatory)

True if the flight plan was filed airborne.

Edition: 27.0 6 1032

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ FlightKeys.ADEP_NONICAOADEP_AND_AIRFILED_ARE_MUTUALLY_EXCLUSIVE

▪ FlightKeys.ONE_OF_ADEP_NONICAOADEP_OR_AIRFILED_IS_MANDATORY

e. AerodromeICAOId aerodromeOfDestination (Optional)

Documentation last updated: 27.0 - Edition 6

ICAO id of the filed aerodrome of destination.

Note that business wise the aerodrome of destination is optional (i.e.

aerodromeOfDestination and nonICAOAerodromeOfDestination can both be null):

1. In output (from NM systems): in FlightIdentificationOutput it will always be present.

Otherwise it will typically not be present (a.o. everything Ehelpdesk or MCDM related),
except for everything flightplan related.

2. In input (to NM systems): for everything flightplan related it is mandatory (unless an

ifplId is provided), otherwise it’s opional. For example : in a FlightRetrievalRequest to
retrieve the flightplan it is mandatory, but to retrieve the flight it is not.

i. Constraints:

▪ FlightKeys.ADES_CANNOT_BE_NULL_IF_NOT_NONICAOADES

▪ FlightKeys.ADES_MUST_BE_NULL_IF_NONICAOADES

f. boolean nonICAOAerodromeOfDestination (Optional)

True if the filed aerodrome of destination is not an ICAO one.

i. Constraints:

▪ FlightKeys.ADES_CANNOT_BE_NULL_IF_NOT_NONICAOADES

▪ FlightKeys.ADES_MUST_BE_NULL_IF_NONICAOADES

g. DateTimeMinute estimatedOffBlockTime (Mandatory)

Documentation last updated: 27.0 - Edition 1

Estimated off-block date/time according to the latest processed flightplan message (by IFPS).
So after each flight plan, the flightkeys.estimatedOffBlockTime can change.

This off-block date/time does not necessarily corresponds to the off-

IMPORTANT block date/time of the FTFM flight profile. See
Flight.cdmEstimatedOffBlockTime and Flight.ftfmPointProfile.

2. Constraints:

a. ONE_OF_ADEP_NONICAOADEP_OR_AIRFILED_IS_MANDATORY

Documentation last updated: 27.0 - Edition 1

Edition: 27.0 6 1033

Document Title: NM 27.0 - NM B2B Reference Manual

Either aerodromeOfDeparture value, or nonICAOAerodromeOfDeparture=true or airFiled=true

must be specified.

Constrained attributes: aerodromeOfDeparture, nonICAOAerodromeOfDeparture, airFiled

Constrained requests: any using request

b. ADEP_NONICAOADEP_AND_AIRFILED_ARE_MUTUALLY_EXCLUSIVE

Documentation last updated: 27.0 - Edition 1

Attributes aerodromeOfDeparture , nonICAOAerodromeOfDeparture=true and airFiled=true are

mutually exclusive.

When aerodromeOfDeparture is specified, nonICAOAerodromeOfDeparture and airFiled must be

set to false .

When aerodromeOfDeparture is not specified, one and only one of

nonICAOAerodromeOfDeparture and airFiled must be set to true

Constrained attributes: aerodromeOfDeparture, nonICAOAerodromeOfDeparture, airFiled

Constrained requests: any using request

c. ADES_MUST_BE_NULL_IF_NONICAOADES

Attribute aerodromeOfDestination must be null if nonICAOAerodromeOfDestination is true.

Constrained attributes: aerodromeOfDestination, nonICAOAerodromeOfDestination

Constrained requests: any using request

d. ADES_CANNOT_BE_NULL_IF_NOT_NONICAOADES

Documentation last updated: 27.0 - Edition 1

Attribute aerodromeOfDestination cannot be null if nonICAOAerodromeOfDestination is false.

Note however that aerodromeOfDestination can be null if nonICAOAerodromeOfDestination is

also false.

Constrained attributes: aerodromeOfDestination, nonICAOAerodromeOfDestination

Constrained requests: any using request

3. Used by: NetworkImpactAssessmentFlightChanges, RoutingAssistanceRequest, EhelpDeskFlightId,

EhelpDeskTicket, UpdateFlightInMeasure, InvalidFiling, UpdateFlightsInMeasureReplyData,
EvaluateFlowImpactRequest, EhelpDeskRemoveFlightsFromFmpStamRerouting,
FlightIdentificationInput, FlightIdentificationOutput, MCDMFlightTopic,
EhelpDeskSwapSlotsInRegulation, ReroutingApplyRequest

Edition: 27.0 6 1034

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.120. FlightListByAerodromeReplyData
<<class>>

The FlightListByAerodromeReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByAerodromeReply

19.7.121. FlightListByAerodromeSetReplyData
<<class>>

The FlightListByAerodromeSetReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByAerodromeSetReply

19.7.122. FlightListByAircraftOperatorReplyData
<<class>>

The FlightListByAircraftOperatorReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByAircraftOperatorReply

19.7.123. FlightListByAircraftRegistrationMarkReplyData
<<class>>

The FlightListByAircraftRegistrationMarkReply payload.

1. Inherits from: FlightListReplyData

2. Used by: FlightListByAircraftRegistrationMarkReply

19.7.124. FlightListByAirspaceReplyData
<<class>>

The FlightListByAirspaceReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByAirspaceReply

19.7.125. FlightListByHotspotReplyData
<<class>>

The FlightListByHotspotReply payload.

Edition: 27.0 6 1035

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByHotspotReply

19.7.126. FlightListByKeysReplyData
<<class>>

The FlightListByKeysReply payload.

1. Inherits from: FlightListReplyData

2. Used by: FlightListByKeysReply

19.7.127. FlightListByLocationReplyData
<<abstract class>>

1. Inherits from: FlightListReplyData

2. Attributes:

a. DateTimeMinutePeriod effectiveTrafficWindow (Mandatory)

The effective period of time for which counts/flights were requested: flights from within this
periods have been used in the flightlist/counts. This is the rounded and/or extended request
trafficWindow (based on the countsInterval attribute). See also
FlightListRequest.trafficWindow.

19.7.128. FlightListByLocationRequest

Edition: 27.0 6 1036

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Abstract request to query a flight list by location.

The logical AND operator applies between all the query fields described below and the query fields
of its ancestor request.

1. Inherits from: FlightListRequest

2. Attributes:

a. CountsInterval countsInterval (Optional)

Documentation last updated: 27.0 - Edition 1

Determines how the effectiveTrafficWindow needs to be derived from the

FlightListRequest.trafficWindow.

By default, the countsInterval.duration is 1 minute and the countsInterval.step is 1 minute.

i. Constraints:

▪ FlightListByLocationRequest.COUNTS_INTERVAL_MUST_BE_NULL

▪ FlightListByLocationRequest.INVALID_COUNTS_INTERVAL

b. AircraftOperatorICAOId[] aircraftOperators (Optional)

Array of aircraft operator ICAO Id(s) for which flights are requested. Mandatory: the array is
empty if there is no such aircraft operator ICAO id.

Edition: 27.0 6 1037

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ array size range : [0, 64]

▪ FlightListByLocationRequest.SLOT_SWAP_CANDIDATE_LIST_REQUIRES_AIRCRAFT_OPERATOR_P
ROVISION
c. boolean includeInvisibleFlights (Optional)

Indicates whether invisible flights (VFR, OAT, STAY, IFPSTOP) shall be included in the flight
list.

This attribute is only used in the following queries:

1. FlightListByAerodromeRequest

2. FlightListByAerodromeSetRequest

3. FlightListByTrafficVolumeRequest (and only if the reference location of the traffic

volume is an airspace, an aerodrome or a set of aerodromes).

This attribute is ignored (i.e. it has no effect) in all other flight list requests.

Defaults to false , i.e. by default invisible flights are not returned.

The flight visibility details are exposed by the Flight.visibility field.

3. Constraints:

a. COUNTS_INTERVAL_MUST_BE_NULL

Documentation last updated: 27.0 - Edition 6

The attribute countsInterval must be null when this request is a FlightListByHotspotRequest.

Constrained attributes: countsInterval

Constrained requests: any using request

b. INVALID_COUNTS_INTERVAL

Documentation last updated: 27.0 - Edition 6

The attributes countsInterval.step and countsInterval.duration must be 0001 when this

request is a FlightListByMeasureRequest.

Constrained attributes: countsInterval

Constrained requests: any using request

c. SLOT_SWAP_CANDIDATE_LIST_REQUIRES_AIRCRAFT_OPERATOR_PROVISION (new 27.0)

The requestedFields.slotSwapCandidateList can be requested on

FlightListByAircraftOperatorRequest and on all other types of FlightListByLocationRequest
provided that the list of aircraftOperators is provided. The

Edition: 27.0 6 1038

Document Title: NM 27.0 - NM B2B Reference Manual

requestedFields.slotSwapCandidateList cannot be requested for other types of

FlightListRequest (i.e., FlightListByKeysRequest and
FlightListByAircraftRegistrationMarkRequest).

Constrained attributes: aircraftOperators

Constrained requests: any using request

19.7.129. FlightListByMeasureMode
<<enumeration>>

Documentation last updated: 27.0 - Edition 6

Flight List By Measure Mode.

For a regulation the concerned flights are those flights that use a regulation slot. However not all of
them have an actual delay/have received a slot allocation message (typically exempted flights do
not get regulated in a normal regulation (non-exceptional-conditions regulation). For a regulation,
the flights that the measure has impacted (measure activated), are a subset of those flights: only
those flights that did get a delay (can be 0 minutes) and have/will receive a SAM (Slot Allocation
Message).

For a rerouting/MCDM-only measure, the concerned flights are those flights that cross the
location/traffic volume during the period on the optional flow, while the flights that the measure
has impacted (measure activated: activated_by_measure), are typically a subset of those flights
(except when a rerouting has been executed: the rerouted flights don’t cross the location anymore):
returns those flights that have been cherry picked for the rerouting/MCDM-only
measure(irrespective if they still cross the location). Note that even if a flight has been cherry
picked for a rerouting, it does not mean that the rerouting could find an alternate
route/improvement (the result can be found inside the flight field: FlightAtfcmMeasureLocation).

1. Values:

a. CONCERNED_BY_MEASURE

The flight list will contain all flights concerned by the measure (not necessarily impacted).

b. ACTIVATED_BY_MEASURE

The flight list will contain all flights impacted by the measure.

2. Used by: FlightListByMeasureRequest

19.7.130. FlightListByMeasureReplyData
<<class>>

The FlightListByMeasureReply payload.

1. Inherits from: FlightListByLocationReplyData

Edition: 27.0 6 1039

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: FlightListByMeasureReply

19.7.131. FlightListByPointReplyData
<<class>>

The FlightListByPointReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByPointReply

19.7.132. FlightListByTrafficVolumeReplyData
<<class>>

The FlightListByTrafficVolumeReply payload.

1. Inherits from: FlightListByLocationReplyData

2. Used by: FlightListByTrafficVolumeReply

19.7.133. FlightListReplyData

<<abstract class>>

Abstract reply returned in response to an abstract FlightListRequest.

1. Attributes:

a. FlightOrFlightPlan[] flights (Mandatory)

Edition: 27.0 6 1040

Document Title: NM 27.0 - NM B2B Reference Manual

The requested flights (together with their invalid filing summary if requested - this feature is
only accessible via FlightListByKeysRequest).

Mandatory: if no match was found, the returned array is empty.

The array does not contain null or duplicate items.

19.7.134. FlightListRequest

<<abstract class>>

Abstract request to query an NM flight list, possibly together with the invalid filing messages.

The logical AND operator applies between all the query fields described below.

It is important to note that NM associates a weight to flight fields (see FlightField definition): a flight
field is either "light" or "heavy", in the sense that heavy flight fields are significantly more
demanding to return than light ones. NM kindly requests its customers to apply the following
strategy:

1. As a rule, client applications should never request flight fields that they do not need, regardless
of their weight

2. Client applications typically implement a query/retrieve pattern:

a. Query the small number of most relevant flight fields to display to the end user.

b. Retrieve more details for a given flight (using the FlightRetrievalRequest ) when the end
user has selected a flight from the list

3. The client application should not request flight fields in the flight list if these fields are not
necessary for the end user to make his selection.

4. In particular, the client application should avoid requesting heavy fields in a flight list if not
strictly necessary.

5. However, in case one or more heavy fields are strictly necessary in the flight list, the customer
is invited to request indeed the heavy fields in the flight list rather than querying first a "light"
flight list and then iterating on the flight list and retrieving each individual flight to get the

Edition: 27.0 6 1041

Document Title: NM 27.0 - NM B2B Reference Manual

heavy ones.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset from which the flight list is requested.

See Forecast and Operational Datasets and Simulation Datasets.

i. Constraints:

▪ FlightListRequest.INVALID_QUERY_PERIOD_RANGE

b. boolean includeProposalFlights (Mandatory)

Determines if the selected traffic must include the proposal flights, or only the "real" flights.
If the proposal flights are included, they replace their corresponding "real" flights.

See Proposal Flights.

i. Access control:

▪ set includeProposalFlights=true requires read access to /flights?proposal=true

c. boolean includeForecastFlights (Mandatory)

Determines if the selected traffic must include the "forecast" flights.

In the OPERATIONAL dataset (or in a simulation on OPERATIONAL), a "forecast" flight is a

predicted flight (cfmuFlightType = PREDICTED_FLIGHT).

In the FORECAST dataset (or in a simulation on FORECAST), a "forecast" flight is a predicted

flight with no intention data.

d. TrafficType trafficType (Mandatory)

Traffic type for which flights are requested.

Returned flights are according to the "highest" available Tactical Flight Model:

1. If the requested traffic type is TrafficType.LOAD , returned flights are according to the
"CTFM" (Current Tactical Flight Model) model if available; otherwise, according to the
"RTFM" (Regulated Tactical Flight Model) model if available; otherwise, according to the
"FTFM" (Filed Tactical Flight Model) model. Note however that suspended flights are
never returned in the flight list obtained with TrafficType.LOAD .

2. If the requested traffic type is TrafficType.REGULATED_DEMAND , returned flights are

according to the "RTFM" (Regulated Tactical Flight Model) model if available; otherwise,
according to the "FTFM" (Filed Tactical Flight Model) model. Note however that
suspended flights are never returned in the flight list obtained with
TrafficType.REGULATED_DEMAND .

Edition: 27.0 6 1042

Document Title: NM 27.0 - NM B2B Reference Manual

3. If the requested traffic type is TrafficType.DEMAND , returned flights are according to the
"FTFM" (Filed Tactical Flight Model) model.

i. Constraints:

▪ FlightListRequest.COMPARE_WITH_OTHER_TRAFFIC_TYPE_INVALID_VALUE

e. DateTimeMinutePeriod trafficWindow (Contextual)

The period of time for which flights are requested.

The meaning of the traffic window depends on the actual request type:

1. If the actual request is a FlightListByLocationRequest , and depending on the concrete

request type, the traffic window specifies that only those flights taking off and/or
landing, or being over a point, or entering a sector in the time window are returned.

Alternatively if an OCCUPANCY calculationType is requested(applicability depending on the

concrete request type), the traffic window specifies that only those flights occupying a
sector or being airborne in the time window are returned (depending on the concrete
request type).

Note that for a FlightListByLocationRequest , the trafficWindow is first (optionally)

rounded and/or extended based on the countsInterval attribute.

The result is the effectiveTrafficWindow in the FlightListByLocationReplyData .

If a countsInterval is used with step 1 minute and duration 1 minute, then no

rounding/extending takes place, and the effectiveTrafficWindow is the request
trafficWindow.

The idea behind: if a user does a TrafficCountRequest with a trafficWindow from

[10:00,10:01[ with a countsInterval with step 1 and duration 10 minutes, the single
count period returned has a duration of 10 minutes ( [10:00,10:10[ ).

If the users want to list corresponding flights, then he can do a flightlist with
trafficWindow [10:00,10:01[ and a countsInterval with step 1 and duration 10 minutes.
(i.e. the parameters that were used in the TrafficCounts request) to get exactly those
flights corresponding to the counts.

So more general: the countsInterval attribute allows to round/extend the request

trafficWindow to get the flights corresponding to the TrafficCounts (corresponding to the
one or more count periods of the TrafficCountsReplyData).

2. If the actual request is a FlightListByKeysRequest, the traffic window specifies that only
those flights having an estimated off-block time in the period are returned.

i. Presence:

▪ Must be null in FlightListByHotspotRequest

▪ Mandatory otherwise

Edition: 27.0 6 1043

Document Title: NM 27.0 - NM B2B Reference Manual

ii. Constraints:

▪ FlightListRequest.INVALID_QUERY_PERIOD_RANGE

▪ FlightListRequest.PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

f. CountsCalculationType worstLoadStateAtReferenceLocationType (Optional)

Documentation last updated: 27.0 - Edition 2

When requestedFlightFields.worstLoadStateAtReferenceLocation is requested, then this

CountsCalculationType indicates how the field needs to be computed :based on entry counts
(with capacity values) or based on occupancy counts (with OTMV).

So basically, the worstLoadStateAtReferenceLocation field indicates if a flight contributes to

an overload counts period (for an entry CountsCalculationType) or if the flight contributes
to a peak/sustained flight overload (w.r.t. OTMV) occupancy count period (for an occupancy
CountsCalculationType).

This info is useful when selecting flights to STAM.

Note that the worstLoadStateAtReferenceLocation flight field is only authorized for a user if
he is also authorized to use the TrafficCounts .

i. Constraints:

▪ FlightListRequest.WORST_LOAD_STATE_AT_REFERENCE_LOCATION_TYPE_PRESENCE

g. TrafficType compareWithOtherTrafficType (Optional)

When requestedFlightFields.compareWithOtherTrafficType is requested, then this

TrafficType indicates how the field needs to be computed.

Basically, the compareWithOtherTrafficType field allows comparing two flight-lists: one

with trafficType and the other with compareWithOtherTrafficType.

The results are shown in this compareWithOtherTrafficType field: it shows for a flight in
trafficType where is the flight in compareWithOtherTrafficType w.r.t. timeOver, lateral
deviation and vertical deviation and if it is an intruder or not for the queried location.

i. Constraints:

▪ FlightListRequest.COMPARE_WITH_OTHER_TRAFFIC_TYPE_INVALID_VALUE

▪ FlightListRequest.COMPARE_WITH_OTHER_TRAFFIC_TYPE_PRESENCE

h. FlightField[] requestedFlightFields (Optional)

The reply returns only the requested flight fields in this array, and only if the values of these
requested fields are available at NM. Note that the flight keys are always returned.

Optional: default is the empty array (used if only flight plan filing summary is requested).

Cannot be null or empty if the concrete request does not add any other data request.

Edition: 27.0 6 1044

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ FlightListRequest.CANNOT_REQUEST_OPERATIONAL_LOG

▪ FlightListRequest.COMPARE_WITH_OTHER_TRAFFIC_TYPE_PRESENCE

▪ FlightListRequest.REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION

▪ FlightListRequest.REQUESTED_FIELDS_CANNOT_CONTAIN_DUPLICATE

▪ FlightListRequest.WORST_LOAD_STATE_AT_REFERENCE_LOCATION_TYPE_PRESENCE

3. Constraints:

a. PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

The period extension must be smaller or equal to 24 hours.

Constrained attributes: trafficWindow

Constrained requests: any using request

b. REQUESTED_FIELDS_CANNOT_CONTAIN_DUPLICATE

If specified, the array cannot contain duplicates.

Constrained attributes: requestedFlightFields

Constrained requests: any using request

c. CANNOT_REQUEST_OPERATIONAL_LOG

Documentation last updated: 27.0 - Edition 6

The field operationalLog is not valid in the FlightListRequest.

Constrained attributes: requestedFlightFields

Constrained requests: any using request

d. WORST_LOAD_STATE_AT_REFERENCE_LOCATION_TYPE_PRESENCE

The field worstLoadStateAtReferenceLocationType must be set if and only if the

requestedFields.worstLoadStateAtReferenceLocation is requested.

Constrained attributes: worstLoadStateAtReferenceLocationType, requestedFlightFields

Constrained requests: any using request

e. COMPARE_WITH_OTHER_TRAFFIC_TYPE_PRESENCE

The field compareWithOtherTrafficType must be set if and only if the

requestedFields.compareWithOtherTrafficType is requested.

Constrained attributes: compareWithOtherTrafficType, requestedFlightFields

Edition: 27.0 6 1045

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

f. COMPARE_WITH_OTHER_TRAFFIC_TYPE_INVALID_VALUE

The two attributes trafficType and compareWithOtherTrafficType cannot have the same
value.

Constrained attributes: trafficType, compareWithOtherTrafficType

Constrained requests: any using request

g. REQUESTED_FIELD_NOT_ALLOWED_FOR_OPERATION

The fields worstLoadStateAtReferenceLocation , compareWithOtherTrafficType are not valid in

the FlightListByAircraftOperatorRequest and in the FlightListByKeysRequest.

The fields timeAtReferenceLocation , timeAtReferenceLocationEntry ,

timeAtReferenceLocationExit , flightLevelAtReferenceLocation ,
flightLevelAtReferenceLocationEntry , flightLevelAtReferenceLocationExit ,
trendAtReferenceLocationEntry , trendAtReferenceLocationExit ,
trendAtReferenceLocationMiddle , worstLoadStateAtReferenceLocation ,
compareWithOtherTrafficType are not valid in the FlightListByMeasureRequest when
FlightListByMeasureRequest.mode equals FlightListByMeasureMode.ACTIVATED_BY_MEASURE.

Constrained attributes: requestedFlightFields

Constrained requests: any using request

h. INVALID_QUERY_PERIOD_RANGE

Documentation last updated: 27.0 - Edition 6

The dataset.type from which the measures are requested and the trafficWindow must be set
according to the following rules:

1. if the DatasetType is equals to FORECAST the trafficWindow shall be defined within the
range [yesterday 21:00 UTC .. today+5d]

2. if the DatasetType is equals to OPERATIONAL the trafficWindow shall be defined within

the range [yesterday .. tomorrow]

Constrained attributes: trafficWindow, dataset

Constrained requests: any using request

19.7.135. FlightOperationalLogEntry
<<class>>

Documentation last updated: 27.0 - Edition 2

Edition: 27.0 6 1046

Document Title: NM 27.0 - NM B2B Reference Manual

Describes an entry in a flight operational log.

The operational log combines business and NM system technical entries.

NM decided to expose the operational log without filtering with the belief
IMPORTANT that some users might benefit from this publication.

However, NM does not provide and does not plan to provide a detailed
documentation of the various operational log entry types and messages.

1. Attributes:

a. DateTimeSecond timestamp (Optional)

The date/time when the entry was recorded.

b. FlightOperationalLogEntryType type (Optional)

The type of the operational log entry.

c. int etfmsId (Optional)

The ETFMS unique id of the flight.

d. IFPLId ifplId (Optional)

The IFPL id of the flight, if any in ETFMS.

e. string issuer (Optional)

The identification of the issuer of the message, if any.

f. string message (Optional)

The detailed text of the message (if the entry is a detailed entry).

g. string[] summaryFields (Optional)

The summary fields (if the entry is a summary entry).

2. Used by: MeasureOpLogRetrievalReplyData, Flight

19.7.136. FlightOperationalLogEntryType
<<enumeration>>

Describes a flight operational log entry type.

1. Values:

a. UNDEFINED

Specifies an Operational log of undefined entry type (new entry type from a more recent NM

Edition: 27.0 6 1047

Document Title: NM 27.0 - NM B2B Reference Manual

release).

b. INCOMING_MESSAGE

Operational log of type Incoming Message.

c. ERRONEOUS_INCOMING_MESSAGE

Operational log of type Erroneous Incoming Message.

d. OUTGOING_MESSAGE

Operational log of type Outgoing Message.

e. VIOLATION

Operational log of type Violation.

f. HISTORY

Operational log of type History.

g. WARNING

Operational log of type Warning.

h. PROCESS_ERROR

Operational log of type Process Error.

i. ERROR_MESSAGE

Operational log of type Error Message.

j. ENVIRONMENT_MESSSAGE

Operational log of type Environment Message.

k. USER_COMMAND

Operational log of type User Command.

l. TEXT_MESSAGE

Operational log of type Text Message.

2. Used by: FlightOperationalLogEntry

19.7.137. FlightOrFlightPlan
<<union>>

For a given IFPLId , represents the flight or flight plan.

Edition: 27.0 6 1048

Document Title: NM 27.0 - NM B2B Reference Manual

In the latter case, the flight plan may contains a valid flight plan or invalid filings messages.

Depending on what has been received by NM, the flight follows the new ICAO2012 standard ( flight
).

1. Choices:

a. Flight flight

The flight.

b. FlightPlanOrInvalidFiling flightPlan

The valid flight plan or invalid filings messages.

2. Used by: FlightListReplyData

19.7.138. FlightPlan

<<class>>

This set contains classes related to flight plan information.

Note that the involved data types are highly inspired by the Flight Plan model proposed by the FO
ICD for ICOG (see Flight Object ICD), where the CamelCase notation has replaced the original "_"
notation.

1. Attributes:

a. IFPLId ifplId (Optional)

Unique, opaque identifier assigned by the NM system to a submitted flight plan.

The attribute FlightPlan.ifplId is ignored in all request messages sent to NM.

When such ifplId information needs to be provided in a request message to NM, it will be
done through a specific structure different from FlightPlan structure such as
FlightIdentificationInput.

The attribute FlightPlan.ifplId is never null when NM returns a submitted FlightPlan

object.

Edition: 27.0 6 1049

Document Title: NM 27.0 - NM B2B Reference Manual

b. AirFiledData airFiledData (Contextual)

Estimate data provided when the flight plan was filed airborne. ICAO item 13 AFIL.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

ii. Constraints:

▪ FlightPlan.ADEP_AIRFILEDDATA_MUTUALLY_EXCLUSIVE

c. Aerodrome aerodromeOfDeparture (Optional)

Aerodrome of departure. ICAO item 13.

i. Constraints:

▪ FlightPlan.ADEP_AIRFILEDDATA_MUTUALLY_EXCLUSIVE

d. AerodromesOfDestination aerodromesOfDestination (Contextual)

Aerodromes of destination, including the alternates. ICAO Item 16. In an input flight plan,
aerodromesOfDestination is mandatory. In an output flight plan, aerodromesOfDestination is
null if the FlightPlan is published in the context of FlightPlanMessage that results from a
flight plan event of type FlightPlanEventType.ARR or FlightPlanEventType.CNL. Otherwise it is
present.

i. Presence:

▪ Mandatory in EvaluateFlowImpactRequest FlightPlanCreationRequest

FlightPlanValidationRequest ReroutingApplyRequest RoutingAssistanceRequest

▪ Optional otherwise

e. AlternateAerodrome_DataType enrouteAlternateAerodromes (Optional)

Aerodromes where the aircraft may land in case of emergency along the route. ICAO item 18
RALT/

f. AlternateAerodrome_DataType takeOffAlternateAerodromes (Optional)

Aerodromes where the aircraft may land in case of emergency at take-off. ICAO item 18
TALT/.

g. AircraftIdentification aircraftId (Contextual)

Information regarding the aircraft in this flight plan, i.e. the aircraft id but also other
information like registration mark or SSR info. ICAO Item 7.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest

Edition: 27.0 6 1050

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Mandatory otherwise

h. int whatIfRerouteReference (Contextual)

Indication of AO What-If rerouting reference in a flight plan.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

ii. Constraints:

▪ range : [1, 9]

i. int numberOfAircraft (Contextual)

Number of aircraft in a formation flight. Optional: default is 1. ICAO Item 9.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest RoutingAssistanceRequest

▪ Optional otherwise

ii. Constraints:

▪ range : [1, 99]

j. AircraftType aircraftType (Contextual)

Aircraft type. ICAO Item 9. In an input flight plan, aircraftType is mandatory. In an output
flight plan, aircraftType is null if the FlightPlan is published in the context of
FlightPlanMessage that results from a flight plan event of type FlightPlanEventType.ARR or
FlightPlanEventType.CNL. Otherwise it is present.

i. Presence:

▪ Mandatory in EvaluateFlowImpactRequest FlightPlanCreationRequest

FlightPlanValidationRequest ReroutingApplyRequest RoutingAssistanceRequest

▪ Optional otherwise

k. DurationHourMinute totalEstimatedElapsedTime (Contextual)

Total estimated elapsed time. ICAO item 16.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest RoutingAssistanceRequest

▪ Mandatory otherwise

l. EstimatedElapsedTimeAtLocation[] eetsToLocations (Contextual)

Array of locations and the corresponding accumulated elapsed time to these locations.

In case of FlightPlanUpdateRequest, the list of locations should be complete. Omitting a

Edition: 27.0 6 1051

Document Title: NM 27.0 - NM B2B Reference Manual

location will delete the location. ICAO item 18 EET/.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

m. WakeTurbulenceCategory wakeTurbulenceCategory (Contextual)

Wake turbulence category. ICAO Item 9.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Mandatory otherwise

n. FlightType flightType (Contextual)

Type of the flight, e.g. scheduled, not scheduled, etc. ICAO item 8.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Mandatory otherwise

o. FlightRules flightRules (Contextual)

Indicates if the rules applicable to the flight are visual ( FlightRules.VFR ), instrumented (
FlightRules.IFR ) or visual and then instrumented ( FlightRules.VFR_THEN_IFR ) or vice versa
( FlightRules.IFR_THEN_VFR ) ICAO Item 8a.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Mandatory otherwise

ii. Constraints:

▪ FlightPlan.VFR_FLIGHT_RULES_NOT_SUPPORTED

p. DateTimeMinute estimatedOffBlockTime (Mandatory)

Estimated off-block date/time. Both ICAO item 13 and ICAO item 18 DOF/.

q. string icaoRoute (Contextual)

Represents the Flight Plan Route. ICAO Item 15. In an input flight plan, icaoRoute is
mandatory. In an output flight plan, icaoRoute is null if the FlightPlan is published in the
context of FlightPlanMessage that results from a flight plan event of type
FlightPlanEventType.ARR or FlightPlanEventType.CNL. Otherwise it is present.

Edition: 27.0 6 1052

Document Title: NM 27.0 - NM B2B Reference Manual

i. Presence:

▪ Mandatory in EvaluateFlowImpactRequest FlightPlanCreationRequest

FlightPlanValidationRequest ReroutingApplyRequest RoutingAssistanceRequest

▪ Optional otherwise

ii. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

r. StayInformation_DataType[] stayInformation (Contextual)

Information concerning the type of activity (training, photographic mission, etc) to be

performed during the stay periods mentioned in the route of the flight.

Item N in the array corresponds to the "STAY<N>" reference in the stay periods of the route,
where N is in [ 1, 9 ].

The value of each item corresponds to the remark string in the ADEXP STAYINFO element.

In case of FlightPlanUpdateRequest , the list of activities should be complete. Omitting an

activity will delete the activity. ICAO DOC 7030.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

ii. Constraints:

▪ array size range : [0, 9]

s. EnrouteDelay[] enrouteDelays (Optional)

Gives the list of delays or holdings planned at given points. ICAO Item 18 DLE/.

Note that in the EUR region the usage of the STAY within the route description is preferred to
the DLE.

t. EquipmentCapabilityAndStatus equipmentCapabilityAndStatus (Contextual)

Represents the capability and status of the equipment of the aircraft of the flight. ICAO Item
10.

For FlightPlanValidationRequest and RoutingAssistanceRequest, the default value

corresponds to "-ADEXP SWY": this value is used if the attribute is null or if it does not
contain any attribute (equipment type) marked as EquipmentStatus.EQUIPPED. All
EquipmentStatus values that are not EquipmentStatus.EQUIPPED are ignored.

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest

Edition: 27.0 6 1053

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Mandatory otherwise

u. SurveillanceEquipment surveillanceEquipment (Contextual)

Surveillance equipment of the aircraft .

For FlightPlanValidationRequest and RoutingAssistanceRequest, the default value of the

surveillance equipment is "S".

i. Presence:

▪ Optional in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Mandatory otherwise

v. OtherInformation otherInformation (Contextual)

Any other flight data Items specified in the bilateral agreement. ICAO Item 18 (Other
Information).

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest RoutingAssistanceRequest

▪ Optional otherwise

w. SupplementaryInformation supplementaryInformation (Contextual)

Supplementary flight data. ICAO item 19 (Supplementary information).

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

x. AircraftIATAId iataFlightNumber (Optional)

IATA Flight Identifier.

y. AirportSlot arrivalAirportSlot (Optional)

Arrival airport slot.

z. AirportSlot departureAirportSlot (Optional)

Departure airport slot.

aa. FlightPlanOriginator flightPlanOriginator (Optional)

Flight plan originator ICAO Item 18 ORGN/.

2. Constraints:

a. ADEP_AIRFILEDDATA_MUTUALLY_EXCLUSIVE

Edition: 27.0 6 1054

Document Title: NM 27.0 - NM B2B Reference Manual

airFiledData cannot be null if aerodromeOfDeparture is null; must be null otherwise.

aerodromeOfDeparture is mandatory, except if airFiledData is not null, in which case it is

optional.

aerodromeOfDeparture is also optional in FlightPlanValidationRequest and

RoutingAssistanceRequest.

Constrained attributes: airFiledData, aerodromeOfDeparture

Constrained requests: any using request

b. VFR_FLIGHT_RULES_NOT_SUPPORTED

The FlightRules.VFR is not supported.

Constrained attributes: flightRules

Constrained requests: FlightPlanCreationRequest, EvaluateFlowImpactRequest,

RoutingAssistanceRequest, FlightPlanValidationRequest

3. Used by: StructuredFlightPlan, StructuredFlightPlanData, FlightDelayReplyData

19.7.139. FlightPlanCancellationReplyData
<<class>>

The FlightPlanCancellationReply payload.

1. Inherits from: FilingReplyData

2. Used by: FlightPlanCancellationReply

19.7.140. FlightPlanCreationReplyData
<<class>>

The FlightPlanCreationReply payload.

1. Inherits from: FilingReplyData

2. Attributes:

a. StructuredFlightPlan structuredFlightPlan (Optional) (new 27.0)

The flight plan as accepted by NM, may have been automatically or manually corrected.

Cannot be null if FilingReply.filingStatus is VALID ; must be null otherwise.

3. Used by: FlightPlanCreationReply

Edition: 27.0 6 1055

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.141. FlightPlanEvent (new 27.0)

<<class>>

The events that affected a flight plan.

1. Attributes:

a. FlightPlanEventType eventType (Mandatory)

The events that affected the flight plan.

b. DateTimeSecond timestamp (Mandatory)

The timestamp when the event has occurred.

c. MessageOriginator originator (Optional) (new 27.0)

The originator that participates to the flight plan message change event.

2. Used by: FlightPlanEventHistoryItem

19.7.142. FlightPlanEventHistoryItem (new 27.0)

<<class>>

An event that affected a flight plan.

1. Attributes:

a. int sequenceNumber (Mandatory)

Sequence number of the flight plan event.

b. FlightPlanEvent event (Mandatory)

The flight plan event.

2. Used by: FlightPlanMessage

19.7.143. FlightPlanEventType (new 27.0)

<<enumeration>>

Lists all the events that may trigger a new flight plan message.

1. Values:

a. AFP

Airborne Flight Plan message

b. ARR

Edition: 27.0 6 1056

Document Title: NM 27.0 - NM B2B Reference Manual

ARRival message

c. CHG

CHanGe message

d. CNL

CaNceL message

e. DEP

DEParture message

f. DLA

DeLAyed message

g. FNM

Flight Notification Message

h. FPL

Flight PLan message

i. MFS

Message From Shanwick

j. REVAL

Periodic Flight Plan IFPS Revalidation

2. Used by: FlightPlanEvent, FlightPlanMessageFilter

19.7.144. FlightPlanHistory
<<class>>

History of a flight plan.

1. Attributes:

a. FlightPlanHistoryInfo[] infos (Optional)

Description of the history

2. Used by: FlightRetrievalReplyData

19.7.145. FlightPlanHistoryInfo
<<class>>

Edition: 27.0 6 1057

Document Title: NM 27.0 - NM B2B Reference Manual

Information associated to the flight plan history.

1. Attributes:

a. DateTimeSecond timeStamp (Optional)

Date and time of the checkpoint logging.

b. string checkPoint (Optional)

Table 47. FlightPlanHistoryInfoDetailed.checkPoints description

Checkpoint Abbreviation Possible Description of the corresponding action

mode

FUM Update FU A NM Internal message.

Reprocess RS A, O A flight plan is suspended by the automatic

Suspended revalidation or by an operator.

Reprocess RA A A flight plan is revalidated and has been

Advisory invalidated in status REVAL_ADVISORY

Reprocess RC A A flight plan becomes compliant as a result

Compliant of automatic revalidation.

Force FC O A flight plan is forced to the NORMAL

Compliant (compliant) state by an operator action.

Create CR A,M,S A message is successfully processed, and an

flight plan is created.

Update UP A,M,S A message is successfully processed, and the

associated flight plan is updated.

Backup BU A,M,S A message is received at the back-up IFPU.

Duplicate DU A Exactly the same message was already

received.

Invalid IN A,M A message is processed and is invalid. It is

passed to manual processing.

Reject RE A,M,S,O A message is rejected.

Close FPD CL A,M,S,O The flight plan is closed.

Multiple MU M An invalid message contains more than one

flight plan.

Delete DE O An operator has deleted an invalid message.

Message

Refer RF O NM Internal event.

Escape ES O NM Internal event.

Manual Transmit MT O

Edition: 27.0 6 1058

Document Title: NM 27.0 - NM B2B Reference Manual

Checkpoint Abbreviation Possible Description of the corresponding action

mode

An operator Transmit TO A
has manually
requested the
transmission
of a message.

Successful Transmit Fail TF A

transmission
of a message.

Failed Edit ED O
transmission
of a message.

Flight plan Associate AS O

editor opened
by an
operator on
an invalid
message.

Manual Discard DI A
association
done by an
operator

c. string mode (Optional)

Table 48. FlightPlanHistoryInfoDetailed.mode description

Mode Abbreviation Description

Auto A The checkpoint logged in Auto mode corresponds to an

automatic action.

Man M The checkpoint logged in Man mode corresponds to an

action performed by an NM operator when correcting an
invalid flight plan.

Semi_Auto S The checkpoint logged in Semi_Auto mode corresponds to

an action performed by an NM operator in the context of
semi-automatic processing of invalid messages in the invalid
group window after the correction of an initial message.

d. string msgIn (Optional)

The type (FPL, CHG, … of the received or processed message.

e. string msgOut (Optional)

Edition: 27.0 6 1059

Document Title: NM 27.0 - NM B2B Reference Manual

The type of the transmitted message.

f. string[] addresses (Optional)

The address of the originator if msgIn ; Addresses to which the msgOut is transmitted.

g. string detail (Optional)

The text of the message concerned by the action.

2. Used by: FlightPlanHistory

19.7.146. FlightPlanInput
<<union>>

Documentation last updated: 27.0 - Edition 1

Input flight plan expressed in one of the following formats: structured according to the NM B2B
model or textual.

1. Choices:

a. StructuredFlightPlan structured

Used when the flight plan data is input in a structured manner according to the NM B2B
model.

b. string textual

FPL message text used when the flight plan data is input via a string.

Two message formats are accepted: ICAO and ADEXP.

2. Used by: EvaluateFlowImpactRequest, FlightPlanValidationRequest, FlightPlanCreationRequest,

RoutingAssistanceRequest, ReroutingApplyRequest

19.7.147. FlightPlanListReplyData
<<class>>

The FlightPlanListReply payload.

1. Attributes:

a. FlightPlanOrInvalidFiling[] summaries (Mandatory)

The summaries of the valid flight plans and invalid filings matching the query fields.

Mandatory: if no match was found, the returned array is empty.

The array does not contain null or duplicate items.

Edition: 27.0 6 1060

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: FlightPlanListReply

19.7.148. FlightPlanMessageFilter (new 27.0)

<<class>>

A message filter for subscription topic SubscriptionTopic.FLIGHT_PLANS .

1. Attributes:

a. set< FlightPlanEventType > events (Optional)

Selects the types if events that should trigger the sending of a message (e.g., FPL , CHG , DLA ,
etc.).

Optional: by default, all events are considered.

i. Constraints:

▪ set size range : [1, 20]

b. set< FlightSetDefinitionElement > flightSet (Mandatory)

Selects which flights to filter.

The logical OR operator is meant between the items in the set.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightPlanMessageFilter.VALID_FLIGHT_SET

2. Constraints:

a. VALID_FLIGHT_SET (altered 27.0)

▪ flightSet size ≤ 10

The following constraints apply to the overall combination of FlightSetDefinitionElements

and not to the individual sets in each element. For example, if a subscription specifies a
filter on aircraft operators, the total number of aircraft operator identifiers across all
FlightSetDefinitionElements must be less or equal to 100, regardless of the number of
FlightSetDefinitionElements used.

▪ The sum of all FlightSetDefinitionElement.aircraftRegistrations sizes must be ≤ 10000

▪ The sum of all

FlightSetDefinitionElement.aerodromesOfDeparture|aerodromesOfArrival|alternateAerodr
omes sizes must be ≤ 1000

▪ The sum of all FlightSetDefinitionElement.anuIds sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.aircraftOperators sizes must be ≤ 250

▪ The sum of all FlightSetDefinitionElement.flightPlanOriginators sizes must be ≤ 250

Edition: 27.0 6 1061

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained attributes: flightSet

Constrained requests: any using request

3. Used by: FlightPlanSubscription, FlightPlanSubscriptionCreationRequest,

FlightPlanSubscriptionUpdateRequest

19.7.149. FlightPlanMessageStatus
<<enumeration>>

Enumerates possible flight plan message status.

1. Values:

a. INVALID

the message was queued for correction.

b. REJECTED

the message was invalid and has been rejected.

c. REFERRED

the message was queued for correction (by supervisor).

d. DELETED

the message has been deleted.

e. DISCARD

the processing of the message has failed (internal error).

f. MULTIPLE

refers to an invalid message that contains more than one flight plan message (coming from
AFTN/SITA).

2. Used by: InvalidFiling

19.7.150. FlightPlanMessageType
<<enumeration>>

Enumerates flight plan message types.

1. Values:

a. FPL

Filed Flight PLan

Edition: 27.0 6 1062

Document Title: NM 27.0 - NM B2B Reference Manual

b. CHG

CHanGe Message

c. CNL

CaNceLled flight plan

d. DLA

DeLAyed flight plan

e. DEP

DEParture

f. ARR

ARRival

g. RQP

ReQuest flight Plan

h. RQS

ReQuest Supplementary flight plan

i. FNM

Flight Notification Message

j. MFS

Message From Shanwick

k. APL

Atc flight PLan

l. ACH

Atc flight plan CHange

m. AFP

Airborne Flight Plan message

2. Used by: InvalidFiling

Edition: 27.0 6 1063

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.151. FlightPlanOriginator
<<class>>

Flight plan originator.

1. Attributes:

a. string address (Optional)

Address of the flight plan originator.

i. Constraints:

▪ Pattern: TEXT{1,30}

▪ FlightPlanOriginator.ORGN_CANNOT_BE_EMPTY

b. string phone (Optional)

Phone number of the flight plan originator.

i. Constraints:

▪ Pattern: TEXT{1,30}

▪ FlightPlanOriginator.ORGN_CANNOT_BE_EMPTY

c. string otherInformation (Optional)

Other information related to the flight plan originator.

i. Constraints:

▪ Pattern: TEXT{1,30}

▪ FlightPlanOriginator.ORGN_CANNOT_BE_EMPTY

2. Constraints:

a. ORGN_CANNOT_BE_EMPTY

At least one element must be populated.

Constrained attributes: address, phone, otherInformation

Constrained requests: any using request

3. Used by: FlightPlanUpdate, FlightPlan

19.7.152. FlightPlanOrInvalidFiling
<<union>>

For a given flight plan, container for the last valid flight keys or the current invalid filing
summaries, not both.

1. Choices:

Edition: 27.0 6 1064

Document Title: NM 27.0 - NM B2B Reference Manual

a. FlightPlanSummary lastValidFlightPlan

The last valid flight plan summary.

b. InvalidFiling currentInvalid

The current invalid filing summaries.

2. Used by: FlightOrFlightPlan, FlightPlanListReplyData

19.7.153. FlightPlanPayloadConfiguration (new 27.0)

<<class>>

This is the payload configuration class dedicated to the SubscriptionTopic.FLIGHT_PLANS subscription

topic.

It allows the user to define the content of the FlightPlanMessages published by NM for such a
subscription.

1. Attributes:

a. boolean concernedUnits (Mandatory)

Indicates whether the message must contain the air navigation units concerned by the flight
plan.

2. Used by: FlightPlanSubscription, FlightPlanSubscriptionCreationRequest,

FlightPlanSubscriptionUpdateRequest

19.7.154. FlightPlanStatus
<<enumeration>>

Flight plan status.

1. Values:

a. FILED

The flight is filed.

b. AIRBORNE

The flight is airborne.

c. SUSPENDED

The flight is suspended.

d. CLOSED

The flight is closed.

Edition: 27.0 6 1065

Document Title: NM 27.0 - NM B2B Reference Manual

e. BACKUP

The flight is in back-up status.

f. TACT_DELETED

The flight has been removed from ETFMS.

g. TERMINATED

The flight is terminated.

h. OFFBLOCKS

The flight is off-block.

2. Used by: FlightPlanSummary

19.7.155. FlightPlanSubscription (new 27.0)

<<class>>

Subscription of topic FLIGHT_PLANS.

1. Inherits from: Subscription

2. Attributes:

a. FlightPlanMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. FlightPlanPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: FlightPlanSubscriptionRetrievalReplyData, FlightPlanSubscriptionUpdateReplyData,

FlightPlanSubscriptionCreationReplyData

Edition: 27.0 6 1066

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.156. FlightPlanSubscriptionCreationReplyData (new 27.0)

<<class>>

The FlightPlanSubscriptionCreationReply payload.

1. Attributes:

a. FlightPlanSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: FlightPlanSubscriptionCreationReply

19.7.157. FlightPlanSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The FlightPlanSubscriptionRetrievalReply payload.

1. Attributes:

a. FlightPlanSubscription subscription (Mandatory)

Instance of the requested subscription.

b. SubscriptionSynchronisationSummary synchronisationSummary (Optional)

Summary information about any on-going subscription synchronisation.

2. Used by: FlightPlanSubscriptionRetrievalReply

19.7.158. FlightPlanSubscriptionUpdateReplyData (new 27.0)

<<class>>

The FlightPlanSubscriptionUpdateReply payload.

1. Attributes:

a. FlightPlanSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: FlightPlanSubscriptionUpdateReply

19.7.159. FlightPlanSummary
<<class>>

Flight plan summary, containing flight identification and flight plan status.

1. Attributes:

a. FlightIdentificationOutput id (Mandatory)

Edition: 27.0 6 1067

Document Title: NM 27.0 - NM B2B Reference Manual

Flight idendification.

b. FlightPlanStatus status (Mandatory)

Flight plan status.

2. Used by: FlightPlanOrInvalidFiling

19.7.160. FlightPlanUpdate
<<class>>

This class is used to express updates on an existing flight plan.

All attributes in this class are optional.

The flight plan resulting from the application of the update to the existing flight plan must comply
with the constraints expressed in FlightPlan .

It is not possible to update separately one attribute of the otherInformation and

supplementaryInformation attributes. This is a consequence of the new ICAO rules for the update of
the field18 and field19. These new rules impose to provide the complete field in a change message
where part of a field needs to be changed.

1. Attributes:

a. Aerodrome aerodromeOfDeparture (Optional)

Aerodrome of departure.

b. AerodromesOfDestination aerodromesOfDestination (Optional)

Aerodromes of destination, including the alternates.

c. AlternateAerodrome_DataType enrouteAlternateAerodromes (Optional)

Aerodromes where the aircraft may land in case of emergency along the route.

i. Constraints:

▪ FlightPlanUpdate.UPDATE_ALTERNATE_AERODROME_ONLY_NOT_SUPPORTED

d. AlternateAerodrome_DataType takeoffAlternateAerodromes (Optional)

Aerodromes where the aircraft may land in case of emergency during take-off.

i. Constraints:

▪ FlightPlanUpdate.UPDATE_ALTERNATE_AERODROME_ONLY_NOT_SUPPORTED

e. AircraftIdentificationUpdate aircraftId (Optional)

Aircraft Identifier.

Edition: 27.0 6 1068

Document Title: NM 27.0 - NM B2B Reference Manual

f. int numberOfAircraft (Optional)

Number of aircraft in a formation flight.

i. Constraints:

▪ range : [1, 99]

g. AircraftType aircraftType (Optional)

Aircraft type.

h. DurationHourMinute totalEstimatedElapsedTime (Optional)

Total estimated elapsed time.

i. EstimatedElapsedTimeAtLocation[] eetsToLocations (Optional)

Array of locations and the corresponding accumulated elapsed times to these locations.

j. WakeTurbulenceCategory wakeTurbulenceCategory (Optional)

Wake turbulence category.

k. FlightType flightType (Optional)

Type of the flight, e.g. scheduled, not scheduled, etc.

l. FlightRules flightRules (Optional)

Indicates if the rules applicable to the flight are visual ( FlightRules.VFR ), instrumented (
FlightRules.IFR ) or visual and then instrumented ( FlightRules.VFR_THEN_IFR ) or vice versa
( FlightRules.IFR_THEN_VFR ).

m. DateTimeMinute estimatedOffBlockTime (Optional)

Estimated off-block date/time.

n. string icaoRoute (Optional)

Represents the Flight Plan ICAO Route (Field15).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

o. StayInformation_DataType[] stayInformation (Optional)

Information concerning the type of activity (training, photographic mission, etc) to be

performed during the stay periods mentioned in the route of the flight.

i. Constraints:

▪ array size range : [0, 9]

Edition: 27.0 6 1069

Document Title: NM 27.0 - NM B2B Reference Manual

p. EquipmentCapabilityAndStatus equipmentCapabilityAndStatus (Optional)

Represents the capability and status of the equipment of the aircraft of the flight.

q. SurveillanceEquipment surveillanceEquipment (Optional)

Surveillance equipment of the aircraft.

r. OtherInformation otherInformation (Optional)

Any other flight data Items specified in the bilateral agreement.

s. SupplementaryInformation supplementaryInformation (Optional)

Supplementary flight data.

t. AircraftIATAId iataFlightNumber (Optional)

IATA Flight Identifier.

u. AirportSlot arrivalAirportSlot (Optional)

Arrival airport slot.

v. AirportSlot departureAirportSlot (Optional)

Departure airport slot.

w. FlightPlanOriginator flightPlanOriginator (Optional)

Flight plan originator.

2. Constraints:

a. UPDATE_ALTERNATE_AERODROME_ONLY_NOT_SUPPORTED (new 27.0)

enrouteAlternateAerodromes and/or takeoffAlternateAerodromes cannot be the only updated

attributes.

Constrained attributes: enrouteAlternateAerodromes, takeoffAlternateAerodromes

Constrained requests: any using request

3. Used by: StructuredFlightPlanUpdate

19.7.161. FlightPlanUpdateReplyData
<<class>>

The FlightPlanUpdateReply payload.

1. Inherits from: FilingReplyData

2. Attributes:

Edition: 27.0 6 1070

Document Title: NM 27.0 - NM B2B Reference Manual

a. StructuredFlightPlan structuredFlightPlan (Optional) (new 27.0)

The flight plan as updated by NM, may have been automatically or manually corrected.

Cannot be null if FilingReply.filingStatus is VALID , meaning that the flight plan was indeed
updated; must be null otherwise.

3. Used by: FlightPlanUpdateReply

19.7.162. FlightPlanValidationReplyData
<<class>>

The FlightPlanValidationReply payload.

1. Attributes:

a. IFPSError[] ifpsErrors (Mandatory)

Array of NM/IFPS errors in response to the flight plan validation.

Mandatory: the array is empty if there is no such error.

2. Used by: FlightPlanValidationReply

19.7.163. FlightPoint
<<class>>

Describes a point in a flight point profile.

1. Attributes:

a. DateTimeSecond timeOver (Mandatory)

Estimated time over the point.

If the point is a first point: take-off time.

If the point is a last point: landing time.

b. FlightLevel flightLevel (Mandatory)

Flight level over the point.

c. FlightTrend entryTrend (Mandatory)

Trend before overflying the point.

d. FlightTrend exitTrend (Mandatory)

Trend after overflying the point.

Edition: 27.0 6 1071

Document Title: NM 27.0 - NM B2B Reference Manual

e. RouteOrTerminalProcedure associatedRouteOrTerminalProcedure (Optional)

Route followed after overflying the point, unless the point is the last one in which case the
route followed before the point (e.g. Standard Arrival Procedure).

It might be DCT.

f. DistanceNM coveredDistance (Mandatory)

Distance from the first point in the profile measured on the 2D track of the point profile.

g. boolean isVisible (Mandatory)

True if the route segment following the point is "visible", i.e. GAT/IFR.

h. AerodromeICAOId aerodrome (Optional)

ICAO id of an aerodrome:

1. The aerodrome of departure if the point is the first in the profile

2. The aerodrome of arrival if the point is the last in the profile

Optional, unless the point is first or last. Must be null if aerodrome is not null.

i. ICAOPoint point (Optional)

Point in the en-route point profile.

Note that for vector points (e.g. bottom of climb, top of descent), the coveredDistance is to be
used to determine where the point is while point itself is set to null..

Must be null if aerodrome is not null. If null and aerodrome is also null, then it concerns a
vector point.

j. boolean flightPlanPoint (Optional)

If point is not null, this attribute is set to true unless the point is not a flight plan point but
was added by NM in order to provide a better approximation on a long DCT segment.

Cannot be null if point is not null; must be null otherwise.

2. Used by: Flight

19.7.164. FlightRestriction
<<class>>

Describes a Restriction event (entry or exit) over a geographical position.

1. Attributes:

a. DateTimeSecond timeOver (Mandatory)

Edition: 27.0 6 1072

Document Title: NM 27.0 - NM B2B Reference Manual

Estimated time over the point.

b. DistanceNM coveredDistance (Mandatory)

Distance from the first point in the profile measured on the 2D track of the point profile.

c. FlightPlanProcessing flightPlanProcessing (Mandatory)

Indicates the kind of restriction with regards to flight plan processing.

d. RestrictionId restrictionId (Mandatory)

Identification of the Restriction.

e. EntryExit event (Mandatory)

Indicates if the restriction is entered or exited at this position.

f. Position position (Mandatory)

Indicates the geographical position where the event occurs.

g. FlightLevel flightLevel (Mandatory)

Indicates the flight level where the event occurs.

2. Used by: Flight

19.7.165. FlightRetrievalReplyData
<<class>>

The FlightRetrievalReply payload.

1. Attributes:

a. StructuredFlightPlan structuredFlightPlan (Optional) (new 27.0)

The flight plan, if requested.

Represents a flight plan with ICAO 2012 content.

b. FlightPlanHistory flightPlanHistory (Optional)

The flight plan history, if requested.

c. Flight flight (Optional)

The flight, if requested.

Represents a flight with ICAO 2012 content

2. Used by: FlightRetrievalReply

Edition: 27.0 6 1073

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.166. FlightRules
<<enumeration>>

Applicable flight rules.

1. Values:

a. VFR_THEN_IFR

First VFR, then IFR

b. IFR_THEN_VFR

First IFR, then VFR

c. VFR

Visual Flight Rules

d. IFR

Instrumental Flight Rules

2. Used by: FlightPlanUpdate, FlightPlan

19.7.167. FlightSetDefinitionElement (new 27.0)

<<class>>

A FlightSetDefinitionElement is designed to capture a set of flights based on the following

attributes.

All attributes within the same FlightSetDefinitionElement instance are combined with a logical AND
operator.

1. Attributes:

a. set< AircraftOperatorICAOId > aircraftOperators (Optional)

Set of aircraft operators.

Optional: by default, any aircraft operator is considered.

i. Constraints:

Edition: 27.0 6 1074

Document Title: NM 27.0 - NM B2B Reference Manual

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

b. set< AircraftRegistrationMark > aircraftRegistrations (Optional)

Set of aircraft registration marks.

Optional: by default, any aircraft registration mark is considered.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

c. set< AerodromeICAOIdWildcard > aerodromesOfDeparture (Optional)

The aerodromes of departure.

Optional: by default, there is no filtering based on ADEP.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

d. set< AerodromeICAOIdWildcard > aerodromesOfArrival (Optional)

The aerodromes of arrival.

Optional: by default, there is no filtering based on ADES.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

e. set< AerodromeICAOIdWildcard > alternateAerodromes (Optional) (new 27.0)

The alternate aerodromes.

Optional: by default, there is no filtering based on alternate aerodromes.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

f. set< AirNavigationUnitId > anuIds (Optional)

Set of air navigation unit ids.

Specifying one or more ANU Id means subscribing to the flight plans that "concern" those air
navigation units.

Edition: 27.0 6 1075

Document Title: NM 27.0 - NM B2B Reference Manual

Optional: by default, no filtering based on air navigation units.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

g. set< AirNavigationUnitId > flightPlanOriginators (Optional)

Set of flight plan originators.

Optional: by default, no filtering based on flight plan originators.

i. Constraints:

▪ set size range : [1, unbounded[

▪ FlightSetDefinitionElement.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_SET (altered 27.0)

At least one attribute must be set.

Constrained attributes: aircraftOperators, aircraftRegistrations, aerodromesOfDeparture,

aerodromesOfArrival, alternateAerodromes, anuIds, flightPlanOriginators

Constrained requests: any using request

3. Used by: FlightDataMessageFilter, FlightPlanMessageFilter

19.7.168. FlightState
<<enumeration>>

Describes the state of a flight resulting from an event in the flight history.

1. Values:

a. PLANNED

Planned state.

b. PLANNED_SLOT_ALLOCATED

Planned Slot Allocated state.

c. PLANNED_REROUTED

Planned Rerouted state.

d. PLANNED_SLOT_ALLOCATED_REROUTED

Planned Slot Allocated Rerouted state.

Edition: 27.0 6 1076

Document Title: NM 27.0 - NM B2B Reference Manual

e. FILED

Filed state.

f. FILED_SLOT_ALLOCATED

Filed Slot Allocated state.

g. FILED_SLOT_ISSUED

Filed Slot Issued state.

h. TACT_ACTIVATED

TACT Activated state.

i. ATC_ACTIVATED

ATC Activated state.

j. CANCELLED

Cancelled state.

k. TERMINATED

Terminated state.

2. Used by: FlightEvent, Flight

19.7.169. FlightTrafficVolume

<<class>>

A traffic volume profile element.

Edition: 27.0 6 1077

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. TrafficVolumeId trafficVolumeId (Mandatory)

The identifier of the traffic volume.

b. DateTimeSecond entryTime (Mandatory)

The traffic volume entry time.

c. FlightLevel entryFlightLevel (Optional)

The entry flight level.

d. FlightTrend entryTrend (Mandatory)

The trend before entering the traffic volume.

e. FlightTrend middleTrend (Mandatory)

The trend in the traffic volume.

f. DateTimeSecond exitTime (Mandatory)

The traffic volume exit time.

g. FlightLevel exitFlightLevel (Optional)

The exit flight level.

h. FlightTrend exitTrend (Mandatory)

The trend after exiting the traffic volume.

i. boolean activated (Mandatory)

True if the traffic volume is activated. The traffic volume activation is explained into the
ATFCM Operations manual (Chapter 15 Annex D).

j. boolean exempted (Mandatory)

Documentation last updated: 27.0 - Edition 5

True if the flight is exempted from any regulation that applies to the traffic volume.

k. list< Flow > flows (Mandatory)

The traffic volume flows to which the flight belongs.

2. Used by: Flight

Edition: 27.0 6 1078

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.170. FlightTrend
<<enumeration>>

Describes a flight trend at some point, i.e. the flight vector that includes the point (as an end point
in "trend in" and as start point in "trend out") is either a cruise vector, a climb vector or a descent
vector.

The NONE value means not applicable in the situation.

1. Values:

a. CRUISE

Cruise flight trend.

b. CLIMB

Climb flight trend.

c. DESCENT

Descent flight trend.

d. NONE

None flight trend.

2. Used by: FlightPoint, Flight, FlightTrafficVolume, FlightAirspace

19.7.171. FlightType
<<enumeration>>

Type of the flight.

1. Values:

a. SCHEDULED

scheduled flight

b. NOT_SCHEDULED

not scheduled flight

c. GENERAL

general flight

Edition: 27.0 6 1079

Document Title: NM 27.0 - NM B2B Reference Manual

d. MILITARY

military flight

e. OTHER

any flight type that is not of a type described above

2. Used by: FlightPlanUpdate, FlightPlan

19.7.172. FlightUpdateChoice
<<union>>

Represents either departure information or en-route information.

1. Choices:

a. DepartureInformation departureInformation

Departure information.

b. LandingInformation landingInformation

Landing information.

c. OceanicInformation oceanicInformation

Oceanic information.

d. AircraftPositionReport aircraftPositionReport

Aircraft position report.

e. EnRouteInformation enRouteInformation

En-route information.

2. Used by: FlightUpdateRequest

19.7.173. FlightUpdateReplyData
<<class>>

The FlightUpdateReply payload.

1. Inherits from: FlightInformationUpdateReplyData

Edition: 27.0 6 1080

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. AirborneFilingReplyData ifpsProcessingResult (Optional)

Details about the processing of FNM/MFS requests.

3. Used by: FlightUpdateReply

19.7.174. FlightVisibility
<<enumeration>>

This enumeration describes the visibility of a flight on a given crossing over a reference location.
It is important to stress that the visibility information conveyed by this enumeration refers to a
specific crossing and not to the whole flight and depends on the type of reference location. For
example, if the reference location is a point, an aerodrome or a set of aerodromes the flight can
only have one crossing over the reference location and the only possible values are VISIBLE and
INVISIBLE. When the reference location is an airspace, then the flight can have multiple crossings
(i.e. the flight can enter and exit the airspace multiple times) and within each crossing the visibility
can switch back and forth.

Possible simplification
The combinations of crossings and visibility switches in an airspace are many. The enumeration is
quite complex because it tries to convey as much information as possible about the cases that are
considered most relevant for FMPs.
However the user can easily reduce the above enumeration to three values (VISIBLE, INVISIBLE,
MIXED) for example as follows:

Table 49. Possible simplification of FlightVisibility values

FlightVisibility Simplified
mapping

VISIBLE VISIBLE

INVISIBLE INVISIBLE

INVISIBLE_BEFORE_VISIBLE MIXED

VISIBLE_AFTER_INVISIBLE MIXED

VISIBLE_BEFORE_INVISIBLE MIXED

VISIBLE_BETWEEN_INVISIBLE MIXED

VISIBLE_WITH_SKIPOUT VISIBLE

1. Values:

a. NO_VISIBILITY

This value means that NM has no visibility information on this crossing. This should never
happen, so this value should never appear in a reply.

b. VISIBLE

Edition: 27.0 6 1081

Document Title: NM 27.0 - NM B2B Reference Manual

The flight is entirely visible, i.e. has no invisible portions, throughout the whole crossing.

c. INVISIBLE

The flight is entirely invisible throughout the whole crossing.

d. INVISIBLE_BEFORE_VISIBLE

This value has semantically the same meaning as the value VISIBLE_AFTER_INVISIBLE: a
flight that changes from invisible to visible inside the crossing. However, this value is
returned (instead of VISIBLE_AFTER_INVISIBLE) when the user has requested to include
invisible flights to indicate that the entry information (time and flight level) refer to the
invisible entry.

e. VISIBLE_AFTER_INVISIBLE

This value has semantically the same meaning as the value INVISIBLE_BEFORE_VISIBLE: a
flight that changes from invisible to visible inside the crossing. However, this value is
returned (instead of INVISIBLE_BEFORE_VISIBLE) when the user has not requested to
include invisible flights to indicate that the entry information (time and flight level) refer to
the visible portion and not to the invisible entry.

f. VISIBLE_BEFORE_INVISIBLE

The flight enters the crossing as visible and switches later to invisible within the crossing.

g. VISIBLE_BETWEEN_INVISIBLE

This value indicates a crossing in which the flight enters as invisible, then switches to visible
and then returns to invisible again (all within the same crossing). This value is only returned
when the user does not request to include invisible flights. Note that if the user requested to
include invisible flights, then such crossing would be considered as
INVISIBLE_BEFORE_VISIBLE.

h. VISIBLE_WITH_SKIPOUT

This value is used to give extra information on an entirely visible crossing, so it is a special
case of VISIBLE: it means that the flight is entirely visible throughout the crossing, but this
visibility information was computed after one or more portions were skipped-out
(according to the TV’s skip-out values).

2. Used by: Flight

19.7.175. FourDFlightPoint
<<class>>

A flight 4D position expressed as a CACD point, level and time over.

1. Attributes:

Edition: 27.0 6 1082

Document Title: NM 27.0 - NM B2B Reference Manual

a. ICAOPoint point (Mandatory)

Point ICAO id.

b. FlightLevel flightLevel (Mandatory)

Flight level.

c. DateTimeMinute timeOver (Mandatory)

Time over the point.

2. Used by: OceanicInformation, EnRouteInformation, AircraftPositionReport

19.7.176. FourDPosition
<<class>>

Four dimensional position.

1. Attributes:

a. DateTimeSecond timeOver (Mandatory)

Time over the position

b. Position position (Mandatory)

Coordinates (latitude/longitude)

c. FlightLevel level (Optional)

Flight level.

Note that in some cases this attribute can be null because in some rare occasions, NM may
receive radar reports that do not contain a flight level (or contain a wrong one).

2. Used by: Flight

19.7.177. FreezePoint
<<typedef[string]>>

If associated to ADEP, the route generation will start from this point. The part of the route from the
ADEP to this point is "frozen"

If associated to ADES, the route generation will end with this point. The part of the route from that
point to the ADES is "frozen"

1. Pattern: ANY{0,15}

2. Used by: RoutingAssistanceRequest

Edition: 27.0 6 1083

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.178. FrequencyOnAircraft
<<enumeration>>

Enumerates frequencies that can be available on an aircraft. (ICAO R/).

1. Values:

a. UHF

Ultra-High Frequency: 243.0 MHz.

b. VHF

Very High Frequency: 121.5 MHz.

c. ELT

Emergency Locator Transmitter.

2. Used by: SupplementaryInformation

19.7.179. GeneralAPIReplyData
<<class>>

The GeneralAPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: GeneralAPIReply

19.7.180. IATAFlightKeys (new 27.0)

<<class>>

The IATA keys that identify a flight.

1. Attributes:

a. AircraftIATAId flightDesignator (Mandatory)

The IATA flight designator.

b. DateTimeMinute estimatedOffBlockTime (Mandatory)

Estimated off-block date/time according to the latest processed flightplan message (by IFPS).

2. Used by: FlightIdentificationInput

19.7.181. ICAOAircraftAddress
<<typedef[string]>>

Edition: 27.0 6 1084

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 6

24-bytes ICAO aircraft address, made of 6 hexadecimal digits expressed as ALPHANUM values
constrained in [ "0", …, "9", "A", …, "F" ].

1. Pattern: HEXA{6}

2. Used by: FlightUpdateRequest, AircraftIdentificationUpdate, Flight, AircraftIdentification

19.7.182. ICAOSTSIndicator
<<enumeration>>

Enumerates the ICAO STS indicators.

1. Values:

a. ALTRV

Flight operated in accordance with an altitude reservation.

b. ATFMX

flight approved for exemption from ATFM measures by the appropriate ATS authority.

c. FFR

Fire-Fighting.

d. FLTCK

Flight check for calibration of navaids.

e. HAZMAT

Flight carrying hazardous material.

f. HEAD

flight with Head of State status.

g. HOSP

medical flight declared by medical authorities.

h. HUM

flight operating on a humanitarian mission.

i. MARSA

Flight for which a military entity assumes responsibility for separation of military aircraft.

j. MEDEVAC

Edition: 27.0 6 1085

Document Title: NM 27.0 - NM B2B Reference Manual

Life critical medical emergency evacuation.

k. NONRVSM

non-RVSM capable flight intending to operate in RVSM airspace.

l. SAR

flight engaged in a search and rescue mission.

m. STATE

flight engaged in military, customs or police services.

2. Used by: SpecialHandlingIndicators

19.7.183. IFPIndicator
<<enumeration>>

Indication of known errors within a flight plan. This is an indication that some automatic or
manual actions have been taken by NM to correct or ignore an error.

1. Values:

a. ROUTE_RAD

The route does not conform with the RAD rules.

b. ROUTE_WE

The route does not conform with the weekend routings.

c. ROUTE

An error that cannot be corrected has been found in the route.

d. AIRCRAFT_TYPE

An error that cannot be corrected has been found in the aircraft type.

e. FLIGHT_LEVEL

An error that cannot be corrected has been found in the requested flight level.

f. EOBDT

An earlier estimated off-block time exists.

g. NON_833

Flight does not comply with 8.33 KHz requirements.

Edition: 27.0 6 1086

Document Title: NM 27.0 - NM B2B Reference Manual

h. UNKNOWN_833

Flight compliance with 8.33 KHz requirements is unknown.

i. NON_RVSM

State flight is non-RVSM approved.

j. UNKNOWN_RVSM

RVSM approval status of the flight is unknown.

k. RVSM_VIOLATION

Flight violates RVSM rules, flight plan originator cannot be contacted.

l. MODE_S

Flight compliance with mode S surveillance.

m. ERREQPT

Flight compliance with equipment.

n. ERRRTECOORD

Flight compliance with route coordinates.

o. IFPSROUTEMOD

Route updated by IFPS.

2. Used by: FilingResultValid, StructuredFlightPlanData

19.7.184. IFPLId
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

Examples
AA00953172, BB00956485, …

1. Pattern: UALPHA{2}DIGIT{8}

2. Used by: FlightDepartureRequest, FlightArrivalRequest, EhelpDeskTicket,

FlightPlanCancellationRequest, FlightInformationUpdateRequest, FlightOperationalLogEntry,
FilingResultValid, FlightIdentificationInput, FlightDelayRequest, FlightPlanUpdateRequest,
CDMInfo, FlightIdentificationOutput, MCDMFlightTopic, FlightPlan, SlotSwapCandidate,
UpdateDPIRequest

Edition: 27.0 6 1087

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.185. IFPSError
<<class>>

Represents an NM/IFPS error.

An IFPS error is made of the IFPS error class (e.g.: EFPM, PROF, …) concatenated with the error
identification number (e.g.: 052), e.g. "EFPM052". This is the error type id passed in the Error
instances via the code attribute. The error description is the same as the one passed in the REJ
message that NM sends to the FPL originator in case on invalid flight plan.

1. Attributes:

a. string code (Mandatory)

An IFPS error code is made of the IFPS error class (e.g.: "EFPM", "PROF", …) concatenated
with the error identification number (e.g.: "052"), e.g. "EFPM052".

b. string description (Optional)

The error description is the same as the one passed in the REJ message that NM sends to the
FPL originator in case on invalid flight plan.

c. string anomalyComment (Optional)

Additional information on the error.

2. Used by: ReroutingApplyReplyData, FilingResultRejected, RoutingAssistanceReplyData, RouteInfo,

EvaluateFlowImpactReplyData, NetworkImpactFlightData, FlightPlanValidationReplyData

19.7.186. ImpactSeverityIndicator
<<enumeration>>

Impact assessment of non-punctual arrival upon the airport planning and AUs business needs

1. Values:

a. OT

On time arrival - No knock-on effect.

b. E

Early arrival with no impact.

c. EI

Early arrival with expected lack of airport resources.

d. L

Late arrival without knock-on effect.

Edition: 27.0 6 1088

Document Title: NM 27.0 - NM B2B Reference Manual

e. LI

Late arrival with knock-on effect.

f. LIP

Late arrival with knock-on effect on priority flight.

2. Used by: GeneralAPIRequest, ArrivalInformation

19.7.187. IntervalPosition
<<enumeration>>

Indicates if a time or distance or … is inside or outside(before or after) an Interval

1. Values:

a. BEFORE

Before the interval.

b. INSIDE

Inside the interval.

c. AFTER

After the interval.

2. Used by: ConcernedRegulationTimeOver, ActualTimeAtTarget

19.7.188. IntruderKind
<<enumeration>>

A flight is an intruder in a flight list if the other profile (according to the requested
FlightListRequest.compareWithOtherTrafficType) is not crossing the reference location.

Intrusion is computed between the requested flight list (FlightListRequest.trafficType) and the flight
list that is compared with (FlightListRequest.compareWithOtherTrafficType).

1. Values:

a. NON_INTRUDER

Delta entry is calculated and flight is not identified as an intruder.

b. HORIZONTAL_INTRUDER

Delta entry is calculated and flight is identified as an intruder due to horizontal deviation
between compared traffic types.

Edition: 27.0 6 1089

Document Title: NM 27.0 - NM B2B Reference Manual

c. VERTICAL_INTRUDER

Delta entry is calculated and flight is identified as an intruder due to vertical deviation
between compared traffic types.

d. MIXED_INTRUDER

Delta entry is calculated and flight is identified as an intruder due to horizontal and vertical
deviation between compared traffic types.

2. Used by: DeltaEntry

19.7.189. InvalidFiling
<<class>>

Summary of an invalid flight plan message.

1. Attributes:

a. DateTimeSecond filingTime (Mandatory)

Filing time.

b. FlightPlanMessageType invalidMessageType (Mandatory)

Invalid message type.

c. FlightPlanMessageStatus invalidMessageStatus (Mandatory)

Invalid message status.

d. FlightKeys keys (Optional)

Flight keys to uniquely identify the flight.

2. Used by: FlightPlanOrInvalidFiling

19.7.190. LandingInformation
<<class>>

This type is used to provide information about a landing flight.

1. Attributes:

a. DateTimeMinute landingTime (Mandatory)

The landing time. It can be either estimated or actual (see takeOffTimeQualifier).

b. EstimateQualifier landingTimeQualifier (Mandatory)

Whether the provided landingTime is an estimate or an actual value.

Edition: 27.0 6 1090

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: FlightUpdateChoice

19.7.191. Latitude
<<typedef[double]>>

Represents latitude as an angle in degrees having the range [-90 .. 90].

Positive values represent Northern latitudes where negative values represent Southern latitudes
taking the place of the traditional "N" and "S" designators.

Accuracy of the latitude coordinates: 0.1 seconds (~3 meters).

Examples
50.78639940000001

1. Used by: Position

19.7.192. LifeJacketEquipment
<<enumeration>>

Enumerates the possible equipment items that life jackets carried by an aircraft can have.

ICAO J/ field.

1. Values:

a. LIGHTS

The life jackets are equipped with lights.

b. FLUORESCEIN

The life jackets are equipped with fluorescein.

c. UHF

All life jackets are equipped with UHF on frequency 243.0 MHz.

d. VHF

All life jackets are equipped with VHF on frequency 121.5 MHz.

2. Used by: SupplementaryInformation

19.7.193. LoadStateAtReferenceLocation
<<union>>

The ENTRY or OCCUPANCY load state at reference location.

1. Choices:

Edition: 27.0 6 1091

Document Title: NM 27.0 - NM B2B Reference Manual

a. LoadState ENTRY

Indicates the monitored entry load state in which the flight is involved.

b. OtmvStatus OCCUPANCY

Indicates the monitored occupancy OTMV load state in which the flight is involved.

2. Used by: Flight

19.7.194. Longitude
<<typedef[double]>>

Represents a longitude as an angle in degrees having the range [-180 .. 180].

Positive values represent Eastern longitudes where negative values represent Western longitudes
taking the place of the traditional "E" and "W" designators.

Accuracy of the longitude coordinates: 0.1 seconds (~3 meters).

Examples
4.247596199999975

1. Used by: Position

19.7.195. ManualProcessingFilingStatus (new 27.0)

<<enumeration>>

The result of the manual processing of a flight plan that was queued for manual correction.

1. Values:

a. ACCEPTED

The flight plan has been accepted in IFPS.

b. INVALID_REJECTED

The flight plan has been rejected.

2. Used by: FilingStatusFilter

19.7.196. MessageOriginator
<<union>>

Originator of a flight message.

1. Choices:

a. AirNavigationUnitId airNavigationUnitId

Edition: 27.0 6 1092

Document Title: NM 27.0 - NM B2B Reference Manual

Id of the originating air navigation unit.

b. NetworkAddress address

Network address of the originating air navigation unit.

2. Used by: FlightFilingResultMessage, FlightPlanEvent, Flight

19.7.197. ModeSCapabilities
<<class>>

Used in the surveillance equipment to describe the Mode S capabilities of the aircraft if equipped
with Mode S transponder.

1. Attributes:

a. EquipmentStatus aircraftIdentification (Optional)

Indicates if the Mode S transponder is transmitting the aircraft identification.

b. EquipmentStatus pressureAltitude (Optional)

Indicates if the Mode S transponder is transmitting the pressure and altitude.

c. EquipmentStatus extendedSquitterADSB (Optional)

Indicates if the Mode S transponder is equipped with an extended squitter (ADS-B).

d. EquipmentStatus enhancedSurveillance (Optional)

Indicates if the Mode S transponder is equipped with extended surveillance.

The accepted combinations and the correspondence with the ICAO Mode S equipment code
I, P, X, E, H, L, S is defined by the following table:

Table 50. ModeSCapabilities.enhancedSurveillance description

ICAO aircraft pressure Altitude extended enhanced

code Identification SquitterADSB Surveillance

I equipped not equipped equipped or not equipped or not

equipped equipped

P not equipped equipped equipped or not equipped or not

equipped equipped

X not equipped not equipped equipped or not equipped or not

equipped equipped

E equipped equipped equipped not equipped

H equipped equipped not equipped equipped

L equipped equipped equipped equipped

Edition: 27.0 6 1093

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO aircraft pressure Altitude extended enhanced

code Identification SquitterADSB Surveillance

S equipped equipped not equipped not equipped

Note
The ICAO description excludes the combination of I, P, X codes. It also excludes the
combination of one or more of E, H, L, S with one of the I, P, X. But it does not exclude the
combination of E, H, L, S codes, this means that when converting the ICAO field 10b into
the 4 ModeSCapabilities , the "not equipped" status induced by one of E, H, L, S code shall
be overwritten by the "equipped" status induced by an other E, H, L, S code.

2. Used by: SurveillanceEquipment

19.7.198. NumberOfDinghies_DataType
<<typedef[int]>>

The number of dinghies carried by the aircraft.

1. range : [0, 99]

2. Used by: Dinghies

19.7.199. OceanicInformation
<<class>>

This type is used to provide oceanic information.

It groups two message types ( FNM and MFS ).

1. Attributes:

a. OceanicAreaControlCentre source (Mandatory)

The source.

i. Constraints:

▪ OceanicInformation.INVALID_OCEANIC_INFORMATION

b. string icaoRoute (Optional)

Represents the Flight Plan ICAO Route (Field15).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

▪ OceanicInformation.INVALID_OCEANIC_INFORMATION

c. FourDFlightPoint position (Mandatory)

The position.

Edition: 27.0 6 1094

Document Title: NM 27.0 - NM B2B Reference Manual

d. ICAOPoint landfallPoint (Optional)

The landfall point.

i. Constraints:

▪ OceanicInformation.INVALID_OCEANIC_INFORMATION

2. Constraints:

a. INVALID_OCEANIC_INFORMATION

If source equals GANDER then icaoRoute shall be present.

If source equals SHANWICK or SANTA_MARIA then landfallPoint must be present.

Constrained attributes: source, icaoRoute, landfallPoint

Constrained requests: any using request

3. Used by: FlightUpdateChoice

19.7.200. OtherAerodromeDesignation
<<class>>

Used to specify either an aerodrome (name and/or location) for which no ICAO identification exists
or the first or last point of the route when departing from or arriving to a place that is not an
aerodrome.

1. Attributes:

a. AerodromeName_DataType aerodromeName (Optional)

The name of the aerodrome.

Cannot be null if firstLastRoutePoint is null. Must be null if otherwise.

i. Constraints:

▪ OtherAerodromeDesignation.AERODROME_AND_ROUTE_POINT_NUTUALLY_EXCLUSIVE

b. NonPublishedPoint aerodromeLocation (Optional)

The location of the aerodrome expressed as a reference point or a geographical position.

Must be null if firstLastRoutePoint is not null.

i. Constraints:

▪ OtherAerodromeDesignation.AERODROME_AND_ROUTE_POINT_NUTUALLY_EXCLUSIVE

c. ICAOPoint firstLastRoutePoint (Optional)

The first or last point of the route: given only when the aircraft departs from or lands to a
place that is not an aerodrome.

Edition: 27.0 6 1095

Document Title: NM 27.0 - NM B2B Reference Manual

Cannot be null if aerodromeName and aerodromeLocation are null. Must be null otherwise.

i. Constraints:

▪ OtherAerodromeDesignation.AERODROME_AND_ROUTE_POINT_NUTUALLY_EXCLUSIVE

2. Constraints:

a. AERODROME_AND_ROUTE_POINT_NUTUALLY_EXCLUSIVE

Attribute firstLastRoutePoint is mutually exclusive with attributes aerodromeName and

aerodromeLocation .

Please specify either firstLastRoutePoint or aerodromeName and/or aerodromeLocation .

Constrained attributes: aerodromeName, aerodromeLocation, firstLastRoutePoint

Constrained requests: any using request

3. Used by: Aerodrome

19.7.201. OtherAircraftTypeDesignation_DataType
<<typedef[string]>>

Name of the aircraft type if no ICAO id exists for this aircraft type (ICAO TYP/ field).

1. Pattern: ANY{1,60}

2. Used by: AircraftType

19.7.202. OtherInformation
<<class>>

Any other flight data items specified in the bilateral agreement.

See also ICAO 4444 document field 18 (other information).

All attributes in this class are optional for all services using the FlightPlan structure.

1. Attributes:

a. SelectiveCallingCode selCalCode (Optional) (altered 27.0)

Selective Calling Code. Included if so prescribed by the appropriate ATS authority.

ICAO item 18 SEL/.

b. AircraftOperatorName_DataType nameOfOperator (Optional)

Name of the operator, if not obvious from the aircraft identification.

ICAO item 18 OPR/.

Edition: 27.0 6 1096

Document Title: NM 27.0 - NM B2B Reference Manual

c. SpecialHandlingIndicators reasonForSpecialHandling (Optional)

Reasons for special handling by ATS.

d. AircraftPerformanceCategory aircraftPerformanceData (Optional)

Aircraft performance data, indicated by a single letter as specified in the ICAO Doc 8168, if
so prescribed by the appropriate ATS authority.

ICAO item 18 PER/.

e. string communicationEquipment (Optional)

Significant data related to communication equipment as required by the appropriate ATS

authority, e.g. COM/UHF only.

ICAO item 18 COM/.

i. Constraints:

▪ Pattern: ANY{1,50}

f. DatalinkCapabilities datalinkCapabilities (Optional)

Up to four different datalink capabilities.

ICAO item 18 DAT/.

g. string navigationEquipment (Optional)

Significant navigation equipment.

ICAO item 18 NAV/.

i. Constraints:

▪ Pattern: ANY{1,50}

h. PerformanceBasedNavigationCode[] performanceBasedNavigationCodes (Optional)

Indication of RNAV and/or RNP capabilities.

No duplicates are accepted.

ICAO item 18 PBN/.

i. Constraints:

▪ array size range : [0, 8]

i. string otherSurveillanceEquipments (Optional)

Includes surveillance applications or capabilities not specified in the surveillanceEquipment

of the flight plan (ICAO 10b).

Edition: 27.0 6 1097

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO item 18 SUR/.

i. Constraints:

▪ Pattern: ANY{1,50}

j. int replacementFlightPlanIndicator (Contextual)

External flight plan version possibly provided by the submitter when a flight plan is
cancelled and re-submitted. This is opaque for NM.

ICAO item 18 RFP/.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

ii. Constraints:

▪ range : [1, 9]

k. DistanceM runwayVisualRange (Contextual)

Runway Visual Range (RVR). Operating minima when special meteorological conditions
exist.

If specified, must be within [ 0, 999 ].

ICAO DOC 7030 placed in ICAO item 18 RVR/.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

l. ReclearanceInFlight reclearanceInFlight (Contextual)

Revised route subject to clearance in flight and terminating with the ICAO designator of the
revised aerodrome of destination.

ICAO item 18 RIF/.

i. Presence:

▪ Ignored in EvaluateFlowImpactRequest FlightPlanValidationRequest

RoutingAssistanceRequest
▪ Optional otherwise

m. string[] otherRemarks (Optional)

Any other plain language remarks when required by the appropriate ATS authority or
deemed necessary by the pilot-in-command for the provision of air traffic services.

Edition: 27.0 6 1098

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO item 18 RMK/.

This attribute is NOT USED in the RouteAssistanceRequest service request. If

NOTE provided, the following syntax error message will be returned: SUSPECT
INVALID FIELD AT ROW= 1, COL= 217 (ICAO REG/ IN RMK DATA).

i. Constraints:

▪ Item pattern: MULTILINE_TEXT{0,1000}

2. Used by: FlightPlanUpdate, FlightPlan

19.7.203. PerformanceBasedNavigationCode
<<enumeration>>

PBN code indicating the RNAV or RNP capability of the aircraft.

1. Values:

a. RNAV_10

A1

b. RNAV_5_ALL

B1

c. RNAV_5_GNSS

B2

d. RNAV_5_DME_DME

B3

e. RNAV_5_VOR_DME

B4

f. RNAV_5_INS_OR_IRS

B5

g. RNAV_5_LORAN_C

B6

h. RNAV_2_ALL

C1

i. RNAV_2_GNSS

Edition: 27.0 6 1099

Document Title: NM 27.0 - NM B2B Reference Manual

C2

j. RNAV_2_DME_DME

C3

k. RNAV_2_DME_DME_IRU

C4

l. RNAV_1_ALL

D1

m. RNAV_1_GNSS

D2

n. RNAV_1_DME_DME

D3

o. RNAV_1_DME_DME_IRU

D4

p. RNP_4

L1

q. BASIC_RNP_1_ALL

O1

r. BASIC_RNP_1_GNSS

O2

s. BASIC_RNP_1_DME_DME

O3

t. BASIC_RNP_1_DME_DME_IRU

O4

u. RNP_APCH

S1

v. RNP_APCH_BARO_VNAV

S2

Edition: 27.0 6 1100

Document Title: NM 27.0 - NM B2B Reference Manual

w. RNP_AR_APCH_RF

T1

x. RNP_AR_APCH_NO_RF

T2

2. Used by: OtherInformation

19.7.204. PointDAL
<<class>>

Point id and its cumulative ground projected distance along the trajectory.

1. Attributes:

a. ICAOPoint point (Mandatory)

Point ICAO id.

i. Constraints:

▪ PointDAL.MUST_BE_PUBLISHED_POINT

b. DistanceM cumulativeDistance (Mandatory)

Cumulative ground projected distance along the trajectory.

2. Constraints:

a. MUST_BE_PUBLISHED_POINT (new 27.0)

The point shall be a published point.

Constrained attributes: point

Constrained requests: any using request

3. Used by: DistanceAtLocation

19.7.205. Position
<<class>>

Represents a position, i.e. a latitude and a longitude.

1. Attributes:

a. Latitude latitude (Mandatory)

Latitude.

b. Longitude longitude (Mandatory)

Edition: 27.0 6 1101

Document Title: NM 27.0 - NM B2B Reference Manual

Longitude.

2. Used by: FourDPosition

19.7.206. PredictedDPIReplyData
<<class>>

The PredictedDPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: PredictedDPIReply

19.7.207. ProfileValidity
<<class>>

Contains data relating to the validity of the FTFM with respect to Flight Plan violations.

1. Attributes:

a. ProfileValidityKind profileValidityKind (Mandatory)

Specifies if the FTFM profile validity:

1. has been evaluated and Flight Plan violations have been encountered before the
maximum time limit has been reached.

2. has been evaluated to the maximum time limit and no Flight Plan violations have been
encountered.

3. has not been evaluated.

b. DateTimeMinute lastValidEOBT (Optional)

The last valid EOBT represents the maximum EOBT to which the profile can be shifted into
the future before any violation error(s) are encountered.

2. Used by: RouteInfo, Flight

19.7.208. ProfileValidityKind
<<enumeration>>

According to the profile validity type value, the interpretation of the lastValidEOBT is different:

1. The FTFM profile validity has been evaluated and Flight Plan violations have been encountered
before the maximum time limit has been reached. The optional field lastValidEOBT will be
present and will represent the maximum EOBT to which the profile can be shifted into the
future before Flight Plan violations have been encountered.

2. The FTFM profile validity has been evaluated to the maximum time limit and no Flight Plan
violations have been encountered. The optional field lastValidEOBT will be present and will be

Edition: 27.0 6 1102

Document Title: NM 27.0 - NM B2B Reference Manual

set to the EOBT shifted by the maximum limit.

3. The FTFM profile validity has not been evaluated. The optional field lastValidEOBT will not be
present.

1. Values:

a. VIOLATIONS

The FTFM profile validity has been evaluated and Flight Plan violations have been
encountered before the maximum time limit has been reached.

b. NO_VIOLATIONS

The FTFM profile validity has been evaluated to the maximum time limit and no Flight Plan
violations have been encountered.

c. UNKNOWN

The FTFM profile validity has not been evaluated.

2. Used by: ProfileValidity

19.7.209. ProposalInformation

<<class>>

Proposal information.

1. Attributes:

a. ProposalKind proposalKind (Mandatory)

Proposal kind.

b. DateTimeMinute responseBy (Mandatory)

Edition: 27.0 6 1103

Document Title: NM 27.0 - NM B2B Reference Manual

Deadline of the proposal. After responseBy the proposal is no longer valid.

c. DateTimeMinute proposedCTOT (Optional)

The CTOT of the proposal.

d. ReroutingRouteId routeId (Optional)

Name of the rerouting reference (only when proposalKind is RRP )

e. Cost deltaCost (Optional)

The cost difference between the current and the alternate route. A negative cost indicates a
gain. The delta cost indicator is computed either by AOWIR or at group rerouting execution
time.

f. SignedDurationHourMinuteSecond deltaDelay (Optional)

The delta delay expresses the difference between the flight delay known at group rerouting
execution with the flight delay of the alternate route. The delta delay indicator is computed
either by AOWIR or at group rerouting execution time.

g. ReroutingId reroutingId (Optional) (new 27.0)

The rerouting unique identifier.

2. Used by: Flight

19.7.210. ProposalKind
<<enumeration>>

This type expresses the kind of proposal, if any.

1. Values:

a. SIP

Slot Improvement Proposal

b. RVR

Flight is suspended and has a booked CTOT waiting for RVR confirmation.

c. RRP

Rerouting Proposal.

d. STAM_SLOT

Proposal from a Short-Term ATFM Measure.

e. DELAY_CONF

Edition: 27.0 6 1104

Document Title: NM 27.0 - NM B2B Reference Manual

Flight is suspended and has a booked CTOT waiting for delay confirmation

2. Used by: ProposalInformation

19.7.211. PSFlightField (new 27.0)

<<enumeration>>

Enumerates the flight fields that the caller may request in FlightDataPayloadConfiguration. Each
enumeration value corresponds to a homonym attribute in the Flight type. Please refer to such
type for a full description of each attribute.

1. Values:

a. aircraftType

See Flight.aircraftType attribute.

b. aircraftOperator

See Flight.aircraftOperator attribute.

c. operatingAircraftOperator

See Flight.operatingAircraftOperator attribute.

d. icaoRoute

See Flight.icaoRoute attribute.

e. routeLength

See Flight.routeLength attribute.

f. filedRegistrationMark

See Flight.filedRegistrationMark attribute.

g. lateFiler

See Flight.lateFiler attribute.

h. lateUpdater

See Flight.lateUpdater attribute.

i. cdmEstimatedOffBlockTime (new 27.0)

See Flight.cdmEstimatedOffBlockTime attribute.

j. calculatedOffBlockTime

See Flight.calculatedOffBlockTime attribute.

Edition: 27.0 6 1105

Document Title: NM 27.0 - NM B2B Reference Manual

k. actualOffBlockTime

See Flight.actualOffBlockTime attribute.

l. estimatedTakeOffTime

See Flight.estimatedTakeOffTime attribute.

m. calculatedTakeOffTime

See Flight.calculatedTakeOffTime attribute.

n. actualTakeOffTime

See Flight.actualTakeOffTime attribute.

o. ctotLimitReason

See Flight.ctotLimitReason attribute.

p. currentDepartureTaxiTimeAndProcedure

See Flight.currentDepartureTaxiTimeAndProcedure attribute.

q. suspensionStatus

See Flight.suspensionStatus attribute.

r. suspensionInfo

See Flight.suspensionInfo attribute.

s. readyStatus

See Flight.readyStatus attribute.

t. cdm

See Flight.cdm attribute.

u. proposalInformation

See Flight.proposalInformation attribute.

v. bestReroutingIndicator

See Flight.bestReroutingIndicator attribute.

w. slotZone

See Flight.slotZone attribute.

x. slotSwapCounter

Edition: 27.0 6 1106

Document Title: NM 27.0 - NM B2B Reference Manual

See Flight.slotSwapCounter attribute.

y. departureTolerance

See Flight.departureTolerance attribute.

z. exemptedFromRegulations

See Flight.exemptedFromRegulations attribute.

aa. delay

See Flight.delay attribute.

ab. delayCharacteristics

See Flight.delayCharacteristics attribute.

ac. mostPenalisingRegulation

See Flight.mostPenalisingRegulation attribute.

ad. mostPenalisingRegulationCause

See Flight.mostPenalisingRegulationCause attribute.

ae. hasOtherRegulations

See Flight.hasOtherRegulations attribute.

af. regulationLocations

See Flight.regulationLocations attribute.

ag. targetTimeOverFix

See Flight.targetTimeOverFix attribute.

ah. excludedRegulations

See Flight.excludedRegulations attribute.

ai. reroutable

See Flight.reroutable attribute.

aj. divertedAerodromeOfDestination

See Flight.divertedAerodromeOfDestination attribute.

ak. estimatedTimeOfArrival

See Flight.estimatedTimeOfArrival attribute.

Edition: 27.0 6 1107

Document Title: NM 27.0 - NM B2B Reference Manual

al. calculatedTimeOfArrival

See Flight.calculatedTimeOfArrival attribute.

am. actualTimeOfArrival

See Flight.actualTimeOfArrival attribute.

an. arrivalInformation

See Flight.arrivalInformation attribute.

ao. apiSubmissionRules

See Flight.apiSubmissionRules attribute.

ap. flightState

See Flight.flightState attribute.

aq. confirmedCTFM

See Flight.confirmedCTFM attribute.

ar. cfmuFlightType

See Flight.cfmuFlightType attribute.

as. isProposalFlight (new 27.0)

See Flight.isProposalFlight attribute.

at. profileValidity

See Flight.profileValidity attribute.

au. lastKnownPosition

See Flight.lastKnownPosition attribute.

av. highestModelPointProfile

The CTFM point profile if it exists, otherwise the RTFM point profile if it exists, otherwise the
FTFM point profile.

aw. highestModelAirspaceProfile

The CTFM airspace profile if it exists, otherwise the RTFM airspace profile if it exists,
otherwise the FTFM airspace profile.

ax. highestModelTrafficVolumeProfile

The CTFM traffic volume profile if it exists, otherwise the RTFM traffic volume profile if it

Edition: 27.0 6 1108

Document Title: NM 27.0 - NM B2B Reference Manual

exists, otherwise the FTFM traffic volume profile.

ay. aircraftAddress

See Flight.aircraftAddress attribute.

az. flightDataVersionNr

See Flight.flightDataVersionNr attribute.

ba. minimumRequestedRVR

See Flight.minimumRequestedRVR attribute.

bb. wakeTurbulenceCategory

See Flight.wakeTurbulenceCategory attribute.

bc. alternateAerodromes (new 27.0)

Light field. See Flight.alternateAerodromes.

bd. flightCriticality

See Flight.flightCriticality attribute.

be. oceanicReroute

See Flight.oceanicReroute attribute.

bf. iataFlightDesignator (new 27.0)

See Flight.iataFlightDesignator attribute.

bg. activeACDMAlerts (new 27.0)

Light field. See Flight.activeACDMAlerts attribute.

bh. routeChargeIndicator (new 27.0)

The route charge indicator of the highest model (CTFM if it exists, otherwise the RTFM if it
exists otherwise the FTFM). See Flight.routeChargeIndicator attribute.

bi. fuelConsumptionIndicator (new 27.0)

The fuel consumption indicator of the highest model (CTFM if it exists, otherwise the RTFM
if it exists otherwise the FTFM). See Flight.fuelConsumptionIndicator attribute.

2. Used by: FlightDataPayloadConfiguration

Edition: 27.0 6 1109

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.212. ReadyStatus
<<class>>

Describes a flight readiness status.

1. Attributes:

a. boolean readyForImprovement (Optional)

True if the flight is in Request For direct Improvement mode (RFI) state. False if it is not, i.e.
when the SIP Wanted Message mode is on (SWM).

Null if readyToDepart is true; cannot be null otherwise.

b. boolean readyToDepart (Mandatory)

The flight is ready to depart (REA message received).

c. DurationHourMinute revisedTaxiTime (Optional)

Revised taxi time, if any: i.e. the minline-up of the last READY message.

Note that this might be different than the taxi time of the FTFM and RTFM and CTFM flight
profiles.

2. Used by: Flight

19.7.213. ReadyToDepartReplyData
<<class>>

The ReadyToDepartReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: ReadyToDepartReply

19.7.214. ReasonForDPICancellation
<<enumeration>>

Improves the understanding of all operational users of the A-CDM events at the airports and helps
the AOs and Handling Agents to take the best action for the flight concerned.

1. Values:

a. NO_AIRPORT_SLOT

No Airport slot.

The airport does not have an airport slot for the departure.

b. TOBT_UNKNOWN_OR_EXPIRED

Edition: 27.0 6 1110

Document Title: NM 27.0 - NM B2B Reference Manual

TOBT unknown or expired.

The TOBT was deleted, the pilot did not request startup or report ready in accordance with
the procedures at the Airport.

c. TSAT_EXPIRED

TSAT expired.

The pilot did not request startup in accordance with the CDM procedures at the airport.

d. RETURN_TO_STAND

Return to stand.

After having started taxiing, the flight returned back to stand/ramp.

e. FLIGHT_PLAN_INVALID

Flight plan invalid.

The discrepancy between TOBT and EOBT is larger then 15min (and needs to be resolved
before startup will be issued).

f. FLIGHT_CANCEL_IN_AODB

Flight cancel in AODB.

Cancellation of the airport slot or Schedule before the ICAO FPL has been cancelled (CNL).

g. OTHER

Other.

Special value to be used when other C-DPI reason applies than the ones listed above. To be
used until this other C-DPI reason is made official in NM systems.

h. UNDEFINED

Undefined.

Absent C-DPI reason stored as UNDEFINED to avoid rejecting C-DPI messages during the
transition period (as the reason field is optional i AFTN/ADEXP). This value is authorised
only as output from NM systems (in CDMInfo), but will lead to rejection if used as input in a
CancelDPIRequest.

i. UNDO_ADPI

Documentation last updated: 27.0 - Edition 6

Undo A-DPI.

Edition: 27.0 6 1111

Document Title: NM 27.0 - NM B2B Reference Manual

Special value to be used to request NMOC to undo the effect of A-DPI information (TTOT, SID,
taxi-time, …) previously received, and to reset the CDM status to its value prior to A-DPI
processing.

This value is only used as input to NM systems, and will not be redistributed in output (in
CDM flight field).

2. Used by: CancelDPIRequest, CDMInfo

19.7.215. ReclearanceInFlight
<<class>>

Describes a re-clearance in flight, i.e. the new route and destination aerodrome.

1. Attributes:

a. string icaoRoute (Mandatory)

New route.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

b. AerodromeICAOId aerodrome (Mandatory)

New aerodrome.

2. Used by: OtherInformation

19.7.216. Relative4DPoint
<<class>>

Describes a four dimensional point relatively to the take-off.

1. Attributes:

a. DistanceM cumulativeDistance (Mandatory)

The total ground distance in meters from the take-off up to the point.

b. FlightLevelM altitude (Mandatory)

Estimated level at the point expressed in meters above mean sea level (MSL).

c. Duration elapsedTime (Mandatory)

Estimated Time elapsed expressed in number of seconds, since take-off up to the point.

2. Used by: BasicTrajectoryData

Edition: 27.0 6 1112

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.217. RequestedFlightLevel
<<class>>

Request flight level in a flight vertical profile.

1. Attributes:

a. FlightLevel flightLevel (Mandatory)

Flight level.

b. int segmentSequenceNumber (Mandatory)

Identifies each segment of the profile.

i. Constraints:

▪ range : [0, 9999]

c. int relativeDistance (Mandatory)

Relative distance (percentage) on the segment. If the requested flight level is on a segment
point, the relative distance is zero.

i. Constraints:

▪ range : [0, 100]

2. Used by: Flight

19.7.218. ReroutableStatus
<<enumeration>>

Describes whether a flight can be rerouted and under what conditions.

1. Values:

a. CANNOT_BE_REROUTED

The flight cannot be rerouted.

b. TRY_ALLOWED

Try rerouting is allowed.

c. TRY_AND_APPLY_ALLOWED

Both Try and Apply rerouting are allowed.

2. Used by: Flight

Edition: 27.0 6 1113

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.219. ReroutingApplyReplyData
<<union>>

1. Choices:

a. ReroutingApplyReplyDataResult result

b. IFPSError[] ifpsErrors

Array of NM/IFPS errors in response to the routing apply request. They are severe errors
such that it is not possible to build a meaningfull result (e.g. the flightplan could not be
parsed at all).

If not null, the array cannot be empty. The array cannot contain null or duplicate items.

2. Used by: ReroutingApplyReply

19.7.220. ReroutingApplyReplyDataResult
<<class>>

1. Attributes:

a. ReroutingProposalStatus reroutingProposalStatus (Mandatory)

Indicates if a proposal flight (e.g. RRN) was successfully created and if the apply was
successful or failed (and the reason why it failed).

b. string reroutingApplyFailedDetails (Optional)

Describes the details why the rerouting apply failed. Can only be present when
reroutingApplyStatus is not OK.

Note that if the reason is NOT_IFPS_COMPLIANT, then the detailed IFPS errors can be found
inside RouteInfo and not here.

c. string filedICAOTextualFlightPlan (Optional)

Describes the ICAO flightplan that was filed/submitted (by NM) or the ICAO flightplan that
should be filed/submitted (by AO).

d. ExtendedAircraftICAOId aircraftId (Mandatory)

The aircraft id of the new flight.

e. DateTimeMinute estimatedTakeOffTime (Mandatory)

The estimated take-off corresponding to the FTFM flight profile of the new route.

f. AircraftTypeICAOId aircraftType (Mandatory)

ICAO id of the aircraft type.

Edition: 27.0 6 1114

Document Title: NM 27.0 - NM B2B Reference Manual

g. RouteInfo appliedRoute (Mandatory)

Contains the route related info according to the applied alternative.

Note that there can be IFPS errors in appliedRoute (meaning the apply did not succeed).

2. Used by: ReroutingApplyReplyData

19.7.221. ReroutingFeedback (new 27.0)

<<class>>

The feedback to a flight rerouting.

1. Attributes:

a. ReroutingFeedbackKind kind (Mandatory)

The kind of feedback.

b. string icaoRoute (Mandatory)

The complete field15 representation of the alternative route proposed by the GRRT.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

c. ReroutingFeedbackReason reason (Mandatory)

The reason for which a route was liked or disliked.

d. string comment (Optional)

A comment about the feedback.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

e. ReroutingId reroutingId (Optional)

The unique identifier of the rerouting that provided the alternate route.

2. Used by: Flight, ReroutingFeedbackRequest

19.7.222. ReroutingFeedbackAction (new 27.0)

<<enumeration>>

The action to execute with some flight rerouting feedback.

1. Values:

a. GIVE_FEEDBACK

Edition: 27.0 6 1115

Document Title: NM 27.0 - NM B2B Reference Manual

Give some rerouting feedback.

b. REMOVE_FEEDBACK

Remove some previously given rerouting feedback.

2. Used by: ReroutingFeedbackRequest

19.7.223. ReroutingFeedbackKind (new 27.0)

<<enumeration>>

The kind of flight rerouting feedback.

1. Values:

a. LIKE

Like the rerouting.

b. DISLIKE

Dislike the rerouting.

2. Used by: ReroutingFeedback

19.7.224. ReroutingFeedbackReason (new 27.0)

<<enumeration>>

The reason for which a flight rerouting was liked or disliked.

1. Values:

a. TOTAL_COST

Total cost.

b. FUEL_SAVINGS

Fuel savings.

c. ROUTE_CHARGES

Route charges.

d. ATFM_DELAY_VALUE

ATFM delay value.

e. DISTANCE

Distance.

Edition: 27.0 6 1116

Document Title: NM 27.0 - NM B2B Reference Manual

f. FLYING_TIME

Flying time.

g. OBT_VALIDITY

OBT validity.

h. AO_INTERNAL_REASONS

Aircraft operator internal reasons.

i. OTHER

Other.

2. Used by: ReroutingFeedback

19.7.225. ReroutingFeedbackReplyData (new 27.0)

<<class>>

The ReroutingFeedbackReply payload.

1. Used by: ReroutingFeedbackReply

19.7.226. ReroutingIndicator

<<class>>

This class describes both a rerouting reason and optionally a rerouting state.

1. Attributes:

a. boolean rerouted (Mandatory)

True if the flight was rerouted.

Edition: 27.0 6 1117

Document Title: NM 27.0 - NM B2B Reference Manual

b. ReroutingReason reason (Optional)

If the flight was rerouted, indicates why.

Cannot be null if rerouted is true; must be null otherwise.

c. ReroutingState state (Optional)

If the flight was rerouted, indicates its resulting rerouted state.

Cannot be null if rerouted is true; must be null otherwise.

2. Used by: Flight

19.7.227. ReroutingOpportunities (new 27.0)

<<class>>

A list of rerouting opportunities.

1. Attributes:

a. DateTimeSecond oplogTimestamp (Mandatory)

The time when the NM system evaluted the rerouting for the flight.

b. ReroutingId reroutingId (Mandatory)

The rerouting identifier.

c. DateTimeMinutePeriod offBlockTimeValidity (Optional)

If the flight is refiled with the proposed route, its new off-block time must lie inside this
period. If not, the flight might be invalid.

d. string reroutingNote (Mandatory)

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,99999}

e. ReroutingPurpose reroutingPurpose (Mandatory)

The rerouting purpose.

f. list< AlternativeRouteInfo > opportunities (Mandatory)

The interesting alternatives, sorted by increasing total cost. Uninteresting alternatives are
omitted.

2. Used by: Flight

Edition: 27.0 6 1118

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.228. ReroutingProposalRejectedReplyData
<<class>>

The ReroutingProposalRejectedReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: ReroutingProposalRejectedReply

19.7.229. ReroutingProposalStatus
<<enumeration>>

Enumerates rerouting proposal status.

Indicates if a proposal/alternative (routing assistance context) is valid (OK or OVERLOAD) or not or

if for a ReroutingApplyRequest , a proposal flight has been created (OK or OVERLOAD values).

1. Values:

a. OK

The rerouting is OK and does not generate additional overload in FMP sectors.

b. NOT_AVAILABLE

ReroutingApplyRequest temporarily not available. Please try again in one minute.

c. NOT_AUTHORIZED

RoutingAssistanceRequest / ReroutingApplyRequest not allowed according to the flight list:

ReroutableStatus.

d. ALREADY_PROPOSAL

There exists already a proposal flight. No proposal flight can be created (

ReroutingApplyRequest context).

e. SUSPENDED

The new route makes the flight become suspended.

f. BAD_DELAY

No proposal flight could be created respecting the maxDelay.

g. OVERLOAD

Warning: this route to apply (or this alternative) generates an additional overload in some
FMP sectors.

h. NOT_IFPS_COMPLIANT

Edition: 27.0 6 1119

Document Title: NM 27.0 - NM B2B Reference Manual

The route to apply contains IFPS errors ( ReroutingApplyRequest context) or the alternative
contains IFPS erors ( RoutingAssistanceRequest context)

i. FLIGHT_ACTIVATED

The flight is already activated. No proposal flight can be created ( ReroutingApplyRequest

context).

j. OBT_VALIDITY

No delay found in OBT validity (flight becomes IFPS non-compliant).

k. CONSTRAINT_VIOLATED

The alternative does not respect the constraints given by the user (not applicable in
ReroutingApplyRequest context).

2. Used by: ReroutingApplyReplyDataResult

19.7.230. ReroutingReason
<<enumeration>>

Documentation last updated: 27.0 - Edition 4

Describes whether a flight was rerouted, and if that is the case, why.

Note that if the flight rerouting originated from a rerouting measure, then there is a relationship
between the flight’s ReroutingIndicator.reason and the rerouting measure’s purpose (shown in the
flight list under atfcmMeasureLocations field): see ReroutingPurpose. See in the values (just below) for
the details/relationship/mapping.

1. Values:

a. ATFM_EXECUTED

Documentation last updated: 27.0 - Edition 4

Executed ATFM rerouting. This type of rerouting only occurs on FORECAST/SIMULATION

datasets. It could technically occur on OPERATIONAL dataset for planned flights (expected
flights for which no confirming flight plan is received yet). The rerouting measure, has
changed the FTFM/RTFM flight profile (no proposal flight, nor RRP message has been
generated). This rerouting reason can correspond to any of the rerouting measure’s
rerouting purposes.

b. AO

Documentation last updated: 27.0 - Edition 1

Aircraft Operator rerouting (AOWIR). This type of rerouting only occurs on operational
dataset. The B2B user did a ReroutingApplyRequest and an RRP was generated.

Edition: 27.0 6 1120

Document Title: NM 27.0 - NM B2B Reference Manual

c. ATFCM_PURPOSE_PROPOSAL

Proposal flight (e.g. RRP) generated due to (NM) ATFCM/AOLO_REROUTING purpose

rerouting measure/NM WIR (CWIR/ AOLO action) / NM AOLO rerouting measure. This type
of rerouting only occurs on operational dataset (typically : an NM user proposed/generated
an RRP to reduce delays).

d. ATC_PURPOSE_PROPOSAL

Proposal flight (e.g. RRP) generated due to ATC_ROUTING purpose rerouting measure /NM
WIR (CWIR / AOLO action) / NM AOLO rerouting measure. This type of rerouting only occurs
on operational dataset (typically : an NM user proposed/generated an RRP).

e. FLIGHT_EFFICIENCY_PURPOSE_PROPOSAL

Proposal flight generated due to (AO) FLIGHT_EFFICIENCY purpose rerouting measure (and
exceptionally by NM WIR (CWIR / AOLO action) / NM AOLO rerouting measure). This type of
rerouting only occurs on operational dataset (typically : an AO user proposed/generated an
RRP to reduce delays/fuel).

f. STAM_PURPOSE_PROPOSAL

Proposal flight generated due to (FMP) STAM purpose rerouting measure (and exceptionally
by NM WIR (CWIR / AOLO action) / NM AOLO rerouting measure). This type of rerouting
only occurs on operational dataset (typically : an FMP user proposed/generated an RRP to
reduce overloads and avoid having to create a regulation).

g. CDR_OPPORTUNITY_PROPOSAL

Proposal flight generated due to (AO) CDR_OPPORTUNITY purpose rerouting measure (e.g.
AUP/UUP related opened route) (and exceptionally by NM WIR (CWIR / AOLO action) / NM
AOLO rerouting measure). This type of rerouting only occurs on operational dataset
(typically : an AO has a special type of flight efficiency rerouting measure that
proposes/generates an RRP to take advantage of AUP/UUP related opened route to reduce
fuel).

2. Used by: ReroutingIndicator

19.7.231. ReroutingRouteId

Edition: 27.0 6 1121

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Rerouting route id.

1. Attributes:

a. ReroutingRouteType routeType (Mandatory)

Route type.

b. StandardRouteId standardRouteId (Mandatory)

Standard route id.

2. Used by: AlternativeRouteInfo, RouteInfo, ProposalInformation,

ReroutingProposalRejectedRequest, ReroutingApplyRequest

19.7.232. ReroutingRouteType
<<enumeration>>

Enumerates rerouting route types.

1. Values:

a. GENERATED

Generated route ( GR ).

b. STANDARD

Standard route from the NM systems route catalogue ( SR ).

c. USER

User defined route ( UR ).

d. VERTICAL

Vertically rerouted route ( VR ).

Edition: 27.0 6 1122

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: ReroutingRouteId

19.7.233. ReroutingState
<<enumeration>>

If a flight was rerouted, describes the current rerouting state.

1. Values:

a. PRODUCED

There is a valid rerouting going on, waiting to be realised by either an FPL or a CHG.

b. EXECUTED

Rerouting has been executed.

c. TIMED_OUT

No FPL/CHG received on time.

d. REJECTED

Rerouting proposal has been rejected.

e. REVOKED

A booking was created for the proposal, but a manual operation that changed the regulation
(typically deep rectify) has deleted the booking before the attempt to accept the proposal.

f. NO_MATCH

Message received did not match the proposal; rerouting has been invalidated.

2. Used by: ReroutingIndicator

19.7.234. RevalidationInformation (new 27.0)

<<class>>

This type contains the result of the periodic flight plan revalidation.

1. Attributes:

a. UUID gufi (Optional)

GUFI.

b. RevalidationStatus revalidationStatus (Mandatory)

The outcome of the flight plan revalidation.

Edition: 27.0 6 1123

Document Title: NM 27.0 - NM B2B Reference Manual

c. string[] revalidationErrors (Optional)

The list of errors detected during the flight plan revalidation.

d. string proposedRoute (Optional)

When populated, this field contains a valid route that can be used as a valid alternative. It is
not always provided.

2. Used by: FlightPlanMessage

19.7.235. RevalidationStatus (new 27.0)

<<enumeration>>

Flight Plan Revalidation status

1. Values:

a. COMPLIANT

The flight plan is compliant with all active constraints.

b. ADVISORY

The flight plan violates some constraints and is no longer operationally acceptable.
However, due to the origin or the nature of the flight it cannot be suspended. This
information is for the flight plan originator and AOCC.

c. SUSPENDED

The flight plan violates some constraints and is no longer operationally acceptable and it
will be suspended. An FLS event will follow.

2. Used by: RevalidationInformation

19.7.236. RevisionTimes
<<class>>

Times to insert aircraft in sequence and remove aircraft from sequence.

1. Attributes:

a. DurationHourMinute timeToInsertInSequence (Optional)

Time to insert in sequence.

b. DurationHourMinute timeToRemoveFromSequence (Optional)

Time to remove from sequence.

2. Used by: Flight

Edition: 27.0 6 1124

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.237. RouteInfo

<<class>>

Description of a route (and related info) in the context of RoutingAssistanceReply ,

EvaluateFlowImpactRequest and ReroutingApplyReply (or rerouting apply) : either for the
original/given flight plan or for a generated alternative route.

1. Attributes:

a. DurationHourMinute duration (Mandatory)

Duration of the route.

Note: includes flight portions being outside the IFPZ or being 'invisible'.

b. DistanceNM length (Mandatory)

Length of the route from ADEP to ADES.

Note: includes flight portions being outside the IFPZ or being 'invisible'.

c. string icaoRoute (Mandatory)

The complete field15 that can be used as an alternate to the route of the given flight plan.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

d. ReroutingRouteId routeId (Mandatory)

Name of the rerouting reference.

Note that it also contains the source that generated this particular route (route generator,

Edition: 27.0 6 1125

Document Title: NM 27.0 - NM B2B Reference Manual

route catalogue, etc.).

e. IFPSError[] routeErrors (Optional)

Errors associated to a proposed alternate route. They can be of the following IFPS error
classes: EFPM, PROF, ROUTE.

In some circumstances a route may be proposed with errors. If radOff is true, the proposed
routes may contain errors.

The array is null if the proposed route has no error.

f. DateTimeMinute ctot (Optional)

The CTOT according to the new route.

Not present if the new route is not crossing any regulations.

g. RegulationId mostPenalisingRegulation (Optional)

Not present if the new route is not crossing any regulations.

h. DurationHourMinute delay (Optional)

The delay the new route gives (i.e., newCTOT - ETOT).

Not present if no CTOT.

i. SuspensionStatus suspensionStatus (Mandatory)

Suspension status.

j. FlightRegulationLocation[] regulations (Optional)

List of flight regulations.

k. set< TrafficVolumeId > overloadedTVs (Optional)

Note that this field is only populated during specific trials (e.g., NMVP).

l. WeightKg consumedFuelIndicator (Mandatory)

Gives an indication about the fuel needed for the route.

m. Cost routeChargeIndicator (Mandatory)

Gives an indication about the cost of the route charges for the route.

n. ProfileValidity profileValidity (Mandatory)

Contains data related to the validity of the RTFM, or else the FTFM with respect to Flight
Plan violation errors.

Edition: 27.0 6 1126

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: ReroutingApplyReplyDataResult, RoutingAssistanceReplyDataResult,

EvaluateFlowImpactReplyData

19.7.238. RoutingAssistanceApplyKind
<<enumeration>>

Indicates how the reply of a routingAssistanceRequest or EvaluateFlowImpactRequest needs to be

applied:

1. The B2B client will refile (via the FlightFiling services). So NM systems cancel the normal flight
and create a proposal flight (with RRP message) with "guaranteed" CTOT and give the AO user
time to re-file a flightplan via local tools.

2. Or NM systems refile on behalf of the AO (while guaranteeing the CTOT)

1. Values:

a. CREATE_PROPOSAL_FLIGHT_ONLY

Documentation last updated: 27.0 - Edition 4

WARNING This value is not supported in operation.

Create a proposal flight (e.g. with RRN) without refiling/cancelling the normal flight.

b. AO_REFILE

Create a proposal flight (e.g. with RRN) and cancel the normal flight. The B2B client is
expected to refile via the FlightFiling services. When a Flight has a FilingRule
OPERATOR_MUST_REFILE, then only AO_REFILE is allowed (or in trials also
CREATE_PROPOSAL_FLIGHT_ONLY)

c. NM_REFILES

NM systems refile on behalf of the AO (while guaranteeing the CTOT). When a Flight has a
FilingRule FILING_ALLOWED_BY_AO_CFMU, then both AO_REFILE and NM_REFILES are
allowed.

2. Used by: ReroutingApplyRequest

19.7.239. RoutingAssistanceReplyData
<<union>>

1. Choices:

a. RoutingAssistanceReplyDataResult result

Contains the generated alternate routes if no NM/IFPS errors occurred.

b. IFPSError[] ifpsErrors

Edition: 27.0 6 1127

Document Title: NM 27.0 - NM B2B Reference Manual

Array of NM/IFPS errors in response to the routing assistance request. They are errors on
the constraint that can be specified when requesting the generation of alternate route (e.g.:
error on via point being unknown)

If not null, the array cannot be empty. The array cannot contain null or duplicate items.

2. Used by: RoutingAssistanceReply

19.7.240. RoutingAssistanceReplyDataResult
<<class>>

1. Attributes:

a. ExtendedAircraftICAOId aircraftId (Mandatory)

The aircraft id of the original flight or flight plan.

b. DateTimeMinute estimatedTakeOffTime (Mandatory)

The estimated take-off corresponding to the FTFM flight profile of the original route.

Note that each alternative will have the same estimated take-off time.

c. AircraftTypeICAOId aircraftType (Mandatory)

ICAO id of the aircraft type.

Note that each alternative will have the same aircraft type.

d. RouteInfo originalRoute (Mandatory)

Contains the original route related info.

e. RouteInfo[] proposedRoutes (Mandatory)

Contains the generated alternate routes.

If there is no NM/IFPS error but no alternate route was found, the array is not null but
empty. The array cannot contain null or duplicate items.

2. Used by: RoutingAssistanceReplyData

19.7.241. SelectiveCallingCode (altered 27.0)

<<typedef[string]>>

A Selective Calling Code acts as a paging system for an ATS unit to establish voice communications
with the pilot of an aircraft.

1. Pattern: (UALPHA|DIGIT){4}

2. Used by: OtherInformation

Edition: 27.0 6 1128

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.242. SlotImprovementModeReplyData
<<class>>

The SlotImprovementModeReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: SlotImprovementModeReply

19.7.243. SlotImprovementStrategy
<<enumeration>>

Slot improvement strategy.

1. Values:

a. READY_FOR_IMPROVEMENT

RFI message

b. SIP_WANTED

SWM message

2. Used by: SlotImprovementModeRequest

19.7.244. SlotMissedReplyData
<<class>>

The SlotMissedReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: SlotMissedReply

19.7.245. SlotProposalFeedbackReplyData
<<class>>

The SlotProposalFeedbackReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: SlotProposalFeedbackReply

19.7.246. SlotSwapCandidate
<<class>>

The list of candidates that can be swapped with the subject flight, with relevant information for
each candidate.

Edition: 27.0 6 1129

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. IFPLId ifplId (Mandatory)

Identification of the candidate flight that can be slot-swapped with the subject flight (the
subject flight being the flight from the flight list from which this information is retrieved).

The candidate flight is always part of the same flight list as the subject flight, so additional
flight data can be retrieved from the same flight list (so with a single query/reply), provided
that the ifplId has been requested in order to make the association.

b. int subjectDeltaDelayMinutes (Mandatory)

The signed difference in minutes between the CTOT that the subject flight currently has and
the CTOT that the subject flight will get if swapped with the candidate flight.

A positive duration means an increase of the delay, a negative duration means a reduction
of the delay.

By CTOT we mean the RTFM CTOT, not necessarily equal to the CTOT from the last SAM/SRM
message.

c. int candidateDeltaDelayMinutes (Mandatory)

Same as subjectDeltaDelayMinutes but for the candidate flight.

d. DateTimeMinute swapDecideByTime (Mandatory)

The deadline for submission of the slot swap request to NMOC.

2. Used by: Flight

19.7.247. SlotSwapCounter
<<class>>

The number of times the flight has already been swapped with another flight, and the associated
limit.

1. Attributes:

a. int currentCounter (Mandatory)

The number of times the flight has been successfully swapped with another flight.

i. Constraints:

▪ range : [0, unbounded[

b. int maxLimit (Mandatory)

When currentCounter has reached maxLimit , any further slot swap request involving this
flight will be rejected by NMOC.

Edition: 27.0 6 1130

Document Title: NM 27.0 - NM B2B Reference Manual

However, it should not be assumed that currentCounter is always lower than or equal to
maxLimit , because under exceptional circumstances, the flight might still be swapped even
when the limit has been already reached.

i. Constraints:

▪ range : [0, unbounded[

2. Used by: Flight

19.7.248. SlotZone
<<class>>

The slot zone around the RTFM of the flight in relative time duration values. NM ensures that any
new shift of the FTFM profile (resulting from a DLA, CHG or DPI message) before or inside the slot
zone will not result in a CTOT recalculation (except in some circumstances, e.g. when the route
changed and the flight is subject to more than one regulation).

E.g. current CTOT = 10:00 and taxi-time = 5 minutes. Any new EOBT value of maximum 10:00 - 5
minutes + afterCTO will not trigger a CTOT recalculation (assuming that the processing of the
message results in a pure shift of the FTFM profile and no change of taxi-time).

For API messages, any new TTO falling inside the slot zone around the CTO over the coordination
fix, will force the CTO to be exactly equal to the TTO.

1. Attributes:

a. DurationMinute beforeCTO (Mandatory)

The duration to be subtracted from the CTO to get the lower bound of the slot zone. This
bound of the slot zone is only relevant in the context of Target Take-Off API messages.

b. DurationMinute afterCTO (Mandatory)

The duration to be added to the CTO/COBT to get the upper bound of the slot zone.

2. Used by: Flight

19.7.249. SpecialHandlingIndicators
<<class>>

STS indicators, ICAO and exemptions (NM or other), used to indicate a reason for special handling
of a flight.

1. Attributes:

a. ICAOSTSIndicator[] icaoSTSIndicators (Optional)

List of ICAO STS indicators. ICAO item 18 STS/

b. EURSTSIndicator[] eurSTSIndicators (Optional)

Edition: 27.0 6 1131

Document Title: NM 27.0 - NM B2B Reference Manual

List of reasons for special handling used in the EUR region. ICAO item 18 EUR/.

2. Used by: OtherInformation

19.7.250. SSRCode
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

Examples
4567, 7683, 1352, …

1. Pattern: DIGIT{4}

2. Used by: SSRInfo, Flight

19.7.251. SSRInfo
<<class>>

SSR code assigned to an aircraft by the ATS and its transmission mode.

1. Attributes:

a. SSRCode code (Mandatory)

SSR code transmitted via the mode described in mode .

b. SSRMode mode (Mandatory)

Transmission mode of the SSR code.

2. Used by: AircraftIdentificationUpdate, AircraftIdentification

19.7.252. SSRMode
<<enumeration>>

Transmission mode of the SSR code. Only SSRMode.A is supported.

1. Values:

a. A

Surveillance Mode 3A.

2. Used by: SSRInfo

19.7.253. StandardRouteId
<<class>>

Edition: 27.0 6 1132

Document Title: NM 27.0 - NM B2B Reference Manual

Standard route id.

1. Attributes:

a. AerodromeICAOId from (Mandatory)

From aerodrome.

b. AerodromeICAOId to (Mandatory)

To aerodrome.

c. int seqNr (Mandatory)

Sequence number.

i. Constraints:

▪ range : [0, 9999]

2. Used by: ReroutingRouteId

19.7.254. StayInformation_DataType
<<typedef[string]>>

Documentation last updated: 27.0 - Edition 6

Examples
AIRWORK 10NM OF WUR BLOCK FL120 TO FL140, 0020 AIR REFUELING IN SPEEDY FL220B250
F16, …

1. Pattern: ANY{0,50}

2. Used by: FlightPlanUpdate, FlightPlan

19.7.255. StructuredFlightPlan
<<class>>

Datatype grouping the FlightPlan , BasicTrajectoryData and DeparatureData types.

1. Attributes:

a. FlightPlan flightPlan (Optional)

The flight plan.

b. BasicTrajectoryData basicTrajectoryData (Optional)

Documentation last updated: 27.0 - Edition 3

The basic trajectory data.

Edition: 27.0 6 1133

Document Title: NM 27.0 - NM B2B Reference Manual

The requested trajectory may be subject to level constraints in the SID that
cannot be expressed in a basic trajectory, which may adjust the distance
along the trajectory in which the Top of Climb reached.

Equally, level constraints in the STAR, may adjust the distance along the
trajectory in which the trajectory leaves its cruising level (Top of Descent) for
approach into the aerodrome, which also cannot be expressed in a basic
NOTE trajectory.

Profile tuning restrictions may affect the distance along the trajectory in
which cruising levels are reached or left.

In the absence of clear requirements on how to return an altered basic

trajectory and to avoid incorrect interpretation, the NM B2B never returns
the basic trajectory data in output.

c. DepartureData departureData (Optional)

The departure data.

2. Used by: FlightRetrievalReplyData, FlightPlanInput, FlightPlanCreationReplyData,

FlightPlanUpdateReplyData

19.7.256. StructuredFlightPlanData (new 27.0)

<<class>>

The structured flight plan data.

1. Attributes:

a. FlightPlan flightPlan (Mandatory)

The flight plan.

b. string originatorAddress (Mandatory)

Originator address.

c. set< IFPIndicator > knownErrorIndicators (Optional)

Known error indicators.

d. AircraftOperatorICAOId aircraftOperator (Optional)

Aircraft operator.

e. AircraftOperatorICAOId operatingAircraftOperator (Optional)

Operating aircraft operator.

2. Used by: FlightPlanMessage

Edition: 27.0 6 1134

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.257. StructuredFlightPlanUpdate
<<class>>

Datatype grouping the FlightPlanUpdate , BasicTrajectoryData and DeparatureData types.

1. Attributes:

a. FlightPlanUpdate flightPlanUpdate (Optional)

The flight plan.

b. BasicTrajectoryData basicTrajectoryDataUpdate (Optional)

The basic trajectory data.

c. DepartureData departureDataUpdate (Optional)

The departure data.

2. Used by: FlightPlanUpdateRequest

19.7.258. SupplementaryInformation
<<class>>

See also ICAO 4444 document field 19 (Supplementary information).

All attributes in this class are optional for all services using the FlightPlan structure.

1. Attributes:

a. DurationHourMinute fuelEndurance (Optional)

Fuel endurance.

b. int numberOfPersons (Optional)

The total number of persons on board, when so prescribed by the appropriate ATS authority.

i. Constraints:

▪ range : [0, unbounded[

c. FrequencyOnAircraft[] frequencyAvailability (Optional)

Frequencies available on the aircraft.

The array does not accept null values or duplicates.

d. SurvivalEquipment[] survivalEquipment (Optional)

Survival equipment carried by the aircraft.

The array does not accept null values or duplicates.

Edition: 27.0 6 1135

Document Title: NM 27.0 - NM B2B Reference Manual

e. string otherSurvivalEquipment (Optional)

Indicates any other survival equipment carried by the aircraft.

i. Constraints:

▪ Pattern: ANY{1,50}

f. LifeJacketEquipment[] lifeJacketEquipment (Optional)

Equipment of the life jackets carried by the aircraft.

The array does not accept null values or duplicates.

g. Dinghies dinghiesInformation (Optional)

Information on the dinghies carried by the aircraft.

h. string aircraftColourAndMarkings (Optional)

The colour and markings of the aircraft.

i. Constraints:

▪ Pattern: ANY{1,50}

i. string pilotInCommand (Optional)

The name of the pilot in command.

i. Constraints:

▪ Pattern: ANY{1,50}

2. Used by: FlightPlanUpdate, FlightPlan

19.7.259. SurveillanceEquipment
<<class>>

Describes the serviceable surveillance equipment and capabilities of the aircraft.

ICAO item 10.

1. Attributes:

a. EquipmentStatus modeA (Optional)

Transponder Mode A (4 digits - 4096 codes).

ICAO code is "A".

b. EquipmentStatus modeAAndC (Optional)

Transponder Mode A (4 digits - 4096 codes) and Mode C.

Edition: 27.0 6 1136

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO code is "C".

c. EquipmentStatus modeS (Optional)

Indicates the presence of a Mode S transponder.

i. Constraints:

▪ SurveillanceEquipment.MODE_S_CAPABILITIES_MISSING_WHEN_MODE_S_EQUIPPED

▪ SurveillanceEquipment.MODE_S_CAPABILITIES_PRESENT_WHEN_MODE_S_NOT_EQUIPPED

d. ModeSCapabilities modeSCapabilities (Optional)

Indicates the capabilities of the Mode S transponder.

i. Constraints:

▪ SurveillanceEquipment.MODE_S_CAPABILITIES_MISSING_WHEN_MODE_S_EQUIPPED

▪ SurveillanceEquipment.MODE_S_CAPABILITIES_PRESENT_WHEN_MODE_S_NOT_EQUIPPED

e. EquipmentStatus adsb1900Out (Optional)

ADS-B with dedicated 1090 MHz ADS-B "out" capability.

ICAO code is "B1".

f. EquipmentStatus adsb1900OutIn (Optional)

ADS-B with dedicated 1090 MHz ADS-B "out" and "in" capability.

ICAO code is "B2".

g. EquipmentStatus adsbOutUAT (Optional)

ADS-B with "out" capability using Universal Access Transceiver (UAT).

ICAO code is "U1".

h. EquipmentStatus adsbOutInUAT (Optional)

ADS-B with "out" capability using UAT.

ICAO code is "U2".

i. EquipmentStatus adsbOutVDL4 (Optional)

ADS-B with "out" capability using VDL Mode 4.

ICAO code is "V1".

j. EquipmentStatus adsbOutInVDL4 (Optional)

ADS-B with "out" and "in" capability using VDL Mode 4.

Edition: 27.0 6 1137

Document Title: NM 27.0 - NM B2B Reference Manual

ICAO code is "V2".

k. EquipmentStatus adscFans (Optional)

ADS-C with FANS 1/A capability.

ICAO code is "D1".

l. EquipmentStatus adscAtn (Optional)

ADS-C with ATN capability.

ICAO code is "G1".

2. Constraints:

a. MODE_S_CAPABILITIES_MISSING_WHEN_MODE_S_EQUIPPED

When modeS is in status equipped the modeSCapabilities shall not be null

Constrained attributes: modeS, modeSCapabilities

Constrained requests: any using request

b. MODE_S_CAPABILITIES_PRESENT_WHEN_MODE_S_NOT_EQUIPPED

modeSCapabilities shall be null when modeS is in status not_equipped . Must not be null
otherwise

Constrained attributes: modeS, modeSCapabilities

Constrained requests: any using request

3. Used by: FlightPlanUpdate, FlightPlan

19.7.260. SurvivalEquipment
<<enumeration>>

Enumerates survival equipment items that an aircraft can carry.

1. Values:

a. POLAR

The aircraft carries equipement for survival in polar areas.

b. DESERT

The aircraft carries equipement for survival in desert areas.

c. MARITIME

The aircraft carries equipement for survival in maritime areas.

Edition: 27.0 6 1138

Document Title: NM 27.0 - NM B2B Reference Manual

d. JUNGLE

The aircraft carries equipement for survival in jungles.

2. Used by: SupplementaryInformation

19.7.261. SuspensionStatus
<<enumeration>>

Describes a flight suspension status.

1. Values:

a. NOT_SUSPENDED

The flight is not suspended.

b. SLOT_MISSED

The flight is suspended after having missed its slot.

c. REGULATION_CONFIRMATION

The flight is suspended waiting for confirmation in a regulation.

d. DELAY_CONFIRMATION

The flight is suspended waiting for confirmation of the delay.

e. TRAFFIC_VOLUMES_CONDITION

The flight is suspended waiting for an RVR value.

f. NOT_REPORTED_AS_AIRBORNE

The flight is suspended because expected airborne for too long and not reported airborne.

g. FLIGHT_PLAN_REVALIDATION

The flight is suspended after revalidation of the flight plan (new IFPS errors).

h. MANUAL_SUSPENSION

The flight has been manually suspended.

i. AIRPORT_SUSPENSION

The flight is suspended by the airport of departure.

j. V_MANUAL_SUSPENSION

The flight is manually suspended and was a V-flight (delay limited due to CTOT limit

Edition: 27.0 6 1139

Document Title: NM 27.0 - NM B2B Reference Manual

constraint).

2. Used by: RouteInfo, Flight, NetworkImpactFlightData

19.7.262. TargetAPIRequest

<<abstract class>>

Base class of all types of target API requests, either providing target time over an AOP-NOP
coordination fix (when targetAPIUseCase = Update), or removing previous target time-related
information (when targetAPIUseCase = Remove).

1. Inherits from: ArrivalPlanningInformationRequest

2. Attributes:

a. TargetAPIUseCase targetAPIUseCase (Mandatory)

This value is used as a discriminant. When targetAPIUseCase = Update, the Target API is
used to provide new target time information. When targetAPIUseCase = Remove, the Target
API is used to remove previous target time information.

i. Constraints:

▪ TargetAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

▪ TargetAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

b. AerodromeOrPublishedPointId coordinationFix (Optional)

The coordination fix for AOP-NOP exchange of target and calculated times over.

It must be the most downstream point of the flight’s trajectory where the AOP retrieves the
estimated time over from NM. If AOP has its own flight’s trajectory calculation, then the
coordination fix is the starting point of the calculation. The coordination fix must be the
ADES if and only if AOP doesn’t have its own trajectory calculation (yet).

The coordination fix cannot be the ADEP.

i. Constraints:

▪ TargetAPIRequest.ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

Edition: 27.0 6 1140

Document Title: NM 27.0 - NM B2B Reference Manual

▪ TargetAPIRequest.ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

3. Constraints:

a. ATTRIBUTE_MISSING_FOR_TARGET_API_UPDATE

When targetAPIUseCase = Update, coordinationFix must not be null.

Constrained attributes: targetAPIUseCase, coordinationFix

Constrained requests: any using request

b. ATTRIBUTE_PRESENT_FOR_TARGET_API_REMOVE

When targetAPIUseCase = Remove, coordinationFix must be null.

Constrained attributes: targetAPIUseCase, coordinationFix

Constrained requests: any using request

19.7.263. TargetAPIUseCase
<<enumeration>>

Target API Use Case.

1. Values:

a. Update

The Target API request is used to provide new target time information.

b. Remove

The Target API request is used to remove previous target time information.

2. Used by: TargetAPIRequest

19.7.264. TargetDPIRequest

<<class>>

There are two subtypes of Target DPI message:

Edition: 27.0 6 1141

Document Title: NM 27.0 - NM B2B Reference Manual

1. T-DPI-t — The T-DPI-t message must contain the Target Take-Off Time (TTOT) that takes into
account all constraints from an AO and Handling Agent perspective.

2. T-DPI-s — The T-DPI-s contains the Take-Off-Time as calculated by the Pre-Departure Sequence.
This Take-Off-Time (target take-off-time) is included in the TTOT-field.

Detailed information regarding Target DPI target and Target DPI sequenced messages can be found
in the document DPI Implementation Guide - sections T-DPI-t and T-DPI-s.

1. Inherits from: UpdateDPIRequest

2. Attributes:

a. DateTimeMinute targetStartupApprovalTime (Optional)

Target Start-up Approval Time.

The TSAT is the time at which the pilot can expect start-up approval from ATC.

Acronym
TSAT.

19.7.265. TargetDPISequencedReplyData
<<class>>

The TargetDPISequencedReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: TargetDPISequencedReply

19.7.266. TargetDPITargetReplyData
<<class>>

The TargetDPITargetReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: TargetDPITargetReply

19.7.267. TargetTakeOffAPIReplyData
<<class>>

The TargetTakeOffAPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: TargetTakeOffAPIReply

Edition: 27.0 6 1142

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.268. TargetTime
<<class>>

1. Attributes:

a. RegulationId regulationId (Mandatory)

The target Time over the relevant flight profile point for the most penalizing regulation of
the flight (Calculated Time Over (CTO) on the "closest" point) ant the actual time over
(according to CTFM profile).

b. DateTimeSecond targetTime (Mandatory)

the Calculated Time Over on point

c. FlightLevel targetLevel (Mandatory)

The target Flight level (from the RTFM point profile) on point

d. AerodromeICAOId aerodromeICAOId (Optional)

ICAO id of an aerodrome:

The aerodrome of departure if the point is the first in the profile

Optional, unless the point is first. Must be null if point is null, cannot be null otherwise

e. ICAOPoint point (Optional)

The en-route point on which the target time is defined (for arrival regulations it will
typically be the first point of the terminal procedure. For en-route regulations it is typically
the first flight plan point after the entry into the regulated traffic volume).

Must be null if aerodrome ICAOId is not null and cannot be null otherwise

f. boolean flightPlanPoint (Optional)

If point is not null, this attribute is set to true unless the point is not a flight plan point but
was added by NM in order to provide a better approximation on a long DCT segment

g. DistanceNM coveredDistance (Mandatory)

Distance from the first point in the profile measured on the 2D track of the point profile.

h. ActualTimeAtTarget actualTimeAtTarget (Optional)

The actual time over on point (according to CTFM flight profile). If the CTFM does not cross
point, then actualTimeAtTarget will not be present.

2. Used by: Flight

Edition: 27.0 6 1143

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.269. TargetTimeOverAPIReplyData
<<class>>

The TargetTimeOverAPIReply payload.

1. Inherits from: FlightInformationUpdateReplyData

2. Used by: TargetTimeOverAPIReply

19.7.270. TaxiTimeAndProcedure

<<class>>

Generic type to group a taxi time value and the terminal procedure, both values being semantically
valid either at the aerodrome of departure, or at the aerodrome of arrival.

1. Attributes:

a. DurationHourMinute taxiTime (Mandatory)

Taxi-time.

b. TaxiTimeSource taxiTimeSource (Mandatory)

The taxi time source is selected by order of preference:

▪ REA if available, otherwise

▪ CDM if available, otherwise

▪ RWY if available, otherwise

▪ FPL if available, otherwise

▪ ENV

c. TerminalProcedure terminalProcedure (Optional)

Terminal procedure.

Edition: 27.0 6 1144

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: Flight

19.7.271. TaxiTimeSource
<<enumeration>>

The source of the taxi time.

1. Values:

a. ENV

CACD

b. FPL

Flight Plan

c. RWY

Runway Tactical Update

d. REA

Ready Message Minimun Lineup

e. CDM

DPI

2. Used by: TaxiTimeAndProcedure

19.7.272. TCOAuthorisation
<<class>>

Representation of a TCO authorisation.

1. Attributes:

a. TCOAuthorisationId id (Mandatory)

The TCO authorisation identifier.

b. AircraftRegistrationMark aircraftRegistration (Mandatory)

The aircraft registration mark associated to the authorisation identifier.

i. Constraints:

▪ TCOAuthorisation.AIRCRAFT_REGISTRATION_INVALID_VALUE

2. Constraints:

a. AIRCRAFT_REGISTRATION_INVALID_VALUE

Edition: 27.0 6 1145

Document Title: NM 27.0 - NM B2B Reference Manual

aircraftRegistration should be maximum of 7 characters.

Constrained attributes: aircraftRegistration

Constrained requests: any using request

3. Used by: TCOAuthorisationUpdate, TCOAuthorisationListReplacementRequest

19.7.273. TCOAuthorisationId
<<typedef[string]>>

Uniquely identifies a TCO authorisation.

1. Pattern: (ALPHA|DIGIT|/|_|*|-){0,50}

2. Used by: TCOAuthorisation

19.7.274. TCOAuthorisationListReplacementReplyData
<<class>>

The TCOAuthorisationListReplacementReply payload.

The TCO authorisation list replacement reply data.

1. Used by: TCOAuthorisationListReplacementReply

19.7.275. TCOAuthorisationListUpdateReplyData
<<class>>

The TCOAuthorisationListUpdateReply payload.

The TCO authorisation list update reply data.

1. Used by: TCOAuthorisationListUpdateReply

19.7.276. TCOAuthorisationUpdate
<<class>>

Representation of a TCO authorisation update.

1. Attributes:

a. TCOAuthorisation authorisation (Mandatory)

The TCO authorisation.

b. TCOAuthorisationUpdateType updateType (Mandatory)

The type of update

Edition: 27.0 6 1146

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: TCOAuthorisationListUpdateRequest

19.7.277. TCOAuthorisationUpdateType
<<enumeration>>

TCO Authorisation Update Type.

1. Values:

a. CREATE

Create.

b. DELETE

Delete.

2. Used by: TCOAuthorisationUpdate

19.7.278. TerminalOrApronStandName
<<typedef[string]>>

Name of the terminal or apron stand where the gate is located.

The terminal is a building at an airport where passengers transfer between ground transportation
and the facilities that allow them to board and disembark from aircraft.

The airport apron is the area of an airport where aircraft are parked, unloaded or loaded, refuelled,
or boarded.

Examples
T1, 2G, T4S, …

1. Pattern: (UALPHA|DIGIT){1,6}

2. Used by: GeneralAPIRequest, ArrivalInformation, CDMInfo, UpdateDPIRequest

19.7.279. TimeAndModel
<<class>>

Time at reference location for a given flight model.

1. Attributes:

a. TrafficType model (Mandatory)

Flight model.

b. DateTimeSecond dateTime (Mandatory)

Edition: 27.0 6 1147

Document Title: NM 27.0 - NM B2B Reference Manual

Time.

2. Used by: Flight

19.7.280. TotalCapacity_DataType
<<typedef[int]>>

The total capacity, in persons, of all dinghies carried by the aircraft.

1. range : [0, 999]

2. Used by: Dinghies

19.7.281. TrafficType
<<enumeration>>

Specifies a traffic type, i.e. if flights are involved in:

1. Values:

a. DEMAND

Traffic demand ("FTFM": Filed Tactical Flight Model).

b. REGULATED_DEMAND

Regulated traffic demand ("RTFM": Regulated Tactical Flight Model).

c. LOAD

Traffic load ("CTFM": Current Tactical Flight Model).

2. Used by: TrafficCountsRequest, FlightListRequest, TrafficCountsReplyData, TimeAndModel

19.7.282. TrafficVolumeSelection (new 27.0)

<<class>>

1. Attributes:

a. set< TrafficVolumeSetId > includedTrafficVolumeSets (Mandatory)

The set of traffic volume sets of which traffic volumes have to be included.

i. Constraints:

▪ set size range : [1, unbounded[

2. Used by: FlightDataPayloadConfiguration

Edition: 27.0 6 1148

Document Title: NM 27.0 - NM B2B Reference Manual

19.7.283. TurnFlightForLocation
<<class>>

1. Attributes:

a. TurnFlightForLocationKind ftfmTurn (Mandatory)

Documentation last updated: 27.0 - Edition 1

This field indicates the presence, or not, of a sharp-turn angle (STA) on the FTFM model
(either NO_SHARP_TURN or INTERESTING_SHARP_TURN or CRITICAL_SHARP_TURN).

b. TurnFlightForLocationKind locationModelTurnKind (Mandatory)

Documentation last updated: 27.0 - Edition 1

This field indicates the presence, or not, of a sharp-turn angle on the queried model, i.e.,
depends on the traffic count type of the query being made. If the query is on Demand then
the value of this field is determined by the FTFM, if Regulated Demand, then either the
RTFM or FTFM depending on whether the RTFM exists. A query on the Load will show a
value based on the CTFM or else the RTFM or else the FTM depending on which exists. If a
query is made on an airspace (or a TV having an airspace as a reference location) then this
field shows an evaluation of the presence of the sharp-turn angle inside, or on the border of,
this airspace.

The value will be one of the following:

1. An indication of whether or not the selected model for the query has at least one
(critical, interesting or uninteresting) sharp-turn angle.

2. In the case of a query on an airspace (or TV with an airspace reference location), and
where the selected model of the query has at least one sharp-turn angle, an indication of
whether the sharp-turn angle is inside, or on the border of, the airspace.

The selected model for the query is as follows: FTFM for Demand, RTFM or FTFM for
Regulated Demand, and either CTFM, or RTFM, or FTFM for Load.

The possible values for the locationModelTurnKind are:

1. CRITICAL_ELSEWHERE / INTERESTING_ELSEWHERE / UNINTERSTING_ELSEWHERE: there is no sharp-

turn angle inside, or on the border of, the queried airspace/TV location

2. CRITICAL_INSIDE / INTERESTING_INSIDE / UNINTERESTING_INSIDE: there is a sharp-turn angle

inside, or on the border of, the queried airspace/TV location

2. Used by: Flight

19.7.284. TurnFlightForLocationKind
<<enumeration>>

Edition: 27.0 6 1149

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. NO_SHARP_TURN

Documentation last updated: 27.0 - Edition 1

No sharp-turn.

b. CRITICAL_SHARP_TURN

Documentation last updated: 27.0 - Edition 1

There is a critical sharp-turn somewhere along the flight.

c. INTERESTING_SHARP_TURN (new 27.0)

There is an "interesting" sharp-turn somewhere along the flight.

d. UNINTERESTING_SHARP_TURN (new 27.0)

There is an "uninteresting" sharp turn somewhere along the flight.

e. CRITICAL_ELSEWHERE

Documentation last updated: 27.0 - Edition 1

There is no sharp turn inside the queried airspace/TV location but there is a critical one
(outside this location) elsewhere along the flight.

f. INTERESTING_ELSEWHERE (new 27.0)

There is no sharp turn inside or overlapping with the queried airspace/TV location but there
is an "interesting" one elsewhere (outside the location) along the flight.

g. UNINTERESTING_ELSEWHERE (new 27.0)

There is no sharp turn inside the queried airspace/TV location, but there is an
"uninteresting" turn elsewhere (in proximity) along the flight.

h. CRITICAL_INSIDE

Documentation last updated: 27.0 - Edition 1

There is a critical sharp turn inside the queried airspace/TV location.

i. INTERESTING_INSIDE (new 27.0)

There is an "interesting" sharp turn inside the queried airspace/TV location.

j. UNINTERESTING_INSIDE (new 27.0)

There is an "uninteresting" sharp turn inside the queried airspace/TV location.

Edition: 27.0 6 1150

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: TurnFlightForLocation

19.7.285. UpdateDPIRequest

<<abstract class>>

Base class of all types of DPI update requests.

1. Inherits from: DeparturePlanningInformationRequest

2. Attributes:

a. AircraftRegistrationMark registrationMark (Optional)

Aircraft registration mark. It is the unique alphanumeric string that identifies a civil
aircraft.

The registrationMark received in a DPI is persisted and used to possibly emit a discrepancy
message when this registration mark is different from the last one received from a flight
plan message.

If provided by the Airport, the registrationMark will be helpful for the correlation between
the inbound and outbound legs of a flight.

ADEXP:
-REG

b. AircraftTypeICAOId aircraftType (Optional)

ICAO Aircraft type.

The aircraft type received in a DPI is persisted but is not used to recalculate the profile. It is
only used to possibly emit a discrepancy message when this aircraft type is different from
the last one received from a flight plan message.

ADEXP:
-ARCTYP

Edition: 27.0 6 1151

Document Title: NM 27.0 - NM B2B Reference Manual

c. AircraftTypeIATAId aircraftTypeIATA (Optional)

IATA Aircraft type.

d. DateTimeMinute targetTakeOffTime (Contextual)

Target Take-Off Time.

The TTOT is the most accurate available take-off-time at airport at that moment in time.

Time taking into account the TOBT (T-DPI-t message) or the TSAT (T-DPI-s message) plus the
Estimated Taxi-Out Time (EXOT)

Acronym
TTOT.

Airports having implemented Extended DPIs should not fill this field (except in
ATCDPIRequest ) during AOP-NOP validation exercises but should use
turnaroundTargetTakeOffTime , earliestTargetTakeOffTime and/or
consolidatedTargetTakeOffTime instead.

i. Presence:

▪ Mandatory in ATCDPIRequest

▪ Must be null in PredictedDPIRequest

▪ Optional otherwise

ii. Constraints:

▪ UpdateDPIRequest.INCORRECT_MIXTURE_OF_TTOT_FIELDS

▪ UpdateDPIRequest.MISSING_TTOT_FIELDS_IN_TARGET_DPI

e. DateTimeMinute turnaroundTargetTakeOffTime (Contextual)

Contains all the constraints stemming from TOBT or late ELDT if existing, else it contains the
schedule time. It is not based upon any local departure capacity constraints. Use best
information on anticipated taxi time to compose.

Only to be filled by airports having implemented Extended DPIs and only during AOP-NOP
validation exercises.

i. Presence:

▪ Mandatory in PredictedDPIRequest

▪ Must be null in ATCDPIRequest

▪ Optional otherwise

ii. Constraints:

▪ UpdateDPIRequest.INCORRECT_MIXTURE_OF_TTOT_FIELDS

▪ UpdateDPIRequest.MISSING_TTOT_FIELDS_IN_TARGET_DPI

Edition: 27.0 6 1152

Document Title: NM 27.0 - NM B2B Reference Manual

f. DateTimeMinute earliestTargetTakeOffTime (Contextual)

Contains the airport departure capacity constraint. If provided for a regulated flight, it
becomes a constraint for slot assignment. If it is not the most penalizing constraint, it is
retained for potential slot improvement. Use best information on anticipated taxi time to
compose.

Only to be filled by airports having implemented Extended DPIs and only during AOP-NOP
validation exercises, and only if a departure constraint exists.

i. Presence:

▪ Must be null in ATCDPIRequest

▪ Optional otherwise

ii. Constraints:

▪ UpdateDPIRequest.INCORRECT_MIXTURE_OF_TTOT_FIELDS

g. DateTimeMinute consolidatedTargetTakeOffTime (Contextual)

Contains all constraints for individual flight and/or constraint based on departure capacity
and including the imposed downstream constraint (CTOT). Sent to acknowledge imposed
departure constraints and place the flight inside the STW.

Only to be filled by airports having implemented Extended DPIs and only during AOP-NOP
validation exercises, and only when a CTOT has been imposed on the flight.

i. Presence:

▪ Must be null in ATCDPIRequest

▪ Optional otherwise

ii. Constraints:

▪ UpdateDPIRequest.INCORRECT_MIXTURE_OF_TTOT_FIELDS

h. DateTimeMinute targetOffBlockTime (Contextual)

Target Off Block Time.

The time that the aircraft operator or ground handler estimates that the aircraft is ready to
push back.

Acronym
TOBT.

i. Presence:

▪ Must be null in ATCDPIRequest

▪ Optional otherwise

i. DurationHourMinute taxiTime (Mandatory)

Edition: 27.0 6 1153

Document Title: NM 27.0 - NM B2B Reference Manual

Estimated Taxi out time.

See DPI Implementation Guide section Use of DPIs during Special Circumstances at the
airport for detail information.

j. TerminalProcedure departureProcedure (Contextual)

Standard Instrument Departure route identifier or DCT to a navaid/waypoint.

Acronym
SID.

i. Presence:

▪ Mandatory in ATCDPIRequest

▪ Optional otherwise

k. RunwayId departureRunway (Optional)

Identifier of the assigned departure runway.

l. TerminalOrApronStandName departureTerminal (Optional)

Identifier of the departure terminal.

m. TerminalOrApronStandName departureApronStand (Optional)

Identifier of the departure apron stand.

n. boolean depstatusDeicing (Optional)

If true, indicates that de-icing of the flight is planned, in progress or completed. The flight
will then benefit from an extended DTW/STW. False by default, meaning that the flight
doesn’t need de-icing.

o. AircraftICAOId aircraftIdInbound (Optional)

Aircraft ICAO id of preceding leg.

p. IFPLId ifplIdInbound (Optional)

Unique IFPL identifier of preceding leg.

q. AircraftRegistrationMark registrationMarkInbound (Optional)

Aircraft registration mark of preceding leg.

3. Constraints:

a. MISSING_TTOT_FIELDS_IN_TARGET_DPI

In TargetDPITargetRequest and TargetDPISequencedRequest , either targetTakeOffTime or

turnaroundTargetTakeOffTime must not be null.

Edition: 27.0 6 1154

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained attributes: targetTakeOffTime, turnaroundTargetTakeOffTime

Constrained requests: any using request

b. INCORRECT_MIXTURE_OF_TTOT_FIELDS

targetTakeOffTime must be null when any of turnaroundTakeOffTime , earliestTakeOffTime or

consolidatedTakeOffTime is not null.

Constrained attributes: targetTakeOffTime, turnaroundTargetTakeOffTime,

earliestTargetTakeOffTime, consolidatedTargetTakeOffTime

Constrained requests: any using request

19.7.286. WakeTurbulenceCategory
<<enumeration>>

Wake turbulence category.

1. Values:

a. LIGHT

Aircraft type with a maximum certificated take-off mass of 7.000 kg or less

b. MEDIUM

Aircraft type with a maximum certificated take-off mass of less than 136.000 kg but more
than 7.000 kg

c. HEAVY

Aircraft type with a maximum certificated take-off mass of 136.000 kg or more

d. SUPER

Super heavy aircraft type in the order of 560.000 kg

2. Used by: FlightUpdateRequest, Flight, FlightPlanUpdate, FlightPlan

19.7.287. YoYoFlightForLocation
<<class>>

Edition: 27.0 6 1155

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. YoYoFlightForLocationKind ftfmYoYo (Mandatory)

This field indicates the presence, or not, of a YoYo portion on the FTFM model (either NO_YOYO
or NON_CRITICAL_YOYO or CRITICAL_YOYO ).

b. YoYoFlightForLocationKind locationModelYoYoKind (Mandatory)

This field indicates the presence or not of a YoYo portion on the queried model, i.e., depends
on the traffic count type of the query being made. If the query is on demand then the value
of this field is determined by the FTFM (if Regulated demand then either RTFM or FTFM
depending on whether the RTFM exists). A query on the load will show a value of this field
depending on the CTFM or else RTFM or else FTFM depending again on what exists. If a
query is made on an airspace then this field shows an evaluation of the overlap between the
YoYo portion and the airspace (also a query on a TV which has an airspace as a reference
location).

The value will be one of the following:

1. An indication of whether or not the selected model for the query has at least one (critical
or non-critical) YoYo portion.

2. In the case of a query on an airspace/or TV with airspace reference location, and where
the selected model of the query has at least one YoYo portion: an indication of how the
YoYo portion and the airspace overlap.

The selected model for the query is as follows: FTFM for demand, RTFM for regulated
demand, and either CTFM or else RTFM or else FTFM, for load.

For this case, the possible values for the locationModelYoYoKind are:

a. CRITICAL_ELSEWHERE / NON_CRITICAL_ELSEWHERE : there is no YoYo inside or overlapping

with the queried airspace/TV location

b. CRITICAL_COMPLETELY_INSIDE / NON_CRITICAL_COMPLETELY_INSIDE : there is a YoYo

Completely inside the queried airspace/TV location

c. LOCATION_INSIDE_CRITICAL / LOCATION_INSIDE_NON_CRITICAL : the queries Airspace

location is completely inside a YoYo portion

d. CRITICAL_STARTS_INSIDE / NON_CRITICAL_STARTS_INSIDE : there is a YoYo that Starts

inside the queried airspace/TV location

e. CRITICAL_ENDS_INSIDE / NON_CRITICAL_ENDS_INSIDE : there is a YoYo that Ends inside the

queried airspace/TV location

2. Used by: Flight

19.7.288. YoYoFlightForLocationKind
<<enumeration>>

Edition: 27.0 6 1156

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. NO_YOYO

There is no YoYo

b. CRITICAL_YOYO

There is a critical YoYo somewhere along the flight

c. NON_CRITICAL_YOYO

There is a non-critical YoYo somewhere along the flight

d. CRITICAL_ELSEWHERE

There is no YoYo inside or overlapping with the queried airspace/TV location but there is a
critical YoYo elsewhere along the flight

e. NON_CRITICAL_ELSEWHERE

There is no YoYo inside or overlapping with the queried airspace/TV location but there is a
non-critical YoYo elsewhere along the flight

f. CRITICAL_COMPLETELY_INSIDE

There is a critical YoYo completely inside the queried airspace/TV location

g. NON_CRITICAL_COMPLETELY_INSIDE

There is a non-critical YoYo completely inside the queried airspace/TV location

h. LOCATION_INSIDE_CRITICAL

The queried Airspace location is completely inside a critical YoYo portion

i. LOCATION_INSIDE_NON_CRITICAL

The queried Airspace location is completely inside a non-critical YoYo portion

j. CRITICAL_STARTS_INSIDE

There is a critical YoYo that starts in inside the queried airspace/TV location

k. NON_CRITICAL_STARTS_INSIDE

There is a non-critical YoYo that starts in inside the queried airspace/TV location

l. CRITICAL_ENDS_INSIDE

There is a critical YoYo that ends in inside the queried airspace/TV location

m. NON_CRITICAL_ENDS_INSIDE

Edition: 27.0 6 1157

Document Title: NM 27.0 - NM B2B Reference Manual

There is a non-critical YoYo that ends in inside the queried airspace/TV location

2. Used by: YoYoFlightForLocation

Appendix L: AIRM Semantic Correspondence

• ACC3Accreditation.aoId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• Aerodrome.icaoId

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• Aerodrome.otherDesignation

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@aerodromeReferencePoint

• AerodromeDAL.aerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• AerodromeDAL.cumulativeDistance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@cumulative
Distance

• AerodromesOfDestination.aerodromeOfDestination

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@destinationAerodrome

• AerodromesOfDestination.alternate1

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AlternateAerodrome

• AerodromesOfDestination.alternate2

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AlternateAerodrome

• AircraftIdentification.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• AircraftIdentification.registrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• AircraftIdentification.aircraftAddress

Edition: 27.0 6 1158

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftAddress

• AircraftIdentification.ssrInfo

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ssrCode

• AircraftIdentificationUpdate.registrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• AircraftIdentificationUpdate.aircraftAddress

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftAddress

• AircraftIdentificationUpdate.ssrInfo

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:SSRCode@code

• AircraftPerformanceCategory.CAT_A

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@A

• AircraftPerformanceCategory.CAT_B

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@B

• AircraftPerformanceCategory.CAT_C

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@C

• AircraftPerformanceCategory.CAT_D

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@D

• AircraftPerformanceCategory.CAT_E

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@E

• AircraftPerformanceCategory.CAT_H

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftApproachCategoryTyp
e@H

• AircraftPositionReport.position

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType

Edition: 27.0 6 1159

Document Title: NM 27.0 - NM B2B Reference Manual

• AircraftType.icaoId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftType@icaoIdentifier

• AircraftType.otherDesignation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftType@operationalName

• AirFiledData.atsUnitId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

• AirFiledData.startingPoint

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• AirFiledData.clearedLevel

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:ATMServiceDeliveryManageme
nt:ATCClearance@clearedFlightLevel

• AlternateAerodrome.icaoId

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• ArrivalInformation.flightStatusInbound

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType

• ArrivalInformation.registrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• ArrivalInformation.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• ArrivalInformation.aircraftIATAId

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:FlightDesignat
or

• ArrivalInformation.arrivalTaxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• ArrivalInformation.apiArrivalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:ArrivalO

Edition: 27.0 6 1160

Document Title: NM 27.0 - NM B2B Reference Manual

perations@star

• ArrivalInformation.nmArrivalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentArrival@designator

• ArrivalInformation.initialApproachFix

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Termina
lArrivalAltitude@iaf (additional)

• ArrivalInformation.arrivalRunway

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ru
nway (additional)

• ArrivalInformation.arrivalTerminal

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Termin
al@designator

• ArrivalInformation.arrivalApronStand

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aircraf
tStand

• ArrivalInformation.landingTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:Landing@time

• ArrivalInformation.inBlockTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:InBlock@time

• ArrivalInformation.airportSlotArrival

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:AirportS
lotManagement:AirportSlot@allocatedSlotTime

• ArrivalInformation.targetTimeOver

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• ArrivalInformation.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

Edition: 27.0 6 1161

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• ArrivalInformation.estimatedOrActualTimeOver

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• ArrivalPlanningInformationRequest.flightStatusInbound

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType

• ArrivalPlanningInformationRequest.arrivalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:ArrivalO
perations@star

• ATSMessageType.FPL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• ATVFlightStatusInbound.AIR

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@AIR

• ATVFlightStatusInbound.DIV

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@DIV

• ATVFlightStatusInbound.FIR

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@FIR

• ATVFlightStatusInbound.FNL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@FNL

• ATVFlightStatusInbound.GOA

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@GOA

• ATVFlightStatusInbound.IBK

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@IBK

• ATVFlightStatusInbound.IDH

Edition: 27.0 6 1162

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@IDH

• ATVFlightStatusInbound.INI

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@INI

• ATVFlightStatusInbound.SCH

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@SCH

• ATVFlightStatusInbound.TMA

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@TMA

• ATVFlightStatusOutbound.SCH

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@SCH

• ATVFlightStatusOutbound.INI

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@INI

• ATVFlightStatusOutbound.BRD

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@BRD

• ATVFlightStatusOutbound.RDY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@RDY

• ATVFlightStatusOutbound.OBK

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@OBK

• ATVFlightStatusOutbound.DEP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@DEP

• ATVFlightStatusOutbound.RDI

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code

Edition: 27.0 6 1163

Document Title: NM 27.0 - NM B2B Reference Manual

AircraftFlightStatusType@RDI

• ATVFlightStatusOutbound.DEI

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@DEI

• BasicTrajectoryData.takeOffWeight

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:TakeOffConfiguration@takeOffWeight

• BasicTrajectoryData.topOfClimb

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectoryPointUsageType
@TOP_OF_CLIMB

• BasicTrajectoryData.topOfDescent

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectoryPointUsageType
@TOP_OF_DESCENT

• BasicTrajectoryData.bottomOfClimb

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectoryPointUsageType
@BOTTOM_OF_CLIMB

• BasicTrajectoryData.bottomOfDescent

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRouteTrajectoryPointUsageType
@BOTTOM_OF_DESCENT

• CDMInfo.taxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• CDMInfo.offBlockTimeDiscrepancy

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ACDMIrregularityType@CDM02

• CDMInfo.flightStatusOutbound

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Flight_status (additional)

• CDMInfo.departureProc

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:Departu
reOperations@sid

Edition: 27.0 6 1164

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirportCDMInformationProduct:DeparturePlanningInformation (additional)

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier (additional)

• CDMInfo.departureRunway

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ru
nway (additional)

• CDMInfo.departureTerminal

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@terminal

• CDMInfo.departureApronStand

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aircraf
tStand

• CDMInfo.aircraftTypeDiscrepancy

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ACDMIrregularityType@CDM03

• CDMInfo.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• CDMInfo.aircraftTypeIATA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftType@iataIdentifier

• CDMInfo.registrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• CDMInfo.registrationMarkDiscrepancy

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ACDMIrregularityType@CDM04

• CDMInfo.departureStatus

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType

• CDMInfo.aircraftIdInbound

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

Edition: 27.0 6 1165

Document Title: NM 27.0 - NM B2B Reference Manual

• CDMInfo.registrationMarkInbound

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@previousFlight (additional)

• CfmuFlightType.IFPL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@IFPL

• CfmuFlightType.ACT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@ATC
_ACTIVATED

• CfmuFlightType.TACT_ACTIVATED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@TAC
T_ACTIVATED_WITH_FSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@TAC
T_ACTIVATED_WITHOUT_FSA

• DepartureData.taxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• DepartureInformation.departureProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:Departu
reOperations@sid

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirportCDMInformationProduct:DeparturePlanningInformation (additional)

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier (additional)

• DepartureInformation.takeOffTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:TakeOff@time

• DepartureInformation.arrivalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentArrival

• DeparturePlanningInformationRequest.flightStatusOutbound

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType

Edition: 27.0 6 1166

Document Title: NM 27.0 - NM B2B Reference Manual

• DepartureStatus.DEICING

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:Departu
reOperations@deicingProcedure

• Dinghies.numberOfDinghies

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Aircraft:SurvivalEquipment@numbe
r

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Aircraft:SurvivalEquipment (additional)

• Dinghies.totalCapacity

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Aircraft:SurvivalEquipment@dinghy
TotalCapacity

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Aircraft:SurvivalEquipment (additional)

• Dinghies.areCovered

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Aircraft:SurvivalEquipment@isCove
red

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Aircraft:SurvivalEquipment (additional)

• Dinghies.colours

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Aircraft:SurvivalEquipment@colour

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Aircraft:SurvivalEquipment (additional)

• DistanceAtLocation.adesDAL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@cumulative
Distance

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:IATAUniqueFli
ghtIdentifier@ades

• DistanceAtLocation.dalPoints

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@cumulative
Distance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@overPoint

• EnrouteDelay.delay

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:EnRouteDelay

• EnrouteDelay.point

Edition: 27.0 6 1167

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• EnRouteInformation.hold

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightPhaseType
@ENROUTE_HOLDING_PHASE

• EnRouteInformation.arrivalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Standar
dInstrumentArrival

• EntryExit.ENTRY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@airspaceEntry

• EntryExit.EXIT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@airspaceExit

• EquipmentCapabilityAndStatus.gbas

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@GBA
S_CAPABILITY

• EquipmentCapabilityAndStatus.lpv

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@LPV

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@LPV
(additional)

• EquipmentCapabilityAndStatus.loranC

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@LOR
AN_C

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@LOR
AN_C (additional)

• EquipmentCapabilityAndStatus.dme

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@DM
E

• EquipmentCapabilityAndStatus.fmcWprAcars

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@FMC_WPR_ACARS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@FMC_WPR_ACARS (additional)

Edition: 27.0 6 1168

Document Title: NM 27.0 - NM B2B Reference Manual

• EquipmentCapabilityAndStatus.dFisAcars

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@DFIS_ACARS

• EquipmentCapabilityAndStatus.pdcAcars

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@PDC_ACARS

• EquipmentCapabilityAndStatus.adf

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@ADF

• EquipmentCapabilityAndStatus.gnss

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@GNS
S

• EquipmentCapabilityAndStatus.hfRtf

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@HF_RTF

• EquipmentCapabilityAndStatus.inertialNavigation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@INE
RTIAL_NAVIGATION

• EquipmentCapabilityAndStatus.cpdlcAtnVdlMode2

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_ATN_VDL_MODE_2

• EquipmentCapabilityAndStatus.cpdlcFans1AHFDL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_FANS_1/A_HFDL

• EquipmentCapabilityAndStatus.cpdlcFans1AVdlModeA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_FANS_1/A_VDL_MODE_A

• EquipmentCapabilityAndStatus.cpdlcFans1AVdlMode2

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_FANS_1/A_VDL_MODE_2

• EquipmentCapabilityAndStatus.cpdlcFans1ASatcomInmarsat

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa

Edition: 27.0 6 1169

Document Title: NM 27.0 - NM B2B Reference Manual

bilityType@CPDLC_FANS_1/A_SATCOM_INMARSAT

• EquipmentCapabilityAndStatus.cpdlcFans1ASatcomMtsat

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_FANS_1/A_SATCOM_MTSAT

• EquipmentCapabilityAndStatus.cpdlcFans1ASatcomIridium

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeDatalinkCommunicationCapa
bilityType@CPDLC_FANS_1/A_SATCOM_IRIDIUM

• EquipmentCapabilityAndStatus.mls

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@MLS

• EquipmentCapabilityAndStatus.ils

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@ILS

• EquipmentCapabilityAndStatus.atcRtfSatcomInmarsat

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@ATC_RTF_SATCOM_INMARSAT

• EquipmentCapabilityAndStatus.atcRtfSatcomMtsat

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@ATC_RTF_MTSAT

• EquipmentCapabilityAndStatus.atcRtfSatcomIridium

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@ATC_RTF_IRIDIUM

• EquipmentCapabilityAndStatus.vor

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@VOR

• EquipmentCapabilityAndStatus.tacan

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@TAC
AN

• EquipmentCapabilityAndStatus.uhfRtf

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@UHF_RTF

• EquipmentCapabilityAndStatus.vhfRtf

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType

Edition: 27.0 6 1170

Document Title: NM 27.0 - NM B2B Reference Manual

@VHF_RTF

• EquipmentCapabilityAndStatus.rvsm

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@RVS
M_APPROVED

• EquipmentCapabilityAndStatus.mnps

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeNavigationCapabilityType@MN
PS_APPROVED

• EquipmentCapabilityAndStatus.khz833

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@VHF_WITH_8.33_KHZ_CHANNEL_SPACING_CAPABILITY

• EquipmentStatus.EQUIPPED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeEquipmentStatusType@EQUIP
PED

• EquipmentStatus.NOT_EQUIPPED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeEquipmentStatusType@NOT_
EQUIPPED

• EstimatedElapsedTimeAtLocation.elapsedTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@estimatedEl
apsedTimeFromReference

• EstimatedElapsedTimeAtLocation.fir

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AircraftFlightStatusType@FIR

• EstimatedElapsedTimeAtLocation.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• EURSTSIndicator.EXM833

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@EXM833

• EURSTSIndicator.PROTECTED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@PROTECTED

• EURSTSIndicator.RNAVX

Edition: 27.0 6 1171

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@RNAVX

• EURSTSIndicator.RNAVINOP

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@RNAVINOP

• EURSTSIndicator.CPDLCX

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@CPDLCX

• EURSTSIndicator.OAT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@OAT

• EvaluateFlowImpactReplyData.originalRoute

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route

• FilingResultValid.ifplId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• Flight.flightId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• Flight.divertedAerodromeOfDestination

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@alternateAerodrome

• Flight.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• Flight.revisionTimes

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:RevisionTimes

• Flight.taxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• Flight.currentDepartureTaxiTimeAndProcedure

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

Edition: 27.0 6 1172

Document Title: NM 27.0 - NM B2B Reference Manual

• Flight.suspensionInfo

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOpe
rations:Turnaround:DepartureSuspension@reason

• Flight.readyStatus

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightReadyStatusType

• Flight.aircraftOperator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• Flight.operatingAircraftOperator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• Flight.reroutingIndicator

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:ATFMBehaviour

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingReasonType (additional)

• Flight.cdm

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination

• Flight.flightLevelAtReferenceLocationEntry

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@assignedFlightLevel

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ReferenceLocation (additional)

• Flight.flightLevelAtReferenceLocationExit

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@assignedFlightLevel

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ReferenceLocation (additional)

• Flight.trendAtReferenceLocationEntry

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

• Flight.trendAtReferenceLocationExit

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

• Flight.trendAtReferenceLocationMiddle

Edition: 27.0 6 1173

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

• Flight.mostPenalisingRegulation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation

• Flight.regulationLocations

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume

• Flight.atfcmMeasureLocations

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume

• Flight.runwayVisualRange

urn:aero:airm:1.0.0:LogicalModel:Subjects:Meteorology:RunwayVisualRange

• Flight.estimatedElapsedTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@totalEstimatedElapsedTime

• Flight.routeLength

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:RouteSe
gment@length

• Flight.departureTolerance

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@toleranceWindow

• Flight.mostPenalisingRegulationCause

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation (additional)

• Flight.ftfmPointProfile

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@routeTrajectory

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:FiledTacticalFlightModel (additional)

• Flight.rtfmPointProfile

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@routeTrajectory

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn

Edition: 27.0 6 1174

Document Title: NM 27.0 - NM B2B Reference Manual

dCapacityBalancing:RegulatedTacticalFlightModel (additional)

• Flight.ctfmPointProfile

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@routeTrajectory

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:CurrentTacticalFlightModel (additional)

• Flight.equipmentCapabilityAndStatus

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:EquipmentCapability

• Flight.ccamsSSRCode

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ssrCode

• Flight.filedRegistrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• Flight.mcdmInfo

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination

• Flight.targetTimeOverFix

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• Flight.lastKnownPosition

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType

• Flight.aircraftAddress

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftAddress

• Flight.arrivalInformation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@arrivalOperations

• Flight.wakeTurbulenceCategory

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftCategory@wakeTurbulenceCategory

• Flight.alternateAerodromes

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@alternateAerodrome

• FlightAirspace.airspaceId

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Airspace:Airspace@designato

Edition: 27.0 6 1175

Document Title: NM 27.0 - NM B2B Reference Manual

• FlightAirspace.airspaceType

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeAirspaceType

• FlightAirspace.firstEntryTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightAirspace.middleTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightAirspace.firstEntryDistance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:AirspaceEntry@distanceFlownAtE
ntry

• FlightAirspace.lastExitTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightAirspace.activated

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeStatusAirspaceTy
pe

• FlightFilingResultMessageFilter.aircraftOperators

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• FlightInformationUpdateRequest.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• FlightInformationUpdateRequest.aerodromeOfDeparture

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@departureAerodrome

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:CommunicationInfrastructur
e:AerodromeLocationIndicator (additional)

Edition: 27.0 6 1176

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:ContextualModel:Abbreviations:ADEP (additional)

• FlightInformationUpdateRequest.aerodromeOfDestination

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@destinationAerodrome

• FlightInformationUpdateRequest.ifplId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• FlightKeys.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• FlightKeys.aerodromeOfDeparture

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@departureAerodrome

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:CommunicationInfrastructur
e:AerodromeLocationIndicator (additional)

urn:aero:airm:1.0.0:ContextualModel:Abbreviations:ADEP (additional)

• FlightKeys.aerodromeOfDestination

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@destinationAerodrome

• FlightKeys.nonICAOAerodromeOfDestination

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@destinationAerodrome

• FlightListByLocationRequest.aircraftOperators

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• FlightListRequest.trafficType

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AirTrafficType

• FlightOperationalLogEntry.etfmsId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• FlightOrFlightPlan.flight

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Flight

• FlightPlan.ifplId

Edition: 27.0 6 1177

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• FlightPlan.enrouteAlternateAerodromes

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AlternateAerodrome

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:En-route_alternate (additional)

• FlightPlan.takeOffAlternateAerodromes

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AlternateAerodrome

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Take-off_alternate (additional)

• FlightPlan.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• FlightPlan.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• FlightPlan.totalEstimatedElapsedTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@totalEstimatedElapsedTime

• FlightPlan.eetsToLocations

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@accumulate
dEstimatedElapsedTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation

• FlightPlan.wakeTurbulenceCategory

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftCategory@wakeTurbulenceCategory

• FlightPlan.flightRules

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFiledFlightRulesType

• FlightPlan.stayInformation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightPhaseType
@STAY_PHASE

• FlightPlan.enrouteDelays

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:EnRouteDelay

• FlightPlan.equipmentCapabilityAndStatus

Edition: 27.0 6 1178

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:EquipmentCapability

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeEquipmentStatusType

• FlightPlan.surveillanceEquipment

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftCapability@surveillanceCapability

• FlightPlan.iataFlightNumber

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@flightDesignator

• FlightPlan.arrivalAirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:AirportS
lotManagement:AirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeAirportSlotKindT
ype@AIRPORT_ARRIVAL_SLOT

• FlightPlan.departureAirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:AirportS
lotManagement:AirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeAirportSlotKindT
ype@AIRPORT_DEPARTURE_SLOT

• FlightPlanCreationReplyData.structuredFlightPlan

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Flight_plan (additional)

• FlightPlanSummary.id

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Flight:Flight (additional)

• FlightPlanUpdate.enrouteAlternateAerodromes

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AlternateAerodrome

• FlightPlanUpdate.takeoffAlternateAerodromes

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAlternateAerodromePurposeTy
pe@TAKEOFF_ALTERNATE

• FlightPlanUpdate.aircraftId

Edition: 27.0 6 1179

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• FlightPlanUpdate.numberOfAircraft

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FormationComponent@numberOfAircraft

• FlightPlanUpdate.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• FlightPlanUpdate.totalEstimatedElapsedTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@totalEstimatedElapsedTime

• FlightPlanUpdate.eetsToLocations

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@accumulate
dEstimatedElapsedTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation

• FlightPlanUpdate.wakeTurbulenceCategory

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftCategory@wakeTurbulenceCategory

• FlightPlanUpdate.flightType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodePlanningStatusType

• FlightPlanUpdate.flightRules

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFiledFlightRulesType

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Flight:FlightRules (additional)

• FlightPlanUpdate.surveillanceEquipment

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType

• FlightPlanUpdate.iataFlightNumber

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@flightDesignator

• FlightPlanUpdate.arrivalAirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:AirportS
lotManagement:AirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeAirportSlotKindT
ype@AIRPORT_ARRIVAL_SLOT

Edition: 27.0 6 1180

Document Title: NM 27.0 - NM B2B Reference Manual

• FlightPlanUpdate.departureAirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:AirportS
lotManagement:AirportSlot

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeAirportSlotKindT
ype@AIRPORT_DEPARTURE_SLOT

• FlightPlanUpdateReplyData.structuredFlightPlan

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Flight_plan (additional)

• FlightPoint.timeOver

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• FlightPoint.flightLevel

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftAltitude@flightLevel

• FlightPoint.entryTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightPoint.exitTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightPoint.associatedRouteOrTerminalProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Procedu
re

urn:aero:airm:1.0.0:ConceptualModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Ter
minalProcedure (additional)

• FlightPoint.aerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• FlightPoint.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

Edition: 27.0 6 1181

Document Title: NM 27.0 - NM B2B Reference Manual

• FlightPoint.flightPlanPoint

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint

• FlightRestriction.timeOver

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• FlightRestriction.restrictionId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCapacityBalancing:
FlightRestriction@designator (additional)

• FlightRestriction.position

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType

• FlightRestriction.flightLevel

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@assignedFlightLevel

• FlightRetrievalReplyData.flight

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Flight

• FlightRules.VFR_THEN_IFR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFiledFlightRulesType@VFR_FIRS
T

• FlightRules.IFR_THEN_VFR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFiledFlightRulesType@IFR_FIRS
T

urn:aero:airm:1.0.0:ConceptualModel:Subjects:Flight:FlightEvent:FlightRulesChange (additional)

• FlightRules.VFR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeFlightRulesType@VFR

• FlightRules.IFR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeFlightRulesType@IFR

• FlightTrafficVolume.trafficVolumeId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn

Edition: 27.0 6 1182

Document Title: NM 27.0 - NM B2B Reference Manual

dCapacityBalancing:TrafficVolume (additional)

• FlightTrafficVolume.entryTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:AirspaceEntry@time

• FlightTrafficVolume.entryTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightTrafficVolume.middleTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightTrafficVolume.exitTrend

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@attitude

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeAircraftAttitudeType
(additional)

• FlightTrafficVolume.activated

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeStatusAirspaceTy
pe

• FlightTrafficVolume.exempted

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeF
lowCombinationRoleType@EXEMPTED

• FlightTrafficVolume.flows

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount@countLocation

• FlightType.SCHEDULED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightType@SCHEDULED_AIR_S
ERVICE

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Scheduled_international_air_service
(additional)

• FlightType.NOT_SCHEDULED

Edition: 27.0 6 1183

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightType@NON_SCHEDULED_
REVENUE_OPERATION

• FlightType.GENERAL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightType@GENERAL_AVIATIO
N_OPERATION

• FlightType.MILITARY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightType@MILITARY_FLIGHT

• FlightUpdateChoice.departureInformation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@departureOperations

• FlightUpdateChoice.landingInformation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@arrivalOperations

• FlightUpdateChoice.enRouteInformation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightPhaseType
@ENROUTE_PHASE

• FourDFlightPoint.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeSignificantPoin
tDesignatorType@ICAO

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• FourDFlightPoint.flightLevel

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftAltitude@flightLevel

• FourDFlightPoint.timeOver

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType@time

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• FourDPosition.timeOver

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType@time

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• FourDPosition.position

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftState@position

Edition: 27.0 6 1184

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType
(additional)

• FourDPosition.level

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:AircraftAltitude@flightLevel

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType@altitu
de (additional)

• FrequencyOnAircraft.UHF

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@UHF_RTF

urn:aero:airm:1.0.0:ContextualModel:Abbreviations:UHF (additional)

• FrequencyOnAircraft.VHF

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeCommunicationCapabilityType
@VHF_RTF

urn:aero:airm:1.0.0:ContextualModel:Abbreviations:VHF (additional)

• FrequencyOnAircraft.ELT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeAircraftEquipmentType@EME
RGENCY_LOCATOR_TRANSMITTER

urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Emergency_locator_transmitter
(additional)

• IATAFlightKeys.flightDesignator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• ICAOSTSIndicator.ALTRV

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@ALTRV

• ICAOSTSIndicator.ATFMX

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@ATFMX

• ICAOSTSIndicator.FFR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@FFR

• ICAOSTSIndicator.FLTCK

Edition: 27.0 6 1185

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@FLTCK

• ICAOSTSIndicator.HAZMAT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@HAZMAT

• ICAOSTSIndicator.HEAD

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@HEAD

• ICAOSTSIndicator.HOSP

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@HOSP

• ICAOSTSIndicator.HUM

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@HUM

• ICAOSTSIndicator.MARSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@MARSA

• ICAOSTSIndicator.MEDEVAC

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@MEDEVAC

• ICAOSTSIndicator.NONRVSM

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@NON_RVSM

• ICAOSTSIndicator.SAR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@SAR

• ICAOSTSIndicator.STATE

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType
@STATE

• IntervalPosition.BEFORE

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeRelativePositionType@BEFO

Edition: 27.0 6 1186

Document Title: NM 27.0 - NM B2B Reference Manual

RE

• IntervalPosition.INSIDE

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeRelativePositionType@AT

• IntervalPosition.AFTER

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeRelativePositionType@AFTE
R

• LandingInformation.landingTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:Landing@time

• LifeJacketEquipment.LIGHTS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeLifeJacketEquipmentType@L

• LifeJacketEquipment.FLUORESCEIN

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeLifeJacketEquipmentType@F

• LifeJacketEquipment.UHF

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeLifeJacketEquipmentType@U

• LifeJacketEquipment.VHF

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeLifeJacketEquipmentType@V

• MessageOriginator.airNavigationUnitId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

• ModeSCapabilities.extendedSquitterADSB

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
MODE_S_ID_PRESSURE_EXTENDED_SQUITTER

• OceanicInformation.position

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:FourDimensionalPointType

• OceanicInformation.landfallPoint

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• OtherAerodromeDesignation.aerodromeName

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@name

Edition: 27.0 6 1187

Document Title: NM 27.0 - NM B2B Reference Manual

• OtherAerodromeDesignation.firstLastRoutePoint

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• OtherInformation.selCalCode

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@selectiveCallingCode

• OtherInformation.nameOfOperator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• OtherInformation.reasonForSpecialHandling

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeReasonForSpecialHandlingType

• OtherInformation.communicationEquipment

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:EquipmentCapability

• OtherInformation.navigationEquipment

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightCapability@navigationCapability

• OtherInformation.performanceBasedNavigationCodes

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightCapability@rnavCapability

• OtherInformation.otherSurveillanceEquipments

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftCapability@surveillanceCapability

• OtherInformation.runwayVisualRange

urn:aero:airm:1.0.0:LogicalModel:Subjects:Meteorology:RunwayVisualRange

• OtherInformation.reclearanceInFlight

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AirspaceUserO
perations:ReclearanceInFlight

• OtherInformation.otherRemarks

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@annotation

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK
(additional)

• PerformanceBasedNavigationCode.RNAV_10

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_10

Edition: 27.0 6 1188

Document Title: NM 27.0 - NM B2B Reference Manual

• PerformanceBasedNavigationCode.RNAV_5_ALL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_ALL_PERMITTED_SENSORS

• PerformanceBasedNavigationCode.RNAV_5_GNSS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_GNSS

• PerformanceBasedNavigationCode.RNAV_5_DME_DME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_DME_DME

• PerformanceBasedNavigationCode.RNAV_5_VOR_DME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_VOR_DME

• PerformanceBasedNavigationCode.RNAV_5_INS_OR_IRS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_INS_OR_IRS

• PerformanceBasedNavigationCode.RNAV_5_LORAN_C

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_5_LORANC

• PerformanceBasedNavigationCode.RNAV_2_ALL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_2_ALL_PERMITTED_SENSORS

• PerformanceBasedNavigationCode.RNAV_2_GNSS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_2_GNSS

• PerformanceBasedNavigationCode.RNAV_2_DME_DME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_2_DME_DME

• PerformanceBasedNavigationCode.RNAV_2_DME_DME_IRU

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_2_DME_DME_IRU

• PerformanceBasedNavigationCode.RNAV_1_ALL

Edition: 27.0 6 1189

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_1_ALL_PERMITTED_SENSORS

• PerformanceBasedNavigationCode.RNAV_1_GNSS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_1_GNSS

• PerformanceBasedNavigationCode.RNAV_1_DME_DME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_1_DME_DME

• PerformanceBasedNavigationCode.RNAV_1_DME_DME_IRU

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNAVFlightCapabilityType@RN
AV_1_DME_DME_IRU

• PerformanceBasedNavigationCode.RNP_4

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@RNP_4

• PerformanceBasedNavigationCode.BASIC_RNP_1_ALL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@BASIC_RNP
_1_ALL_PERMITTED_SENSORS

• PerformanceBasedNavigationCode.BASIC_RNP_1_GNSS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@BASIC_RNP
_1_GNSS

• PerformanceBasedNavigationCode.BASIC_RNP_1_DME_DME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@BASIC_RNP
_1_DME_DME

• PerformanceBasedNavigationCode.BASIC_RNP_1_DME_DME_IRU

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@BASIC_RNP
_1_DME_DME_IRU

• PerformanceBasedNavigationCode.RNP_APCH

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@RNP_APCH

• PerformanceBasedNavigationCode.RNP_APCH_BARO_VNAV

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@RNP_APCH
_WITH_BARO_VNAV

• PerformanceBasedNavigationCode.RNP_AR_APCH_RF

Edition: 27.0 6 1190

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@RNP_AR_A
PCH_WITH_RF

• PerformanceBasedNavigationCode.RNP_AR_APCH_NO_RF

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeRNPCapabilityType@RNP_AR_A
PCH_WITHOUT_RF

• PointDAL.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeSignificantPoin
tDesignatorType@ICAO

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• PointDAL.cumulativeDistance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@cumulative
Distance

• ProposalInformation.responseBy

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlotImprovementProposal@respondBy

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalReroutingProposal@respondBy

• ProposalInformation.proposedCTOT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlotImprovementProposal@improvedSlot

• ProposalInformation.routeId

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalReroutingProposal@designator

• ProposalInformation.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• ReadyStatus.readyForImprovement

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightReadyStatusType@READY
_FOR_IMPROVEMENT

• ReadyStatus.readyToDepart

Edition: 27.0 6 1191

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightReadyStatusType@READY
_TO_DEPART

• ReadyStatus.revisedTaxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• ReclearanceInFlight.aerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• Relative4DPoint.cumulativeDistance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@cumulative
Distance

• Relative4DPoint.altitude

urn:aero:airm:1.0.0:LogicalModel:DataTypes:GeometryTypes:ThreeDimensionalPointType@altit
ude

• Relative4DPoint.elapsedTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint@estimatedEl
apsedTimeFromReference

• ReroutingApplyReplyDataResult.reroutingProposalStatus

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalReroutingProposal@status

• ReroutingApplyReplyDataResult.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• ReroutingApplyReplyDataResult.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• ReroutingFeedback.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• ReroutingIndicator.reason

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingReasonType

Edition: 27.0 6 1192

Document Title: NM 27.0 - NM B2B Reference Manual

• ReroutingIndicator.state

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType

• ReroutingReason.ATFM_EXECUTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingReasonType@ATFM

• ReroutingReason.AO

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingReasonType@AO

• ReroutingRouteId.standardRouteId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route
(additional)

• ReroutingState.PRODUCED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@PRODUCED

• ReroutingState.EXECUTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@EXECUTED

• ReroutingState.TIMED_OUT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@TIMED_OUT

• ReroutingState.REJECTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@REJECTED

• ReroutingState.REVOKED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@REVOKED

• ReroutingState.NO_MATCH

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType@NO_MATCH

Edition: 27.0 6 1193

Document Title: NM 27.0 - NM B2B Reference Manual

• RevalidationInformation.gufi

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@globallyUniqueFlightIdentifier

• RevisionTimes.timeToInsertInSequence

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:RevisionTimes@timeToInsertI
nSequence

• RevisionTimes.timeToRemoveFromSequence

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:RevisionTimes@timeToRemov
eFromSequence

• RouteInfo.duration

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectorySegment@duration

• RouteInfo.routeId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route
(additional)

• RouteInfo.ctot

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@ctot

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:Flight:FlightEvent:CalculatedTak
eOffTime (additional)

• RouteInfo.mostPenalisingRegulation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation

• RoutingAssistanceReplyDataResult.aircraftId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• RoutingAssistanceReplyDataResult.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• RoutingAssistanceReplyDataResult.originalRoute

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route

• RoutingAssistanceReplyDataResult.proposedRoutes

Edition: 27.0 6 1194

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:RouteAndProcedure:Route

• SlotSwapCandidate.ifplId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ifplIdentifier

• SpecialHandlingIndicators.icaoSTSIndicators

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@reasonForSpecialHandling

• SpecialHandlingIndicators.eurSTSIndicators

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@reasonForSpecialHandling

• SSRInfo.code

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@ssrCode

• SSRInfo.mode

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeSSRModeType

• SSRMode.A

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeSSRModeType@MODE_3A

• StandardRouteId.from

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@departureAerodrome

• StandardRouteId.to

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@destinationAerodrome

• StructuredFlightPlanData.aircraftOperator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• StructuredFlightPlanData.operatingAircraftOperator

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:AircraftOperator

• SupplementaryInformation.fuelEndurance

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@fuelEndurance

• SupplementaryInformation.survivalEquipment

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Aircraft:SurvivalEquipment

• SupplementaryInformation.lifeJacketEquipment

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeLifeJacketEquipmentType

Edition: 27.0 6 1195

Document Title: NM 27.0 - NM B2B Reference Manual

• SupplementaryInformation.aircraftColourAndMarkings

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:OperatorConfiguration@colourAndMarking

• SupplementaryInformation.pilotInCommand

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@pilot

• SurveillanceEquipment.modeA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
MODE_A

• SurveillanceEquipment.modeAAndC

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
MODE_A_AND_C

• SurveillanceEquipment.modeS

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
MODE_S

• SurveillanceEquipment.modeSCapabilities

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType

• SurveillanceEquipment.adsb1900Out

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_1090MHZ_ADS-B_OUT

• SurveillanceEquipment.adsb1900OutIn

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_1090MHZ_ADS-B_OUT_IN

• SurveillanceEquipment.adsbOutUAT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_OUT_UAT

• SurveillanceEquipment.adsbOutInUAT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_OUT_IN_UAT

• SurveillanceEquipment.adsbOutVDL4

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_OUT_VDL_MODE_4

Edition: 27.0 6 1196

Document Title: NM 27.0 - NM B2B Reference Manual

• SurveillanceEquipment.adsbOutInVDL4

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-B_OUT_IN_VDL_MODE_4

• SurveillanceEquipment.adscFans

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-C_FANS_1/A

• SurveillanceEquipment.adscAtn

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurveillanceCapabilityType@
ADS-C_ATN

• SurvivalEquipment.POLAR

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurvivalEquipmentType@POL
AR

• SurvivalEquipment.DESERT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurvivalEquipmentType@DES
ERT

• SurvivalEquipment.MARITIME

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurvivalEquipmentType@MA
RITIME

• SurvivalEquipment.JUNGLE

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeSurvivalEquipmentType@JUN
GLE

• SuspensionStatus.NOT_SUSPENDED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
DepartureSuspensionStatusType@NOT_SUSPENDED

• TargetTime.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• TargetTime.targetTime

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:OverPoint@time

• TargetTime.aerodromeICAOId

Edition: 27.0 6 1197

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• TargetTime.point

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Geometry:SignificantPoint@designator

• TargetTime.flightPlanPoint

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:RouteTrajectoryPoint

• TaxiTimeAndProcedure.taxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• TCOAuthorisation.id

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• TCOAuthorisation.aircraftRegistration

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• TrafficType.DEMAND

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AirTrafficType@DEMAND

• TrafficType.REGULATED_DEMAND

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AirTrafficType@REGULATED_DEMAND

• TrafficType.LOAD

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
AirTrafficType@TRAFFIC_LOAD

• UpdateDPIRequest.registrationMark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

• UpdateDPIRequest.aircraftType

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@icaoAircraftCategory

• UpdateDPIRequest.aircraftTypeIATA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:AircraftType@iataIdentifier

• UpdateDPIRequest.taxiTime

Edition: 27.0 6 1198

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• UpdateDPIRequest.departureProcedure

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:Departu
reOperations@sid

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:Informatio
nServicesProducts:AirportCDMInformationProduct:DeparturePlanningInformation (additional)

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier (additional)

• UpdateDPIRequest.departureRunway

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ru
nway (additional)

• UpdateDPIRequest.departureTerminal

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@terminal

• UpdateDPIRequest.departureApronStand

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Apron
@name

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:AerodromeOperations:Departu
reOperations (additional)

• UpdateDPIRequest.depstatusDeicing

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeDeicingStatusTyp
e

• UpdateDPIRequest.aircraftIdInbound

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification@aircraft

• UpdateDPIRequest.registrationMarkInbound

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Aircraft@aircraftRegistration

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight@previousFlight (additional)

• WakeTurbulenceCategory.LIGHT

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeWakeTurbulenceCategoryTyp
e@LIGHT

Edition: 27.0 6 1199

Document Title: NM 27.0 - NM B2B Reference Manual

• WakeTurbulenceCategory.MEDIUM

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeWakeTurbulenceCategoryTyp
e@MEDIUM

• WakeTurbulenceCategory.HEAVY

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeWakeTurbulenceCategoryTyp
e@HEAVY

• WakeTurbulenceCategory.SUPER

urn:aero:airm:1.0.0:LogicalModel:Subjects:Aircraft:Codelists:CodeWakeTurbulenceCategoryTyp
e@SUPER

Appendix M: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

19.M.1. Request / Reply Settings

Table 51. Compression settings

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

19.M.2. Time Window Request / Reply Count Quotas

Table 52. FlightPreparation Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightPlanValidationRe 3450 4140 600

quest/Reply

RoutingAssistanceReque 30 36 60
st/Reply

Edition: 27.0 6 1200

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

EvaluateFlowImpactRequ 20 24 60
est/Reply

ReroutingApplyRequest/ 30 36 60
Reply

Table 53. FlightFiling Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightPlanCreationRequ 150 180 600

est/Reply

FlightPlanUpdateReques 150 180 600

t/Reply

FlightPlanCancellation 150 180 600

Request/Reply

FlightDelayRequest/Rep 150 180 600

ly

FlightDepartureRequest 150 180 600

/Reply

FlightArrivalRequest/R 150 180 600

eply

FilingStatusRequest/Re 150 180 600

ply

FlightFilingResultSubs 30 36 60
criptionCreationReques
t/Reply

FlightFilingResultSubs 30 36 60
criptionUpdateRequest/
Reply

FlightFilingResultSubs 30 36 60
criptionRetrievalReque
st/Reply

Table 54. FlightManagement Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightPlanListRequest/ 975 1170 600

Reply

FlightListByKeysReques 3750 4500 600

t/Reply

FlightListByAircraftOp 600 720 600

eratorRequest/Reply

Edition: 27.0 6 1201

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

FlightListByAerodromeR 600 720 600

equest/Reply

FlightListByAerodromeS 600 720 600

etRequest/Reply

FlightListByAirspaceRe 600 720 600

quest/Reply

FlightListByPointReque 600 720 600

st/Reply

FlightListByTrafficVol 600 720 600

umeRequest/Reply

FlightListByMeasureReq 300 360 600

uest/Reply

FlightListByHotspotReq 300 360 600

uest/Reply

FlightListByAircraftRe 300 360 600

gistrationMarkRequest/
Reply

FlightRetrievalRequest 5250 6300 600

/Reply

EarlyDPIRequest/Reply 180 216 600

TargetDPITargetRequest 225 270 600

/Reply

TargetDPISequencedRequ 225 270 600

est/Reply

ATCDPIRequest/Reply 30 36 60

CancelDPIRequest/Reply 30 36 60

PredictedDPIRequest/Re 600 720 600

ply

FlightUpdateRequest/Re 30 36 60
ply

ACDMAlertRequest/Reply 30 36 60

GeneralAPIRequest/Repl 600 720 600

y

TargetTakeOffAPIReques 180 216 600

t/Reply

TargetTimeOverAPIReque 30 36 60
st/Reply

FlightConfirmationRequ 30 36 60
est/Reply

Edition: 27.0 6 1202

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

SlotMissedRequest/Repl 30 36 60
y

ReadyToDepartRequest/R 30 36 60
eply

SlotImprovementModeReq 30 36 60
uest/Reply

ReroutingProposalRejec 30 36 60
tedRequest/Reply

SlotProposalFeedbackRe 30 36 60
quest/Reply

FlightCriticalityReque 30 36 60
st/Reply

ReroutingFeedbackReque 30 36 60
st/Reply

FlightDataSubscription 30 36 60
CreationRequest/Reply

FlightDataSubscription 30 36 60
UpdateRequest/Reply

FlightDataSubscription 30 36 60
RetrievalRequest/Reply

FlightPlanSubscription 30 36 60
CreationRequest/Reply

FlightPlanSubscription 30 36 60
UpdateRequest/Reply

FlightPlanSubscription 30 36 60
RetrievalRequest/Reply

Table 55. FlightSafety Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

ACC3AccreditationListR 30 36 60
eplacementRequest/Repl
y

TCOAuthorisationListRe 30 36 60
placementRequest/Reply

TCOAuthorisationListUp 30 36 60
dateRequest/Reply

19.M.3. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Edition: 27.0 6 1203

Document Title: NM 27.0 - NM B2B Reference Manual

Table 56. FLIGHT_FILING_RESULT

Parameter (unit) Default Description

TTL (min) 60 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the filing submission
was processed by the NM IFPS or by the the NM
IFPS operator
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 57. FLIGHT_PLANS

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the flight plan was
updated in the NM IFPS
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 58. FLIGHT_DATA

Parameter (unit) Default Description

TTL (min) 5 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the flight was updated
in the NM system
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED true
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Edition: 27.0 6 1204

Document Title: NM 27.0 - NM B2B Reference Manual

Chapter 20. Flow

20.1. Context
1. The FlowServices service group is intended to provide services in the flow and capacity
management domain.

20.2. PREOPS Testing

1. The data available in the PREOPS platform for the current MeasuresService is fed daily from the
OPS systems.

20.2.1. REGULATION P/S Messages

1. ATFCM Regulations are imported in PREOPS every 5 minutes.

2. For each imported regulation, if new or updated, a new P/S Message is published.

3. Therefore new REGULATION messages on PREOPS may be published at intervals of 5 minutes.

20.3. TrafficCounts Port Type

20.3.1. Overview

1. This service is intended to provide querying of traffic counts. The requests currently available
are:

a. S-R/R TrafficCountsByAircraftOperatorRequest/Reply

b. S-R/R TrafficCountsByAerodromeRequest/Reply

c. S-R/R TrafficCountsByAerodromeSetRequest/Reply

d. S-R/R TrafficCountsByAirspaceRequest/Reply

e. S-R/R TrafficCountsByPointRequest/Reply

f. S-R/R TrafficCountsByTrafficVolumeRequest/Reply

g. S-R/R TrafficCountsByMeasureRequest/Reply

20.3.2. Requests/Replies

20.3.2.1. TrafficCountsByAircraftOperatorRequest/Reply

Edition: 27.0 6 1205

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficCountsByAircraftOperatorRequest

Reply: TrafficCountsByAircraftOperatorReply

Response time: not available

Default settings: request count quotas

SOAP operation:

TrafficCountsByAircraftOperatorReply
queryTrafficCountsByAircraftOperator(TrafficCountsByAircraftOperatorRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

Queries the traffic counts by aircraft operator.

20.3.2.1.1. TrafficCountsByAircraftOperatorRequest

Edition: 27.0 6 1206

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic counts for an aircraft operator.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. AircraftOperatorICAOId aircraftOperator (Mandatory)

The Aircraft operator ICAO Id for which traffic counts are requested.

b. CountsCalculationType calculationType (Mandatory)

Indicates what is the calculation type of the count (entry or occupancy).

20.3.2.1.2. TrafficCountsByAircraftOperatorReply

Edition: 27.0 6 1207

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to TrafficCountsByAircraftOperatorRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByAircraftOperatorReplyData data (Optional)

The reply payload.

20.3.2.2. TrafficCountsByAerodromeRequest/Reply

Edition: 27.0 6 1208

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficCountsByAerodromeRequest

Reply: TrafficCountsByAerodromeReply

Response time: 10 / 27 / 130 (ms)

Default settings: request count quotas

SOAP operation:

TrafficCountsByAerodromeReply
queryTrafficCountsByAerodrome(TrafficCountsByAerodromeRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

Queries the traffic counts by aerodrome.

20.3.2.2.1. TrafficCountsByAerodromeRequest

Edition: 27.0 6 1209

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic ENTRY counts for an aerodrome.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. AerodromeICAOId aerodrome (Mandatory)

ICAO id of the aerodrome.

b. AerodromeRole aerodromeRole (Mandatory)

Documentation last updated: 27.0 - Edition 1

Specifies whether the aerodrome is meant to be departure, arrival or both.

If aerodromeRole is set to AerodromeRole.DEPARTURE , the traffic window specifies that only

those flights taking off in the time window are requested.

If aerodromeRole is set to AerodromeRole.ARRIVAL , the traffic window specifies that only those
flights arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.GLOBAL , the traffic window specifies that only those
flights taking off or arriving in the time window are requested.

i. Constraints:

▪ TrafficCountsByAerodromeRequest.ALTERNATE_ROLE_NOT_ALLOWED

c. boolean includeInvisibleFlights (Optional)

Edition: 27.0 6 1210

Document Title: NM 27.0 - NM B2B Reference Manual

Indicates whether invisible flights (VFR, OAT, STAY, IFPSTOP) shall be included in the traffic
counts.

Defaults to false .

3. Constraints:

a. ALTERNATE_ROLE_NOT_ALLOWED (new 27.0)

The aerodromeRole cannot be equals to ALTERNATE.

Constrained attributes: aerodromeRole

Constrained requests: any using request

20.3.2.2.2. TrafficCountsByAerodromeReply

<<class>>

Returned in response to TrafficCountsByAerodromeRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByAerodromeReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1211

Document Title: NM 27.0 - NM B2B Reference Manual

20.3.2.3. TrafficCountsByAerodromeSetRequest/Reply

MEP: S-R/R

Request: TrafficCountsByAerodromeSetRequest

Reply: TrafficCountsByAerodromeSetReply

Response time: not available

Default settings: request count quotas

SOAP operation:

TrafficCountsByAerodromeSetReply
queryTrafficCountsByAerodromeSet(TrafficCountsByAerodromeSetRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

Queries the traffic counts by aerodrome set.

20.3.2.3.1. TrafficCountsByAerodromeSetRequest

Edition: 27.0 6 1212

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic ENTRY counts for an aerodrome set.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. AerodromeSetId aerodromeSet (Mandatory)

Id of the aerodrome set.

b. AerodromeRole aerodromeRole (Mandatory)

Documentation last updated: 27.0 - Edition 1

Specifies whether the aerodrome is meant to be departure, arrival or both.

If aerodromeRole is set to AerodromeRole.DEPARTURE , the traffic window specifies that only

those flights taking off in the time window are requested.

If aerodromeRole is set to AerodromeRole.ARRIVAL , the traffic window specifies that only those
flights arriving in the time window are requested.

If aerodromeRole is set to AerodromeRole.GLOBAL , the traffic window specifies that only those
flights taking off or arriving in the time window are requested.

i. Constraints:

▪ TrafficCountsByAerodromeSetRequest.ALTERNATE_ROLE_NOT_ALLOWED

c. boolean includeInvisibleFlights (Optional)

Edition: 27.0 6 1213

Document Title: NM 27.0 - NM B2B Reference Manual

Indicates whether invisible flights (VFR, OAT, STAY, IFPSTOP) shall be included in the traffic
counts.

Defaults to false .

3. Constraints:

a. ALTERNATE_ROLE_NOT_ALLOWED (new 27.0)

The aerodromeRole cannot be equals to ALTERNATE.

Constrained attributes: aerodromeRole

Constrained requests: any using request

20.3.2.3.2. TrafficCountsByAerodromeSetReply

<<class>>

Returned in response to TrafficCountsByAerodromeSetRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByAerodromeSetReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1214

Document Title: NM 27.0 - NM B2B Reference Manual

20.3.2.4. TrafficCountsByAirspaceRequest/Reply

MEP: S-R/R

Request: TrafficCountsByAirspaceRequest

Reply: TrafficCountsByAirspaceReply

Response time: 21 / 190 / 240 (ms)

Default settings: request count quotas

SOAP operation:

TrafficCountsByAirspaceReply
queryTrafficCountsByAirspace(TrafficCountsByAirspaceRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

Queries the traffic counts by airspace.

20.3.2.4.1. TrafficCountsByAirspaceRequest

Edition: 27.0 6 1215

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic counts for an airspace.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. AirspaceId airspace (Mandatory)

Id of the airspace.

b. CountsCalculationType calculationType (Mandatory)

Indicates what is the calculation type of the count (entry or occupancy).

20.3.2.4.2. TrafficCountsByAirspaceReply

Edition: 27.0 6 1216

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to TrafficCountsByAirspaceRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByAirspaceReplyData data (Optional)

The reply payload.

20.3.2.5. TrafficCountsByPointRequest/Reply

Edition: 27.0 6 1217

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficCountsByPointRequest

Reply: TrafficCountsByPointReply

Response time: 11 / 32 / 180 (ms)

Default settings: request count quotas

SOAP operation:

TrafficCountsByPointReply queryTrafficCountsByPoint(TrafficCountsByPointRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

Queries the traffic counts by point.

20.3.2.5.1. TrafficCountsByPointRequest

Edition: 27.0 6 1218

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic ENTRY counts for a point.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. PublishedPointId point (Mandatory)

Id of the published point.

b. FlightLevelRange flightLevelRange (Mandatory)

The range in which the flight level should be over the point.

20.3.2.5.2. TrafficCountsByPointReply

Edition: 27.0 6 1219

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to TrafficCountsByPointRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByPointReplyData data (Optional)

The reply payload.

20.3.2.6. TrafficCountsByTrafficVolumeRequest/Reply

Edition: 27.0 6 1220

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficCountsByTrafficVolumeRequest

Reply: TrafficCountsByTrafficVolumeReply

Response time: 26 / 120 / 160 (ms)

Default settings: request count quotas

SOAP operation:

TrafficCountsByTrafficVolumeReply
queryTrafficCountsByTrafficVolume(TrafficCountsByTrafficVolumeRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• assert certificate read access to /scenarios

if request.computeFlowCounts=SCENARIO

Queries the traffic counts by traffic volume.

20.3.2.6.1. TrafficCountsByTrafficVolumeRequest

Edition: 27.0 6 1221

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the NM traffic counts for a traffic volume.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. TrafficVolumeId trafficVolume (Mandatory)

Id of the traffic volume.

b. CountsCalculationType calculationType (Mandatory)

Indicates what is the calculation type of the count (entry or occupancy).

Occupancy counts for traffic volumes are only supported for traffic volumes
NOTE
defined on an airspace.

i. Constraints:

▪ TrafficCountsByTrafficVolumeRequest.INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALE
RTS
c. boolean computeOtmvAlerts (Optional)

Indicates if OTMV alerts need to be computed (e.g., is the flight in an OTMV peak and during
what count periods; see OtmvAlert) or not.

Default is false .

i. Constraints:

▪ TrafficCountsByTrafficVolumeRequest.INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALE

Edition: 27.0 6 1222

Document Title: NM 27.0 - NM B2B Reference Manual

RTS
▪ TrafficCountsByTrafficVolumeRequest.INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERT
S
d. FlowType computeFlowCounts (Optional)

Indicates if traffic counts need to be computed by linked or associated or scenario flows.

By default (i.e., if computeFlowCounts is not specified), traffic counts are not computed by flow.

i. Constraints:

▪ TrafficCountsByTrafficVolumeRequest.INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERT
S
ii. Access control:

▪ set computeFlowCounts=SCENARIO requires read access to /scenarios

e. boolean includeInvisibleFlights (Optional)

Indicates whether invisible flights (VFR, OAT, STAY, IFPSTOP) shall be included in the traffic
counts.

Defaults to false.

3. Constraints:

a. INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALERTS

If attribute computeOtmvAlerts is true then attribute calculationType must be OCCUPANCY and

attribute countsInterval.step must be one minute ( 0001 ).

Constrained attributes: calculationType, computeOtmvAlerts

Constrained requests: any using request

b. INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERTS

If attribute computeFlowCounts is SCENARIO then the attribute computeOtmvAlerts must be false.

Constrained attributes: computeFlowCounts, computeOtmvAlerts

Constrained requests: any using request

20.3.2.6.2. TrafficCountsByTrafficVolumeReply

Edition: 27.0 6 1223

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to TrafficCountsByTrafficVolumeRequest.

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByTrafficVolumeReplyData data (Optional)

The reply payload.

20.3.2.7. TrafficCountsByMeasureRequest/Reply

Edition: 27.0 6 1224

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficCountsByMeasureRequest

Reply: TrafficCountsByMeasureReply

Response time: not available

Default settings: request count quotas

SOAP operation:

TrafficCountsByMeasureReply
queryTrafficCountsByMeasure(TrafficCountsByMeasureRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /counts

• assert certificate read access to /flights?proposal=true

if request.includeProposalFlights=true

• assert certificate read access to /scenarios

if request.computeFlowCounts=SCENARIO

Queries the traffic counts by measure.

20.3.2.7.1. TrafficCountsByMeasureRequest

Edition: 27.0 6 1225

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query the traffic counts for a measure.

1. Inherits from: TrafficCountsRequest

2. Attributes:

a. MeasureId measureId (Mandatory)

Id of the measure.

b. CountsCalculationType calculationType (Mandatory)

Indicates what is the calculation type of the count (entry or occupancy).

i. Constraints:

▪ TrafficCountsByMeasureRequest.INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALERTS

c. boolean computeOtmvAlerts (Optional)

Indicates if OTMV alerts need to be computed (e.g., is the flight in an OTMV peak and during
what count periods; see OtmvAlert) or not.

Default is false .

i. Constraints:

▪ TrafficCountsByMeasureRequest.INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALERTS

▪ TrafficCountsByMeasureRequest.INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERTS

d. FlowType computeFlowCounts (Optional)

Edition: 27.0 6 1226

Document Title: NM 27.0 - NM B2B Reference Manual

Indicates if traffic counts need to be computed by linked or associated or scenario flows.

By default (i.e., if computeFlowCounts is not specified), traffic counts are not computed by flow.

i. Constraints:

▪ TrafficCountsByMeasureRequest.INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERTS

3. Constraints:

a. INCONSISTENT_COUNTS_TYPE_AND_COMPUTE_OTMV_ALERTS

If attribute computeOtmvAlerts is true then attribute calculationType must be OCCUPANCY and

attribute countsInterval.step must be one minute (0001).

Constrained attributes: calculationType, computeOtmvAlerts

Constrained requests: any using request

b. INCONSISTENT_FLOW_TYPE_AND_COMPUTE_OTMV_ALERTS

If attribute computeFlowCounts is SCENARIO then the attribute computeOtmvAlerts must be false.

Constrained attributes: computeFlowCounts, computeOtmvAlerts

Constrained requests: any using request

20.3.2.7.2. TrafficCountsByMeasureReply

<<class>>

Returned in response to TrafficCountsByMeasureRequest.

Edition: 27.0 6 1227

Document Title: NM 27.0 - NM B2B Reference Manual

See TrafficCountsReplyData.

1. Inherits from: Reply

2. Attributes:

a. TrafficCountsByMeasureReplyData data (Optional)

The reply payload.

20.4. Measures Port Type

20.4.1. Overview

1. This service is intended to provide querying and update capabilities on ATFCM measures. The
requests currently available are:

a. P/S REGULATIONS

b. P/S REROUTINGS

c. S-R/R RegulationListRequest/Reply

d. S-R/R RegulationCreationRequest/Reply

e. S-R/R RegulationUpdateRequest/Reply

f. S-R/R RegulationCancelRequest/Reply

g. S-R/R RegulationProposalListRequest/Reply

h. S-R/R RegulationProposalFilingRequest/Reply

i. S-R/R RegulationProposalUpdateRequest/Reply

j. S-R/R RegulationProposalRevocationRequest/Reply

k. S-R/R ReroutingListRequest/Reply

l. S-R/R ReroutingCreationRequest/Reply

m. S-R/R ReroutingUpdateRequest/Reply

n. S-R/R ReroutingCancelRequest/Reply

o. S-R/R MeasureOpLogRetrievalRequest/Reply

p. S-R/R UpdateFlightsInMeasureRequest/Reply

q. S-R/R SimulationMeasureRevertRequest/Reply

r. S-R/R ATFCMSituationRequest/Reply

s. S-R/R NetworkImpactAssessmentRetrievalRequest/Reply

20.4.2. Concepts

Edition: 27.0 6 1228

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.2.1. Update Pattern

1. The pattern used for all measure updates is the update of one measure at the time. There can
only exist 1 contiguous measure with the same id per day.

2. When updating a measure, the B2B client can send a delta containing only those fields that need
to be updated. Alternatively the B2B client can send the full object with all relevant data fields.

3. When the user wants to update an existing (normal) measure via a proposal, then the user
needs to send the full object with all relevant data fields. On the other hand, when the B2B
client wants to update a proposal measure (before NM has started reviewing), then he can send
a delta containing only those fields that need to be updated.

4. Any of the measures and proposal measures may be updated via B2C and/or B2B and/or by
NMOC, and by different operators. When an operator updates a measure via B2C, the next B2B
retrieve operation will include these changes done via B2C. The pattern used on the backend
side to deal with concurrent updates is the following:

a. Each measure is returned with a data id that expresses a data version number (equivalent to
a timestamp).

b. Before updating a measure (via a proposal or directly), the updater must first get the
measure and subsequently pass the associated data id when updating it. IMPORTANT: note
that this data id is also related to the dataset in use, i.e. a data id obtained from a dataset
cannot be used with another dataset: doing so would result in an error.

c. A concurrent update is defined as an update that took place earlier (i.e. before the update
that the updater wants to execute now) but after the timestamp associated to the data id
passed within the update to execute now.

For example:

i. A B2B client shows in a local screen a regulation corresponding to dataId I1.

ii. A NM client in a parallel modifies the same regulation (for the same measure id) via B2B
or B2C → latest version in NM systems : dataId I2.

iii. The B2B client end-user modifies some values of the regulation and tries to commit them
as a proposal to modify the regulation (includes sending to NM; changes wrt I1).

iv. As the B2B client end-user started from dataId I1 but the measure was also conflictingly
modified in parallel CONFLICTING_UPDATE ReplyStatus is returned.

d. From the concurrency perspective, a measure update or proposal to modify a measure is

successful if:

i. There was no concurrent update, or

ii. There were identical concurrent updates.

e. IMPORTANT: NM insists that the B2B client only does a measure update in case something
has changed for that measure.

5. The data id is an opaque identifier of the version of the global state of the backend system
related to CACD or tactical updatable related data (not pure flight data: so including capacity
updates, measures,). Whenever dataId is passed in an update request, the system verifies if

Edition: 27.0 6 1229

Document Title: NM 27.0 - NM B2B Reference Manual

there have been conflicting updates between what the B2B client tried to update (wrt the state
of the system linked to the dataId) and the latest state. Note that the dataId represent the global
state of the backend system (not linked to specific locations). It changes continuously (between
subsequent retrieve requests). However the fact that it changes continuously does not impact
the B2B client, as it is only used to detect if there have been conflicting parallel updates between
the latest state and what the B2B client changed in the update request.

6. Unlike with capacity plan updates (See Tactical updates : Update Pattern) there is only 1 valid
pattern to use the dataId :

a. B2C/NMOC (via phone coordination) can update the concerned measures. The dataId (in
combination with the CONFLICTING_UPDATE error reply) must be used to detect conflicting
parallel updates and report those to the end user so that he can decide what to do.

b. So the detailed steps for a regulation update (via proposal) would be :

i. On the create of a regulation R (via proposal regulation),

ii. B2B.fileRegulationProposal is used without dataId. The reply contains a dataId PR1

iii. Each next update for proposal R or to the MCDM state of R, would use the dataId
returned by the previous update (PR1,PR2,…). Alternatively when updating a proposal R,
the B2B client uses as dataId , the dataId from the regulation object as it was retrieved
for showing to the client. In that case the dataId corresponds to the regulation version
from which the client started to make changes.

iv. If the NM systems detect a conflicting parallel update between the time corresponding to
the dataId PR1/PR2.. and the latest NM state wrt proposal regulation PR or MCDM of PR,
the reply contains a CONFLICTING_UPDATE error. In that case the client system must
warn the operator that a conflicting parallel update has occurred and would show the
local data and the NM data to allow the operator to choose (and optionally update any
local system as well).

When the B2b client, wants to create a proposal to update/cancel the normal regulation
R, then B2B.fileRegulationProposal is used with normalRegulationDataId = NR2 and no
dataId. The reply contains proposal regulation dataId PR5.

Alternatively the NM systems detect a conflicting parallel update between the time
corresponding to the dataId NR2 and the latest NM state wrt normal regulation R or
MCDM of R. In that case the reply contains a CONFLICTING_UPDATE error. In that case
the client system must warn the operator that a conflicting parallel update has occurred
and would show the local data and the NM data to allow the operator to choose (and
optionally update any local system as well).

7. If measure S is updated, then data Id of measure S (S1) needs to be used.

8. Note that this pattern is also used by a.o. NM systems:

a. When an normal regulation needs to be updated (proposal for modification), first the NM
data is shown and in the screen data the associated dataId NR1 is kept. (the user has seen the
NM data corresponding to dataId NR1).

When the user applies his changes, this data Id NR1 is then used in the

Edition: 27.0 6 1230

Document Title: NM 27.0 - NM B2B Reference Manual

RegulationProposalFilingRequest . In case there were parallel conflicting updates, the user is

notified and he needs to redo his update (including first looking at the latest NM data). The
main reason behind: multiple operators at different terminals (including NMOC) can do
conflicting updates and they need to be notified.

b. When a proposal regulation needs to be updated, first the NM proposal data is shown and in
the screen data the associated dataId PR1 is kept. (the user has seen the NM proposal data
corresponding to dataId PR1).

When the user applies his changes, this data Id PR1 is then used in the
RegulationProposalRevocationRequest, RegulationProposalUpdateRequest or
MCDMStateUpdateRequest . In case there were parallel conflicting updates, the user is notified
and he needs to redo his update (including first looking at the latest NM data).

20.4.2.2. Transaction and Errors

1. See Transactions and Errors.

20.4.2.3. Allowed Times for Retrievals and Updates

20.4.2.3.1. Forecast and Operational Datasets

1. See Forecast and Operational Datasets.

20.4.2.3.2. Past

1. Unlike with the tactical updates (See tactical updates : Past) , measure updates can modify the
past:

2. A typical scenario is: a runway got broken and since X minutes no flights were allowed to take-
off. In such a case a regulation can be created that starts e.g. 30 minutes in the past and that
gives the impacted flights a new CTOT in the future. In NM systems there is the slot change
control that allows to control which flights must be changed and which flights cannot be
changed or impacted when modifying regulations. By default only flights which have an EOBT
of Y minutes or more in the future can be changed (See ATFCM reference manual). If the B2B
client needs to change more/less flights, then this needs to be coordinated via phone with
NMOC.

3. So when the B2B client updates a regulation or submits a proposal to update a regulation that
has already started and it is not the purpose to change the past, then the B2B client should not
modify the past (a.o. archiving reasons). So the B2B clients should not change the start of the
regulation but rather split the "current" period inside the initialConstraints in two parts: one for
that past (unchanged) and one for the future part (somewhat similar to the remote updates that
can not change the past but only change the future: (See tactical updates : Past)).

20.4.2.4. Simulations

1. See Simulations.

Edition: 27.0 6 1231

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.2.5. Overload Protection

1. There are some technical limitations to the amount of outstanding proposals that can exist at
the same time from a given FMP and the amount of proposals that may be sent in a day. The
objective of these limits is to protect the NM systems from excessive or faulty demand (e.g.
communication errors that triggers a loop of proposals being sent).

a. Classic Regulation Proposals:

i. A maximum of 15 outstanding (not accepted, nor rejected) ATFM regulation proposals

can exist at a time per FMP.

b. Cherry picked Regulation Proposals:

i. A maximum of 1 CP regulation proposal in MCMState PROPOSED can exist at a time per

FMP.

ii. A maximum of 5 CP regulation proposals can be sent per day and per FMP.

iii. A maximum of 50 CP regulation proposals with regulationState="APPLIED" can exist at

the same time (for all users combined).

2. Note that if the required number exceeds the figures above the request shall be coordinated via
telephone.

20.4.3. Publish/Subscribe Topics

20.4.3.1. REGULATIONS

Edition: 27.0 6 1232

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: P/S

Message: RegulationMessage

Ordering policy:

Messages referring to the same regulation shall be ordered by alphanumerically sorting on

the field payload.dataId.

Message filter: RegulationMessageFilter

Payload configuration: RegulationPayloadConfiguration

Subscription management (topic specific):

• S-R/R RegulationSubscriptionCreationRequest/Reply

• S-R/R RegulationSubscriptionUpdateRequest/Reply

• S-R/R RegulationSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert read access to /regulations

Notification about changes to ATFCM Regulations.

20.4.3.1.1. RegulationMessage (new 27.0)

<<class>>

The business P/S message for topic REGULATIONS.

1. Inherits from: BusinessPSMessage

2. Attributes:

a. Regulation payload (Mandatory)

The payload of this RegulationMessage .

Edition: 27.0 6 1233

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.3.1.2. RegulationSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: RegulationSubscriptionCreationRequest

Reply: RegulationSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RegulationSubscriptionCreationReply
createRegulationSubscription(RegulationSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulations

• assert certificate read access to /mcdmTopics

if RegulationField.mcdmRequired is requested

• assert certificate read access to /scenarios

if RegulationField.scenarioReference is requested

Creates a subscription for topic REGULATIONS.

RegulationSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 1234

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic REGULATIONS.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. RegulationMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. RegulationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

RegulationSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to RegulationSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. RegulationSubscriptionCreationReplyData data (Optional)

The reply payload.

20.4.3.1.3. RegulationSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 1235

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RegulationSubscriptionUpdateRequest

Reply: RegulationSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RegulationSubscriptionUpdateReply
updateRegulationSubscription(RegulationSubscriptionUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulations

• assert certificate read access to /mcdmTopics

if RegulationField.mcdmRequired is requested

• assert certificate read access to /scenarios

if RegulationField.scenarioReference is requested

Updates a subscription for topic REGULATIONS.

RegulationSubscriptionUpdateRequest (new 27.0)

Edition: 27.0 6 1236

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows updating an existing subscription for topic REGULATIONS.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. RegulationMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. RegulationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

RegulationSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to RegulationSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. RegulationSubscriptionUpdateReplyData data (Optional)

The reply payload.

20.4.3.1.4. RegulationSubscriptionRetrievalRequest/Reply (new 27.0)

Edition: 27.0 6 1237

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RegulationSubscriptionRetrievalRequest

Reply: RegulationSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RegulationSubscriptionRetrievalReply
retrieveRegulationSubscription(RegulationSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulations

Retrieves a subscription for topic REGULATIONS.

RegulationSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic REGULATIONS.

1. Inherits from: SubscriptionRetrievalRequest

RegulationSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to RegulationSubscriptionRetrievalRequest.

Edition: 27.0 6 1238

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. RegulationSubscriptionRetrievalReplyData data (Optional)

The reply payload.

20.4.3.2. REROUTINGS (new 27.0)

MEP: P/S

Message: ReroutingMessage

Ordering policy:

Messages referring to the same rerouting shall be ordered by alphanumerically sorting on the
field payload.dataId.

Message filter: ReroutingMessageFilter

Payload configuration: ReroutingPayloadConfiguration

Subscription management (topic specific):

• S-R/R ReroutingSubscriptionCreationRequest/Reply

• S-R/R ReroutingSubscriptionUpdateRequest/Reply

• S-R/R ReroutingSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert read access to /reroutings

Notification about changes to ATFCM Reroutings.

20.4.3.2.1. ReroutingMessage (new 27.0)

<<class>>

The business P/S message for topic REROUTINGS.

1. Inherits from: BusinessPSMessage

Edition: 27.0 6 1239

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. Rerouting payload (Mandatory)

The payload of this ReroutingMessage .

20.4.3.2.2. ReroutingSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: ReroutingSubscriptionCreationRequest

Reply: ReroutingSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingSubscriptionCreationReply
createReroutingSubscription(ReroutingSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /reroutings

• assert certificate read access to /mcdmTopics

if ReroutingField.mcdmRequired is requested

• assert certificate read access to /scenarios

if ReroutingField.scenarioReference is requested

Creates a subscription for topic REROUTINGS.

ReroutingSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 1240

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic REROUTINGS.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. ReroutingMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. ReroutingPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

ReroutingSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to ReroutingSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingSubscriptionCreationReplyData data (Optional)

The reply payload.

20.4.3.2.3. ReroutingSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 1241

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ReroutingSubscriptionUpdateRequest

Reply: ReroutingSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingSubscriptionUpdateReply
updateReroutingSubscription(ReroutingSubscriptionUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /reroutings

• assert certificate read access to /mcdmTopics

if ReroutingField.mcdmRequired is requested

• assert certificate read access to /scenarios

if ReroutingField.scenarioReference is requested

Updates a subscription for topic REROUTINGS.

ReroutingSubscriptionUpdateRequest (new 27.0)

Edition: 27.0 6 1242

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows updating an existing subscription for topic REROUTINGS.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. ReroutingMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. ReroutingPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

ReroutingSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to ReroutingSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingSubscriptionUpdateReplyData data (Optional)

The reply payload.

20.4.3.2.4. ReroutingSubscriptionRetrievalRequest/Reply (new 27.0)

Edition: 27.0 6 1243

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ReroutingSubscriptionRetrievalRequest

Reply: ReroutingSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingSubscriptionRetrievalReply
retrieveReroutingSubscription(ReroutingSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /reroutings

Retrieves a subscription for topic REROUTINGS.

ReroutingSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic REROUTINGS.

1. Inherits from: SubscriptionRetrievalRequest

ReroutingSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to ReroutingSubscriptionRetrievalRequest.

Edition: 27.0 6 1244

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. ReroutingSubscriptionRetrievalReplyData data (Optional)

The reply payload.

20.4.4. Requests/Replies

20.4.4.1. RegulationListRequest/Reply

MEP: S-R/R

Request: RegulationListRequest

Reply: RegulationListReply

Response time: 43 / 110 / 190 (ms)

Default settings: request count quotas

SOAP operation:

RegulationListReply queryRegulations(RegulationListRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulations

• assert certificate read access to /mcdmTopics

if RegulationField.mcdmRequired is requested

• assert certificate read access to /scenarios

if RegulationField.scenarioReference is requested

Queries regulations.

20.4.4.1.1. RegulationListRequest

Edition: 27.0 6 1245

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query regulation.

The reply will only contain "real" regulations (not any proposal regulations).

1. Inherits from: RegulationOrMCDMOnlyListRequest

2. Attributes:

a. set< RegulationField > requestedRegulationFields (Mandatory)

The reply returns only the requested regulation fields in this set, and only if the values of

Edition: 27.0 6 1246

Document Title: NM 27.0 - NM B2B Reference Manual

these requested fields are available at NM. Note that the regulation id is always returned.

b. set< RegulationState > regulationStates (Optional)

Selects the regulations with a state that matches an entry in this set.

By default, regulations are selected regardless to their state.

i. Constraints:

▪ set size range : [1, unbounded[

20.4.4.1.2. RegulationListReply

Edition: 27.0 6 1247

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to RegulationListRequest.

See RegulationOrMCDMOnlyListReplyData.

Edition: 27.0 6 1248

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. RegulationListReplyData data (Optional)

The reply payload.

20.4.4.2. RegulationCreationRequest/Reply

MEP: S-R/R

Request: RegulationCreationRequest

Reply: RegulationCreationReply

Response time: 940 / 1500 / 1800 (ms)

Default settings: request count quotas

SOAP operation:

RegulationCreationReply createRegulation(RegulationCreationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulations

• assert certificate write access to /regulations?cherry_pick=true

if created regulation is cherry pick (request.regulation.measureCherryPick=true)

• assert certificate write access to /regulations?cherry_pick=false

if created regulation is non cherry pick (request.regulation.measureCherryPick=false)

• assert certificate write access to /mcdmTopics

if created regulation requires MCDM (request.regulation.mcdmRequired=true)

• assert certificate write access to /networkImpactAssessments

if network assessment computing is requested

(request.computeNetworkImpactAssessment=true)

Edition: 27.0 6 1249

Document Title: NM 27.0 - NM B2B Reference Manual

Creates a new regulation.

20.4.4.2.1. RegulationCreationRequest

<<class>>

Request to create a regulation.

Edition: 27.0 6 1250

Document Title: NM 27.0 - NM B2B Reference Manual

• On OPS platform, the RegulationCreationRequest is supported on SIMULATION

dataset only.

• On PREOPS platform, the RegulationCreationRequest is supported on

SIMULATION and OPERATIONAL datasets.
NOTE
• The creation of the regulation is synchronous but the activation is
asynchronous. So before flights can be added, the regulation needs to have been
activated in the system. A typical client will poll until the regulationState has
become active, before forcing flights or requesting flightlists onMeasure. In
simulation context the creation of the regulation is completely synchronous.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the regulation needs to be created.

b. Regulation regulation (Mandatory)

The filed regulation.

i. Constraints:

▪ RegulationCreationRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

ii. Access control:

▪ set regulation.measureCherryPick=true requires write access to

/regulations?cherry_pick=true
▪ set regulation.measureCherryPick=false requires write access to
/regulations?cherry_pick=false
▪ set regulation.mcdmTopicRequired=true requires write access to /mcdmTopics

c. boolean computeNetworkImpactAssessment (Optional)

In simulation dataset, indicates if the network impact assesment needs to be computed (see
NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/neworkInpactAssessments
3. Constraints:

a. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid regulation (measure) applicability period should overlap Dataset period

Constrained attributes: regulation

Constrained requests: any using request

Edition: 27.0 6 1251

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.4.2.2. RegulationCreationReply

<<class>>

Returned in response to RegulationCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. RegulationCreationReplyData data (Optional)

The reply payload.

20.4.4.3. RegulationUpdateRequest/Reply

Edition: 27.0 6 1252

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RegulationUpdateRequest

Reply: RegulationUpdateReply

Response time: 940 / 1400 / 1800 (ms)

Default settings: request count quotas

SOAP operation:

RegulationUpdateReply updateRegulation(RegulationUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulations

• assert certificate write access to /regulations?cherry_pick=true

if updated regulation is cherry pick

• assert certificate write access to /regulations?cherry_pick=false

if updated regulation is non cherry pick

• assert certificate write access to /mcdmTopics

if updated regulation requires MCDM

• assert certificate write access to /networkImpactAssessments

if network assessment computing is requested

(request.computeNetworkImpactAssessment=true)

Updates an existing regulation.

20.4.4.3.1. RegulationUpdateRequest

Edition: 27.0 6 1253

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update (modify) an existing regulation. As a result the regulation will be modified and
all concerned flights will be updated accordingly.

• On OPS platform, the RegulationUpdateRequest is supported on SIMULATION

dataset only.

• On PREOPS platform, the RegulationUpdateRequest is supported on SIMULATION

NOTE
and OPERATIONAL datasets.

• The activation of the updated regulation is asynchronous (See

regulationCreationRequest).

1. Inherits from: Request

Edition: 27.0 6 1254

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the regulation needs to be updated.

b. Regulation regulation (Mandatory)

The regulation fields to be updated.

Note that only those fields that need to be updated, need to be non null. The other fields
simply remain unchanged.

i. Constraints:

▪ RegulationUpdateRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

c. boolean computeNetworkImpactAssessment (Optional)

In simulation dataset, indicates if the network impact assesment needs to be computed (see
NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/networkImpactAssessments
3. Constraints:

a. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid regulation (measure) applicability period should overlap Dataset period

Constrained attributes: regulation

Constrained requests: any using request

20.4.4.3.2. RegulationUpdateReply

<<class>>

Returned in response to RegulationUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. RegulationUpdateReplyData data (Optional)

The reply payload.

20.4.4.4. RegulationCancelRequest/Reply

Edition: 27.0 6 1255

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RegulationCancelRequest

Reply: RegulationCancelReply

Response time: 1100 / 1600 / 2100 (ms)

Default settings: request count quotas

SOAP operation:

RegulationCancelReply cancelRegulation(RegulationCancelRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulations

• assert certificate write access to /regulations?cherry_pick=true

if cancelled regulation is cherry pick

• assert certificate write access to /regulations?cherry_pick=false

if cancelled regulation is non cherry pick

• assert certificate write access to /mcdmTopics

if cancelled regulation requires MCDM

Cancels an existing regulation.

20.4.4.4.1. RegulationCancelRequest

Edition: 27.0 6 1256

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to cancel a regulation. As a result the regulation will be cancelled and all concerned flights
will be updated and de-regulated if no other regulations impact the flight.

• On OPS platform, the RegulationCancelRequest is supported on SIMULATION

dataset only.
NOTE
• On PREOPS platform, the RegulationCancelRequest is supported on SIMULATION
and OPERATIONAL datasets.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the regulation has to be cancelled.

b. RegulationId regulationId (Mandatory)

The identifier of the regulation to be cancelled.

c. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the regulation has to be cancelled.

d. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of the regulation to revoke. The caller shall
always keep this value unchanged.

e. boolean computeNetworkImpactAssessment (Optional)

Edition: 27.0 6 1257

Document Title: NM 27.0 - NM B2B Reference Manual

In simulation dataset, indicates if the network impact assesment needs to be computed (see
NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/networkImpactAssessments

20.4.4.4.2. RegulationCancelReply

<<class>>

Returned in response to RegulationCancelRequest.

1. Inherits from: Reply

2. Attributes:

a. RegulationCancelReplyData data (Optional)

The reply payload.

20.4.4.5. RegulationProposalListRequest/Reply

Edition: 27.0 6 1258

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RegulationProposalListRequest

Reply: RegulationProposalListReply

Response time: 54 / 210 / 320 (ms)

Default settings: request count quotas

SOAP operation:

RegulationProposalListReply queryRegulationProposals(RegulationProposalListRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulationProposals

• assert certificate read access to /mcdmTopics

if RegulationProposalField.mcdmRequired is requested

• assert certificate read access to /scenarios

if RegulationProposalField.scenarioReference is requested

Queries regulation proposals.

20.4.4.5.1. RegulationProposalListRequest

Edition: 27.0 6 1259

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query regulation proposals.

Regulation proposals are proposals to NM for creation/modification/cancellation of a regulation.

Regulation proposals do not impact any flights directly.

Edition: 27.0 6 1260

Document Title: NM 27.0 - NM B2B Reference Manual

There are 2 types of regulation proposals : Those that support proposal flights and those that do not.

Regulation proposals without proposal flights are basically filled in template for NM to
accept/reject.

Regulation proposals with proposal flights are cherry picked regulations (with initially no flights
forced). When the users delays some flights, the real flight do not get delayed. Instead proposal
flights are created that are reflected in the (with includeProposalFlights ) flightlist and counts.

NM can accept or reject a regulation proposal. If a proposal is rejected (MCDMApprovalState.REJECTED)

or interrupted (MCDMState.INTERRUPTED), the user can refile a new proposal. When NM accepts a
regulation creation proposal (optionally modifying some attributes:a.o. regulationId), then a real
regulation is created (retrievable via the RegulqtionListrequest) and the regulation proposal has its
MCDMApprovalState set to ACCEPTED and MCDMState set to IMPLEMENTED). When NM accepts a regulation
modification/cancellation proposal (optionally modifying some attributes), then the real regulation
is modified/cancelled.

1. Inherits from: RegulationOrMCDMOnlyListRequest

2. Attributes:

a. set< RegulationProposalField > requestedRegulationProposalFields (Mandatory)

The reply returns only the requested regulation proposal fields in this set, and only if the
values of these requested fields are available at NM. Note that the regulation proposal id is
always returned.

b. set< MCDMApprovalState > approvalStates (Optional)

Selects the regulation proposals with a NMOC approval state that matches an entry in this
set.

By default, regulation proposals are selected regardless to their state.

i. Constraints:

▪ set size range : [1, unbounded[

20.4.4.5.2. RegulationProposalListReply

Edition: 27.0 6 1261

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Edition: 27.0 6 1262

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to RegulationProposalListRequest.

See RegulationOrMCDMOnlyListReplyData.

1. Inherits from: Reply

2. Attributes:

a. RegulationProposalListReplyData data (Optional)

The reply payload.

20.4.4.6. RegulationProposalFilingRequest/Reply

MEP: S-R/R

Request: RegulationProposalFilingRequest

Reply: RegulationProposalFilingReply

Response time: 280 / 400 / 690 (ms)

Default settings: request count quotas

SOAP operation:

RegulationProposalFilingReply
fileRegulationProposal(RegulationProposalFilingRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulationProposals

• assert certificate write access to /regulationProposals?cherry_pick=true

if proposed regulation is cherry pick (request.proposal.measureCherryPick=true)

• assert certificate write access to /regulationProposals?cherry_pick=false

if proposed regulation is non cherry pick (request.proposal.measureCherryPick=false)

• assert certificate write access to /mcdmTopics

if proposed regulation requires MCDM (request.proposal.mcdmRequired=true)

Edition: 27.0 6 1263

Document Title: NM 27.0 - NM B2B Reference Manual

Files a new regulation proposal.

20.4.4.6.1. RegulationProposalFilingRequest

<<class>>

Request to file a proposal to create a regulation or to file a proposal to update a regulation (non-
proposal regulation from a RegulationListRequest) or to file a proposal to cancel a regulation (non-
proposal regulation from a RegulationListRequest).

Edition: 27.0 6 1264

Document Title: NM 27.0 - NM B2B Reference Manual

When NMOC accepts the proposal, the end result corresponds to a:

• RegulationCreationRequest

• RegulationUpdateRequest

• RegulationCancelRequest

See also RegulationProposalListRequest.

Edition: 27.0 6 1265

Document Title: NM 27.0 - NM B2B Reference Manual

• The creation of the cherry picked regulations is synchronous but the activation
is asynchronous. So before flights can be added, the regulation needs to have
been activated in the system. A typical client will poll until the regulationState
has become active, before adding flights or requesting flightlists on Measure.

• If there is already a proposal regulation that has not been accepted, nor rejected
by NMOC, then RegulationProposalFilingRequest is not to be used. Instead
RegulationProposalUpdateRequest or RegulationProposalRevocationRequest should
be used.

• There are limitation on the number of proposal regulations that can be

requested per day: See Overload protections.

• Once a proposal regulation has been accepted by NMOC, it becomes visible in

the RegulationListReply. Before it is only visible in the
RegulationProposalListRequest. When a proposal is filed to update a regulation,
then this regulation remains unchanged and visible in the
RegulationListRequest. The proposal itself becomes visible via the
RegulationProposalListRequest (or the previously accepted or rejected proposal
is replaced with the new proposal for the RegulationProposalListRequest).

• ACTION=CREATION is only allowed if no (non-proposal) regulation exists yet (via

RegulationListReply) with that regulationId.
NOTE • ACTION=UPDATE is only allowed if a (non-proposal) regulation already exists (via
RegulationListReply) with that regulationId.

• ACTION=CANCELLATION is supported for CherryPicked regulations but only as a

RegulationProposalWithoutProposalFlights (meaning there is no possibility to
see the what-if proposal flights before submitting to NM for approval).

• When creating a proposal regulation, the reason hotspot can be passed inside
the RegulationProposal to indicate the original hotspot that will be solved via the
proposal regulation. This does not imply that this hotspot needs to exist in NM
systems as a hotspot object, nor that the hotspot will be created automatically by
NM systems, nor that the B2B client should first create the hotspot nor that the
B2B client needs to keep the hotspot field updated at all times. The hotspot field
is only for informational awareness and can guide different actors in their
decision process.

• The regulationIds used when filing a RegulationProposal in an operational

context are subject to extra rules (the regulationId naming convention
containing a.o. how to shorten the TrafficVolumeId to be included in the
regulationId).

• There is detailed B2B client documentation about proposal regulations via B2B
(cherry picked regulation and normal regulations) describing the workflows in
detail.

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 1266

Document Title: NM 27.0 - NM B2B Reference Manual

a. Dataset dataset (Mandatory)

Dataset on which the regulation proposal is filed.

See Forecast and Operational Datasets.

b. RegulationProposal proposal (Mandatory)

The regulation proposal to be filled.

Note that only those fields that need to be updated, need to be non null. The other fields
simply remain unchanged.

i. Constraints:

▪ RegulationProposalFilingRequest.INVALID_ACTION

▪ RegulationProposalFilingRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

▪ RegulationProposalFilingRequest.SUPPLEMENTARY_RATES_PROVISION

ii. Access control:

▪ set proposal.measureCherryPick=true requires write access to

/regulationProposals?cherry_pick=true
▪ set proposal.measureCherryPick=false requires write access to
/regulationProposals?cherry_pick=false
▪ set proposal.mcdmTopicRequired=true requires write access to /mcdmTopics

c. PlanDataId normalRegulationDataId (Optional)

Documentation last updated: 27.0 - Edition 1

In case it concerns a proposal to update/cancel an existing regulation, then

normalRegulationDataId must contain the dataId of that regulation (i.e. the dataId returned in
the RegulationListRequest for the regulation with the same proposal.regulationId).

See Update pattern.

i. Constraints:

▪ RegulationProposalFilingRequest.INVALID_NORMAL_REGULATION_DATA_ID_VALUE

3. Constraints:

a. INVALID_ACTION

When creating or updating a normal (non cherry picked regulation), proposal.kind needs to
be RegulationProposalWithoutProposalFlights.

Cancelling a regulation (cherry picked or not), is only supported for proposal.kind ==

RegulationProposalWithoutProposalFlights.

Constrained attributes: proposal

Edition: 27.0 6 1267

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

b. INVALID_NORMAL_REGULATION_DATA_ID_VALUE

From regulationProposal.action value, the normalRegulationDataId field can take different

values as follows:

1. if the regulation proposal action is set as CREATION then the normalRegulationDataId must
be null

2. if the regulation proposal action is set as UPDATE then the normalRegulationDataId cannot
be null

3. if the regulation proposal action is set as CANCELLATION then the normalRegulationDataId

cannot be null

Constrained attributes: normalRegulationDataId

Constrained requests: any using request

c. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid proposal (measure) applicability period should overlap Dataset period

Constrained attributes: proposal

Constrained requests: any using request

d. SUPPLEMENTARY_RATES_PROVISION

The proposal.supplementaryConstraints shall be null if proposal.action != UPDATE.

Constrained attributes: proposal

Constrained requests: any using request

20.4.4.6.2. RegulationProposalFilingReply

Edition: 27.0 6 1268

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to RegulationProposalFilingRequest.

Special error conditions:

1. INVALID_DATASET [Temporary error] If the FORECAST update was rejected due to D-1 forecast
update cut-off or if the OPERATIONAL update was rejected due to D-1 plan not transferred yet.

2. CONFLICTING_UPDATE [Permanent error] If the update failed due to incompatible concurrent

changes.

3. OBJECT_NOT_FOUND [Permanent error] If the Traffic Volume is not known.

4. Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : action=CREATE for a regulation
proposal when there is already a normal (non-proposal) regulation with that regulationId.

1. Inherits from: Reply

2. Attributes:

a. RegulationProposalFilingReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1269

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.4.7. RegulationProposalUpdateRequest/Reply

MEP: S-R/R

Request: RegulationProposalUpdateRequest

Reply: RegulationProposalUpdateReply

Response time: 280 / 630 / 800 (ms)

Default settings: request count quotas

SOAP operation:

RegulationProposalUpdateReply
updateRegulationProposal(RegulationProposalUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulationProposals

• assert certificate write access to /regulationProposals?cherry_pick=true

if proposed regulation is cherry pick

• assert certificate write access to /regulationProposals?cherry_pick=false

if proposed regulation is non cherry pick

• assert certificate write access to /mcdmTopics

if proposed regulation requires MCDM

Updates an existing regulation proposal.

20.4.4.7.1. RegulationProposalUpdateRequest

Edition: 27.0 6 1270

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update a filed regulation proposal before it has been accepted, nor rejected by NMOC.

The B2B client has filed a regulation proposal but he changed his mind (or the solution was not
sufficient enough after evaluating the proposal counts and flightlists) and the B2B client wants to
make some changes before NMOC starts reviewing the proposal regulation.

Edition: 27.0 6 1271

Document Title: NM 27.0 - NM B2B Reference Manual

• The creation of the cherry picked regulations is synchronous but the activation
is asynchronous. So before flights can be added, the regulation needs to have
been activated in the system. A typical client will poll until the regulationState
has become active after a RegulationProposalUpdateRequest, before adding
flights or requesting flightlists on Measure.

• If there is no proposal regulation or the proposal regulation has already been

acknowledged, accepted or rejected by NMOC, then
NOTE
RegulaRegulationProposalUpdateRequest is not to be used (so it is only allowed if
MCDMState is DRAFT or PROPOSED). Instead RegulationProposalFilingRequest should
be used. For RegulationProposalWithProposalFlights,
RegulationProposalUpdateRequest is only allowed if the regulationState is
APPLIED.

• In RegulationProposalUpdateRequest, RegulationProposalKind is immutable (w.r.t.

RegulationProposalKind from the RegulationProposalFilingRequest).

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the regulation proposal is updated.

See Forecast and Operational Datasets.

b. RegulationProposal proposal (Mandatory)

The regulation proposal fields to be updated.

i. Constraints:

▪ RegulationProposalUpdateRequest.INVALID_ACTION

▪ RegulationProposalUpdateRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

▪ RegulationProposalUpdateRequest.SUPPLEMENTARY_RATES_PROVISION

3. Constraints:

a. INVALID_ACTION

The value for proposal.action should be set to CREATION when proposal.kind is

RegulationProposalWithProposalFlights.

Constrained attributes: proposal

Constrained requests: any using request

b. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid proposal (measure) applicability period should overlap Dataset period

Constrained attributes: proposal

Edition: 27.0 6 1272

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

c. SUPPLEMENTARY_RATES_PROVISION

The proposal.supplementaryConstraints shall be null if proposal.action != UPDATE.

Constrained attributes: proposal

Constrained requests: any using request

20.4.4.7.2. RegulationProposalUpdateReply

<<class>>

Returned in response to RegulationProposalUpdateRequest.

Special error conditions:

1. INVALID_DATASET [Temporary error] If the FORECAST update was rejected due to D-1 forecast
update cut-off or if the OPERATIONAL update was rejected due to D-1 plan not transferred yet.

2. CONFLICTING_UPDATE [Permanent error] If the update failed due to incompatible concurrent

changes.

3. OBJECT_NOT_FOUND [Permanent error] If the Traffic Volume is not known.

Edition: 27.0 6 1273

Document Title: NM 27.0 - NM B2B Reference Manual

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : trying to change the regulation from
cherry picked to non cherry picked or the other way around.

1. Inherits from: Reply

2. Attributes:

a. RegulationProposalUpdateReplyData data (Optional)

The reply payload.

20.4.4.8. RegulationProposalRevocationRequest/Reply

MEP: S-R/R

Request: RegulationProposalRevocationRequest

Reply: RegulationProposalRevocationReply

Response time: 260 / 500 / 810 (ms)

Default settings: request count quotas

SOAP operation:

RegulationProposalRevocationReply
revokeRegulationProposal(RegulationProposalRevocationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulationProposals

Revokes an existing regulation propposal.

20.4.4.8.1. RegulationProposalRevocationRequest

Edition: 27.0 6 1274

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to revoke a regulation proposal.

The B2B client has filed a regulation proposal but he changed his mind and wants to undo: remove
the proposal.

For example: if the B2B client has filed a regulation proposal and it has been accepted by NMOC,
and afterwards the B2B client adds or changes some flights, then a revoke will simply remove this
new proposal but leaves the already accepted regulation and flights unchanged. Note that
RegulationProposalFilingRequest with ACTION=CANCELLATION is a proposal to cancel a regulation.
So when the cancellation is accepted it will update and de-regulate the already accepted flights.

• Revoking a never applied cherry pick regulation, results in cancelling the

proposal regulation (so the regulationId can no longer be re-used in other
proposal regulations). The cancellation of a cherry picked regulation is is
asynchronous. So it can take some times (typically a few seconds) before all
flights are de-regulated and the regulation state becomes cancelled.

NOTE • If there is no proposal regulation or the proposal regulation has already been
acknowledged, accepted or rejected by NMOC, then
RegulaRegulationProposalRevocationRequest is not to be used (so it is only
allowed if MCDMState is DRAFT or PROPOSED). Instead
RegulationProposalFilingRequest should be used. For
RegulationProposalWithProposalFlights, RegulationProposalRevocationRequest is
only allowed if the regulationState is APPLIED.

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 1275

Document Title: NM 27.0 - NM B2B Reference Manual

a. Dataset dataset (Mandatory)

Dataset on which the regulation proposal has to be revoked.

See Forecast and Operational Datasets.

b. RegulationId regulationId (Mandatory)

The id of the regulation for which this proposal is to be revoked.

c. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the proposal is to be revoked.

i. Constraints:

▪ RegulationProposalRevocationRequest.INVALID_DAY_OF_OPERATION

d. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of the regulation proposal to revoke. The caller
shall always keep this value unchanged.

See Update pattern.

e. string remark (Optional)

Updated remark field of the proposal. The client can indicate the reason for the revocation
to NM.

f. boolean forceDelete (Optional) (new 27.0)

If set to true, the draft regulation is cancelled then deleted.

By default, the NM B2B assumes the value is false. The draft regulation is cancelled but not
deleted.

The purpose of the forceDelete flag is to allow the re-using of

regulation identifiers. However, by forcing the deletion of a draft
IMPORTANT
regulation, the client application also forces the deletion of its
associated MCDM.

3. Constraints:

a. INVALID_DAY_OF_OPERATION

Invalid dayOfOperation should be within Dataset period -1 day(yesterday including)

Constrained attributes: dayOfOperation

Constrained requests: any using request

Edition: 27.0 6 1276

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.4.8.2. RegulationProposalRevocationReply

<<class>>

Returned in response to RegulationProposalRevocationRequest.

Special error conditions:

1. INVALID_DATASET [Temporary error] If the FORECAST update was rejected due to D-1 forecast
update cut-off or if the OPERATIONAL update was rejected due to D-1 plan not transferred yet.

2. CONFLICTING_UPDATE [Permanent error] If the update failed due to incompatible concurrent

changes.

3. OBJECT_NOT_FOUND [Permanent error] If the proposal regulation is not known.

4. Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : trying to revoke a proposal regulation
that has already been acknowledged (MCDMState = COORDINATED).

1. Inherits from: Reply

2. Attributes:

a. RegulationProposalRevocationReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1277

Document Title: NM 27.0 - NM B2B Reference Manual

20.4.4.9. ReroutingListRequest/Reply

MEP: S-R/R

Request: ReroutingListRequest

Reply: ReroutingListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingListReply queryReroutings(ReroutingListRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /reroutings

• assert certificate read access to /mcdmTopics

if ReroutingField.mcdmRequired is requested

• assert certificate read access to /scenarios

if ReroutingField.scenarioReference is requested

Queries reroutings.

20.4.4.9.1. ReroutingListRequest

Edition: 27.0 6 1278

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query reroutings.

Reroutings are measures to level cap or reroute flights to avoid an airspace/point or to find
shorter/cheaper routes. Typically they are used for ATFCM reasons (for example to avoid a zero rate
regulation) or for STAM or for Flight Efficiency or to handle forecast expected flows (for example
NAT traffic).

Rerouting can either create a proposal flight (containing a proposed route) or they can modify the
FTFM/RTFM point profile directly (used in forecast and simulations) or they can generate proposed
routes in operational log messages.

1. Inherits from: MeasureListRequest

2. Attributes:

a. set< ReroutingIdWildcard > reroutings (Optional)

Edition: 27.0 6 1279

Document Title: NM 27.0 - NM B2B Reference Manual

The set of rerouting ids or wildcards

if specified, the reply returns only the requested reroutings.

The logical OR operator is meant between the items in the set.

i. Constraints:

▪ set size range : [1, 100]

b. set< ReroutingField > requestedReroutingFields (Mandatory)

The reply returns only the requested rerouting fields in this set, and only if the values of
these requested fields are available at NM. Note that the rerouting id is always returned.

c. set< ReroutingMeasureState > reroutingStates (Optional)

Selects the reroutings with a state that matches an entry in this set.

By default, reroutings are selected regardless to their state.

i. Constraints:

▪ set size range : [1, unbounded[

20.4.4.9.2. ReroutingListReply

<<class>>

Returned in response to ReroutingListRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingListReplyData data (Optional)

The reply payload.

20.4.4.10. ReroutingCreationRequest/Reply

Edition: 27.0 6 1280

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ReroutingCreationRequest

Reply: ReroutingCreationReply

Response time: 1900 / 1900 / 1900 (ms)

Default settings: request count quotas

SOAP operation:

ReroutingCreationReply createRerouting(ReroutingCreationRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /reroutings

• assert certificate write access to /reroutings?cherry_pick=false

if created rerouting is non cherry pick (request.rerouting.measureCherryPick=false)

• assert certificate write access to /flights

if created rerouting is for execution (request.rerouting.reroutingApplyKind=EXECUTE)

• assert certificate write access to /flights?proposal=true

if created rerouting is for indication with proposal creation

(request.rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP|INDICATION_WITH_AUT
OMATIC_RRN)

• assert certificate write access to /flights/messages/rrp

if created rerouting is for indication with RRP message sending

(request.rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP)

• assert certificate write access to /flights/messages/rrn

if created rerouting is for indication with RRN message sending

(request.rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRN)

• assert certificate write access to /mcdmTopics

if created rerouting requires MCDM

• assert certificate write access to /networkImpactAssessments

if network assessment computing is requested

Edition: 27.0 6 1281

Document Title: NM 27.0 - NM B2B Reference Manual

(request.computeNetworkImpactAssessment=true)

Creates a new rerouting.

20.4.4.10.1. ReroutingCreationRequest

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to create a rerouting.

Edition: 27.0 6 1282

Document Title: NM 27.0 - NM B2B Reference Manual

On OPS and PREOPS platforms:

• The ReroutingCreationRequest is supported on SIMULATION dataset without

further constraints.

• The ReroutingCreationRequest is supported on OPERATIONAL and FORECAST

NOTE datasets only if a scenario reference is provided as described in the Operational
Instruction or in the ATFCM Operations Manual.

The creation of the rerouting is synchronous (both on in a simulation context and a

operationel/forecast contect). A client application can immediately after this reply,
add flights to the rerouting.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the rerouting needs to be created.

b. Rerouting rerouting (Mandatory)

The rerouting that is going to be created.

i. Constraints:

▪ ReroutingCreationRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

ii. Access control:

▪ set rerouting.measureCherryPick=false requires write access to

/regulations?cherry_pick=false
▪ set rerouting.reroutingApplyKind=EXECUTE requires write access to /flights

▪ set
rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP|INDICATION_WITH_AUTOMA
TIC_RRN requires write access to /flights?proposal=true

▪ set rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP requires write

access to /flights/messages/rrp

▪ set rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRN requires write

access to /flights/messages/rrn

▪ set rerouting.mcdmTopicRequired=true requires write access to /mcdmTopics

c. boolean computeNetworkImpactAssessment (Optional)

In simulation dataset, indicates if the networkImpactAssesment needs to be computed (see

NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/networkImpactAssessments

Edition: 27.0 6 1283

Document Title: NM 27.0 - NM B2B Reference Manual

3. Constraints:

a. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid rerouting (measure) applicability period should overlap Dataset period

Constrained attributes: rerouting

Constrained requests: any using request

20.4.4.10.2. ReroutingCreationReply

<<class>>

Returned in response to ReroutingCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingCreationReplyData data (Optional)

The reply payload.

20.4.4.11. ReroutingUpdateRequest/Reply

Edition: 27.0 6 1284

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ReroutingUpdateRequest

Reply: ReroutingUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ReroutingUpdateReply updateRerouting(ReroutingUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /reroutings

• assert certificate write access to /reroutings?cherry_pick=false

if updated rerouting is non cherry pick

• assert certificate write access to /flights

if updated rerouting is for execution

• assert certificate write access to /flights?proposal=true

if updated rerouting is for indication with proposal creation

• assert certificate write access to /flights/messages/rrp

if updated rerouting is for indication with RRP message sending

• assert certificate write access to /flights/messages/rrn

if updated rerouting is for indication with RRN message sending

• assert certificate write access to /mcdmTopics

if updated rerouting is associated to a MCDM topic

• assert certificate write access to /networkImpactAssessments

if network assessment computing is requested

(request.computeNetworkImpactAssessment=true)

Edition: 27.0 6 1285

Document Title: NM 27.0 - NM B2B Reference Manual

Updates an existing rerouting.

20.4.4.11.1. ReroutingUpdateRequest

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to update (modify) an existing rerouting.

Edition: 27.0 6 1286

Document Title: NM 27.0 - NM B2B Reference Manual

On OPS and PREOPS platforms:

• The ReroutingUpdateRequest is supported on SIMULATION dataset without

further constraints.

NOTE • The ReroutingUpdateRequest is supported on OPERATIONAL and FORECAST

datasets only if a scenario reference is provided as described in the Operational
Instruction or in the ATFCM Operations Manual.

The update of a rerouting is synchronous. (See rerouting creation request). A client

application can immediately after this reply, add flights.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the rerouting needs to be updated.

i. Access control:

▪ set rerouting.reroutingApplyKind=EXECUTE requires write access to /flights

▪ set
rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP|INDICATION_WITH_AUTOMA
TIC_RRN requires write access to /flights?proposal=true

▪ set rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRP requires write

access to /flights/messages/rrp

▪ set rerouting.reroutingApplyKind=INDICATION_WITH_AUTOMATIC_RRN requires write

access to /flights/messages/rrn

b. Rerouting rerouting (Mandatory)

The rerouting fields to be updated.

Note that only those fields that need to be updated, need to be non null. The other fields
simply remain unchanged.

i. Constraints:

▪ ReroutingUpdateRequest.INVALID_MEASURE_APPLICABILITY_PERIOD

c. boolean computeNetworkImpactAssessment (Optional)

In simulation dataset, indicates if the network impact assesment needs to be computed (see
NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/networkImpactAssessments
3. Constraints:

Edition: 27.0 6 1287

Document Title: NM 27.0 - NM B2B Reference Manual

a. INVALID_MEASURE_APPLICABILITY_PERIOD

Invalid rerouting (measure) applicability period should overlap Dataset period

Constrained attributes: rerouting

Constrained requests: any using request

20.4.4.11.2. ReroutingUpdateReply

<<class>>

Returned in response to ReroutingUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingUpdateReplyData data (Optional)

The reply payload.

20.4.4.12. ReroutingCancelRequest/Reply

Edition: 27.0 6 1288

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ReroutingCancelRequest

Reply: ReroutingCancelReply

Response time: 910 / 910 / 910 (ms)

Default settings: request count quotas

SOAP operation:

ReroutingCancelReply cancelRerouting(ReroutingCancelRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /reroutings

• assert certificate write access to /reroutings?cherry_pick=false

if cancelled rerouting is non cherry pick

• assert certificate write access to /flights

if cancelled rerouting is for execution

• assert certificate write access to /flights?proposal=true

if cancelled rerouting is for indication with proposal creation

• assert certificate write access to /flights/messages/rrp

if cancelled rerouting is for indication with RRP message sending

• assert certificate write access to /flights/messages/rrn

if cancelled rerouting is for indication with RRN message sending

Cancels an existing rerouting.

20.4.4.12.1. ReroutingCancelRequest

Edition: 27.0 6 1289

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to cancel a rerouting. Undo the effect on the flights.

On OPS and PREOPS platforms:

• The ReroutingCancelRequest is supported on SIMULATION dataset without

NOTE further constraints.

• The ReroutingCancelRequest is supported on OPERATIONAL and FORECAST

datasets only if a scenario reference is provided as described in the Operational
Instruction or in the ATFCM Operations Manual.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the rerouting proposal has to be cancelled.

b. ReroutingId reroutingId (Mandatory)

The identifier of the rerouting to be cancelled.

c. DateYearMonthDay dayOfOperation (Mandatory)

Day for which the rerouting has to be cancelled.

d. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of the rerouting to revoke. The caller shall
always keep this value unchanged.

Edition: 27.0 6 1290

Document Title: NM 27.0 - NM B2B Reference Manual

e. boolean computeNetworkImpactAssessment (Optional)

In simulation dataset, indicates if the network impact assesment needs to be computed (see
NetworkImpactAssessmentRetrievalRequest).

i. Access control:

▪ set computeNetworkImpactAssessment=true requires write access to

/networkImpactAssessments

20.4.4.12.2. ReroutingCancelReply

<<class>>

Returned in response to ReroutingCancelRequest.

1. Inherits from: Reply

2. Attributes:

a. ReroutingCancelReplyData data (Optional)

The reply payload.

20.4.4.13. MeasureOpLogRetrievalRequest/Reply

Edition: 27.0 6 1291

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: MeasureOpLogRetrievalRequest

Reply: MeasureOpLogRetrievalReply

Response time: 160 / 990 / 1200 (ms)

Default settings: request count quotas

SOAP operation:

MeasureOpLogRetrievalReply retrieveMeasureOpLog(MeasureOpLogRetrievalRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /regulations

if target measure is a regulation

• assert certificate read access to /reroutings

if target measure is a rerouting

Retrieves the operational logs of a measure.

20.4.4.13.1. MeasureOpLogRetrievalRequest

Edition: 27.0 6 1292

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to retrieve operational logs of a particular measure.

For a rerouting, the returned operational logs contain the global results of the rerouting
(considering all rerouted and non rerouted flights):

1. The network impact: additional or avoided regulations, violated restrictions if no good solution
could be found, the important traffic volumes where there is a change (i.e. those traffic volumes
that are overloaded/have a peak/sustained traffic counts alert)

2. The complete set of impacted On-Loaded/Off-loaded sectors

3. For the unsuccessfully rerouted flights: the reason why they could not be rerouted

4. For the successfully rerouted flights: the additional /gained distance/fuel/time

5. Per rerouted flight: the rerouting result, a.o., did the flight reroute according to the proposed
route or not

For a cherry picked regulation: it contains per flight the network impact of the delay

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the measure operational logs are requested.

Edition: 27.0 6 1293

Document Title: NM 27.0 - NM B2B Reference Manual

b. MeasureId measureId (Mandatory)

Measure id for which the operational logs must be retrieved.

20.4.4.13.2. MeasureOpLogRetrievalReply

<<class>>

Returned in response to MeasureOpLogRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. MeasureOpLogRetrievalReplyData data (Optional)

The reply payload.

20.4.4.14. UpdateFlightsInMeasureRequest/Reply

Edition: 27.0 6 1294

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: UpdateFlightsInMeasureRequest

Reply: UpdateFlightsInMeasureReply

Response time: 1600 / 1600 / 1600 (ms)

Default settings: request count quotas

SOAP operation:

UpdateFlightsInMeasureReply updateFlightsInMeasure(UpdateFlightsInMeasureRequest
request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /flights#ctot

if one of the flight updates is 'forceFlightInRegulation', 'unforceFlightInRegulation'

• assert certificate write access to /regulations#excluded_flights

if one of the flight update is 'excludeFlightInRegulation' or

'reincludeFlightInRegulation'

• assert certificate write access to /reroutings#captured_flights

if one of the flight update is 'addFlightToRerouting' or 'removeFlightFromRerouting'

Adds, removes or updates flights in a measure. For example it updats the CTOT of a flight for a
regulation.

20.4.4.14.1. UpdateFlightsInMeasureRequest

Edition: 27.0 6 1295

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to add/remove/modify flights in a measure (for example: change the CTOT of a flight for a
regulation).

This service acts directly on the flights. As such it is only available in simulation context/dataset.
Only for specific trials (e.g. rerouting related) it is allowed to be used on the operation/forecast
dataset (authorization controlled). Create proposal to NMOC to accept is done via
createEhelpdeskTicket service. To create proposal flights on the server (to be able to evaluate the
impact on counts etc.), proposal flights can be created on the server with createEhelpdeskTicket
service with subtype ForceFlightsInRegulation (for FMP to propose to NM to force a flight).

For a cherry picked measure, forceFlightInRegulation allows to initially associate the flight to a
measure (and give or change the CTOT) or afterwards add additional flights or modify already
added flights. For a cherry picked measure unforceFlightInRegulation allows to unforce ("remove")
a forced flight from a regulation (becomes exempted again).

Edition: 27.0 6 1296

Document Title: NM 27.0 - NM B2B Reference Manual

Cherry picked regulation context

• Flights should not be ATC_ACTIVATED yet. Flights can be only be added if they
have the ETO (expected time over according to FTFM) or ATO (actual time
over according to CTFM: e.g. for TACT_ACTIVATED flights due to DPI) inside the
regulation period.

• The forceFlightInRegulation results in an updated regulation proposal

applicability period if the regulation period needs to be extended or reduced
(See ATFCM reference manual). In that case the B2B client needs to wait until
the regulationActivity is APPLIED again before doing any subsequent
UpdateFlightsInMeasureRequest.

NOTE On OPS platform

• All subtypes are supported on SIMULATION dataset.

• The addFlightToRerouting and removeFlightFromRerouting subtypes are also

supported on OPERATIONAL and FORECAST datasets.

On PREOPS platform
• All subtypes are supported on SIMULATION datasets.

• The addFlightToRerouting and removeFlightFromRerouting subtypes are also

supported on OPERATIONAL and FORECAST dataset.

• Other subtypes are supported on OPERATIONAL datasets but are subjected to

prior coordination with NM Customer Support.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset in which the flights need to be updated in one or more measures.

See Forecast and Operational Datasets.

i. Constraints:

▪ UpdateFlightsInMeasureRequest.UPDATE_FLIGHTS_IN_REROUTING

b. set< UpdateFlightInMeasure > flights (Mandatory)

Flights to be updated in one or more measures.

i. Constraints:

▪ set size range : [1, 100]

▪ UpdateFlightsInMeasureRequest.UPDATE_FLIGHTS_IN_REROUTING

3. Constraints:

a. UPDATE_FLIGHTS_IN_REROUTING

Edition: 27.0 6 1297

Document Title: NM 27.0 - NM B2B Reference Manual

flights may contain UpdateFlightInMeasure 's of kind addFlightToRerouting or

removeFlightFromRerouting only if dataset.type equals SIMULATION.

Constrained attributes: dataset, flights

Constrained requests: any using request

20.4.4.14.2. UpdateFlightsInMeasureReply

<<class>>

Returned in response to UpdateFlightsInMeasureRequest.

1. Inherits from: Reply

2. Attributes:

a. UpdateFlightsInMeasureReplyData data (Optional)

The reply payload.

20.4.4.15. SimulationMeasureRevertRequest/Reply

Edition: 27.0 6 1298

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SimulationMeasureRevertRequest

Reply: SimulationMeasureRevertReply

Response time: not available

Default settings: request count quotas

SOAP operation:

SimulationMeasureRevertReply
revertSimulationMeasure(SimulationMeasureRevertRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /regulations

if reverted measure is a regulation

• assert certificate write access to /reroutings

if reverted measure is a rerouting

Reverts a measure to its initial simulation state.

20.4.4.15.1. SimulationMeasureRevertRequest

Edition: 27.0 6 1299

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to revert a measure to its initial/start simulation state (undoing any changes made in the
simulation to that measure).

Note that it can occur that a regulation creation/modification, triggers changes in the order of
slot_issued flights in the regulation slots of other regulations (for flights captured by multiple
regulations). A SimulationMeasureRevertRequest will not always undo those (CTOT) changes. A
SimulationResetRequest will undo all effects (direct and indirect). So the
SimulationMeasureRevertRequest is to be considered more of an undo of a change/typo, while the
SimulationResetRequest is to reset everyhting exactly as it was at the start of a simul.

1. Inherits from: Request

2. Attributes:

a. Dataset simulation (Mandatory)

The dataset of the UserManagedSimulation in which the measure must be reverted.

i. Constraints:

▪ SimulationMeasureRevertRequest.INVALID_DATASET_TYPE

▪ SimulationMeasureRevertRequest.INVALID_SIMULATION_STATE

▪ SimulationMeasureRevertRequest.INVALID_SIMULATION_TYPE

b. MeasureId measureId (Mandatory)

The identifier of the measure that needs to be reverted to its initial simulation state.

i. Constraints:

▪ SimulationMeasureRevertRequest.INVALID_MEASURE_TYPE

3. Constraints:

a. INVALID_DATASET_TYPE

The simulation.type must be set to SIMULATION.

Constrained attributes: simulation

Constrained requests: any using request

b. INVALID_SIMULATION_STATE

The simulation.state must be set to CURRENT.

Constrained attributes: simulation

Constrained requests: any using request

Edition: 27.0 6 1300

Document Title: NM 27.0 - NM B2B Reference Manual

c. INVALID_SIMULATION_TYPE

The simulation.simulationIdentifier.simulationType must be set to USER_MANAGED_SIMULATION.

Constrained attributes: simulation

Constrained requests: any using request

d. INVALID_MEASURE_TYPE

The measureId must be a REGULATION.

Constrained attributes: measureId

Constrained requests: any using request

20.4.4.15.2. SimulationMeasureRevertReply

<<class>>

Returned in response to SimulationMeasureRevertRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationMeasureRevertReplyData data (Optional)

The reply payload.

20.4.4.16. ATFCMSituationRequest/Reply

Edition: 27.0 6 1301

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ATFCMSituationRequest

Reply: ATFCMSituationReply

Response time: 1 / 8 / 190 (ms)

Default settings: request count quotas

SOAP operation:

ATFCMSituationReply retrieveATFCMSituation(ATFCMSituationRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /atfcmSituations

Retrieves the ATFCM situation of a given day.

20.4.4.16.1. ATFCMSituationRequest

<<class>>

Request to retrieve the ATFCM situation of a given day.

Edition: 27.0 6 1302

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset from which the ATFCM situation must be retrieved.

i. Constraints:

▪ ATFCMSituationRequest.INCONSISTENT_DAY_AND_DATASET_TYPE

b. DateYearMonthDay day (Mandatory)

Day for which the ATFCM situation is requested.

i. Constraints:

▪ ATFCMSituationRequest.INCONSISTENT_DAY_AND_DATASET_TYPE

3. Constraints:

a. INCONSISTENT_DAY_AND_DATASET_TYPE

Documentation last updated: 27.0 - Edition 5

Depending on dataset type:

1. day must be in must be in [D-5, D] in a FORECAST context

2. day must be in must be in [D-1, D+3] in an OPERATIONAL context

3. day is not constrained in a SIMULATION context

Constrained attributes: day, dataset

Constrained requests: any using request

20.4.4.16.2. ATFCMSituationReply

<<class>>

Returned in response to ATFCMSituationRequest.

1. Inherits from: Reply

2. Attributes:

a. ATFCMSituationReplyData data (Optional)

The reply payload.

20.4.4.17. NetworkImpactAssessmentRetrievalRequest/Reply

Edition: 27.0 6 1303

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: NetworkImpactAssessmentRetrievalRequest

Reply: NetworkImpactAssessmentRetrievalReply

Response time: 5000 / 22000 / 28000 (ms)

Default settings: request count quotas

SOAP operation:

NetworkImpactAssessmentRetrievalReply
retrieveNetworkImpactAssessment(NetworkImpactAssessmentRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /networkImpactAssessments

Retrieves the Network Impact Assessment for measure (regulation or rerouting) creation,
update or cancellation.

20.4.4.17.1. NetworkImpactAssessmentRetrievalRequest

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to retrieve the NetworkImpactAssessment for:

1. a regulation or rerouting creation/modification/cancellation.

Edition: 27.0 6 1304

Document Title: NM 27.0 - NM B2B Reference Manual

2. a simulation (comparing all the changes done inside the simulation) with the 'INITIAL'
simulation state (see Dataset.simulationState).

3. for a set of EhelpdeskTickets (e.g. evaluate one or more exclude flight from regulations
requests).

When the user e.g. creates a regulation in a simulation the NetworkImpactAssessmentRetrievalRequest

will return a summary of the impact:

1. In terms of delay changes in the directly or indirectly impacted regulations (via a Delta
ATFCMSituation) (See also ATFCMSituationRequest).

2. In terms of count changes in the directly or indirectly impacted traffic volumes (via delta
counts).

3. In terms of impacted(i.e. changed) flights: the changes (a.o. before/after: CTOT, concerned
regulations, IFPS restriction violations)

The user would then typically request to see the detailed counts/flightlists on those impacted traffic
volumes where the B2B client could e.g. show the before and after situation (by doing a
flightlist/count query and showing the delta as returned by the
NetworkImpactAssessmentRetrievalRequest).

The NetworkImpactAssessmentRetrievalRequest returns which traffic volumes are impacted and gives
a summary of the impact. The summary includes the impacted active traffic volumes and the non
impacted active traffic volumes: i.e. traffic volumes/counts that had or have otmv alerts or that
were or are in overload. (if the user is only interrested in the changed counts, it is up to the B2B
client to filter out unnecessary counts/traffic volumes).

In simulation dataset context:

1. Returns the Delta ATFCMSituation (see also ATFCMSituationRequest) comparing the before and
after situation.

2. Returns the relevant active traffic volumes and the delta counts and otmv alerts.

3. Returns the relevant flight changes.

In forecast/operational dataset context:

1. Returns no Delta ATFCMSituation.

2. Returns the relevant count changes in the active traffic volumes comparing normal vs proposal
flights: supporting rerouting with proposal flights and proposal cherry picked regulations (both
with proposal flights). In case of Ehelpdesktickets impact assesment for which there are no
proposal flight involved, the Network Impact assesment is still supported (temporarely a
fake/hidden proposal flight is created in the backend systems).

3. Returns the relevant flight changes (i.e. those are the changed flights)

Note that in simulation context for kind FOR_MEASURE_MODIFICATION, the user needs to have asked
explicitly to computeNetworkImpactAssessment in the regulation/rerouting request. (see e.g.
RegulationCreationRequest).

Edition: 27.0 6 1305

Document Title: NM 27.0 - NM B2B Reference Manual

Note that in simulation context, this operation can take some time (depending on the number of
flights directly and indirectly impacted). It could take ~ 20 seconds to compute.

Note that when evaluating the NetworkImpact for Ehelpdesk tickets, the B2B client still needs to
specify a measure id: only the Ehelpdesktickets concerning that measure will be taken into account.
For example :

1. not yet responded/NMOC_handled (i.e. in draft/proposed/coordinated MCDM states) exclusions

from forMeasure

2. or not yet responded/NMOC_handled slot_improvements/slot_extensions for flights with Most

Penalising regulation forMeasure).

In addition, for e.g. a slot improvement, for the what-if/new CTOT, NM systems will take the
best/optimal CTOT for the network impact assessment. However when NMOC reviews the request,
it is likely that NMOC might actually select a different(i.e. later) CTOT or might even reject some
requests. The same applies for other kinds of Ehelpdesk tickets/requests.

In addition, not all Ehelpdesk tickets are supported: tickets that are not supported for an impact
assessment are ignored when computing the results (currently only exclusion/inclusion,
force/unforce, slot_improvement/slot_extension request types are supported).

Also note that if the B2B client wants to evaluate e.g. a different what-if/new CTO, he can do that via
simulations (by creating a cherry picked regulation and forcing the flight at a different CTOT and
then asking for the network impact assessment for that cherry picked regulation).

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the measure has been created.

Note that to evaluate the network impact of Ehelpdesk Tickets, the B2B client needs to do
this directly on the operational dataset.

i. Constraints:

▪ NetworkImpactAssessmentRetrievalRequest.VALID_FLIGHT_SELECTION

b. MeasureId forMeasure (Optional)

The regulation or rerouting for which to retrieve the NetworkImpactAssessment of the last
creation or modification or cancellation or the measure for which to assess related
EhelpdeskTickets.

i. Constraints:

▪ NetworkImpactAssessmentRetrievalRequest.VALID_FLIGHT_SELECTION

c. NetworkImpactAssessmentKind kind (Mandatory)

Describes the kind of network impact assessment requested: either for the last measure

Edition: 27.0 6 1306

Document Title: NM 27.0 - NM B2B Reference Manual

modification (of forMeasure ) or else for the currently outstanding EhelpdeskTickets (i.e.,
standalone flight MCDM requests/topics in draft/proposed/coordinated MCDM state)
concerning forMeasure. Note that, kind=FOR_EHELPDESK_TICKETS, is not supported in
simulations. Ehelpdesk tickets are best what-if assessed with the latest up-to-date server
data. If one really wants to assess Ehelpdesk Tickets in a simulation (e.g. because specific
CTOT’s need to be evaluated), the B2B client is supposed to

1. First make a dummy modification to the concerned regulation

(RegulationUpdateRequest with computeNetworkImpactAssessment = True) (to store in
NM systems the before situation).

2. Then do the needed force CTOTs(with the new CTOTs to be what-if evaluaed) &
reg_exclusions (for the required flights) : via UpdateFlightsInMeasureRequest.

3. Then request to compute a NIA (via NetworkImpactAssessmentRetrievalRequest) with

kind = FOR_MEASURE_MODIFICATION.

i. Constraints:

▪ NetworkImpactAssessmentRetrievalRequest.VALID_FLIGHT_SELECTION

d. NetworkImpactAssessmentFilter filter (Mandatory)

Filter wrt. returned traffic volumes (and their delta counts).

e. NetworkImpactAssessmentPayload payload (Mandatory)

Payload.

3. Constraints:

a. VALID_FLIGHT_SELECTION

Attribute forMeasure is required if kind is FOR_MEASURE_MODIFICATION or FOR_EHELPDESK_TICKETS.

Otherwise forMeasure shall be null.

Attribute kind can be set to FROM_INITIAL_SIMULATION_STATE only if dataset.type = SIMULATION.

Constrained attributes: dataset, forMeasure, kind

Constrained requests: any using request

20.4.4.17.2. NetworkImpactAssessmentRetrievalReply

<<class>>

Returned in response to NetworkImpactAssessmentRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. NetworkImpactAssessmentRetrievalReplyData data (Optional)

Edition: 27.0 6 1307

Document Title: NM 27.0 - NM B2B Reference Manual

The reply payload.

20.5. Mcdm Port Type

20.5.1. Overview

1. MCDM operations provide requests that aim at managing MCDM coordination:

a. P/S MCDM

b. S-R/R MCDMTopicListRequest/Reply

c. S-R/R MCDMTopicUpdateRequest/Reply

d. S-R/R MCDMStateUpdateRequest/Reply

e. S-R/R EhelpDeskTicketCreationRequest/Reply

f. S-R/R EhelpDeskTicketUpdateRequest/Reply

g. S-R/R EhelpDeskTicketRevocationRequest/Reply

20.5.2. Concepts

20.5.2.1. MCDM Operations

1. The MCDM operations are providing a collaboration facility, which allows coordination between
ATFM actors for the implementation of a measure or individual flight actions (e.g. exclude flight
1 from Regulation 1).

2. It provides facilities to each actor to:

a. Monitor and update the state of coordination.

b. Organize their work according to deadlines with the help of ordered tasks and visual
timelines.

c. Communicate with each other using Query/Response text fields.

3. The MCDM operations allows coordination on 3 levels:

a. On measures: Actors can comment/approve/reject individual measures and manage the

actors.

b. On flights in the context of a measure action under review: Actors can

comment/approve/reject on individual flights and manage the actors.

c. On individual flight level (Ehelpdesk related context: a.o. exclude a flight from a regulation,
or request additional information for a flight or slot swap EhelpdeskTickets)

4. In the context of regulation proposals or EhelpdeskTickets a subset of the full MCDM process is
used:

a. In the context of regulation proposals MCDM deadlines are not used. MCDM state FINISHED
is not used. Draft is only used for FMP related requests (to first be able to evaluate the
impact ond only when ok move the MCDM state to proposed for NMOC to review)

Edition: 27.0 6 1308

Document Title: NM 27.0 - NM B2B Reference Manual

b. Actors cannot be changed or set: only the initiator and NMOC are involved.

c. There is only MCDM for measures and in case of cherry pick regulations there is also MCDM
for the flights. In the case of standalone MCDM flights (EhelpdeskTickets not in the context
of a cherry picked regulation review process), there is only MCDM for the flights.

d. Measure MCDM allows B2B clients to see when NMOC has acknowledged the reception of a
proposal regulation and when NMOC has accepted or rejected the proposal regulation or
when afterwards the regulation got cancelled (due to other reasons).

e. Flight MCDM allows B2B clients to track for EhelpdeskTickets (a.o. cherry picked regulation)
which flights got accepted and which flights got rejected (possibly asynchronously due to the
application of Ehelpdesk system rules and user rules). In the context of force/unforce also
which flights got unforced or deregulated afterwards (after NMOC accept) due to other
reasons.

f. In the context of regulation proposals: the B2B client can update the MCDM state for
RegulationProposalWithProposalFlights (via MCDMStateUpdateRequest ) : limited to (re-)setting
the MCDM state of the proposal regulation to DRAFT or to PROPOSED. In addition the B2B
client can query the MCDM data (measures and flights) via MCDMTopicListRequest (based on a
measureId) or via the flightlist (atfcm_measure_locations field) or via the
RegulationProposalListRequest . The regulation proposal MCDM services are accessible
(authorized) when the user has access to cherry pick proposalRegulationFiling .

g. In the context of EhelpdeskTickets : the FMP B2B client can update the MCDM state for the
tickets via the MCDMTopicUpdateRequest . For AO/TWR B2B clients, changing the MCDM state
(i.e. from draft to proposed) is not needed.

h. When a flight is added to a cherry picked proposal regulation (EhelpdeskTicket:

forceFlightsInRegulation or a standalone EhelpdeskTicket or created, the EhelpdeskTickets
get an MCDMTopicId ). This is a Uuid identifying the request. The MCDMTopicId can be used to
afterwards update or revoke the EhelpdeskTicket or find the Ehelpdesk request back in the
retrieveMCDMTopicListReply .

5. There is detailed B2B client documentation about Ehelpdesk via B2B and about proposal
regulations via B2B (cherry picked regulation and normal regulations) describing the
workflows in detail.

Note that the full set of MCDM related services are trial related (a.o. STAM): it is only
NOTE
accessible (authorized) during specific trials or on specific test platforms.

20.5.2.2. Update Pattern

1. Similar to: See Update Pattern.

2. However in the context of regulation proposals, the dataId to be used in MCDMStateUpdateRequest

can be either the dataId retrieved via the MCDMTopicListRequest or retrieved via the
RegulationProposalListRequest or returned by the EhelpdeskTicketCreationReply .

20.5.3. Publish/Subscribe Topics

Edition: 27.0 6 1309

Document Title: NM 27.0 - NM B2B Reference Manual

20.5.3.1. MCDM

MEP: P/S

Message: MCDMMessage

Ordering policy:

Messages referring to the same MCDM topic shall be ordered by alphanumerically sorting on
the field payload.[mcdmMeasure|standaloneMcdmFlight|nonStandaloneMcdmFlight].dataId.

Message filter: MCDMMessageFilter

Payload configuration: MCDMPayloadConfiguration

Subscription management (topic specific):

• S-R/R MCDMSubscriptionCreationRequest/Reply

• S-R/R MCDMSubscriptionUpdateRequest/Reply

• S-R/R MCDMSubscriptionRetrievalRequest/Reply

Default settings: P/S message settings

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert read access to /mcdmTopics

• assert read access to /mcdmTopics#deadlines

if MCDMTopicField.deadlines is requested

Notification about MCDM-specific topics, e.g. MCDMMeasureTopic, standalone or non-standalone

MCDMFlightTopic.

20.5.3.1.1. MCDMMessage (new 27.0)

<<class>>

Documentation last updated: 27.0 - Edition 1

The business P/S message for topic MCDM.

1. Inherits from: BusinessPSMessage

2. Attributes:

Edition: 27.0 6 1310

Document Title: NM 27.0 - NM B2B Reference Manual

a. MCDMMessagePayload payload (Mandatory)

The payload of this MCDMMessage .

20.5.3.1.2. MCDMSubscriptionCreationRequest/Reply (new 27.0)

MEP: S-R/R

Request: MCDMSubscriptionCreationRequest

Reply: MCDMSubscriptionCreationReply

Response time: not available

Default settings: request count quotas

SOAP operation:

MCDMSubscriptionCreationReply
createMCDMSubscription(MCDMSubscriptionCreationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /mcdmTopics

• assert certificate read access to /mcdmTopics#deadlines

if MCDMTopicField.deadlines is requested

• assert certificate read access to /mcdmTopics?actors=null

if request.messageFilter.anuIds=null

Creates a subscription for topic MCDM.

MCDMSubscriptionCreationRequest (new 27.0)

Edition: 27.0 6 1311

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows creating a new subscription for topic MCDM.

1. Inherits from: SubscriptionCreationRequest

2. Attributes:

a. MCDMMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. MCDMPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

MCDMSubscriptionCreationReply (new 27.0)

<<class>>

Returned in response to MCDMSubscriptionCreationRequest.

1. Inherits from: Reply

2. Attributes:

a. MCDMSubscriptionCreationReplyData data (Optional)

The reply payload.

20.5.3.1.3. MCDMSubscriptionUpdateRequest/Reply (new 27.0)

Edition: 27.0 6 1312

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: MCDMSubscriptionUpdateRequest

Reply: MCDMSubscriptionUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

MCDMSubscriptionUpdateReply updateMCDMSubscription(MCDMSubscriptionUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /mcdmTopics

• assert certificate read access to /mcdmTopics#deadlines

if MCDMTopicField.deadlines is requested

• assert certificate read access to /mcdmTopics?actors=null

if request.messageFilter.anuIds=null

Updates a subscription for topic MCDM.

MCDMSubscriptionUpdateRequest (new 27.0)

Edition: 27.0 6 1313

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

It allows updating an existing subscription for topic MCDM.

1. Inherits from: SubscriptionUpdateRequest

2. Attributes:

a. MCDMMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. MCDMPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

MCDMSubscriptionUpdateReply (new 27.0)

<<class>>

Returned in response to MCDMSubscriptionUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. MCDMSubscriptionUpdateReplyData data (Optional)

The reply payload.

20.5.3.1.4. MCDMSubscriptionRetrievalRequest/Reply (new 27.0)

Edition: 27.0 6 1314

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: MCDMSubscriptionRetrievalRequest

Reply: MCDMSubscriptionRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

MCDMSubscriptionRetrievalReply
retrieveMCDMSubscription(MCDMSubscriptionRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Retrieves a subscription for topic MCDM.

MCDMSubscriptionRetrievalRequest (new 27.0)

<<class>>

Subscription retrieval request for topic MCDM.

1. Inherits from: SubscriptionRetrievalRequest

MCDMSubscriptionRetrievalReply (new 27.0)

<<class>>

Returned in response to MCDMSubscriptionRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. MCDMSubscriptionRetrievalReplyData data (Optional)

Edition: 27.0 6 1315

Document Title: NM 27.0 - NM B2B Reference Manual

The reply payload.

20.5.4. Requests/Replies

20.5.4.1. MCDMTopicListRequest/Reply

MEP: S-R/R

Request: MCDMTopicListRequest

Reply: MCDMTopicListReply

Response time: 6 / 90 / 160 (ms)

Default settings: request count quotas

SOAP operation:

MCDMTopicListReply queryMCDM(MCDMTopicListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /mcdmTopics

• assert certificate read access to /mcdmTopics#deadlines

if MCDMTopicField.deadlines is requested

Queries the MCDM topics.

20.5.4.1.1. MCDMTopicListRequest

Edition: 27.0 6 1316

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to query a list of MCDM related summary information, as well as to retrieve the MCDM
topic details. See also MCDM Port Type for more info. This query method allows the caller to select
the topic fields requested in the reply (see requestedTopicFields ). NM kindly requests its customers
to apply the following strategy:

1. As a rule, client applications should never request topic fields that they do not need

2. Client applications typically implement a query/retrieve pattern:

a. Query the small number of most relevant topic fields to display to the end user (using this
MCDMTopicListRequest )

b. Retrieve more details for a given regulation when the end user has selected a topic from the
list (also using this MCDMTopicListRequest , but with other requested fields)

The logical AND operator applies between all the query fields described below.

NOTE There can be up to 5 seconds of delay to see the latest info (due to NM side caches).

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 1317

Document Title: NM 27.0 - NM B2B Reference Manual

a. Dataset dataset (Mandatory)

Dataset on which the MCDM summary is requested

See Forecast and Operational Datasets.

b. DateYearMonthDay date (Mandatory)

Day of operation for which the MCDM summary is requested

c. MCDMTopicListRequestSelector selector (Optional)

Selects topics either by topic ids or by measure ids or by actor ids.

Note: special authorization is required to access all requests from all users (by not filling the
selector attribute).

d. boolean activeOnly (Mandatory)

If true , then the reply returns only the active MCDM topics (i.e. those that have an MCDM
State that is not yet abandoned or finished).

e. set< MCDMTopicField > requestedMCDMTopicFields (Mandatory)

The reply returns only the requested topic fields in this set, and only if the values of these
requested fields are available at NM. Note that the topic id is always returned.

20.5.4.1.2. MCDMTopicListReply

<<class>>

Returned in response to MCDMTopicListRequest.

1. Inherits from: Reply

2. Attributes:

a. MCDMTopicListReplyData data (Optional)

The reply payload.

20.5.4.2. MCDMTopicUpdateRequest/Reply

Edition: 27.0 6 1318

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: MCDMTopicUpdateRequest

Reply: MCDMTopicUpdateReply

Response time: 15 / 120 / 420 (ms)

Default settings: request count quotas

SOAP operation:

MCDMTopicUpdateReply updateMCDM(MCDMTopicUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /mcdmTopics

• assert certificate write access to /mcdmTopics#deadlines

if topic.deadlines is set

Updates a MCDM topic.

20.5.4.2.1. MCDMTopicUpdateRequest

Edition: 27.0 6 1319

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update a MCDM topic (e.g., change the MCDM state or a vote or change the roles and
approvals for users).

NOTE A call to this service triggers a refresh of the MCDMTopic cache.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the MCDM topic update is requested

b. DateYearMonthDay date (Mandatory)

Day of operation for which the MCDM topic update is requested

c. MCDMTopic topic (Mandatory)

The topic to be updated

20.5.4.2.2. MCDMTopicUpdateReply

<<class>>

Returned in response to MCDMTopicUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. MCDMTopicUpdateReplyData data (Optional)

The reply payload.

20.5.4.3. MCDMStateUpdateRequest/Reply

Edition: 27.0 6 1320

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: MCDMStateUpdateRequest

Reply: MCDMStateUpdateReply

Response time: 1700 / 2700 / 2800 (ms)

Default settings: request count quotas

SOAP operation:

MCDMStateUpdateReply updateMCDMState(MCDMStateUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /mcdmTopics

Updates the MCDM state of a measure.

20.5.4.3.1. MCDMStateUpdateRequest

Edition: 27.0 6 1321

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update the MCDMState of a measure (typically used in the context of measure
proposals).

• In regulation proposal context, it is only allowed to change he MCDM state of the

regulation when NMOC is not yet reviewing the regulation or when the review
has been completed (so then MCDMState is DRAFT, PROPOSED, IMPLEMENTED,
NOTE ABANDONED or INTERRUPTED). When the regulationState is CANCELLED or
TERMINATED, then it is no longer possible to update the MCDMState. The MCDM
state can only be changed to PROPOSED from the DRAFT MCDMState.

• A call to this service triggers a refresh of the MCDMTopic cache.

1. Inherits from: Request

2. Attributes:

a. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of the MCDM state to update. See Update Pattern.

b. Dataset dataset (Mandatory)

Dataset to which the regulation belongs. See Forecast and Operational Datasets.

c. MeasureId measureId (Mandatory)

The unique id of the measure or measure proposal.

d. MCDMState newMCDMState (Optional)

The new MCDM state.

In the context of regulation proposals, only DRAFT or PROPOSED are allowed (DRAFT when
the B2B client wants to update a regulation or a regulation proposal and PROPOSED when
the B2B client wants NMOC to review): See MCDM Port Type.

20.5.4.3.2. MCDMStateUpdateReply

Edition: 27.0 6 1322

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Returned in response to MCDMStateUpdateRequest.

Special error conditions:

1. INVALID_DATASET [Temporary error] If the FORECAST update was rejected due to D-1 forecast
update cut-off or if the OPERATIONAL update was rejected due to D-1 plan not transferred yet.

2. CONFLICTING_UPDATE [Permanent error] If the update failed due to incompatible concurrent

changes.

3. OBJECT_NOT_FOUND [Permanent error] If the measure is not known or if it has no MCDM.

4. Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : trying to change the MCDMState to
FINISHED in the context of regulation proposal)

1. Inherits from: Reply

2. Attributes:

a. MCDMStateUpdateReplyData data (Optional)

The reply data.

20.5.4.4. EhelpDeskTicketCreationRequest/Reply

Edition: 27.0 6 1323

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EhelpDeskTicketCreationRequest

Reply: EhelpDeskTicketCreationReply

Response time: 16 / 170 / 450 (ms)

Default settings: request count quotas

SOAP operation:

EhelpDeskTicketCreationReply createEhelpDeskTicket(EhelpDeskTicketCreationRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /ehelpdeskTickets?kind=FORCE_FLIGHTS_IN_REGULATION

if ticket kind is 'forceFlightInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=UNFORCE_FLIGHTS_IN_REGULATION

if ticket kind is 'unforceFlightInRegulation'

• assert certificate write access to /flights?proposal=true#ctot

if ticket kind is 'forceFlightInRegulation' or 'unforceFlightInRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=EXCLUDE_FLIGHT_FROM_REGULATION

if ticket kind is 'excludeFlightFromRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=REINCLUDE_FLIGHT_IN_REGULATION

if ticket kind is 'reincludeFlightInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=IMPROVE_SLOT_IN_REGULATION

if ticket kind is 'improveSlotInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=EXTEND_SLOT_IN_REGULATION

if ticket kind is 'extendSlotInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=SWAP_SLOTS_IN_REGULATION

Edition: 27.0 6 1324

Document Title: NM 27.0 - NM B2B Reference Manual

if ticket kind is 'swapSlotsInRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=ADD_FLIGHTS_IN_FMP_STAM_REROUTING

if ticket kind is 'addFlightsInFmpStamRerouting'

• assert certificate write access to

/ehelpdeskTickets?kind=REMOVE_FLIGHTS_FROM_FMP_STAM_REGULATION

if ticket kind is 'removeFlightsFromFmpStamRerouting'

• assert certificate write access to /flights?proposal=true

if ticket kind is 'addFlightsInFmpStamRerouting' or 'removeFlightsFromFmpStamRerouting'

• assert certificate write access to /ehelpdeskTickets?kind=INFORMATION

if ticket kind is 'information'

• assert certificate write access to /ehelpdeskTickets?kind=OTHER

if ticket kind is 'other'

• assert certificate write access to /flights#criticality

if a flight criticality indicator is provided ('request.flightCriticalityIndicator' is

set and ticket kind is none of 'forceFlightInRegulation', 'unforceFlightInRegulation',
'addFlightsInFmpStamRerouting', 'removeFlightsFromFmpStamRerouting')

Creates a new E-Helpdesk ticket.

20.5.4.4.1. EhelpDeskTicketCreationRequest

Edition: 27.0 6 1325

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

EhelpDesk ticket creation request. Allows to submit an Ehelpdesk request via B2B for NMOC to
review and accept/reject for a.o. slot swaps, slot improvements, slot extensions, regulation
exclusion, force flight …

Note that updateFlightsInMeasure service is to be used to do the equivalent operation in a simulation

(acting directly on the simulation flights to evaluate impact).

QueryMCDM service can be used to check the status of the request. (note that it can take up to 1 second
before the updated info is reflected inside the reply of the QueryMCDM service).

There is specific authorization for these Read/Write services (access only given after specific
validations involving TEC and OPS people).

Note that it in some cases, a request is really invalid (wrt pre-submission validations). In such a
case the request does not even result in an NM systems stored EH request (e.g. an EH request for a
not_existing/cancelled flight, or a really NOK force/unforce or slotswap request). In such a case, the
reply indicates an INTERRUPTED MCDM state (with a
EhelpDeskTicketResponseDetails.responseText indicating the problem), but without any
automatedResponseRule, nor a requestDetails.creationTime.

Force/Unforce Ehelpdesk Tickets allow to act on more than 1 flight in one go. An Ehelpdesk ticket is
created for each flight.

For a cherry picked measure (Regulation proposal context), forceFlightsInRegulation ticket allows
FMP to initially associate flight(s) to a measure (and give or change the CTOT) or afterwards add
additional flights. For a cherry picked measure unforceFlightsInRegulation allows to unforce
("remove") a flight from a regulation (becomes exempted again).

Regulation proposal context:

1. The ticket kind forceFlightsInRegulation / unforceFlightsInRegulation is accessible (authorized)

when the FMP user has access to cherry pick proposalRegulationFiling. In that case it is limited
to adding proposal flights to a regulation or creating a proposal flight to remove (re-exempt) a
flight from the cherry picked regulation.

2. Forcing/Unforcing flights results in proposal flights that are forced/unforced. When NMOC
accepts the regulation proposal, the proposal flight is removed and the normal flight gets a
CTOT or CTOT cancellation.

3. Forcing/Unforcing flights is only allowed if the MCDMState of the cherry picked proposal
regulation is (re-)set to DRAFT and the regulationActivity is applied. For
forceFlightsInRegulation, the flights need to have their CTOT in the future and CTOT cannot be
earlier than ETOT.

4. Flights should not be ATC_ACTIVATED yet. Flights can only be added if hey have the ETO
(expected time over according to FTFM) or ATO (actual time over according to CTFM: e.g. for
TACT_ACTIVATED flights due to DPI) inside the regulation period.

5. forceFlightInRegulation / unforceFlightInRegulation , removes any previous proposal flight and

creates a new proposal flight.

Edition: 27.0 6 1326

Document Title: NM 27.0 - NM B2B Reference Manual

6. The forceFlightsInRegulation (proposal regulation context) results in an updated regulation

proposal applicability period if the regulation period needs to be extended or reduced (See
ATFCM reference manual and Regulation Proposal technical documentation (explaining in B2B
terms, the workflow to follow)).

7. In that case the B2B client needs to wait until the regulationActivity is APPLIED again before
doing any subsequent UpdateFlightsInMeasureRequests.

Force/Unforce not in regulation proposal context:

1. Allows an FMP to force/unforce a flight in one of his existing (non-cherry picked) regulation.
This allows to fine-tune the regulated flights to solve demand-capacity related issues (i.e.avoid
overloads in counts).

2. Forcing/Unforcing flights results in proposal flights that are forced. When NMOC accepts the
force proposal, the proposal flight is removed and the normal flight gets an updated CTOT (SRM
message).

3. A call to this service triggers a refresh of the MCDMTopic cache.

See the more detailed B2B EHelpDeskTickets usage and Operational Instructions document.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset in which the flights need to be updated in one or more measures. Typically this is
the OPERATIONAL dataset. For usage with FORECAST or SIMULATION datasets, users should
coordinate first with NM Customer Support.

See Forecast and Operational Datasets.

b. FlightCriticalityIndicator flightCriticalityIndicator (Optional)

Allows to set or update the criticality of a flight when submitting a EhelpdeskTicket.

When not given, it means leave the flight criticality unchanged.

Note that one cannot revoke the flight criticality (once it has been set).

Also note that quota apply on how many flights can be marked critical (see detailed B2B
EhelpdeskTicket usage documentation).

i. Constraints:

▪ EhelpDeskTicketCreationRequest.FLIGHT_CRITICALITY_INDICATOR_MUST_BE_NULL

c. EhelpDeskTicketChoice ticket (Mandatory)

EhelpDesk ticket to be created.

i. Constraints:

Edition: 27.0 6 1327

Document Title: NM 27.0 - NM B2B Reference Manual

▪ EhelpDeskTicketCreationRequest.REMOVE_FLIGHTS_FROM_FMP_STAM_REROUTING_NOT_ALLOWED

ii. Access control:

▪ set ticket.forceFlightInRegulation|ticket.unforceFlightInRegulation requires write

access to /flights?proposal=true#ctot

▪ set ticket.forceFlightInRegulation requires write access to

/ehelpdeskTickets?kind=FORCE_FLIGHTS_IN_REGULATION
▪ set ticket.unforceFlightInRegulation requires write access to
/ehelpdeskTickets?kind=UNFORCE_FLIGHTS_IN_REGULATION
▪ set ticket.excludeFlightFromRegulation requires write access to
/ehelpdeskTickets?kind=EXCLUDE_FLIGHT_FROM_REGULATION
▪ set ticket.reincludeFlightInRegulation requires write access to
/ehelpdeskTickets?kind=REINCLUDE_FLIGHT_IN_REGULATION
▪ set ticket.improveSlotInRegulation requires write access to
/ehelpdeskTickets?kind=IMPROVE_SLOT_IN_REGULATION
▪ set ticket.extendSlotInRegulation requires write access to
/ehelpdeskTickets?kind=EXTEND_SLOT_IN_REGULATION
▪ set ticket.swapSlotsInRegulation requires write access to
/ehelpdeskTickets?kind=SWAP_SLOTS_IN_REGULATION
▪ set ticket.addFlightsInFmpStamRerouting|ticket.removeFlightsFromFmpStamRerouting
requires write access to /flights?proposal=true

▪ set ticket.addFlightsInFmpStamRerouting requires write access to

/ehelpdeskTickets?kind=ADD_FLIGHTS_IN_FMP_STAM_REROUTING
▪ set ticket.removeFlightsFromFmpStamRerouting requires write access to
/ehelpdeskTickets?kind=REMOVE_FLIGHTS_FROM_FMP_STAM_REGULATION
▪ set ticket.information requires write access to /ehelpdeskTickets?kind=INFORMATION

▪ set ticket.other requires write access to /ehelpdeskTickets?kind=OTHER

3. Constraints:

a. FLIGHT_CRITICALITY_INDICATOR_MUST_BE_NULL

The flightCriticalityIndicator must be null in the context of force/unforce requests and

add flights in FMP STAM rerouting.

Constrained attributes: flightCriticalityIndicator

Constrained requests: any using request

b. REMOVE_FLIGHTS_FROM_FMP_STAM_REROUTING_NOT_ALLOWED

A EhelpDeskTicketCreationRequest cannot specify a ticket of kind

removeFlightsFromFmpStamRerouting. To remove a flight from a FMP STAM rerouting, it should
have been added before, so you have a ticket when the flight was added to the rerouting
before, and you should use that ticket to remove the flight from the rerouting via a
EhelpDeskTicketUpdateRequest.

Constrained attributes: ticket

Edition: 27.0 6 1328

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: any using request

20.5.4.4.2. EhelpDeskTicketCreationReply

<<class>>

Returned in response to EhelpDeskTicketCreationRequest.

The reply contains an updateMCDMTopicId if the ticket creation got accepted by NMOC systems. (note
that the request can still have an INTERRUPTED MCDM state to indicate that the Ehelpdesk
request(s) got rejected due to a Ehelpdesk system rule). If the reply does contain an
updateMCDMTopicId , then the concerned ticket(s) will also be returned in the QueryMCDM service reply.
If in the reply flight(s) ticket(s) got rejected due to validation errors (i.e. tickets reply without an
updateMCDMTopicId ), then it means the ticket is not stored in NM systems (a.o. will not be returned
via the QueryMCDM service).

1. Inherits from: Reply

2. Attributes:

a. EhelpDeskTicketCreationReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1329

Document Title: NM 27.0 - NM B2B Reference Manual

20.5.4.5. EhelpDeskTicketUpdateRequest/Reply

Edition: 27.0 6 1330

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: EhelpDeskTicketUpdateRequest

Reply: EhelpDeskTicketUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

EhelpDeskTicketUpdateReply updateEhelpDeskTicket(EhelpDeskTicketUpdateRequest
request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /ehelpdeskTickets?kind=FORCE_FLIGHTS_IN_REGULATION

if ticket kind is 'forceFlightInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=UNFORCE_FLIGHTS_IN_REGULATION

if ticket kind is 'unforceFlightInRegulation'

• assert certificate write access to /flights?proposal=true#ctot

if ticket kind is 'forceFlightInRegulation' or 'unforceFlightInRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=EXCLUDE_FLIGHT_FROM_REGULATION

if ticket kind is 'excludeFlightFromRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=REINCLUDE_FLIGHT_IN_REGULATION

if ticket kind is 'reincludeFlightInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=IMPROVE_SLOT_IN_REGULATION

if ticket kind is 'improveSlotInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=EXTEND_SLOT_IN_REGULATION

if ticket kind is 'extendSlotInRegulation'

• assert certificate write access to /ehelpdeskTickets?kind=SWAP_SLOTS_IN_REGULATION

Edition: 27.0 6 1331

Document Title: NM 27.0 - NM B2B Reference Manual

if ticket kind is 'swapSlotsInRegulation'

• assert certificate write access to

/ehelpdeskTickets?kind=ADD_FLIGHTS_IN_FMP_STAM_REROUTING

if ticket kind is 'addFlightsInFmpStamRerouting'

• assert certificate write access to

/ehelpdeskTickets?kind=REMOVE_FLIGHTS_FROM_FMP_STAM_REGULATION

if ticket kind is 'removeFlightsFromFmpStamRerouting'

• assert certificate write access to /flights?proposal=true

if ticket kind is 'addFlightsInFmpStamRerouting' or 'removeFlightsFromFmpStamRerouting'

• assert certificate write access to /ehelpdeskTickets?kind=INFORMATION

if ticket kind is 'information'

• assert certificate write access to /ehelpdeskTickets?kind=OTHER

if ticket kind is 'other'

• assert certificate write access to /flights#criticality

if a flight criticality indicator is provided ('request.flightCriticalityIndicator' is

set and ticket kind is none of 'forceFlightInRegulation', 'unforceFlightInRegulation',
'addFlightsInFmpStamRerouting', 'removeFlightsFromFmpStamRerouting')

Updates an existing E-Helpdesk ticket.

20.5.4.5.1. EhelpDeskTicketUpdateRequest

Edition: 27.0 6 1332

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 2

EhelpDesk ticket update request.

Allows to update the request specific details (inside EhelpDeskTicketChoice):

1. For a slot improvement request: the subtype (i.e. EhelpDeskImproveSlotInRegulationType ) and

minRequestedCto/minRequestedCTOT can be updated.

2. For a regulation exclusion/re_inclusion request : the list of regulations can be updated.

3. For a force request : the new most penalising regulation and newCto/newCTOT can be updated.
Note that it is not possible to add extra flights to a Force/Unforce Request: those extra flights
(aka requests) need to be added via the createEhelpDeskTicket service. Removing selected flights
(aka requests) from a Force/Unforce is done with the revokeEhelpDeskTicket service.

4. For a slot extension : the subtype can be updated.

5. For a slot_swap request: the subtype and the flight identifier of the other flight (i.e. the flight to
swap with) can be updated

Requests can only be updated while they have not yet been processed (or are being processed) by
NMOC operator, i.e. while in MCDM state DRAFT or PROPOSED (due to Ehelpdesk auto_rejection
system rule).

A call to this service triggers a refresh of the MCDMTopic cache.

See the more detailed B2B EHelpDeskTickets usage and Operational Instructions document.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset in which the flights need to be updated in one or more measures.

See Forecast and Operational Datasets.

b. FlightCriticalityIndicator flightCriticalityIndicator (Optional)

Allows to set or update the criticality of a flight when updating a EhelpdeskTicket.

When not given, it means leave the flight criticality unchanged.

Note that one cannot revoke the flight criticality (once it has been set).

Also note that quota apply on how many flights can be marked critical (see detailed B2B
EhelpdeskTicket usage documentation).

i. Constraints:

▪ EhelpDeskTicketUpdateRequest.FLIGHT_CRITICALITY_INDICATOR_MUST_BE_NULL

Edition: 27.0 6 1333

Document Title: NM 27.0 - NM B2B Reference Manual

c. EhelpDeskTicketChoice ticket (Mandatory)

EhelpDesk ticket to be updated.

i. Access control:

▪ set ticket.forceFlightInRegulation|ticket.unforceFlightInRegulation requires write

access to /flights?proposal=true#ctot

▪ set ticket.forceFlightInRegulation requires write access to

/ehelpdeskTickets?kind=FORCE_FLIGHTS_IN_REGULATION
▪ set ticket.unforceFlightInRegulation requires write access to
/ehelpdeskTickets?kind=UNFORCE_FLIGHTS_IN_REGULATION
▪ set ticket.excludeFlightFromRegulation requires write access to
/ehelpdeskTickets?kind=EXCLUDE_FLIGHT_FROM_REGULATION
▪ set ticket.reincludeFlightInRegulation requires write access to
/ehelpdeskTickets?kind=REINCLUDE_FLIGHT_IN_REGULATION
▪ set ticket.improveSlotInRegulation requires write access to
/ehelpdeskTickets?kind=IMPROVE_SLOT_IN_REGULATION
▪ set ticket.extendSlotInRegulation requires write access to
/ehelpdeskTickets?kind=EXTEND_SLOT_IN_REGULATION
▪ set ticket.swapSlotsInRegulation requires write access to
/ehelpdeskTickets?kind=SWAP_SLOTS_IN_REGULATION
▪ set ticket.addFlightsInFmpStamRerouting|ticket.removeFlightsFromFmpStamRerouting
requires write access to /flights?proposal=true

▪ set ticket.addFlightsInFmpStamRerouting requires write access to

/ehelpdeskTickets?kind=ADD_FLIGHTS_IN_FMP_STAM_REROUTING
▪ set ticket.removeFlightsFromFmpStamRerouting requires write access to
/ehelpdeskTickets?kind=REMOVE_FLIGHTS_FROM_FMP_STAM_REGULATION
▪ set ticket.information requires write access to /ehelpdeskTickets?kind=INFORMATION

▪ set ticket.other requires write access to /ehelpdeskTickets?kind=OTHER

3. Constraints:

a. FLIGHT_CRITICALITY_INDICATOR_MUST_BE_NULL

The flightCriticalityIndicator must be null in the context of force/unforce requests and

add/remove flights to/from FMP STAM rerouting.

Constrained attributes: flightCriticalityIndicator

Constrained requests: any using request

20.5.4.5.2. EhelpDeskTicketUpdateReply

<<class>>

Returned in response to EhelpDeskTicketUpdateRequest.

Edition: 27.0 6 1334

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Reply

2. Attributes:

a. EhelpDeskTicketUpdateReplyData data (Optional)

The reply payload.

20.5.4.6. EhelpDeskTicketRevocationRequest/Reply

MEP: S-R/R

Request: EhelpDeskTicketRevocationRequest

Reply: EhelpDeskTicketRevocationReply

Response time: 14 / 980 / 1100 (ms)

Default settings: request count quotas

SOAP operation:

EhelpDeskTicketRevocationReply
revokeEhelpDeskTicket(EhelpDeskTicketRevocationRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /ehelpdeskTickets

Revokes an existing E-Helpdesk ticket.

20.5.4.6.1. EhelpDeskTicketRevocationRequest

Edition: 27.0 6 1335

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 2

EhelpDesk ticket revocation request.

Allows to revoke one or more EhelpdeskTickets (results in MCDM state ABANDONED).

Requests can only be revoked while they have not yet been processed (or are being processed) by
NMOC operator, i.e. while in MCDM state DRAFT or PROPOSED (due to Ehelpdesk auto_rejection
system rule).

NOTE A call to this service triggers a refresh of the MCDMTopic cache.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset in which the flights need to be updated in one or more measures.

See Forecast and Operational Datasets.

b. set< EhelpDeskFlightId > tickets (Mandatory)

EhelpDesk tickets to be removed.

Edition: 27.0 6 1336

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ set size range : [1, 100]

20.5.4.6.2. EhelpDeskTicketRevocationReply

<<class>>

Returned in response to EhelpDeskTicketRevocationRequest.

1. Inherits from: Reply

2. Attributes:

a. EhelpDeskTicketRevocationReplyData data (Optional)

The reply payload.

20.6. TacticalUpdates Port Type

20.6.1. Overview

1. This service is intended to provide querying and update capabilities on Tactical updates. The
requests currently available are:

a. S-R/R SectorConfigurationPlanRetrievalRequest/Reply

b. S-R/R SectorConfigurationPlanUpdateRequest/Reply

c. S-R/R CapacityPlanRetrievalRequest/Reply

d. S-R/R CapacityPlanUpdateRequest/Reply

e. S-R/R TrafficVolumeActivationPlanRetrievalRequest/Reply

f. S-R/R TrafficVolumeActivationPlanUpdateRequest/Reply

g. S-R/R OTMVPlanRetrievalRequest/Reply

h. S-R/R OTMVPlanUpdateRequest/Reply

i. S-R/R RunwayConfigurationPlanRetrievalRequest/Reply

j. S-R/R RunwayConfigurationPlanUpdateRequest/Reply

k. S-R/R HotspotListRequest/Reply

l. S-R/R HotspotPlanUpdateRequest/Reply

m. S-R/R RestrictionActivationPlanRetrievalRequest/Reply

n. S-R/R RestrictionActivationPlanUpdateRequest/Reply

20.6.2. Concepts

20.6.2.1. CACD Retrievals vs. Tactical Situation

1. The current situation is that the airspace data involved in the Daily Plan is maintained in two

Edition: 27.0 6 1337

Document Title: NM 27.0 - NM B2B Reference Manual

systems:

a. The NM CACD (airspace) system for AIRAC definitions

b. NM flow system for tactical updates

2. The export of related CACD objects (consistently with the export of other CACD objects) does not
take into account the tactical updates done via the NM flow system (pre-tactical and tactical
situations). Hence:

a. When retrieving a daily plan (see below), the caller receives the superset of CACD values on
periods that were not updated (pre-)tactically and of the tactical updates.

b. The caller can only input the tactical updates. These should not include the CACD values
(providing the CACD values has the effect of overwriting all that has been planned in CACD
see below).

c. To retrieve a Daily Plan:

▪ Retrieve a Sector Configuration Plan;

▪ Retrieve a Capacity Plan;

▪ Retrieve a Traffic Volume Activation Plan;

▪ Retrieve an OTMV Plan;

▪ Retrieve a Runway Configuration Plan.

▪ Retrieve a Restriction Activation Plan.

20.6.2.2. Daily Plan Update Pattern

1. The pattern used for all tactical updates is the update of the entire list of values for a day. This
list of values must be a consistent and complete time partition for the whole day. For each time
period the user can specify whether new values or the existing CACD values should be used.

2. More precisely, the client system will be able to update in one shot:

a. The plan of runway configurations for an entire day and an aerodrome;

b. The plan of sector configuration activations for an entire day and an airspace (AUA or sector
cluster);

c. The plan of capacities for an entire day and a traffic volume;

d. The plan of traffic volume activations for an entire day and a traffic volume;

e. The plan of OTMVs for an entire day and a traffic volume for a duration;

3. As mentioned above, each daily plan is a complete time partition of the day, meaning that each
daily plan update which is made of values defined over periods must be such that its periods do
not overlap and cover the whole day. Providing a daily plan that is not a time partition will
result in an error.

4. The data value associated to each period of the plan must be:

a. either an indication that for this period the CACD data is to be used (note that for some
plans, e.g. for some capacity plans, there is no data defined in CACD for certain
locations/traffic volumes)

Edition: 27.0 6 1338

Document Title: NM 27.0 - NM B2B Reference Manual

b. or the specific values to be used for that period.

5. So, it is up to the B2B client to either always pass the plan with the full CACD values (which are
copied over, hence overwritten) when not updated, or to pass only the actual tactical updates
and indications that CACD values should be used in the absence of tactical updates.

6. Any of the plans mentioned above may be updated via B2C and/or B2B, and in both cases by
different operators. When an operator updates a plan via B2C, the next B2B retrieve plan
operation will include these changes done via B2C. The pattern used on the backend side to deal
with concurrent updates is the following:

a. Each daily plan is returned with a data id that expresses a data version number (equivalent
to a timestamp)

b. Before updating a daily plan, the updater must first get the plan and subsequently pass the
associated data id when updating it. IMPORTANT: note that this data id is also related to the
dataset in use, i.e. a data id obtained from a dataset cannot be used with another dataset:
doing so would result in an error.

c. A concurrent update is defined as an update that took place earlier (i.e. before the update
that the updater wants to execute now) but after the timestamp associated to the data id
passed within the update to execute now.

For example:

i. A B2B client shows in a local screen a daily plan.corresponding to dataId I1

ii. A NM client in a parallel modifies the same daily plan (for the same location and
updated periods) via B2B or B2C → latest version in NM systems : dataId I2.

iii. The B2B client end-user modifies some values of the plan and tries to commit them
(includes sending to NM; changes wrt I1)

iv. As the B2B client end-user started from dataId I1 but the periods that were modified
were also conflictingly modified in parallel CONFLICTING_UPDATE ReplyStatus is
returned

d. From the concurrency perspective, a daily plan update is successful if:

i. There was no concurrent update, or

ii. There were identical concurrent updates, and/or

iii. There were concurrent updates that did not involve time periods overlapping with the
time periods for which there is a change in the newly updated plan.

e. IMPORTANT: NM insists that the B2B client only does a tactical update to a plan in case
something has changed for that plan. Updates that do not change anything are logged. In
case too many of such non-updates are logged, then access can be restricted. This ensures
that the backend responsible for the (pre-) tactical updates, does not get overloaded with
non-updates.

7. The data id is an opaque identifier of the version of the global state of the backend system
related to CACD or tactical updatable related data (not pure flight data). Whenever dataId is
passed in an update request, the system verifies if there have been conflicting updates between
what the B2B client tried to update (wrt the state of the system linked to the dataid) and the

Edition: 27.0 6 1339

Document Title: NM 27.0 - NM B2B Reference Manual

latest state. Note that the dataId represent the global state of the backend system (not linked to
specific locations). It changes continuously (between subsequent retrievePlan requests).
However the fact that it changes continuously does not impact the B2B client, as it is only used
to detect if there have been conflicting parallel updates between the latest state and what the
B2B client changed in the update request.

8. There are basically 2 ways (operationally) to use dataId :

a. In case B2C/NMOC (via phone coordination) will not be used anymore to update daily plans
concerning the B2B client (nor in tactical, nor in forecast (PREDICT) and B2B is not used by
any other systems to update the concerned daily plans and the master repository of the data
is inside the B2B client’s systems, then the B2B client can just before each update first do a
query to retrieve the relevant daily plan (and its associated dataId .

So the detailed steps for a sector configuration update would be:

i. Retrieve the sector configuration plan for the AUA (Reply S1 includes dataId1)

ii. Produce the sectorConfigurationPlanUpdateRequest based on the client’s local systems

(using dataId1 and optionally merging/keeping S1 past data (if NM systems could/would
be used as contingency repository and as such past data could have become different))

iii. B2B.updateRunwayConfigurationPlan with this sectorConfigurationPlanUpdateRequest.

This usage pattern, would on each update systematically wipe out any changes applied
via B2C/NMOC/other B2B systems). Note that in case NM systems are used as contingency
repository, on restart the B2B client may want to import the data again into the local
system.

b. In case the B2C/NMOC (via phone coordination) could still occasionally be used to update the
concerned daily plans (e.g. contingency) or B2B is used by other systems to update the
concerned daily plans or the B2B client system is not the master repository of the data (e.g.
runway configurations that could be done by FMP or by tower), then the dataId (in
combination with the CONFLICTING_UPDATE error reply) can be used to detect conflicting
parallel updates and report those to the end user so that he can decide what to do.

So the detailed steps for a sector configuration update would be :

i. On the first update for a specific AUA A for a specific day X, the B2B client would first do
a retrieveSectorConfigurationPlan to get a dataId A1. In the returned
sectorConfigurationPlan there should not be any periods that have a data source tactical
and that are different with the data in the local system. In case of differences, the
operator is notified and needs to decide what values to choose.

ii. B2B.updateRunwayConfigurationPlan is used with dataId A1. The reply contains a dataId
A2.

iii. Each next update for AUA A for day X, would use the dataId returned by the previous
update (A2,A3,…).

iv. If the NM systems detect a conflicting parallel update between the time corresponding to
the dataId A1/A2.. and the latest NM state wrt AUA A and day X, the reply contains a
CONFLICTING_UPDATE error. In that case the client system would warn the operator
that a conflicting parallel update has occurred and would show the local data and the

Edition: 27.0 6 1340

Document Title: NM 27.0 - NM B2B Reference Manual

NM data to allow the operator to choose (and optionally update any local system as well)

v. If AUA B for Day X is updated, then data Id B1 needs to be associated to AUA B .

This usage pattern, would make sure that no changes are lost un-expectedly and the
operator is in full control if updates are done via B2C or by the NM plan transfer of
forecast data into operational.

Note that this second pattern is a bit more robust (operationally speaking) and can also
handle the case were B2C is no longer used (point a above).

Note that it is this second pattern that a.o. NM systems use: when an AUA I is updated,
first the NM data is shown and in the screen data the associated dataId I1 is kept. (the
user has seen the NM data corresponding to dataId I1).

When the user applies his changes, this data Id I1 is then used in the
sectorConfugrationPlanUpdateRequest . In case there were parallel conflicting updates, the
user is notified and he needs to redo his update (including first looking at the latest NM
data). The main reason behind: multiple operators at different terminals can do
conflicting updates and they need to be notified.

Note that technically the B2B client can also use this pattern to detect parallel conflicting
updates between different operators inside the client’s own organization. (in case it is
needed/useful).

20.6.2.3. Transactions and Errors

1. If any change in the plan fails to be successfully processed by the NM system, the whole new
plan is rejected so that the previous version of the pl an remains unchanged.

2. In some cases, the B2B layer can not do all validations involved in tactical updates. Some
validations are done by the backend system. These errors are reported as a reply with
ReplyStatus INVALID_INPUT and the error message string describes the problem. This error
message string cannot be considered by the B2B client as part of the B2B contract (that string
may change any time).

3. As seen below, some error conditions are permanent in the sense that retrying the transaction
later will never solve the problem (typically because the data in the request violates some
validation rule), and a few others are temporary, e.g. the transaction failed because the NM
system is itself in some temporar y state that prevents it from processing the request (e.g. the
daily plan is being transferred see below). In any case, the temporary error conditions are
always w ell identified within the reply so that the B2B client knows when it is worth retrying a
few minutes later NM insists that the updates that failed due to a tempora ry condition are only
retried a few minutes later, not a few seconds later and even less a few milliseconds later.

4. Note that violations of the input constraints mentioned in the B2B model below will be reported
in a structured way so that the B2B client will be a ble to decide what to do with them.

5. Also note that permanent errors due to unknown references to airspace elements (like
aerodrome ids, sector configurations ids, traffic volume ids) will NOT be returned formally.
They are returned as a reply with ReplyStatus OBJECT_NOT_FOUND and an error message

Edition: 27.0 6 1341

Document Title: NM 27.0 - NM B2B Reference Manual

describing what attribute can not be found.

20.6.2.4. Allowed Times for Retrievals and Updates

20.6.2.4.1. Forecast and Operational Datasets

1. See also Forecast and Operational Datasets.

2. The forecast and operational datasets are concepts that the NM customers (ANSPs in particular)
are already familiar with. In short, the NM system prepares the plan between D-6 (6 days in
advance) and D-1 (1 day in advance) within the forecast dataset, which is transferred to the
operational dataset on D-1 around 16:00 UTC.

3. The plan remains available in the forecast dataset after transfer, until the end of D (day of
operations), even though it does not evolve anymore in that dataset.

4. To summarize:

a. The plan can be updated:

i. In the forecast dataset: in [ D-5 (5 days in the future), D-1 16:00 UTC]

ii. In the operational dataset: at any point in time on D-1 and D via B2B, D-1 updates are
only allowed after the plan has been transferred (the ability to update the plan in the
operational dataset before the plan has been transferred exists but is reserved to the NM
OPS Room and in exceptional circumstances)

b. The plan can be retrieved:

i. From the forecast dataset: at any time in [ D-5, D ]

ii. From the operational dataset: at any point in time in [ D-1, D ].

The most up-to-date plan for a specific day X can be found in operational if the plan has
already been transferred for day X. If the plan has not been transferred yet for day X,
then the most up-to-date plan for day X can be found in forecast.

5. Regarding the plan transfer, the updates to the forecast dataset are rejected from a cut-off time
on D-1 that is 16:00 UTC; the NM OPS Room may then fine tune the plan for a little while, and
finally transfers it to the operational dataset. The time elapsed between the cut-off time of the
forecast dataset and the time at which the plan has been actually transferred to the operational
dataset is typically around 10 minutes. This elapsed time may exceptionally be longer though,
e.g. in case of unexpected change of the network situation (like unexpected strike or weather
conditions), so that the plan can exceptionally be transferred a few hours after the cut-off time.
The B2B client designer is invited to take this variability into consideration.

Updates to the plan, in the forecast or operational datasets, are rejected during this elapsed
time.

6. The B2B caller knows whether the plan has been transferred or not via the planTransferred
attribute of a plan. Similarly, the B2B caller knows that the forecast update cut-off time has been
reached or not via the planCutOffReached attribute of a plan.

This will be tentatively solved in NM 19.0.

Edition: 27.0 6 1342

Document Title: NM 27.0 - NM B2B Reference Manual

20.6.2.4.2. Past

1. A tactical update is rejected if it attempts to update the past. More precisely, the period
associated to any update in the plan must start after the clock of the NM system. So when doing
an tactical update at e.g. 13:00 for the remainder of day D, the clientschedule needs to also
contain all the periods before 13:00 unaltered: i.e. as they were in a previously retrieved/send
clientschedule. So all past periods marked with CACD need to be kept CACD (i.e. AIRSPACE
datasource) and past all periods marked as tactically updated need to be kept tactically updated
(TACTICAL datasource with the corresponding past data). Changing for a period, the datasource
AIRSPACE (CACD) to TACTICAL is considered a change (because a TACTICAL updated period
hides the CACD (AIRSPACE) data for that period and as such subsequent CACD changes are
"ignored" for a tactically updated period)

Hence, an attempt to modify the past results in a permanent error.

This error will be formally identified as such if the modification is requested for D+1 (yesterday)
or earlier.

But in case the attempt is made to modify the past within D, the resulting permanent error will
not be formally identified as an attempt to update the past within D: the only way for the B2B
client to investigate why the request failed will be to log and exploit the returned informal error
message (string).

2. In order to support changes on existing tactical updates, an existing period, starting in the past
and ending in the future, can be split into a shorter period, starting at the same moment as the
initial one but ending earlier, as long as the first new period still finishes in the future (i.e. the
second new period starts in the future), and the data associated to the first new period is left
unchanged.

3. Retrievals in the past are limited to the past within D, i.e. the whole daily plan is returned for D
but the B2B client cannot request the plans for D+1 or earlier.

This permanent error will be formally identified.

20.6.3. Requests/Replies

20.6.3.1. SectorConfigurationPlanRetrievalRequest/Reply

Edition: 27.0 6 1343

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SectorConfigurationPlanRetrievalRequest

Reply: SectorConfigurationPlanRetrievalReply

Response time: 6 / 25 / 58 (ms)

Default settings: request count quotas

SOAP operation:

SectorConfigurationPlanRetrievalReply
retrieveSectorConfigurationPlan(SectorConfigurationPlanRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/sectorConfiguration

Retrieves a sector configuration plan for a given AUA or sector cluster on a given day.

20.6.3.1.1. SectorConfigurationPlanRetrievalRequest

<<class>>

Request to retrieve the sector configuration plan for a given AUA or sector cluster on a given day.

1. Inherits from: TacticalConfigurationRetrievalRequest

2. Attributes:

a. AirspaceId airspace (Mandatory)

AUA or sector cluster for which the sector configuration plan is requested.

Edition: 27.0 6 1344

Document Title: NM 27.0 - NM B2B Reference Manual

20.6.3.1.2. SectorConfigurationPlanRetrievalReply

<<class>>

Returned in response to SectorConfigurationPlanRetrievalRequest.

Special error conditions:

1. OBJECT_NOT_FOUND

1. Inherits from: Reply

2. Attributes:

a. SectorConfigurationPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.2. SectorConfigurationPlanUpdateRequest/Reply

Edition: 27.0 6 1345

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SectorConfigurationPlanUpdateRequest

Reply: SectorConfigurationPlanUpdateReply

Response time: 120 / 230 / 290 (ms)

Default settings: request count quotas

SOAP operation:

SectorConfigurationPlanUpdateReply
updateSectorConfigurationPlan(SectorConfigurationPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/sectorConfiguration

Updates a sector configuration plan for a given AUA or sector cluster on a given day.

20.6.3.2.1. SectorConfigurationPlanUpdateRequest

<<class>>

Request to update the sector configuration plan for a given AUA or sector cluster on a given day.

1. Inherits from: Request

Edition: 27.0 6 1346

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. SectorConfigurationPlan plan (Mandatory)

Sector configuration plan reflecting the requested updates.

20.6.3.2.2. SectorConfigurationPlanUpdateReply

<<class>>

Returned in response to SectorConfigurationPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

2. CONFLICTING_UPDATE

3. OBJECT_NOT_FOUND

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (see Transaction and Errors). For example : errors when modifying the past (see
Airspace Past).

1. Inherits from: Reply

2. Attributes:

a. SectorConfigurationPlanUpdateReplyData data (Optional)

The reply data.

20.6.3.3. CapacityPlanRetrievalRequest/Reply

Edition: 27.0 6 1347

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: CapacityPlanRetrievalRequest

Reply: CapacityPlanRetrievalReply

Response time: 4 / 28 / 100 (ms)

Default settings: request count quotas

SOAP operation:

CapacityPlanRetrievalReply retrieveCapacityPlan(CapacityPlanRetrievalRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/capacity

Retrieves a capacity plan for a given traffic volume on a given day.

20.6.3.3.1. CapacityPlanRetrievalRequest

<<class>>

Request to retrieve the capacity plan for a given traffic volume on a given day.

1. Inherits from: TacticalConfigurationRetrievalRequest

2. Attributes:

a. set< TrafficVolumeId > trafficVolumes (Mandatory)

The traffic volume for which the capacity plan is requested.

Edition: 27.0 6 1348

Document Title: NM 27.0 - NM B2B Reference Manual

20.6.3.3.2. CapacityPlanRetrievalReply

<<class>>

Returned in response to CapacityPlanRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. CapacityPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.4. CapacityPlanUpdateRequest/Reply

MEP: S-R/R

Request: CapacityPlanUpdateRequest

Reply: CapacityPlanUpdateReply

Response time: 170 / 1100 / 1900 (ms)

Default settings: request count quotas

SOAP operation:

CapacityPlanUpdateReply updateCapacityPlan(CapacityPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/capacity

Updates a capacity plan for a given traffic volume on a given day.

20.6.3.4.1. CapacityPlanUpdateRequest

Edition: 27.0 6 1349

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update the capacity plan for a given traffic volume on a given day.

The update of several traffic volumes is possible in the same B2B request.

1. Inherits from: Request

2. Attributes:

a. CapacityPlans plans (Mandatory)

Capacity plan reflecting the requested updates.

20.6.3.4.2. CapacityPlanUpdateReply

<<class>>

Returned in response to CapacityPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

Edition: 27.0 6 1350

Document Title: NM 27.0 - NM B2B Reference Manual

2. CONFLICTING_UPDATE

3. OBJECT_NOT_FOUND

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : errors when modifying the past (See
Airspace Past)

1. Inherits from: Reply

2. Attributes:

a. CapacityPlanUpdateReplyData data (Optional)

The reply data.

20.6.3.5. TrafficVolumeActivationPlanRetrievalRequest/Reply

MEP: S-R/R

Request: TrafficVolumeActivationPlanRetrievalRequest

Reply: TrafficVolumeActivationPlanRetrievalReply

Response time: 7 / 17 / 120 (ms)

Default settings: request count quotas

SOAP operation:

TrafficVolumeActivationPlanRetrievalReply
retrieveTrafficVolumeActivationPlan(TrafficVolumeActivationPlanRetrievalRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/trafficVolumeActivation

Retrieves the traffic volume activation plan for a given traffic volume on a given day.

20.6.3.5.1. TrafficVolumeActivationPlanRetrievalRequest

Edition: 27.0 6 1351

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to retrieve the traffic volume activation plan for a given traffic volume on a given day.

1. Inherits from: TacticalConfigurationRetrievalRequest

2. Attributes:

a. set< TrafficVolumeId > trafficVolumes (Mandatory)

The traffic volumes for which according activation plans are requested.

20.6.3.5.2. TrafficVolumeActivationPlanRetrievalReply

<<class>>

Returned in response to TrafficVolumeActivationPlanRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. TrafficVolumeActivationPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.6. TrafficVolumeActivationPlanUpdateRequest/Reply

Edition: 27.0 6 1352

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: TrafficVolumeActivationPlanUpdateRequest

Reply: TrafficVolumeActivationPlanUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

TrafficVolumeActivationPlanUpdateReply
updateTrafficVolumeActivationPlan(TrafficVolumeActivationPlanUpdateRequest
request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/trafficVolumeActivation

Updates the traffic volume activation plan for a given traffic volume on a given day.

20.6.3.6.1. TrafficVolumeActivationPlanUpdateRequest

<<class>>

Request to update the traffic volume activation plan for a given traffic volume on a given day.

The update of several traffic volumes is possible in the same B2B request.

Edition: 27.0 6 1353

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Request

2. Attributes:

a. TrafficVolumeActivationPlans plans (Mandatory)

Traffic volumes activation plans reflecting the requested updates.

20.6.3.6.2. TrafficVolumeActivationPlanUpdateReply

<<class>>

Returned in response to TrafficVolumeActivationPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

2. CONFLICTING_UPDATE

3. OBJECT_NOT_FOUND

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (see Transaction and Errors). For example : errors when modifying the past (see
Airspace Past).

1. Inherits from: Reply

2. Attributes:

a. TrafficVolumeActivationPlanUpdateReplyData data (Optional)

The reply data.

20.6.3.7. OTMVPlanRetrievalRequest/Reply

Edition: 27.0 6 1354

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: OTMVPlanRetrievalRequest

Reply: OTMVPlanRetrievalReply

Response time: 4 / 27 / 100 (ms)

Default settings: request count quotas

SOAP operation:

OTMVPlanRetrievalReply retrieveOTMVPlan(OTMVPlanRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/otmv

Retrieves, for a given day, the OTMV plans for a given traffic volume (for all applicable OTMV
durations) or the OTMV plan for a specific (traffic volume, OTMV duration) pair.

20.6.3.7.1. OTMVPlanRetrievalRequest

<<class>>

Request to retrieve for a given day, the OTMV plans for a given traffic volume (for all applicable
OTMV durations) or to retrieve the OTMV plan for a specific (traffic volume, OTMV duration) pair.

1. Inherits from: TacticalConfigurationRetrievalRequest

Edition: 27.0 6 1355

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. set< OTMVWithDuration > otmvsWithDuration (Mandatory)

The Set of OTMVWithDuration objects, which contain traffic volume and the OTMV plan is
requested.

20.6.3.7.2. OTMVPlanRetrievalReply

<<class>>

Returned in response to OTMVPlanRetrievalRequest.

Special error conditions:

1. OBJECT_NOT_FOUND

1. Inherits from: Reply

2. Attributes:

a. OTMVPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.8. OTMVPlanUpdateRequest/Reply

Edition: 27.0 6 1356

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: OTMVPlanUpdateRequest

Reply: OTMVPlanUpdateReply

Response time: 120 / 320 / 570 (ms)

Default settings: request count quotas

SOAP operation:

OTMVPlanUpdateReply updateOTMVPlan(OTMVPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/otmv

Updates, for a given day, the OTMV plan for a given (traffic volume, OTMV duration) pair.

20.6.3.8.1. OTMVPlanUpdateRequest

<<class>>

Request to update the OTMV plan for a given (traffic volume, OTMV duration) pair on a given day.

The update of several traffic volumes is possible in the same B2B request.

1. Inherits from: Request

Edition: 27.0 6 1357

Document Title: NM 27.0 - NM B2B Reference Manual

2. Attributes:

a. OTMVPlans plans (Mandatory)

OTMV plans reflecting the requested updates.

20.6.3.8.2. OTMVPlanUpdateReply

<<class>>

Returned in response to OTMVPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

2. CONFLICTING_UPDATE

3. OBJECT_NOT_FOUND

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (see Transaction and Errors). For example : errors when modifying the past (see
Airspace Past).

1. Inherits from: Reply

2. Attributes:

a. OTMVPlanUpdateReplyData data (Optional)

The reply data.

20.6.3.9. RunwayConfigurationPlanRetrievalRequest/Reply

Edition: 27.0 6 1358

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RunwayConfigurationPlanRetrievalRequest

Reply: RunwayConfigurationPlanRetrievalReply

Response time: 5 / 26 / 150 (ms)

Default settings: request count quotas

SOAP operation:

RunwayConfigurationPlanRetrievalReply
retrieveRunwayConfigurationPlan(RunwayConfigurationPlanRetrievalRequest request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/runwayConfiguration

Retrieves the runway configuration plan for a given aerodrome on a given day.

20.6.3.9.1. RunwayConfigurationPlanRetrievalRequest

<<class>>

Request to retrieve the runway configuration plan for a given aerodrome on a given day.

1. Inherits from: TacticalConfigurationRetrievalRequest

2. Attributes:

a. AerodromeICAOId aerodrome (Mandatory)

The aerodrome for which the runway configuration plan is requested.

Edition: 27.0 6 1359

Document Title: NM 27.0 - NM B2B Reference Manual

20.6.3.9.2. RunwayConfigurationPlanRetrievalReply

<<class>>

Returned in response to RunwayConfigurationPlanRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. RunwayConfigurationPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.10. RunwayConfigurationPlanUpdateRequest/Reply

MEP: S-R/R

Request: RunwayConfigurationPlanUpdateRequest

Reply: RunwayConfigurationPlanUpdateReply

Response time: 230 / 610 / 810 (ms)

Default settings: request count quotas

SOAP operation:

RunwayConfigurationPlanUpdateReply
updateRunwayConfigurationPlan(RunwayConfigurationPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/runwayConfiguration

Updates the runway configuration plan for a given aerodrome on a given day.

20.6.3.10.1. RunwayConfigurationPlanUpdateRequest

Edition: 27.0 6 1360

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update the runway configuration plan for a given aerodrome on a given day.

1. Inherits from: Request

2. Attributes:

a. RunwayConfigurationPlan plan (Mandatory)

Runway configuration plan reflecting the requested updates.

20.6.3.10.2. RunwayConfigurationPlanUpdateReply

<<class>>

Returned in response to RunwayConfigurationPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

2. CONFLICTING_UPDATE

Edition: 27.0 6 1361

Document Title: NM 27.0 - NM B2B Reference Manual

3. OBJECT_NOT_FOUND

4. INVALID_INPUT

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : errors when modifying the past (see
Airspace Past).

1. Inherits from: Reply

2. Attributes:

a. RunwayConfigurationPlanUpdateReplyData data (Optional)

The reply data.

20.6.3.11. HotspotListRequest/Reply

MEP: S-R/R

Request: HotspotListRequest

Reply: HotspotListReply

Response time: not available

Default settings: request count quotas

SOAP operation:

HotspotListReply queryHotspots(HotspotListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /hotspots

• assert certificate read access to /hotspots?kind=LOCATION_OF_INTEREST

if request.hotspotKind=LOCATION_OF_INTEREST

• assert certificate read access to /hotspots?kind=PROBLEM

if request.hotspotKind=PROBLEM

Edition: 27.0 6 1362

Document Title: NM 27.0 - NM B2B Reference Manual

Queries for a given day and a hotspot kind:

• the hotspots for all traffic volumes and for all applicable durations, or

• the hotspots for a given traffic volume for all applicable durations, or

• the hotspots for a specific (traffic volume, duration) pair.

20.6.3.11.1. HotspotListRequest

<<class>>

Request to retrieve for a given day and a hotspotKind, the hotspots for all traffic volumes and for all
applicable durations or the hotspots for a given traffic volume for all applicable durations, or to
retrieve the hotspots for a specific (traffic volume, duration) pair.

There exists 2 types of hotspots : LOCATION_OF_INTEREST hotspots and PROBLEM hotspots. See
usage limitations at HotspotKind.

Basically, LOCATION_OF_INTEREST hotspots are used operationally to raise awareness about

difficult conditions, e.g. severe weather storms or satellite missile launches.

LOCATION_OF_INTEREST are created/prepared by NMOC in the context of the dynamic Network

Plan (See NOP) the day before. However tactically they are not updated. So typically on the
OPERATIONAL dataset, this data is about weather forecasts prepared the day before (before 16:00
UTC).

Specific error conditions:

1. Permanent error: OBJECT_NOT_FOUND reply status if the traffic volume is not known or if it is a

Edition: 27.0 6 1363

Document Title: NM 27.0 - NM B2B Reference Manual

traffic volume that does not have as reference location an airspace.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset for which the hotspot list is requested. See Forecast and Operational Datasets.

b. DateYearMonthDay day (Mandatory)

Day for which the hotspot list is requested.

c. TrafficVolumeId trafficVolume (Contextual)

The traffic volume for which the hotspot list is requested. If not present then all hotspots of
hotspotKind are returned.

i. Presence:

▪ Optional in HotspotListRequest

▪ Mandatory otherwise

d. DurationHourMinute duration (Optional)

Selects the hotspots applying to the given traffic volume according to their duration.

When not specified, all duration are considered.

i. Constraints:

▪ HotspotListRequest.DURATION_MUST_BE_0001_WITH_LOCATION_OF_INTEREST

e. HotspotKind hotspotKind (Mandatory)

The kind of hotspot.

i. Constraints:

▪ HotspotListRequest.DURATION_MUST_BE_0001_WITH_LOCATION_OF_INTEREST

3. Constraints:

a. DURATION_MUST_BE_0001_WITH_LOCATION_OF_INTEREST

The duration must be 0001 when hotspotKind is LOCATION_OF_INTEREST .

Constrained attributes: duration, hotspotKind

Constrained requests: any using request

20.6.3.11.2. HotspotListReply

<<class>>

Edition: 27.0 6 1364

Document Title: NM 27.0 - NM B2B Reference Manual

Returned in response to HotspotListRequest.

1. Inherits from: Reply

2. Attributes:

a. HotspotListReplyData data (Optional)

The reply payload.

20.6.3.12. HotspotPlanUpdateRequest/Reply

MEP: S-R/R

Request: HotspotPlanUpdateRequest

Reply: HotspotPlanUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

HotspotPlanUpdateReply updateHotspots(HotspotPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate write access to /hotspots

• assert certificate write access to /hotspots?kind=LOCATION_OF_INTEREST

if request.plans.hotspotKind=LOCATION_OF_INTEREST

• assert certificate read access to /hotspots?kind=PROBLEM

if request.plans.hotspotKind=PROBLEM

Updates the hotspot plans for a set of (traffic volume, duration) pairs on a given day.

20.6.3.12.1. HotspotPlanUpdateRequest

Edition: 27.0 6 1365

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to update the hotspot plans for a set of (traffic volume, duration) pairs on a given day.

There exists 2 types of hotspots : LOCATION_OF_INTEREST hotspots and

IMPORTANT
PROBLEM hotspots. See usage limitations at HotspotKind.

Note that the service includes Hotspot creation and Hotspot cancellation.

Specific error conditions:

1. Temporary error: INVALID_DATASET reply status if the FORECAST update was rejected due to D-1
forecast update cut-off or if the OPERATIONAL update was rejected due to D-1 plan not transferred
yet.

2. Permanent error: CONFLICTING_UPDATE reply status if the update failed due to incompatible
concurrent changes.

3. Permanent error: OBJECT_NOT_FOUND reply status if one of the traffic volumes is not known or if
there is PROBLEM hotspot with a traffic volume that does not have as reference location an
airspace.

4. Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : errors when modifying the past (see
Airspace Past)

5. If errors are detected with at least one of the hotspot plans, then none of the hotspotplans are
updated in NM systems.

1. Inherits from: Request

2. Attributes:

a. HotspotPlans plans (Mandatory)

Hotspot plans reflecting the requested updates.

Edition: 27.0 6 1366

Document Title: NM 27.0 - NM B2B Reference Manual

20.6.3.12.2. HotspotPlanUpdateReply

<<class>>

Returned in response to HotspotPlanUpdateRequest.

1. Inherits from: Reply

2. Attributes:

a. HotspotPlanUpdateReplyData data (Optional)

The reply payload.

20.6.3.13. RestrictionActivationPlanRetrievalRequest/Reply

MEP: S-R/R

Request: RestrictionActivationPlanRetrievalRequest

Reply: RestrictionActivationPlanRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RestrictionActivationPlanRetrievalReply
retrieveRestrictionActivationPlan(RestrictionActivationPlanRetrievalRequest
request)

Access mode: READ

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate read access to /plans/restrictionActivation

Retrieves the restriction activation plan for one or more given restrictions on a given day.

20.6.3.13.1. RestrictionActivationPlanRetrievalRequest

Edition: 27.0 6 1367

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Request to retrieve the restriction activation plan for one or more given restrictions on a given day.

If one of the restrictions is not valid (e.g. not existing), then processing stops and an error is
returned (instead of simply ignoring the NOK restrictions).

Note that only dynamcally updatable Profile Tuning restrictione can be queried (i.e. those that are
marked in NM CACD as dynamically updatable by NMOC (on request of FMP)). However, in
simulations one can query/update any RAD or PTR.

Note that the dynamically updatable flag itself is not exported via B2B (AIXM). However, the B2B
client can still determine if a restriction is dynamically updatable, by querying it’s activation plan
in operational or forecast (when no error is returned, it means it’s dynamically updatable).

1. Inherits from: TacticalConfigurationRetrievalRequest

2. Attributes:

a. set< RestrictionId > restrictions (Mandatory)

The restrictions for which according activation plans are requested.

20.6.3.13.2. RestrictionActivationPlanRetrievalReply

<<class>>

Returned in response to RestrictionActivationPlanRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. RestrictionActivationPlanRetrievalReplyData data (Optional)

The reply data.

20.6.3.14. RestrictionActivationPlanUpdateRequest/Reply

Edition: 27.0 6 1368

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: RestrictionActivationPlanUpdateRequest

Reply: RestrictionActivationPlanUpdateReply

Response time: not available

Default settings: request count quotas

SOAP operation:

RestrictionActivationPlanUpdateReply
updateRestrictionActivationPlan(RestrictionActivationPlanUpdateRequest request)

Access mode: WRITE

Accessed dataset: the value of request.dataset.type

Access check list:

• assert certificate write access to /plans/restrictionActivation

Updates the restriction activation plan for a given set of restriction on a given day.

20.6.3.14.1. RestrictionActivationPlanUpdateRequest

<<class>>

Request to update the restriction activation plan for a given set of restriction on a given day. Note
that updating a restriction plan also updates the concerned flights profiles (including already
airborne flights).

Edition: 27.0 6 1369

Document Title: NM 27.0 - NM B2B Reference Manual

The update of several restrictions is possible in the same B2B request.

If one of the restrictionplans has validation errors, then actual processing does not start and an
error is returned (instead of simply ignoring the NOK restrictions).

Note that only dynamcally updatable Profile Tuning restrictions can be updated (see
RestrictionActivationPlanRetrievalRequest). However, in simulations one can query/update any
RAD or PTR.

1. Inherits from: Request

2. Attributes:

a. RestrictionActivationPlans plans (Mandatory)

Restrictions activation plans reflecting the requested updates.

20.6.3.14.2. RestrictionActivationPlanUpdateReply

<<class>>

Returned in response to RestrictionActivationPlanUpdateRequest.

Special error conditions:

1. INVALID_DATASET

2. CONFLICTING_UPDATE

3. OBJECT_NOT_FOUND

Note that there are also the INVALID_INPUT replyStatus errors, that cover the errors detected by
the backend (See Transaction and Errors). For example : errors when modifying the past (see
Airspace Past).

1. Inherits from: Reply

2. Attributes:

Edition: 27.0 6 1370

Document Title: NM 27.0 - NM B2B Reference Manual

a. RestrictionActivationPlanUpdateReplyData data (Optional)

The reply data.

20.7. Simulations Port Type

20.7.1. Overview

1. This service is intended to provide querying and management capabilities of Simulations. The
requests currently available are:

a. S-R/R SimulationListRequest/Reply

b. S-R/R SimulationAvailabilityRequest/Reply

c. S-R/R SimulationStartRequest/Reply

d. S-R/R SimulationStopRequest/Reply

e. S-R/R SimulationResetRequest/Reply

20.7.2. Concepts

20.7.2.1. Simulations

Last updated: 27.0 - Edition 2

1. NM supports "flow simulation" features, where NM prepares simulations (airspace, traffic,

strike scenarios). A simulation is basically a sandboxed environment containing some
environment data, some traffic and a plan. It allows different actors to look at effects of a
specific user scenario that is simulated and allows the different actors to interact with the
simulation (for example: updating runway activations/sector configurations, regulations). In
addition (selected) changes can be pushed back to the server.

There can be more than 1 such simulations ongoing at the same time, each evaluating different
What-If scenarios. Each such simulation is identified by a simulationId.

2. For this reason, the dataset types presented below are not limited to "forecast" and
"operational" as indicated above, but include also "simulation" datasets. More details can be
found below within the DatasetType and Dataset type descriptions.

3. There are 4 main types of simulation:

◦ Simulations on OPERATIONAL: Such simulations are started with a snapshot of the data
contained in OPERATIONAL. Flights and regulations are automatically loaded from the
OPERATIONAL dataset when such a simulation is started for the simulationPeriod (the
period that is being simulated). The user can then modify regulations and reroutings and
tactical updates and query the results via flight list, counts, regulations list etc. Optionally
the B2B user can compare the results (e.g. counts) of the simulation with the results on the
reference dataset (i.e. the operational dataset itself).

◦ Simulations on FORECAST: Such simulations are started with a snapshot of the data

Edition: 27.0 6 1371

Document Title: NM 27.0 - NM B2B Reference Manual

contained in FORECAST. The user can then modify regulations and reroutings and tactical
updates and query the results via flightlist, counts, regulations list etc. Optionally the B2B
user can compare the results (e.g. counts) of the simulation with the results on the reference
dataset (i.e. the forecast dataset itself).

◦ STANDALONE_SIMEX: The simulation is a standalone SIMulation Experiment (SIMEX).

Special future events are typically prepared and simulated on SIMEX with specially
modified environment (CACD) data and forecasted traffic for a date in the future. These type
of simulation are managed (start/stop) and prepared by NMOC for the other users (B2B and
B2C) to have a look at the results. Optionally the B2B user can make changes to this
STANDALONE_SIMEX. There can be more than one STANDALONE_SIMEX: NMOC can
prepare multiple independent future events at the same time.

◦ Simulations on a STANDALONE_SIMEX: Such simulations are started with a snapshot of the

data contained in a STANDALONE_SIMEX reference dataset. The user can then modify
regulations and reroutings and tactical updates and query the results via flight list, counts,
regulations list etc. Optionally the B2B user can compare the results (e.g. counts) of the
simulation with the results on the reference dataset (i.e. the STANDALONE_SIMEX dataset
itself).

4. A simulation can be managed by NMOC or by B2B (or NOP) users. For a NMOC managed
simulation, the typical workflow is:

◦ NMOC first starts and prepares a simulation.

◦ The client application then queries the simulations currently running in NM systems (via
the querySimulations service request). The result contains the details of the different
simulations and the datasets of those simulations.

◦ Then the client application can do counts, flight list, regulation list, create or modify
regulations or reroutings etc by specifying the dataset on which to do the requested
operation.

5. For a simulation managed by the client application:

◦ The client application first queries the available simulations that can be used to start a
simulation. (via queryAvailableSimulations). There is only a limited pool of user managed
simulations available.

◦ If there are still simulations available, the client application starts a new simulation on the
desired reference: so either a simulation on OPERATIONAL or on FORECAST or on a
STANDALONE_SIMEX.

◦ Once the user is done with the simulation, the simulation needs to be stopped (via
stopSimulation) to make it available again for the next startSimulation request.

6. If for a simulation, the simulationPeriod (the period that is being simulated) is in the past, then
counts, flight list, etc., can no longer retrieve any data (as e.g. flight list and count querying
expects the queried date to be inside of the reference data set period). So the simulation needs
to be stopped. See also SimulationListRequest.

7. To better support the impact assessment of one or more measures, the client application can
query both the CURRENT and INITIAL states of a simulation (see Dataset.simulationState), e.g. via
the ATFCMSituationRequest/Reply.

Edition: 27.0 6 1372

Document Title: NM 27.0 - NM B2B Reference Manual

However, only READ Requests/Replies are allowed to access the INITIAL state of a simulation.

8. If the user wants to evaluate different solutions (e.g. regulations) for a problem, the client
application should not start multiple simulations in parallel (using multiple simulation slots of
the fixed amount available in NM systems). The B2B client should rather evaluate the diferent
solutions, one after the other (using resetSimulation in between to each time revert to the
INITIAL state) and in the end show the results/comparison of the different solutions evaluated
(see Dataset.simulationState).

20.7.3. Requests/Replies

20.7.3.1. SimulationListRequest/Reply

MEP: S-R/R

Request: SimulationListRequest

Reply: SimulationListReply

Response time: 10 / 23 / 340 (ms)

Default settings: request count quotas

SOAP operation:

SimulationListReply querySimulations(SimulationListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Queries the published simulations.

20.7.3.1.1. SimulationListRequest

Edition: 27.0 6 1373

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Documentation last updated: 27.0 - Edition 6

Request to query the published simulations.

A simulation is basically a sandboxed environment containing some environment data, some traffic
and a plan. It allows different actors to look at effects of a specific user scenario that is simulated
and allows the different actors to interact with the simulation (for example: updating runway
activations/sector configurations, regulations). In addition (selected) changes can be pushed back to
the server.

Simulations can be started via B2C and/or B2B and/or by NMOC.

When an NMOC user starts a simulation, the NMOC user can decide to publish the simulation (i.e.
make the simulation accessable via B2C and B2B). The simulation remains accessible via B2C and
B2B until the simulation is unpublished or until the simulation is stopped.

When a simulation is started via B2C and/or B2B, then that simulation is considered always
published (accessible via B2C and B2B) until the simulation is stopped via B2C or B2B.

A simulation typically is based on a reference: starting the simulation implies copying all the flight,
regulation, environment, and tactical-updates related data into the simulation from a reference
dataset: typically operational or forecast. This is the reference from which the data has been
loaded. The user can then, after having created or modified some regulations or reroutings,
compare the results with the data in the reference dataset.

There is a limited number of simulation engines available for the users to start and stop. The user
needs to stop a simulation after having started it, in order to make the simulation engine available
again for the users.

A simulation only support processing one request in parallel. So the B2B user should serialise the
simulation requests (e.g. counts and flightlist and regulation creations).

See also general text on simulations.

Edition: 27.0 6 1374

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Request

2. Attributes:

a. SimulationId retrieveFilter (Optional)

Retrieves the simulation corresponding to a specific simulation. By default all simulations

are returned.

b. DatasetReference datasetReference (Optional)

Retrieves the simulation corresponding to a specific reference data set. By default all
simulations are returned.

20.7.3.1.2. SimulationListReply

<<class>>

Returned in response to SimulationListRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationListReplyData data (Optional)

The reply payload.

20.7.3.2. SimulationAvailabilityRequest/Reply

MEP: S-R/R

Request: SimulationAvailabilityRequest

Reply: SimulationAvailabilityReply

Response time: 9 / 31 / 350 (ms)

Default settings: request count quotas

SOAP operation:

SimulationAvailabilityReply
queryAvailableSimulations(SimulationAvailabilityRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Edition: 27.0 6 1375

Document Title: NM 27.0 - NM B2B Reference Manual

Queries simulation availability information per dataset, in order to start a user managed
simulation.

20.7.3.2.1. SimulationAvailabilityRequest

<<class>>

Request to query the available (user managed) simulation engines that can be used to start a
simulation.

1. Inherits from: Request

2. Attributes:

a. DatasetReference datasetReference (Optional)

Retrieves the available user managed simulations corresponding to a specific reference data
set.

By default all available user_managed simulations are returned

20.7.3.2.2. SimulationAvailabilityReply

<<class>>

Returned in response to SimulationAvailabilityRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationAvailabilityReplyData data (Optional)

The reply payload.

Edition: 27.0 6 1376

Document Title: NM 27.0 - NM B2B Reference Manual

20.7.3.3. SimulationStartRequest/Reply

MEP: S-R/R

Request: SimulationStartRequest

Reply: SimulationStartReply

Response time: 4700 / 8700 / 11000 (ms)

Default settings: request count quotas

SOAP operation:

SimulationStartReply startSimulation(SimulationStartRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Starts a user managed simulation.

20.7.3.3.1. SimulationStartRequest

<<class>>

Request to start a user managed simulation based on a reference.

All environment (CACD) data, tactical updates, flights and measures are initially loaded from the
reference.

Note that, once the flights have been loaded into the simulation, the flighs are not updated , except
for timers related events (like terminating the flights when they should have landed) and actions

Edition: 27.0 6 1377

Document Title: NM 27.0 - NM B2B Reference Manual

done in the simlation(like creating or modifying regulations or rerouting). So new radar info or
flightUpdate related info is not processed in the simulation.

Note that starting the simulation and loading the flights can take some time. (typically around 30
seconds to 1 minute)

Note that when the user is done with the simulation, the user needs to use the StopSimulation
service to free the simulation again.

1. Inherits from: Request

2. Attributes:

a. UserManagedSimulation newSimulation (Mandatory)

The simulation to start.

The reference dataset shall indicate the reference for the new simulation.

20.7.3.3.2. SimulationStartReply

<<class>>

Returned in response to SimulationStartRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationStartReplyData data (Optional)

The reply payload.

20.7.3.4. SimulationStopRequest/Reply

Edition: 27.0 6 1378

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SimulationStopRequest

Reply: SimulationStopReply

Response time: 1600 / 6000 / 8200 (ms)

Default settings: request count quotas

SOAP operation:

SimulationStopReply stopSimulation(SimulationStopRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Stops a user managed simulation.

20.7.3.4.1. SimulationStopRequest

<<class>>

Request to stop a user managed simulation. This will free the simulation and make it available to
start again.

Note that stopping a simulation can take some time (typically around 1 or 2 minutes).

1. Inherits from: Request

2. Attributes:

a. Dataset simulation (Mandatory)

Edition: 27.0 6 1379

Document Title: NM 27.0 - NM B2B Reference Manual

The dataset of the UserManagedSimulation that needs to be stopped.

i. Constraints:

▪ SimulationStopRequest.INVALID_DATASET_TYPE

▪ SimulationStopRequest.INVALID_SIMULATION_TYPE

3. Constraints:

a. INVALID_DATASET_TYPE

The simulation.type must be set to SIMULATION.

Constrained attributes: simulation

Constrained requests: any using request

b. INVALID_SIMULATION_TYPE

The simulation.simulationIdentifier.simulationType must be set to USER_MANAGED_SIMULATION.

Constrained attributes: simulation

Constrained requests: any using request

20.7.3.4.2. SimulationStopReply

<<class>>

Returned in response to SimulationStopRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationStopReplyData data (Optional)

The reply payload.

20.7.3.5. SimulationResetRequest/Reply

Edition: 27.0 6 1380

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: SimulationResetRequest

Reply: SimulationResetReply

Response time: 3300 / 4000 / 4100 (ms)

Default settings: request count quotas

SOAP operation:

SimulationResetReply resetSimulation(SimulationResetRequest request)

Access mode: WRITE

Accessed dataset: OPERATIONAL

Documentation last updated: 27.0 - Edition 1

Resets a user managed simulation to its initial state (see Dataset.simulationState).

20.7.3.5.1. SimulationResetRequest

<<class>>

Documentation last updated: 27.0 - Edition 1

Request to reset a user managed simulation to its initial state(see Dataset.simulationState).

1. Inherits from: Request

2. Attributes:

Edition: 27.0 6 1381

Document Title: NM 27.0 - NM B2B Reference Manual

a. Dataset simulation (Mandatory)

The dataset of the UserManagedSimulation that needs to be reset.

i. Constraints:

▪ SimulationResetRequest.INVALID_SIMULATION_TYPE

3. Constraints:

a. INVALID_SIMULATION_TYPE

The simulation.simulationIdentifier.simulationType must be set to USER_MANAGED_SIMULATION.

The simulation.type must be set to SIMULATION.

Constrained attributes: simulation

Constrained requests: any using request

20.7.3.5.2. SimulationResetReply

<<class>>

Returned in response to SimulationResetRequest.

1. Inherits from: Reply

2. Attributes:

a. SimulationResetReplyData data (Optional)

The reply payload.

20.8. ScenarioRepository Port Type

20.8.1. Overview

1. This service is intended to provide querying and update capabilities on the ScenarioRepository.
The requests currently available are:

a. S-R/R ScenarioRegulationRetrievalRequest/Reply

b. S-R/R ScenarioReroutingRetrievalRequest/Reply

c. S-R/R ScenarioListRequest/Reply

20.8.2. Concepts

20.8.2.1. Scenario Repository

1. The scenario repository contains pre-defined (and pre-agreed) solutions to handle an overload:
scenarios.

Edition: 27.0 6 1382

Document Title: NM 27.0 - NM B2B Reference Manual

2. Typically the solutions make the flight reroute horizontally or vertically to avoid a congested
airspace.

3. To handle an overload an FMP can decide to either regulate the concerned traffic volume(s) or
the FMP can implement one or more FL or RR type scenarios.

4. Those scenarios contain a zero rate suspending regulation "forcing" the flights to reroute
outside of the congested airspace.

Those scenarios also contain a rerouting. The rerouting allows to evaluate the impact of
applying the 0 rate suspending regulation: applying the rerouting shows how the flights are
expected to fly.

5. Note it is the Airspace user that decides how he will file to avoid the congested airspace.

The rerouting gives a possible way to reroute: it represents the most likely or most efficient way
for the flights to reroute.

6. STAM scenario typically contain only cherry picked rerouting. When applied, the Airspace User
receives from NM systems an RRN message indicating that airspace user should reroute. In this
STAM case, the flights are not suspended.

7. Note that a scenario can have multiple measures : for example a contingency scenario contains
multiple measures (on different traffic volumes) that can be used to handle the contingency.

When such a scenario is applied one or more measures of the scenario are applied (but not
necessarily all measures of the scenario).

8. The scenario from the scenario repository are published to the external users (AO, FMP,..) via
the public portal and via B2B.

9. The scenario allow airspace users to have an idea how to refile and it allows FMP to know
where the typical on-load and off-load areas are in case he scenario is applied.

10. The B2B user can query, via flightlist and traffic count, the applicableScenarios for a problem
traffic volume (e.g. "overloaded" ).

The result will include all the different scenarios (on different traffic volumes) that can off-load
the problem traffic volume.

11. The queryScenarioRepository service request can be used to retrieve the details about the
scenarios.

12. The retrieveRegulationsFromScenario and retrieveReroutingsFromScenario service requests can

then be used to retrieve the applicable measures themselves from these scenarios.

13. The scenario regulations can then be applied via B2B in:

◦ A NM simulation (to evaluate the impact) via the createRegulation service request for a
simulation dataset

◦ or can be requested for implementation in FORECAST or in OPERATIONAL via the

fileRegulationProposal service request.

14. The scenario rerouting can then be applied via B2B in:

Edition: 27.0 6 1383

Document Title: NM 27.0 - NM B2B Reference Manual

◦ A NM simulation (to evaluate the impact) via the createRerouting service request for a
simulation dataset.

◦ FORECAST or in OPERATIONAL via createRerouting service: only supported for cherry

picked rerouting (e.g. STAM type scenario) with a scenario reference pointing to an existing
scenario measure Note that in that case, the traffic volume of the rerouting needs to match
the traffic volume of the scenario measure.

15. Note that in specific trial contexts, NM test systems can be configured to also accept creating any
type of rerouting in FORECAST or OPERATIONAL.

16. Note that the scenario repository is shared between FORECAST and OPERATIONAL. So when
querying the scenario repository, it will return the same result for FORECAST or OPERATIONAL
or any simulation that has as reference forecast or operational.

20.8.3. Requests/Replies

20.8.3.1. ScenarioRegulationRetrievalRequest/Reply

MEP: S-R/R

Request: ScenarioRegulationRetrievalRequest

Reply: ScenarioRegulationRetrievalReply

Response time: not available

Default settings: request count quotas

SOAP operation:

ScenarioRegulationRetrievalReply
retrieveRegulationsFromScenario(ScenarioRegulationRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /scenarios

• assert certificate read access to /regulations

Retrieves the list of regulations of a scenario.

Edition: 27.0 6 1384

Document Title: NM 27.0 - NM B2B Reference Manual

20.8.3.1.1. ScenarioRegulationRetrievalRequest

<<class>>

Request to retrieve the regulation(s) contained in scenario from the scenario repository.

1. Inherits from: ScenarioMeasureRetrievalRequest

2. Attributes:

a. set< RegulationField > requestedRegulationFields (Mandatory)

The reply returns only the requested regulation fields in this set, and only if the values of
these requested fields are available at NM. Note that the regulation id is always returned.

20.8.3.1.2. ScenarioRegulationRetrievalReply

<<class>>

Returned in response to ScenarioRegulationRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. ScenarioRegulationRetrievalReplyData data (Optional)

The reply payload.

20.8.3.2. ScenarioReroutingRetrievalRequest/Reply

Edition: 27.0 6 1385

Document Title: NM 27.0 - NM B2B Reference Manual

MEP: S-R/R

Request: ScenarioReroutingRetrievalRequest

Reply: ScenarioReroutingRetrievalReply

Response time: 110 / 160 / 250 (ms)

Default settings: request count quotas

SOAP operation:

ScenarioReroutingRetrievalReply
retrieveReroutingsFromScenario(ScenarioReroutingRetrievalRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /scenarios

• assert certificate read access to /reroutings

Retrieves the list of reroutings of a scenario.

20.8.3.2.1. ScenarioReroutingRetrievalRequest

<<class>>

Request to retrieve rerouting contained in scenario from the scenario repository.

Edition: 27.0 6 1386

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: ScenarioMeasureRetrievalRequest

2. Attributes:

a. set< ReroutingField > requestedReroutingFields (Mandatory)

The reply returns only the requested rerouting fields in this set, and only if the values of
these requested fields are available at NM. Note that the regulation id is always returned.

20.8.3.2.2. ScenarioReroutingRetrievalReply

<<class>>

Returned in response to ScenarioReroutingRetrievalRequest.

1. Inherits from: Reply

2. Attributes:

a. ScenarioReroutingRetrievalReplyData data (Optional)

Data

20.8.3.3. ScenarioListRequest/Reply

MEP: S-R/R

Request: ScenarioListRequest

Reply: ScenarioListReply

Response time: 600 / 820 / 1100 (ms)

Default settings: request count quotas

SOAP operation:

ScenarioListReply queryScenarioRepository(ScenarioListRequest request)

Access mode: READ

Accessed dataset: OPERATIONAL

Access check list:

• assert certificate read access to /scenarios

Queries scenarios.

Edition: 27.0 6 1387

Document Title: NM 27.0 - NM B2B Reference Manual

20.8.3.3.1. ScenarioListRequest

<<class>>

Request to query the scenario and the scenario attributes from the scenario repository.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset for which the scenario list is requested. See Forecast and Operational Datasets.

b. DateTimeSecond scenarioModifiedSince (Optional)

Selects scenario only that have been modified since this time.

i. Constraints:

▪ ScenarioListRequest.INVALID_SCENARIO_MODIFIED_SINCE

c. set< TrafficVolumeId > concerningTrafficVolumes (Optional)

Selects scenario only with a traffic volume that matches an entry in this set.

d. set< ScenarioId > fromScenarios (Optional)

Selects only scenario that matches an entry in this set.

e. set< ScenarioName > fromPublicationIds (Optional)

Selects only scenario that matches an entry in this set.

f. set< AirNavigationUnitId > ownerFMPs (Optional)

Selects scenario only with a owner (FMP) that matches an entry in this set.

Edition: 27.0 6 1388

Document Title: NM 27.0 - NM B2B Reference Manual

3. Constraints:

a. INVALID_SCENARIO_MODIFIED_SINCE

scenarioModifiedSince shall be after 2010-01-01 00:00:00

Constrained attributes: scenarioModifiedSince

Constrained requests: any using request

20.8.3.3.2. ScenarioListReply

<<class>>

Returned in response to ScenarioListRequest.

Reply to the query scenario attributes from the scenario repository.

1. Inherits from: Reply

2. Attributes:

a. ScenarioListReplyData data (Optional)

Data

20.9. Data Types

20.9.1. AerodromeLocation
<<class>>

Aerodrome location.

1. Inherits from: Location

Edition: 27.0 6 1389

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.2. AirspaceLocation
<<class>>

Airspace location.

1. Inherits from: Location

20.9.3. AllFlightsLocation
<<class>>

All flights location.

1. Inherits from: Location

20.9.4. AoLocation
<<class>>

Aircraft operator location.

1. Inherits from: Location

20.9.5. ATFCMSituationCounts
<<class>>

ATFCM situation counts.

1. Attributes:

a. CountsValue landedFlightCount (Mandatory) (new 27.0)

Number of flights which are landed.

Includes all flights whose status is either ATC terminated, TACT terminated, expecting FSA,
or TACT terminated without expecting FSA.

b. CountsValue airborneFlightCount (Mandatory) (new 27.0)

Number of flights which are airborne.

Includes all flights whose status is either ATC activated, TACT activated expecting FSA, or
TACT activated without expecting FSA.

c. CountsValue expectedFlightCount (Mandatory) (new 27.0)

Number of flights that have not taken off as of ATFCMSituationReply.data.lastUpdated.

d. CountsValue undefinedSlotComplianceFlightCount (Mandatory) (new 27.0)

Includes all regulated and not suspended flights for which slot compliance information is

Edition: 27.0 6 1390

Document Title: NM 27.0 - NM B2B Reference Manual

not known.

e. CountsValue beforeSlotDepartureFlightCount (Mandatory) (new 27.0)

Includes all regulated and not suspended flights whose ATOT is before (CTOT-5) minutes.

f. CountsValue slotCompliantFlightCount (Mandatory) (new 27.0)

Includes all regulated and not suspended flights whose ATOT is either at or between (CTOT-
5) and (CTOT+10) minutes.

g. CountsValue afterSlotDepartureFlightCount (Mandatory) (new 27.0)

Includes all regulated and not suspended flights whose ATOT is after (CTOT+10) minutes.

h. CountsValue atfmMeasureSuspendedFlightCount (Mandatory) (new 27.0)

Number of flights which are suspended due to an ATFM measure.

Includes all suspended flights whose suspension status is either

REGULATION_CONFIRMATION or TRAFFIC_VOLUMES_CONDITION.

i. CountsValue famSuspendedFlightCount (Mandatory) (new 27.0)

Number of flights which are suspended due to FAM.

Includes all suspended flights whose suspension status is NOT_REPORTED_AS_AIRBORNE.

j. CountsValue delayedFlightCount (Mandatory) (new 27.0)

Number of flights which are delayed.

k. CountsValue significantlyDelayedFlightCount (Mandatory) (new 27.0)

Number of flights of which delay is greater than a configuration threshold. The threshold is
currently set to 30 minutes.

l. CountsValue forecastFlightCount (Mandatory) (new 27.0)

Number of forecast flights.

2. Used by: ATFCMSituationReplyData

20.9.6. ATFCMSituationDelays
<<class>>

ATFCM situation delays.

1. Attributes:

a. LongDurationHourMinute enRouteDelay (Mandatory)

Edition: 27.0 6 1391

Document Title: NM 27.0 - NM B2B Reference Manual

Includes all regulated and not suspended flights which are subject to a most penalising
regulation whose reference location is not an airport or a set of airports.

b. LongDurationHourMinute airportDelay (Mandatory)

Includes all regulated and not suspended flights which are subject to a most penalising
regulation whose reference location is an airport or a set of airports.

c. map< RegulationReason, LongDurationHourMinute > delaysPerRegulationReason (Mandatory)

Total delays per regulation reasons.

i. Constraints:

▪ map size range : [1, 15]

2. Used by: ATFCMSituationReplyData

20.9.7. ATFCMSituationRegulation
<<class>>

Regulation in ATFCM situation.

1. Attributes:

a. RegulationId regulationId (Mandatory)

Regulation unique identifier.

b. DateTimeMinutePeriod period (Mandatory)

Period.

c. TrafficVolumeId trafficVolumeId (Mandatory)

Traffic volume id.

d. RegulationState regulationState (Mandatory)

Regulation state.

e. RegulationReason regulationReason (Mandatory)

Regulation reason.

f. LongDurationHourMinute delay (Mandatory)

Documentation last updated: 27.0 - Edition 2

The cumulated delay of the flights having the regulation as most penalising regulation.

g. CountsValue impactedFlightCount (Mandatory) (new 27.0)

Edition: 27.0 6 1392

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 2

Number of flights which are crossing the regulation location during the regulation
activation period.

This count does not reflect the number of flight really impacted by the
CAUTION regulation. Flights that receive no delay from this regulation might be
included in this count.

h. AerodromeICAOId protectedAerodrome (Optional)

The protected aerodrome of the regulation.

2. Used by: DeltaATFCMSituationRegulation, ATFCMSituationReplyData

20.9.8. ATFCMSituationReplyData
<<class>>

Documentation last updated: 27.0 - Edition 2

The ATFCMSituationReply payload.

The average delay of an ATFCM situation is defined as:

IMPORTANT
(delays.enRouteDelay + delays.airportDelay) /
counts.delayedFlightCount

1. Attributes:

a. DateTimeSecond lastUpdated (Mandatory)

Indicates when the ATFCM situation was last updated.

b. ATFCMSituationCounts counts (Mandatory)

ATFCM situation counts.

c. ATFCMSituationDelays delays (Mandatory)

ATFCM situation delays.

d. set< ATFCMSituationRegulation > regulations (Optional)

ATFCM situation regulations.

i. Constraints:

▪ set size range : [1, 10000]

2. Used by: ATFCMSituationReply

Edition: 27.0 6 1393

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.9. AvoidAirspaceReroutingKind
<<enumeration>>

Enumeration of possible Avoid Airspace Kinds.

1. Values:

a. HORIZONTAL

Avoid an airspace by an horizontal change of the route.

b. VERTICAL

Avoid an airspace by a flight level change.

c. HORIZONTAL_OR_VERTICAL

Avoid an airspace by horizontal change of the route or by a flight level change.

2. Used by: AvoidViaAirspaceReroutingConstraint

20.9.10. AvoidViaAirspaceReroutingConstraint

<<class>>

Describes a manual rerouting constraint to avoid an airspace or to force the flights to cross an
airspace. The AvoidViaAirspaceReroutingConstraint applies to both horizontal and vertical rerouting
constraints.

1. Inherits from: ReroutingConstraint

2. Attributes:

a. AvoidViaReroutingType type (Mandatory)

Edition: 27.0 6 1394

Document Title: NM 27.0 - NM B2B Reference Manual

The kind of restriction.

b. AirspaceId location (Mandatory)

Documentation last updated: 27.0 - Edition 6

The airspace identifier.

For information about the airspace identifier format, see AirspaceId

CAUTION
documentation.

c. AvoidAirspaceReroutingKind avoidKind (Optional)

If it concerns an avoid airspace rerouting constraint, indicates how the airspace is to be

avoided (horizontally or vertically). If not present, then the default is used: if the vertical
rerouting source is used, then defaults to Vertical otherwise horizontal. Note the typical use
case is: a level cap (vertical rerouting) that sometimes has to slightly change horizontally as
well (to e.g. respect the DCT restrictions at lower levels). In this case, the B2B client would
need to create a horizontal rerouting with avoid airspace vertically.

20.9.11. AvoidViaPointReroutingConstraint

<<class>>

Describes a manual rerouting constraint to avoid a point or to force the flights to cross point. This
type of constraint only applies for horizontal rerouting constraints.

1. Inherits from: ReroutingConstraint

2. Attributes:

a. AvoidViaReroutingType type (Mandatory)

The kind of restriction.

Edition: 27.0 6 1395

Document Title: NM 27.0 - NM B2B Reference Manual

b. DBEOrPublishedPointId location (Mandatory)

The point identifier.

20.9.12. AvoidViaReroutingType
<<enumeration>>

Enumerates the two possible AvoidVia rerouting constraint types: AVOID and VIA .

1. Values:

a. AVOID

Generated routes (rerouting context) need to avoid the concerned location.

b. VIA

Generated routes (rerouting context) need to go via the concerned location.

2. Used by: AvoidViaPointReroutingConstraint, AvoidViaAirspaceReroutingConstraint

20.9.13. Capacity
<<typedef[int]>>

Capacity on a traffic volume, expressed as a number of flights per hour.

1. range : [0, 999]

2. Used by: PlannedCapacity

20.9.14. CapacityPlanRetrievalReplyData
<<class>>

The CapacityPlanRetrievalReply payload.

1. Attributes:

a. CapacityPlans plans (Mandatory)

The complete capacity plan for a given traffic volume on a given day.

2. Used by: CapacityPlanRetrievalReply

20.9.15. CapacityPlans
<<class>>

Capacity plans for one or more traffic volumes on a given day.

A capacity plan is a special plan in the sense that, there can be cases where no capacity is defined in

Edition: 27.0 6 1396

Document Title: NM 27.0 - NM B2B Reference Manual

CACD. So there exist traffic volumes for which the capacity is not known at all or not known for
some periods.

In addition, regulation measures can overrule the capacity values defined (either in CACD or by the
B2B update capacity service). This (optional) overruling regulation info can be found back in the
nmSchedule attribute. However in the client schedule the non regulated capacities are maintained
(just in case the regulation can be cancelled before the end of its applicability period).

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources (including NO_DATA data source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values) or limited to the (full list) of (pre-)tactical updates with the gaps marked as
AIRSPACE datasource (to obtain a complete time partition).

In any case, periods in the time partition marked as AIRSPACE datasource correspond to removing
any potential (pre-)tactical update and hence reset the corresponding values to the CACD definition
for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. map< TrafficVolumeId, PlannedCapacities > tvCapacities (Mandatory)

Capacity plans for one or more traffic volumes on a given day.

i. Constraints:

▪ CapacityPlans.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

tvCapacities has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: tvCapacities

Constrained requests: any using request

4. Used by: CapacityPlanUpdateReplyData, CapacityPlanRetrievalReplyData,

CapacityPlanUpdateRequest

20.9.16. CapacityPlanUpdateReplyData
<<class>>

The CapacityPlanUpdateReply payload.

1. Attributes:

a. CapacityPlans plans (Mandatory)

Edition: 27.0 6 1397

Document Title: NM 27.0 - NM B2B Reference Manual

The complete capacity plan for a given traffic volume on a given day, resulting from the
update.

2. Used by: CapacityPlanUpdateReply

20.9.17. CherryPickedLocation
<<class>>

Cherry picked location.

1. Inherits from: Location

20.9.18. ConcernedRegulationTimeOver
<<class>>

Concerned regulation time over.

It contains for a flight for a specific regulation (from the regulation profile before or after a change)
:

1. Calculated time over (entry & exit times) in the concerned regulation (before or after)

2. Position in the regulation (before or inside or after the regulation period)

3. Is the flight exempted or excluded from the regulation

1. Attributes:

a. DateTimeMinute timeOver (Mandatory)

The calculated time over (entry time in the concerned regulation).

b. IntervalPosition timeOverInRegPeriod (Mandatory)

Position of the calculated time over in the regulation (before or inside or after the regulation
period).

c. boolean exempted (Mandatory)

Is the flight exempted from the regulation.

d. boolean excluded (Mandatory)

Is the flight excluded from the regulation.

e. DateTimeMinute exitTime (Mandatory)

The calculated exit time in the concerned regulation.

2. Used by: NetworkImpactFlightRegulationChange

Edition: 27.0 6 1398

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.19. Counts
<<class>>

Container for traffic counts values, for a given DateTimeMinutePeriod and TrafficType.

1. Attributes:

a. CountsValue totalCounts (Mandatory)

Total traffic counts.

b. map< FlowId, CountsValue > flowCounts (Optional)

Traffic counts by flow.

This attribute is set only when requested (i.e.,

TrafficCountsByTrafficVolumeRequest.computeFlowCounts has been set to true )

Note that if there are more than 50 flows (e.g. in case of scenario flow counts), then only the
first 50 are shown here while TrafficCountsReply.flows does show them all.

i. Constraints:

▪ map size range : [0, 50]

c. map< SubTotalsTrafficCountsType, CountsValue > subTotalsCountsByTrafficType (Optional)

Sub total traffic counts by traffic type.

This attribute is set only when requested (i.e., TrafficCountsRequest.subTotalComputeMode has

been set to SUB_TOTALS_BY_TRAFFIC_TYPE )

i. Constraints:

▪ map size range : [6, 6]

d. map< SubTotalsRegulationDetailedType, CountsValue > subTotalsCountsByRegulationDetails

(Optional)

Documentation last updated: 27.0 - Edition 1

Sub total traffic counts by influencing regulation details. The sub-totals indicate a.o. how
many flights have an other regulation as MPR (most penalizing regulation) or how many
flights are exempted/alre_earborne. This(a.o.) allows to evaluate how good a regulation is
performing (see SubTotalsRegulationDetailedType ).

This attribute is set only when requested (i.e., TrafficCountsRequest.subTotalComputeMode has

been set to SUB_TOTALS_BY_REGULATION_DETAILS and it concerns a
TrafficCountsByMeasureRequest)

i. Constraints:

▪ map size range : [8, 8]

Edition: 27.0 6 1399

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: TrafficCountsReplyData

20.9.20. CountsCalculationType
<<enumeration>>

Documentation last updated: 27.0 - Edition 1

The possible counts calculation types.

1. Values:

a. ENTRY

Documentation last updated: 27.0 - Edition 1

Flights taking off and/or landing, or being over a point, or entering a sector in the traffic
window are considered.

b. OCCUPANCY

Documentation last updated: 27.0 - Edition 1

Flights occupying a sector or being airborne in the traffic window are considered.

2. Used by: FlightListByAircraftOperatorRequest, RegulationOrMCDMOnly,

LoadStateAtReferenceLocation, CountsCalculationTypeAndInterval,
TrafficCountsByAircraftOperatorRequest, TrafficCountsByAirspaceRequest, FlightListRequest,
FlightListByTrafficVolumeRequest, TrafficCountsByMeasureRequest, FlightListByAirspaceRequest,
TrafficCountsByTrafficVolumeRequest

20.9.21. CountsCalculationTypeAndInterval
<<class>>

1. Attributes:

a. CountsCalculationType calculationType (Mandatory)

Indicates what is the calculation type of the count (entry or occupancy).

b. DurationHourMinute duration (Mandatory)

Specifies the duration used to calculate the counts (or the duration used to calculate the
flightlist corresponding to those counts) : each count period, concerns a period of duration.

c. DurationHourMinute step (Mandatory)

Specifies the every x minutes a count need to be done: determines how many counts are
returned for a requested period. It also determines the rounding of the trafficWindow.

Edition: 27.0 6 1400

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: NetworkImpactAssessmentRetrievalReplyData

20.9.22. CountsInterval
<<class>>

Description what is the interval that is used to compute the counts / flight list.

For ENTRY counts, the typical value is: show counts every 20 minutes and each count period has a
duration of 60 minutes.

For OCCUPANCY counts, the step is typically 1 minute while the duration can vary (depending on the
location)

1. Attributes:

a. DurationHourMinute duration (Mandatory)

Specifies the duration used to calculate the counts (or the duration used to calculate the
flightlist corresponding to those counts) : each count period, concerns a period of duration.

So if a user does a TrafficCounts request with a trafficWindow from [10:00,10:01[ with a

countsInterval with step 1 and duration 10 minutes, the single count period returned has a
duration of 10 minutes ( [10:00,10:10[ ).

A duration of 1 minute, means that no extension of the trafficWindow is done.

i. Constraints:

▪ CountsInterval.INVALID_COUNTS_INTERVAL

▪ CountsInterval.INVALID_DURATION_RANGE

b. DurationHourMinute step (Mandatory)

Specifies the every x minutes a count need to be done: determines how many counts are
returned for a requested period. It also determines the rounding of the trafficWindow.

So if a user does a TrafficCounts request with a trafficWindow from [09:59,11:20[ with a

countsInterval with step 20 and duration 60 minutes, the 5 count periods returned are (
[09:40,10:40[ , [10:00,11:00[ , [10:20,11:20[ , [10:40,11:40[ , [11:00,12:00[ ).

This corresponds to an effectiveTrafficWindow of [09:40, 12:00[ : flights from within this

periods have been considered in the counts.

Note that the start of the count periods is rounded to a multiple of step.

i. Constraints:

▪ CountsInterval.INVALID_COUNTS_INTERVAL

▪ CountsInterval.INVALID_STEP_RANGE

2. Constraints:

Edition: 27.0 6 1401

Document Title: NM 27.0 - NM B2B Reference Manual

a. INVALID_DURATION_RANGE

The allowed duration value must be between 1 minute ( 0001 ) and 24 hours ( 2400 ).

Constrained attributes: duration

Constrained requests: any using request

b. INVALID_STEP_RANGE

The allowed step value must be between 1 minute ( 0001 ) and 24 hours ( 2400 ) and must be
a divisor of 24 hours.

Constrained attributes: step

Constrained requests: any using request

c. INVALID_COUNTS_INTERVAL

The duration must be a multiple of step .

Constrained attributes: duration, step

Constrained requests: any using request

3. Used by: FlightListByLocationRequest, TrafficCountsRequest

20.9.23. CountSubTotalComputeMode
<<enumeration>>

The algorithm to use while computing flight count sub-totals.

1. Values:

a. NO_SUB_TOTALS

Do not compute flight count sub-totals.

b. SUB_TOTALS_BY_TRAFFIC_TYPE

Compute flight count sub-totals by traffic type (see Counts.subTotalsCountsByTrafficType).

c. SUB_TOTALS_BY_REGULATION_DETAILS

Documentation last updated: 27.0 - Edition 1

Compute flight count sub-totals by influencing regulation details (see

Counts.subTotalsCountsByRegulationDetails). The sub-totals indicate a.o. how many flights
have an other regulation as MPR (most penalizing regulation) or how many flights are
exempted/alre_earborne. This allows to evaluate how good a regulation is performing (e.g.
when creating a regulation in a simulation).

Edition: 27.0 6 1402

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: TrafficCountsRequest

20.9.24. CountsValue
<<typedef[int]>>

1. range : [0, 100000]

2. Used by: DeltaATFCMSituationRegulation, ScenarioImpact, SignificantDeltaCount,

ATFCMSituationCounts, Counts, TrafficCountsReplyData, ATFCMSituationRegulation, DeltaCounts

20.9.25. DatasetReference
<<class>>

A simulation can be based on a reference (i.e. from which environment data has been copied and
where initially the flights and measures have been copied from). This DataSetReference class
represents these references.

For a simulation based on a STANDALONE_SIMEX reference, then type must be

STANDALONE_SIMEX and the simulationId must be value of SimulationIdentifier.simulationId.

For a simulation based on a OPERATIONAL/FORECAST reference, then type must be

OPERATIONAL/FORECAST and the simulationId is not allowed.

1. Attributes:

a. DatasetReferenceType type (Mandatory)

The type of reference dataset.

b. SimulationId simulationId (Optional)

The StandaloneSimex simulation identifier on which a UserManagedSimulation or a

NMOCManagedSimulation is based.

For a simulation based on a STANDALONE_SIMEX reference, the simulationId is value of

SimulationIdentifier.simulationId.

For a simulation based on a OPERATIONAL/FORECAST reference, the simulationId is not

allowed.

i. Constraints:

▪ DatasetReference.INVALID_SIMULATION_ID

2. Constraints:

a. INVALID_SIMULATION_ID

Invalid Simulation Id.

If the type is STANDALONE_SIMEX then simulationId should not be null .

Edition: 27.0 6 1403

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained attributes: simulationId

Constrained requests: any using request

3. Used by: NMOCManagedSimulation, SimulationAvailabilityRequest, SimulationListRequest,

UserManagedSimulation, SimulationAvailabilityReplyData

20.9.26. DatasetReferenceType
<<strict enumeration>>

Possible reference dataset types for simulations (i.e. the simulation contains a copy of that data).

1. Values:

a. OPERATIONAL

The reference of the simulation is the operational (tactical) data.

b. FORECAST

The reference of the simulation is the forecast (pre-tactical) data.

c. STANDALONE_SIMEX

The reference of the simulation is the data from a standalone_simex (specially modified
environment (CACD) data and forecasted traffic for a date in the future).

2. Used by: DatasetReference

20.9.27. DelayLocation
<<class>>

Delay location.

1. Inherits from: Location

20.9.28. DeltaATFCMSituation

<<class>>

Edition: 27.0 6 1404

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. DeltaATFCMSituationCounts countsChanges (Mandatory)

ATFCM situation counts.

b. DeltaATFCMSituationDelays delaysChanges (Mandatory)

ATFCM situation delays.

c. set< DeltaATFCMSituationRegulation > regulationsChanges (Optional)

ATFCM situation regulations.

2. Used by: NetworkImpactAssessmentRetrievalReplyData

20.9.29. DeltaATFCMSituationCounts
<<class>>

Delta ATFCM situation counts.

1. Attributes:

a. SignificantDeltaCount landedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights which are landed.

Includes all flights whose status is either ATC terminated, TACT terminated, expecting FSA,
or TACT terminated without expecting FSA.

b. SignificantDeltaCount airborneFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights which are airborne.

Includes all flights whose status is either ATC activated, TACT activated expecting FSA, or
TACT activated without expecting FSA.

c. SignificantDeltaCount expectedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights that have not taken off as of ATFCMSituationReply.data.lastUpdated.

d. SignificantDeltaCount undefinedSlotComplianceFlightDeltaCount (Mandatory) (new 27.0)

Delta count of all regulated and not suspended flights for which slot compliance information
is not known.

e. SignificantDeltaCount beforeSlotDepartureFlightDeltaCount (Mandatory) (new 27.0)

Delta count of all regulated and not suspended flights whose ATOT is before (CTOT-5)
minutes.

f. SignificantDeltaCount slotCompliantFlightDeltaCount (Mandatory) (new 27.0)

Edition: 27.0 6 1405

Document Title: NM 27.0 - NM B2B Reference Manual

Delta count of all regulated and not suspended flights whose ATOT is either at or between
(CTOT-5) and (CTOT+10) minutes.

g. SignificantDeltaCount afterSlotDepartureFlightDeltaCount (Mandatory) (new 27.0)

Delta count of all regulated and not suspended flights whose ATOT is after (CTOT+10)
minutes.

h. SignificantDeltaCount atfmMeasureSuspendedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights which are suspended due to an ATFM measure.

Includes all suspended flights whose suspension status is either

REGULATION_CONFIRMATION or TRAFFIC_VOLUMES_CONDITION.

i. SignificantDeltaCount famSuspendedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights which are suspended due to FAM.

Includes all suspended flights whose suspension status is NOT_REPORTED_AS_AIRBORNE.

j. SignificantDeltaCount delayedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights which are delayed.

k. SignificantDeltaCount significantlyDelayedFlightDeltaCount (Mandatory) (new 27.0)

Delta count of flights of which delay is greater than a configuration threshold. The threshold
is currently set to 30 minutes.

l. SignificantDeltaCount forecastFlightDeltaCount (Mandatory) (new 27.0)

Delta count of forecast flights.

2. Used by: DeltaATFCMSituation

20.9.30. DeltaATFCMSituationDelays
<<class>>

Delta ATFCM situation delays.

1. Attributes:

a. SignificantDeltaDuration enRouteDelay (Mandatory)

Includes all regulated and not suspended flights which are subject to a most penalising
regulation whose reference location is not an airport or a set of airports.

b. SignificantDeltaDuration airportDelay (Mandatory)

Includes all regulated and not suspended flights which are subject to a most penalising

Edition: 27.0 6 1406

Document Title: NM 27.0 - NM B2B Reference Manual

regulation whose reference location is an airport or a set of airports.

c. map< RegulationReason, SignificantDeltaDuration > delaysPerRegulationReason (Mandatory)

Total delays per regulation reasons.

i. Constraints:

▪ map size range : [1, 15]

2. Used by: DeltaATFCMSituation

20.9.31. DeltaATFCMSituationRegulation
<<class>>

Compares a before and after situation and indicates if the change is significant. An insignificant
change is a change that is considered not relevant.

1. Attributes:

a. ATFCMSituationRegulation afterSituation (Mandatory)

Contains some information about the concerned regulation and it’s updated delay (and
number of impacted flights) after the change

b. LongDurationHourMinute beforeDelay (Mandatory) (new 27.0)

Total delay due to the regulation before the change.

c. CountsValue beforeImpactedFlightCount (Mandatory) (new 27.0)

Number of flights which were impacted by the regulation before the change.

d. boolean isSignificantChange (Mandatory)

Indicates if the change is to be considered significant/relevant. Note that when a measure

(e.g. regulation) is created/modiified on the server (FORECAST or OPERATIONAL datasets), in
parallel flghts are also changing (e.g. due to DPI or radar plots or …). isSignificantChange
allows to differentiate between changes (e.g. in delay) due to the regulation
creation/modification and the background noise (flight changes not related to the regulation
modification)

2. Used by: DeltaATFCMSituation

20.9.32. DeltaCounts
<<class>>

Compares a before and after situation and represent the differences (counts and OTMV alerts)
between the before and after situation for a certain TV with a CountsCalculationTypeAndInterval
for a certain count period.

Edition: 27.0 6 1407

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. set< OtmvAlert > otmvAlertsBefore (Mandatory)

OTMV alerts (i.e. peak and sustained OTMV overdeliveries) for the before situation.

b. set< OtmvAlert > otmvAlertsAfter (Mandatory)

OTMV alerts (i.e. peak and sustained OTMV overdeliveries) for the after situation.

c. CountsValue[] countsBefore (Mandatory)

The counts corresponding to the concerned period and CountsCalculationTypeAndInterval

(count step and duration) for the before situation.

d. CountsValue[] countsAfter (Mandatory)

The counts corresponding to the concerned period and CountsCalculationTypeAndInterval

(count step and duration) for the after before situation.

2. Used by: NetworkImpactAssessmentRetrievalReplyData

20.9.33. DeltaLevelReroutingConstraint
<<class>>

Describes a delta level rerouting constraint: i.e. reroute the flights by shifting the levels up or down
by a fixed amound of FlightLevels.

1. Inherits from: ReroutingConstraint

2. Attributes:

a. DBEOrPublishedPointId pointId (Mandatory)

Update the Levels from this point onward until the next constraint (or when no subsequent
constraints: until theend of the profile).

b. int deltaFlightLevel (Mandatory)

The amount of flightlevels to shift the flights up (positive) or down (negative).

i. Constraints:

▪ range : [-998, 998[

20.9.34. EhelpDeskAddFlightInFmpStamRerouting
<<class>>

Allows to apply a FMP STAM rerouting.

1. Inherits from: EhelpDeskTicket

Edition: 27.0 6 1408

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: EhelpDeskAddFlightsInFmpStamRerouting

20.9.35. EhelpDeskAddFlightsInFmpStamRerouting
<<class>>

Allows to apply a FMP STAM rerouting on flights.

1. Attributes:

a. ReroutingId reroutingId (Mandatory)

Rerouting id to be applied.

b. set< EhelpDeskAddFlightInFmpStamRerouting > flights (Mandatory)

The flights to be added in the FMP STAM rerouting.

i. Constraints:

▪ set size range : [1, 100]

2. Used by: EhelpDeskTicketChoice

20.9.36. EhelpDeskExcludeReIncludeFlightInRegulation
<<class>>

Allows to exclude or re-include a flight in one or more regulations.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. set< RegulationId > regulations (Mandatory)

Regulations to additionally exclude or re-include.

i. Constraints:

▪ set size range : [1, 20]

3. Used by: EhelpDeskTicketChoice

20.9.37. EhelpDeskExtendSlotInRegulation
<<class>>

EhelpDesk extend slot in regulation.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. EhelpDeskExtendSlotInRegulationType subType (Mandatory)

Edition: 27.0 6 1409

Document Title: NM 27.0 - NM B2B Reference Manual

The subtype.

3. Used by: EhelpDeskTicketChoice

20.9.38. EhelpDeskExtendSlotInRegulationType
<<enumeration>>

Enumeration of possible eHelpDek extend slot in regulation subtypes.

1. Values:

a. LATE_PASSENGER

Late Passenger

b. PASSENGER_REMOVAL

Removal of Passenger

c. LOST_BAG

Lost bag

d. BAG_REMOVAL

Removal of bags

e. CREW_REPLACEMENT

Replacement of crew

f. SICK_OR_LATE_CREW

Sick or late crew

g. UNWANTED_LATE_IMPROVEMENT

Unwanted late improvement received

h. ATC_WILL_NOT_RELEASE

ATC will not release

i. DEICING

Deicing

j. TECHNICAL_PROBLEM

Technical problem

k. LATE_INBOUND_AIRCRAFT

Edition: 27.0 6 1410

Document Title: NM 27.0 - NM B2B Reference Manual

Late inbound aircraft

l. NO_REASON

No reason

Note that FMP and TWR users are typically supposed to only submit NO_REASON requests (See
also detailed documentation about Ehelpdesk via B2B)

2. Used by: EhelpDeskExtendSlotInRegulation

20.9.39. EhelpDeskFlightId
<<class>>

Documentation last updated: 27.0 - Edition 6

The id of an E-Helpdesk request and it’s corresponding flight id.

1. Attributes:

a. FlightKeys keys (Mandatory)

The flight id of the E-Helpdesk request.

b. MCDMTopicId mcdmTopicId (Mandatory)

The request id that uniquely identifes a Ehelpdesk request (e.g. there can be multiple
requests for a flight)

2. Used by: EhelpDeskTicketRevocationRequest

20.9.40. EhelpDeskForceFlightInRegulation
<<class>>

EhelpDesk force flight in regulation.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. DateTimeMinute newCto (Optional)

The new calculated time over the regulation.

i. Constraints:

▪ EhelpDeskForceFlightInRegulation.BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

▪ EhelpDeskForceFlightInRegulation.EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

b. DateTimeMinute newCtot (Optional)

The new calculated take-off time.

Edition: 27.0 6 1411

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ EhelpDeskForceFlightInRegulation.BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

▪ EhelpDeskForceFlightInRegulation.EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

3. Constraints:

a. EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

Only one of either newCto or newCtot attribute must be set.

Constrained attributes: newCto, newCtot

Constrained requests: EhelpDeskTicketCreationRequest, EhelpDeskTicketUpdateRequest

b. BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

Both newCto and newCtot attributes must be set.

Constrained attributes: newCto, newCtot

Constrained requests: EhelpDeskTicketCreationReply, EhelpDeskTicketUpdateReply

4. Used by: EhelpDeskForceFlightsInRegulation

20.9.41. EhelpDeskForceFlightsInRegulation
<<class>>

EhelpDesk ticket to force flights in regulation : in the context of cherry picked regulation review
(add a flight to a cherry picked regulation, or update the CTOT of a flight in a cherry picked
regulation) or for changing the CTOT of flights in normal regulations.

1. Attributes:

a. RegulationId mostPenalisingRegulation (Mandatory)

The new most penalising regulation unique identifier.

b. set< EhelpDeskForceFlightInRegulation > flights (Mandatory)

The flights in regulation.

i. Constraints:

▪ set size range : [1, 100]

2. Used by: EhelpDeskTicketChoice

20.9.42. EhelpDeskImproveSlotInRegulation
<<class>>

EhelpDesk improve slot in regulation.

Edition: 27.0 6 1412

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. EhelpDeskImproveSlotInRegulationType subType (Mandatory)

The subtype.

b. DateTimeMinute minRequestedCto (Optional)

The new minimum requested calculated time over the regulation.

i. Constraints:

▪ EhelpDeskImproveSlotInRegulation.MIN_REQUESTED_CTO_AND_MIN_REQUESTED_CTOT_MUTUALL
Y_EXCLUSIVE
c. DateTimeMinute minRequestedCtot (Optional)

The new minimum requested calculated take-off time.

If no minRequestedCto and minRequestedCTOT specified, then the minRequestedCTOT is equal to

the minimum CTOT (based on ETOT, clock, Departure Info: typically equal to ETOT). The
minRequestedCTOT allows e.g. an AO user to indicate the earliest take off time (e.g. 10:50) for a
flight at e.g. clock = 10:30 when ETOT = 10:00 and CTOT = 11:30.

i. Constraints:

▪ EhelpDeskImproveSlotInRegulation.MIN_REQUESTED_CTO_AND_MIN_REQUESTED_CTOT_MUTUALL
Y_EXCLUSIVE
3. Constraints:

a. MIN_REQUESTED_CTO_AND_MIN_REQUESTED_CTOT_MUTUALLY_EXCLUSIVE

At most one of minRequestedCto or minRequestedCtot attribute can be set.

Note that minRequestedCto and minRequestedCtot attributes can be null.

Constrained attributes: minRequestedCto, minRequestedCtot

Constrained requests: any using request

4. Used by: EhelpDeskTicketChoice

20.9.43. EhelpDeskImproveSlotInRegulationType
<<enumeration>>

Enumeration of possible eHelpDesk improve slot in regulation subtypes.

1. Values:

a. MAINTAIN_SCHEDULE

Maintain schedule

Edition: 27.0 6 1413

Document Title: NM 27.0 - NM B2B Reference Manual

b. LATE_REVIEW_TO_CTOT

Received late review to CTOT

c. LATE_REVIEW_TO_CTOT_ON_TAXI_TRACK

Received late review to CTOT while on taxi track

d. CREW_TIME

Crew time

e. AIRPORT_CLOSURE

Airport closure

f. AIRPORT_CLOSURE_NOISE

Airport closure noise

g. CONNECTING_PASSENGER

Connecting passenger

h. VIP_FLIGHT

VIP flights

i. LIVE_STOCK

Live stock

j. SICK_PASSENGER

Sick passenger

k. RELIGIOUS_REASON

Religious reason

l. DIVERSION

Diversion

m. DISPROPORTIONATE_DELAY_LATE_FILER_BUSINESS_JET

Disproportionate delay late filer business jet

n. DISPROPORTIONATE_DELAY_LATE_UPDATER

Disproportionate delay late updater

o. NO_REASON

Edition: 27.0 6 1414

Document Title: NM 27.0 - NM B2B Reference Manual

No reason.

Note that FMP and TWR users are typically supposed to only submit NO_REASON requests (See
also detailed documentation about Ehelpdesk via B2B)

2. Used by: EhelpDeskImproveSlotInRegulation

20.9.44. EhelpDeskInformationTicket
<<class>>

EhelpDesk information ticket.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. EhelpDeskInformationTicketType subType (Mandatory)

The subtype.

3. Used by: EhelpDeskTicketChoice

20.9.45. EhelpDeskInformationTicketType
<<enumeration>>

Enumeration of possible eHelpDesk information ticket subtypes.

1. Values:

a. OPERATIONAL_TEL_NUMBERS

Request for operational telephone numbers for a specific agency.

b. UNCLEAR_HEADLINE_NEWS

Request Network Headline News info wrt an unclear part of the headline news.

c. CONTACT_CREW

Contact crew with a message.

d. CANNOT_FIND_FLIGHT

I have plotted the flight on a map, but still can’t find it. Can you please tell me where it is?

e. OTHER_INFO_REQUEST

State your information query in the request text field.

2. Used by: EhelpDeskInformationTicket

Edition: 27.0 6 1415

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.46. EhelpDeskOtherTicket
<<class>>

EhelpDesk other ticket.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. EhelpDeskOtherTicketType subType (Mandatory)

The subtype.

3. Used by: EhelpDeskTicketChoice

20.9.47. EhelpDeskOtherTicketType
<<enumeration>>

Enumeration of possible eHelpDesk other ticket subtypes.

1. Values:

a. SUSPENDED_WHAT_TO_DO

If the conditions to send this request have been fulfilled (See detailed documentation about
Ehelpdesk via B2B), then one can submit a request to get information on how to get a flight
de-suspended.

b. DEACTIVATE_MY_FLIGHT

If the flight is not departing from an A-CDM airport and the flight is ATC activated, but it is
still on the ground, then one can use this request to de-activate the flight.

c. PROFILE_INCORRECT_CAPTURE

Request to report that a flight is incorrectly captured in a regulation. Please state the reason
in the request Text why the flight is incorrectly captured in the regulation.

d. MILITARY_FORMATION_DIFFERENT_CTOT

Military formations with different CTOTs. State the callsigns that request similar CTOTs in
the request Text field.

e. QUERY_COMPETITORS_CTOT

Same citypair, similar EOBT but disproportionate delay. State competitor’s callsign in the
request Text field to request explanation or improvement.

f. REQUEST_REROUTING_PROPOSAL

Request to obtain a rerouting proposal (RRP proposal flight)

Edition: 27.0 6 1416

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: EhelpDeskOtherTicket

20.9.48. EhelpDeskRemoveFlightsFromFmpStamRerouting
<<class>>

Allows to remove flights from a FMP STAM rerouting.

1. Attributes:

a. ReroutingId reroutingId (Mandatory)

Rerouting id to be applied.

b. set< FlightKeys > flights (Contextual)

The flights to be removed from a FMP STAM rerouting.

i. Presence:

▪ Mandatory in EhelpDeskTicketUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ set size range : [1, 100]

c. map< FlightKeys, string > unsuccessfullyUpdatedFlights (Contextual)

A reason description is given for every flight that was not updated successfully.

i. Presence:

▪ Must be null in EhelpDeskTicketUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ map size range : [1, 100]

2. Used by: EhelpDeskTicketChoice

20.9.49. EhelpDeskRuleType
<<enumeration>>

Enumeration of ehelpDesk rule types.

1. Values:

a. SIT1_REQUEST_REJECTION

SIT1 Request Rejection rule (request can only be submitted after SIT1)

b. DUPLICATE_REQUEST_REJECTION

Edition: 27.0 6 1417

Document Title: NM 27.0 - NM B2B Reference Manual

Duplicate Request Rejection

c. SLOT_EXTENSION

Slot Extension rejection rule

d. SLOT_EXTENSION_CDM

Slot Extension CDM rejection rule

e. NOT_SUITABLE_FOR_MANUAL_IMPROVEMENT

Not Suitable for manual Improvement rejection rule

f. REGULATION_SLOT_IMPROVEMENT_MINIMUM_DELAY

Regulation Slot Improvement minimum delay rejection rule

g. GENERAL_AUTO_RESPONSE

General Auto Response rule

h. NOT_REGULATED

Not Regulated rejection rule

i. MOST_PENALISING_REGULATION_CHANGED

Most Penalising Regulation changed rejection rule

j. FLIGHT_STATUS_REJECTION

Request rejected because the flight state has changed (e.g., from ATC activated to terminated
or cancelled) such that the request is no relevant/possible

k. FLIGHT_CHANGED_REJECTION

The concerned regulations have changed, and CTOT is modified, therefore there is no need
for the eHelpDesk ticket

l. XSD_OR_RESTRICTION_VIOLATION

The new CTOT would push the flight in a flight plan restriction (e.g. RAD restriction, CDR
closure, Zero Rate, RVR, etc.). Please send a DLA/CHG to make sure that your flight will
adhere with the existing flight plan restrictions. Eventually you can ask AOLO for a
rerouting proposal.

m. SLOT_SWAP_REJECTION

One of the two flights is not (or no longer) a swappable candidate

n. FORCE_REJECTION

Edition: 27.0 6 1418

Document Title: NM 27.0 - NM B2B Reference Manual

Flight cannot (or no longer) be forced with the requested CTOT in the request MPR.

o. UNFORCE_REJECTION

Flight cannot (or no longer) be unforced (e.g., because it is no longer forced)

p. EXCLUDE_REJECTION

Flight cannot (or no longer) be excluded from the requested list of regulations (e.g., because
it is no longer affected by some of them)

q. RE_INCLUDE_REJECTION

Flight cannot (or no longer) be re-included in the requested list of regulations (e.g., because
it is no longer affected or excluded by some of them)

2. Used by: EhelpDeskTicketResponseDetails

20.9.50. EhelpDeskSwapSlotsInRegulation
<<class>>

EhelpDesk swap slots in regulation.

1. Inherits from: EhelpDeskTicket

2. Attributes:

a. FlightKeys otherFlightKeys (Mandatory)

Flight keys of the other flight with which to swap slots.

b. EhelpDeskSwapSlotsInRegulationType subType (Mandatory)

The subtype.

3. Used by: EhelpDeskTicketChoice

20.9.51. EhelpDeskSwapSlotsInRegulationType
<<enumeration>>

Enumeration of possible eHelpDesk swap slots in regulation subtypes.

1. Values:

a. SAME_AIRCRAFT_OPERATORS

Same aircraft operators

b. DIFFERENT_AIRCRAFT_OPERATORS

Different aircraft operators

Edition: 27.0 6 1419

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: EhelpDeskSwapSlotsInRegulation

20.9.52. EhelpDeskTicket
<<abstract class>>

EhelpDesk ticket.

1. Attributes:

a. FlightKeys flightKeys (Mandatory)

The flight keys.

b. IFPLId ifplId (Optional)

The IFPL id.

c. MCDMTopicId updateMCDMTopicId (Contextual)

If the user wants to update a specific EhelpDeskTicket (e.g., change the minimum CTOT of a
slot improvement request of force flight request), then the updateMCDMTopicId needs to be
specified.

Otherwise, MCDM-wise, this EhelpDeskTicket request will be considered as a new ticket, and
the old one will be interrupted due to the superseded rule (but kept as a topic, e.g., in the
MCDMTopicListReply ).

In replies, it will always be present (except if the requests was rejected due to a validation
rule and as such not stored in NM systems)

i. Presence:

▪ Mandatory in EhelpDeskTicketUpdateRequest

▪ Must be null in EhelpDeskTicketCreationRequest

▪ Optional otherwise

d. EhelpDeskTicketRequestDetails requestDetails (Mandatory)

Request details.

e. EhelpDeskTicketResponseDetails responseDetails (Contextual)

Response details (if any).

Note that in replies, it will also be present if the request was rejected due to a validation
rule. The (validation) error message will be inside the response details.

i. Presence:

▪ Must be null in EhelpDeskTicketCreationRequest EhelpDeskTicketUpdateRequest

▪ Optional otherwise

Edition: 27.0 6 1420

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.53. EhelpDeskTicketChoice
<<union>>

Describes the different kind of operations supported on a flight in the context of an EhelpDeskTicket
.

1. Choices:

a. EhelpDeskForceFlightsInRegulation forceFlightsInRegulation

Force one or more flights in a regulation or add a flight to a cherry picked regulation (by
forcing) by creating proposal flights for NMOC to review.

The tickets start in DRAFT MCDM state (allowing FMP to review first the impact on
counts/network impact assessment). It is up to the B2B client to afterwards move the MCDM
state of the requests (or the concerned cherry picked measure) to PROPOSED . Ticket typically
only available to FMP users. Other users should coordinate first with NM Customer Support.

b. EhelpDeskUnforceFlightsInRegulation unforceFlightsInRegulation

Creates a proposal for NMOC to unforce forced flights in a regulation or remove flights from
a cherry picked regulation (by unforcing it will become exempted again).

Ticket typically only available to FMP users. Other users should coordinate first with NM
Customer Support.

c. EhelpDeskExcludeReIncludeFlightInRegulation excludeFlightFromRegulation

Ticket to exclude a flight from 1 or more regulations.

Typically only available to FMP users. Other users should coordinate first with NM Customer
Support.

The MCDM state of this ticket starts in DRAFT .

d. EhelpDeskExcludeReIncludeFlightInRegulation reIncludeFlightInRegulation

Ticket to re-include a flight in one or more regulations from which the flight is excluded.

Typically only available to FMP users. Other users should coordinate first with NM Customer
Support.

The MCDM state of this ticket starts in DRAFT .

e. EhelpDeskImproveSlotInRegulation improveSlotInRegulation

Allows AO/FMP/TWR to request to improve a slot/CTOT for a regulated flight (as a proposal
for NMOC to approve).

The MCDM state of this ticket starts in PROPOSED .

Edition: 27.0 6 1421

Document Title: NM 27.0 - NM B2B Reference Manual

f. EhelpDeskExtendSlotInRegulation extendSlotInRegulation

Allows AO/FMP/TWR to request to extend a slot/CTOT for a regulated flight (as a proposal for
NMOC to approve).

The MCDM state of this ticket starts in PROPOSED .

g. EhelpDeskSwapSlotsInRegulation swapSlotsInRegulation

Allows AO to request to swap slots in the most penalising regulation (both flights need to
have the same most penalising regulation).

The MCDM state of this ticket starts in PROPOSED .

h. EhelpDeskAddFlightsInFmpStamRerouting addFlightsInFmpStamRerouting

Add flights to FMP STAM rerouting.

i. EhelpDeskRemoveFlightsFromFmpStamRerouting removeFlightsFromFmpStamRerouting

Remove flights from FMP STAM rerouting.

j. EhelpDeskInformationTicket information

Allows AO to request information ticket.

The MCDM state of this ticket starts in PROPOSED .

k. EhelpDeskOtherTicket other

Allows AO/FMP to request other ticket.

The MCDM state of this ticket starts in PROPOSED .

2. Constraints:

a. VALID_TICKET_REQUEST_IN_RESPONSE_TO

Verifies the presence of the requestDetails.inResponseTo.ctot and

requestDetails.inResponseTo.mostPenalisingRegulation attributes as follows:

1. choice = forceFlightsInRegulation(EhelpDeskForceFlightsInRegulation)

▪ Optional requestDetails.inResponseTo.ctot

▪ Optional requestDetails.inResponseTo.mostPenalisingRegulation

2. choice = unforceFlightsInRegulation(EhelpDeskUnforceFlightsInRegulation)

▪ Mandatory requestDetails.inResponseTo.ctot

▪ Mandatory requestDetails.inResponseTo.mostPenalisingRegulation

3. choice = excludeFlightFromRegulation(EhelpDeskExcludeReIncludeFlightInRegulation)

▪ Mandatory requestDetails.inResponseTo.ctot

Edition: 27.0 6 1422

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Mandatory requestDetails.inResponseTo.mostPenalisingRegulation

4. choice = reIncludeFlightInRegulation(EhelpDeskExcludeReIncludeFlightInRegulation)

▪ Optional requestDetails.inResponseTo.ctot

▪ Optional requestDetails.inResponseTo.mostPenalisingRegulation

5. choice = improveSlotInRegulation(EhelpDeskImproveSlotInRegulation)

▪ Mandatory requestDetails.inResponseTo.ctot

▪ Mandatory requestDetails.inResponseTo.mostPenalisingRegulation

6. choice = extendSlotInRegulation(EhelpDeskExtendSlotInRegulation)

▪ Mandatory requestDetails.inResponseTo.ctot

▪ Mandatory requestDetails.inResponseTo.mostPenalisingRegulation

7. choice = swapSlotsInRegulation(EhelpDeskSwapSlotsInRegulation)

▪ Mandatory requestDetails.inResponseTo.ctot

▪ Mandatory requestDetails.inResponseTo.mostPenalisingRegulation

8. choice = addFlightsInFmpStamRerouting(EhelpDeskAddFlightsInFmpStamRerouting)

▪ Optional requestDetails.inResponseTo.ctot

▪ Optional requestDetails.inResponseTo.mostPenalisingRegulation

9. choice =
removeFlightsFromFmpStamRerouting(EhelpDeskRemoveFlightsFromFmpStamRerouting)
▪ OK

10. choice = information(EhelpDeskInformationTicket)

▪ Optional requestDetails.inResponseTo.ctot

▪ Optional requestDetails.inResponseTo.mostPenalisingRegulation

11. choice = other(EhelpDeskOtherTicket)

▪ Optional requestDetails.inResponseTo.ctot

▪ Optional requestDetails.inResponseTo.mostPenalisingRegulation

Constrained requests: any using request

3. Used by: EhelpDeskTicketUpdateRequest, EhelpDeskTicketCreationRequest,

EhelpDeskTicketUpdateReplyData, MCDMFlightTopic, EhelpDeskTicketCreationReplyData

20.9.54. EhelpDeskTicketCreationReplyData
<<class>>

The EhelpDeskTicketCreationReply payload.

1. Attributes:

a. EhelpDeskTicketChoice ticket (Mandatory)

Edition: 27.0 6 1423

Document Title: NM 27.0 - NM B2B Reference Manual

Created eHelpDesk ticket.

2. Used by: EhelpDeskTicketCreationReply

20.9.55. EhelpDeskTicketFlightInfo
<<class>>

EhelpDesk ticket flight information.

1. Attributes:

a. DateTimeMinute estimatedOffBlockTime (Mandatory)

Initial Estimated Off Block Time.

b. DateTimeMinute ctot (Optional)

Calculated Take Off Time.

Not present when the flight is not regulated.

c. RegulationId mostPenalisingRegulation (Optional)

Most penalising regulation impacting this flight.

Not present when the flight is not regulated.

2. Used by: EhelpDeskTicketResponseDetails, EhelpDeskTicketRequestDetails

20.9.56. EhelpDeskTicketRequestDetails
<<class>>

EhelpDesk ticket request details.

1. Attributes:

a. EhelpDeskTicketFlightInfo inResponseTo (Mandatory)

EhelpDesk ticket flight information.

This is the information as it was when the user decided to submit the ticket.

It allows NMOC to understand better the request : for example the user requested a slot
improvement request when the CTOT was 10:00 and Estimated Off Block Time was 08:00,
but when NMOC reviews the request (e.g. 2 minutes later).

NM systems have in the mean time automaticaly changed the CTOT to 08:10 (or e.g. 12:00).

This gives NMOC more context on the request: the requests was submitted when the CTOT
was 10:00 and the current CTOT is 08:10 (or e.g. 12:00).

Edition: 27.0 6 1424

Document Title: NM 27.0 - NM B2B Reference Manual

So typically this info is stored in the Ehelpdesk ticket creation screen (on opening of the
screen in the B2B client application) and then passed to NMOC inside inResponseTo when
the B2B client application creates the ticket.

Note that the operator/B2B client could have submitted the request e.g. 3 minutes after
opening the ticket creation screen because of a high priority/more urgent interrupt for the
operator.

b. string requestText (Optional)

Request text.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1000}

c. DateTimeSecond creationTime (Contextual)

Creation time.

i. Presence:

▪ Optional in EhelpDeskTicketCreationReply

▪ Must be null in EhelpDeskTicketCreationRequest MCDMTopicUpdateRequest

▪ Optional otherwise

d. DateTimeSecond lastModificationTime (Contextual)

Last modification time.

When a request has not been modified since creation, this will not be present.

i. Presence:

▪ Optional in EhelpDeskTicketCreationReply EhelpDeskTicketUpdateReply

▪ Must be null in EhelpDeskTicketCreationRequest EhelpDeskTicketUpdateRequest

MCDMTopicUpdateRequest
▪ Optional otherwise

2. Used by: EhelpDeskTicket

20.9.57. EhelpDeskTicketResponseDetails
<<class>>

EhelpDesk ticket response details.

1. Attributes:

a. MCDMState state (Optional)

MCDM state.

Edition: 27.0 6 1425

Document Title: NM 27.0 - NM B2B Reference Manual

b. EhelpDeskTicketFlightInfo responseFlightInfo (Optional)

EhelpDesk ticket response flight information. It contains the flight info at the moment the
flight got responded (e.g. the new CTOT after NMOC has accepted the slot improvement
request)

In principle, normally always present, except if the flight request has not been accepted (e.g.,
validation error, not existing flight, etc.).

c. boolean generalInterest (Mandatory)

Indicates if the request and response are deemed of general interest for all originators.

d. string responseText (Optional)

Response text: can be either a failed validation rule, or a system/user auto-rejection rule
text, or can be user entered (for manual rejects/accepts).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1000}

e. EhelpDeskRuleType automatedResponseRule (Optional)

Automated response rule.

Present if the request was rejected by an automatic rule.

f. MCDMTopicId supersededByRequest (Optional)

Superseded by request.

Present if the request was superseded (interrupted) by the submission of another

duplicate/similar request.

2. Used by: EhelpDeskTicket

20.9.58. EhelpDeskTicketRevocationReplyData
<<class>>

The EhelpDeskTicketRevocationReply payload.

1. Attributes:

a. set< MCDMTopicId > successfullyRevokedTickets (Optional)

Successfully revoked eHelpDesk tickets.

i. Constraints:

▪ set size range : [1, 100]

b. map< MCDMTopicId, string > unsuccessfullyRevokedTickets (Optional)

Edition: 27.0 6 1426

Document Title: NM 27.0 - NM B2B Reference Manual

A reason description is given for every tickets that was not revoked successfully.

i. Constraints:

▪ map size range : [1, 100]

2. Used by: EhelpDeskTicketRevocationReply

20.9.59. EhelpDeskTicketUpdateReplyData
<<class>>

The EhelpDeskTicketUpdateReply payload.

1. Attributes:

a. EhelpDeskTicketChoice ticket (Mandatory)

Updated eHelpDesk ticket.

2. Used by: EhelpDeskTicketUpdateReply

20.9.60. EhelpDeskUnforceFlightInRegulation
<<class>>

EhelpDesk ticket to unforce flight in regulation (in the context of cherry picked regulation review or
for forced flights in normal regulations).

1. Inherits from: EhelpDeskTicket

2. Used by: EhelpDeskUnforceFlightsInRegulation

20.9.61. EhelpDeskUnforceFlightsInRegulation
<<class>>

EhelpDesk unforce flights in regulation.

1. Attributes:

a. set< EhelpDeskUnforceFlightInRegulation > flights (Mandatory)

The flights in regulation.

i. Constraints:

▪ set size range : [1, 100]

2. Used by: EhelpDeskTicketChoice

20.9.62. ExcludeReIncludeFlightInRegulation
<<class>>

Edition: 27.0 6 1427

Document Title: NM 27.0 - NM B2B Reference Manual

Allows to exclude or re-include a flight in 1 or more regulations.

1. Attributes:

a. set< RegulationId > excludeFromRegulations (Mandatory)

Regulations to additionally exclude or re-include.

i. Constraints:

▪ set size range : [1, 20]

2. Used by: UpdateFlightInMeasureChoice

20.9.63. FlightAtfcmMcdmOnlyLocation
<<class>>

Flight ATFCM MCDM only location.

1. Inherits from: FlightAtfcmMeasureLocation

2. Attributes:

a. RegulationId mcdmOnlyMeasureId (Mandatory)

The id of the MCDM only measure.

20.9.64. FlightAtfcmMeasureLocation
<<abstract class>>

Documentation last updated: 27.0 - Edition 1

The location (and additional information) of an ATFCM measure impacting a flight.

1. Attributes:

a. TrafficVolumeLocationInfo trafficVolumeLocationInfo (Optional) (new 27.0)

The traffic volume identifier and reference location on which the measure applies.

The value is set to null if the measure has no traffic volume location.

b. MeasureSubType measureSubType (Mandatory)

Documentation last updated: 27.0 - Edition 1

The measure result.

c. HotspotId hotspotId (Optional)

The Id of the problem hotspot associated to the measure.

In addition, the hotspot id is not immutable as it contains the applicability period and the

Edition: 27.0 6 1428

Document Title: NM 27.0 - NM B2B Reference Manual

applicability period of a hotspot can change depending on traffic evolution.

NOTE See usage limitations in HotspotKind documentation.

d. MCDMState mcdmState (Optional)

The mcdm state of the measure (null if this measure is not under MCDM)

2. Used by: Flight

20.9.65. FlightAtfcmRegulationLocation
<<class>>

Documentation last updated: 27.0 - Edition 1

The location (and additional information) of a regulation impacting a flight.

1. Inherits from: FlightAtfcmMeasureLocation

2. Attributes:

a. RegulationId regulationId (Mandatory)

The regulation identifier.

b. boolean toConfirm (Mandatory)

True if the regulation must still be confirmed.

20.9.66. FlightAtfcmReroutingLocation
<<class>>

Documentation last updated: 27.0 - Edition 1

The location, the type of rerouting and the outcome of the rerouting (basically success or no
alternative/better route found) of a rerouting impacting a flight.

1. Inherits from: FlightAtfcmMeasureLocation

2. Attributes:

a. ReroutingId reroutingId (Mandatory)

The rerouting unique identifier.

b. ReroutingApplyKind reroutingApplyKind (Mandatory)

Indicates how the rerouting has been applied on the flight.

c. GroupReroutingIndicator groupReroutingIndicator (Mandatory)

Edition: 27.0 6 1429

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 1

Indicates the result of the rerouting for this flight (was a rerouting found or not).

d. ReroutingPurpose reroutingPurpose (Mandatory)

The rerouting purpose.

e. string requestText (Optional)

Textual description explaining the reason for the creation of the request.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1000}

f. boolean aoAcknowledgedRRP (Mandatory) (new 27.0)

Flag indicating if the AO acknowledged the RRP proposal flight. Only applicable for a STAM
RRP rerouting.

g. AirNavigationUnitId originator (Optional) (new 27.0)

The ANU id of the FMP who created the flight proposal request.

h. boolean originatorLatestReroutingProposalFlight (Mandatory)

Indicates if this rerouting led to the latest Rerouting Proposal Flight (e.g.
RRP/RRN/STAM_related_proposal_flight)

For simulations or planned flights it indicates if the rerouting led to the latest executed
rerouting (i.e. flight’s FTFM or RTFM has been actually rerouted)

Note that there can be only one measure that led to the LatestReroutingProposalFlight.

20.9.67. FlightHotspotLocation
<<class>>

The hotspot is used to indicate a period when there is too much traffic in a traffic volume according
to occupancy counts or complexity analysis for a specific occupancy traffic count duration.

1. Attributes:

a. Hotspot hotspot (Mandatory)

A hotspot by which the flight is or was concerned.

b. ReferenceLocation referenceLocation (Mandatory)

Reference location of the traffic volume on which the hotspot applies.

2. Used by: Flight

Edition: 27.0 6 1430

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.68. FlightMCDMInfo
<<class>>

A summary of the Flight M-CDM (Measure Collaborative Decision Making) information: represents
if there are MCDM topics (Eheldesk requests or Cherry picked regulation/rerouting) for which
coordination is ongoing (or has just finished) (in which case it might be useful to check the details
using the queryMCDM service). In addition it shows for that MCDM topic, the MCDM state and the
id of the involved Measure. In addition it informs if the flight is (or has been) involved in other
MCDM measure related activities (e.g. Cherry picked regulations/reroutings with MCDM). So
basically, it gives a very short summary of the full MCDM info aviable via queryMCDM.

1. Attributes:

a. MeasureId leastAdvancedMCDMMeasure (Optional)

Represents the Measure Id involved in the least advanced MCDM topic: i.e.:

the latest MCDM topic for which coordination is ongoing (but not yet completed) wrt
EhelpdeskTickets (i.e. with MCDM state PROPOSED/COORDINATED/FOR_IMPLEMENTATION)

or else latest MCDM topic for which coordination is ongoing (but not yet completed) wrt
Measures (proposal Cherry picked regulation / reroutings)

or else latest draft/completed MCDM topic wrt EhelpdeskTickets or cherry picked Measures
(i.e. with MCDM state in DRAFT/IMPLMENTED/INTERRUPTED/ABANDONED/FINISHED).

Note that for an exclusion EhelpdeskTicket, this contains the regulation id to exclude from
(in case there are multiple exluded regulation, it shows the first one).

Note: should always be present, except if it concerns an eHelpDesk ticket that is not
involving any measure.

b. int nrAssociatedMCDMRegulations (Mandatory)

The number of proposal Cherry picked regulations, the flight is (or has been) involved in.

i. Constraints:

▪ range : [0, unbounded[

c. int nrAssociatedMCDMReroutings (Mandatory)

The number of MCDM reroutings, the flight is (or has been) involved in.

i. Constraints:

▪ range : [0, unbounded[

d. MCDMState leastAdvancedMCDMState (Mandatory)

The MCDM state of the least advanced MCDM topics amongst all the MCDM objects
associated to the flight. worstMCDMState and firstAssociatedMCDMMeasure both give
details about the (same) least Advanced MCDM Topic.

Edition: 27.0 6 1431

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: Flight

20.9.69. FlightRegulationLocation
<<class>>

Describes the location of a regulation based on the reference location of the traffic volume to which
the regulation applies.

1. Attributes:

a. RegulationId regulationId (Mandatory)

Id of the regulation.

b. ReferenceLocation referenceLocation (Mandatory)

Reference location in the traffic volume on which the regulation applies.

c. boolean toConfirm (Mandatory)

True if the regulation must still be confirmed.

2. Used by: RouteInfo, Flight

20.9.70. Flow
<<class>>

Flow identification.

1. Attributes:

a. FlowId id (Mandatory)

Flow id or the scenario traffic volume id (in case of scenario flow counts).

b. FlowType type (Mandatory)

Flow type.

i. Constraints:

▪ Flow.FLOW_ROLE_MUST_BE_NULL

▪ Flow.SCENARIO_IMPACT_AND_APPLICABLE_SCENARIO_CANNOT_BE_NULL

c. FlowRoleSelection role (Optional)

Flow role selection.

i. Constraints:

▪ Flow.FLOW_ROLE_MUST_BE_NULL

d. TrafficVolumeScenarios applicableScenarios (Optional)

Edition: 27.0 6 1432

Document Title: NM 27.0 - NM B2B Reference Manual

Describes the applicable scenarios that have measures on the traffic volume corresponding
to id .

Note that even scenario are returned that have no scenarioImpact (e.g. no flights for the
selected period captured by the traffic volume).

This allows the B2B client to also use this field to query more generally the scenario
repository: what are all the scenario impacting a traffic volume (not looking at specific dates
or flights).

i. Constraints:

▪ Flow.SCENARIO_IMPACT_AND_APPLICABLE_SCENARIO_CANNOT_BE_NULL

e. ScenarioImpact scenarioImpact (Optional)

Scenario impact.

i. Constraints:

▪ Flow.SCENARIO_IMPACT_AND_APPLICABLE_SCENARIO_CANNOT_BE_NULL

2. Constraints:

a. FLOW_ROLE_MUST_BE_NULL

The role must be null if type is ASSOCIATED .

Constrained attributes: role, type

Constrained requests: any using request

b. SCENARIO_IMPACT_AND_APPLICABLE_SCENARIO_CANNOT_BE_NULL

The scenarioImpact and applicableScenario can not be null if type is SCENARIO and must be
null otherwise.

Constrained attributes: applicableScenarios, scenarioImpact, type

Constrained requests: any using request

3. Used by: FlightTrafficVolume, TrafficCountsReplyData

20.9.71. FlowId
<<typedef[string]>>

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,8}

2. Used by: FlightListByHotspotRequest, FlightListByTrafficVolumeRequest, Rerouting, Counts, Flow

20.9.72. FlowRoleSelection
<<enumeration>>

Edition: 27.0 6 1433

Document Title: NM 27.0 - NM B2B Reference Manual

The selection flow role (for FlowType.LINKED flows of traffic volume).

1. Values:

a. INCLUDED

Flights on INCLUDED flows are considered part of the traffic volume. If there are INCLUDED or
INCLUDED_AND_EXEMPTED flows, then any flight that is not on an INCLUDED or
INCLUDED_AND_EXEMPTED flow, is considered not part of the traffic volume.

b. EXCLUDED

Flights on EXCLUDED flows are not considered part of the traffic volume (so they are not taken
into account in flight lists or counts or regulations on that traffic volume).

c. EXEMPTED

Flights on EXEMPTED flows are considered part of the traffic volume if there are no INCLUDED /
INCLUDED_AND_EXEMPTED flows (so they are taken into account in flight lists or counts on that
traffic volume). However, w.r.t. regulations and delay: the flights are exempted. This means
only exceptional constraint regulations can impact the flight.

d. INCLUDED_AND_EXEMPTED

Flights on an INCLUDED_AND_EXEMPTED flow, are considered part of the traffic volume. However
hey are also considered as an INCLUDED flow (w.r.t. other flights that are not on an INCLUDED
flow) and as an EXEMPTED flow (w.r.t. regulations).

2. Used by: Flow

20.9.73. FlowType
<<enumeration>>

Enumerates the possible flow types.

1. Values:

a. LINKED

The counts correspond to the traffic inside each one of the INCLUDED, EXEMPTED and
INCLUDED_AND_EXEMPTED flows that are specified on the traffic volume. The counts are per
INCLUDED, EXEMPTED and INCLUDED_AND_EXEMPTED flow.

b. ASSOCIATED

The counts correspond to the traffic of each one of the ASSOCIATED flows and the OHERS flow
specified on the reference location that intersects the traffic inside the traffic volume
excluding the traffic of the EXCLUDED flows. The returned counts is per ASSOCIATED and OTHERS
flow.

Following possibilities exist:

Edition: 27.0 6 1434

Document Title: NM 27.0 - NM B2B Reference Manual

1. Traffic volume without flows: the returned counts contain traffic counts for the traffic of
each ASSOCIATED flow.

2. Traffic volume with included flows: the returned counts contain traffic counts for the
traffic of each ASSOCIATED flow intersecting with the traffic of the INCLUDED flows. The
traffic counts are equal to the counts of the traffic intersection (common traffic) of each
ASSOCIATED flow with the INCLUDED flows.

3. Traffic volume with excluded flows: the returned counts contain traffic counts for the
traffic of each ASSOCIATED flow and the OTHERS flow, excluding the traffic of the excluded
flows. The traffic counts are equal to the counts of the traffic of each ASSOCIATED and
OTHERS flow minus the traffic of the excluded flows.

4. Traffic volume with included and excluded flows: the returned counts contain traffic
counts for the traffic of each ASSOCIATED flow with traffic intersecting the traffic of the
INCLUDED flows, excluding the traffic of the excluded flows. The traffic counts are equal to
the counts of the traffic intersection (common traffic) of each ASSOCIATED flow with the
INCLUDED flows minus the traffic of the excluded flows.

Note that it is possible that a traffic volume has no associated nor linked flows.

c. SCENARIO

When querying flowcounts for scenario type flows, the flow counts show one flow per
scenario traffic volume. This allows to show for a traffic volume, which scenarios can be
applied to off-load that traffic volume and by how much (inside the scenario flow count
numbers).

In this case, the flow counts correspond to the common traffic (intersection) between

1. the traffic inside the traffic volume (excluding the traffic of the EXCLUDED flows)

2. the traffic on the traffic volumes of the applicable scenarios and their measures See also
TrafficVolumeScenarios and general into inside scenario repository.

Querying the scenario flow counts is a heavy field for the NM systems.

2. Used by: TrafficCountsByMeasureRequest, Flow, TrafficCountsByTrafficVolumeRequest

20.9.74. ForceFlightInRegulation
<<class>>

Flight in regulation.

1. Attributes:

a. RegulationId regulationId (Mandatory)

The regulation unique identifier.

b. DateTimeMinute newCto (Optional)

Edition: 27.0 6 1435

Document Title: NM 27.0 - NM B2B Reference Manual

The new calculated time over the regulation.

i. Constraints:

▪ ForceFlightInRegulation.BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

▪ ForceFlightInRegulation.EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

c. DateTimeMinute newCtot (Optional)

The new calculated take-off time.

i. Constraints:

▪ ForceFlightInRegulation.BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

▪ ForceFlightInRegulation.EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

2. Constraints:

a. EITHER_NEW_CTO_OR_CTOT_MUST_BE_SET

Only one of either newCto or newCtot attribute must be set.

Constrained attributes: newCto, newCtot

Constrained requests: UpdateFlightsInMeasureRequest

b. BOTH_NEW_CTO_AND_CTOT_MUST_BE_SET

Both newCto and newCtot attributes must be set.

Constrained attributes: newCto, newCtot

Constrained requests: UpdateFlightsInMeasureReply

3. Used by: UpdateFlightInMeasureChoice

20.9.75. FreezeTP
<<enumeration>>

Enumeration of possible freeze terminal procedure. When generating routes (RoutingMeasure

context or RoutingAssistanceRequest context), this impacts the amount of routes generated :

e.g. if one can generate routes with optimal SID&STAR (including choosing the optimal TP
connecting point), more candidates can be found vs. when restricting the returned routes to only
those that keep the given SID&STAR & "given" connection points.

1. Values:

a. NO

No restrictions apply for the generated alternative routes for freezing/keeping terminal
procedures (SID&STAR) wrt :

Edition: 27.0 6 1436

Document Title: NM 27.0 - NM B2B Reference Manual

1. the given/input flightplan (RoutingAssistanceRequest context) : i.e. no need to keep the

same SID&STAR as was given by the FlightPlanInput).

2. or wrt the existing flights (RoutingMeasure context) : i.e. no need to keep the same
SID&STAR as in the currently existing flights.

b. FREEZE_SID_STAR

Only those generated alternatives are returned that use the same SID & STAR.

Although the connection points (to the enroute portion of the flight) to those SID & STARs
can be optimized.

c. FREEZE_SID_STAR_AND_CONNECTING_POINTS

Only those generated alternatives are returned that use the same SID & STAR and use the
same connection points to those SID & STAR.

2. Used by: HorizontalReroutingSourcesAndConstraints

20.9.76. GroupReroutingIndicator
<<enumeration>>

Group rerouting indicator.

1. Values:

a. NO_REROUTING

No rerouting attempted or no rerouting executed

b. UNINTERESTING

No rerouting proposal

c. INTERESTING

Group rerouting for indication attempted and an alternative route found

d. OPPORTUNITY

Group rerouting for opportunity attempted and an opportunity found

e. EXECUTED

Rerouting executed and new route stored in the RTFM of the flight

2. Used by: FlightAtfcmReroutingLocation, GroupReroutingSummary

20.9.77. GroupReroutingSummary

Edition: 27.0 6 1437

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

A GroupReroutingSummary encapsulates the flight efficiency indicators generated by the Group

Rerouting Tool on the basis of a group rerouting template for a given flight.

1. Attributes:

a. GroupReroutingIndicator groupReroutingIndicator (Mandatory)

The group rerouting indicator.

b. ReroutingId reroutingId (Mandatory) (new 27.0)

The rerouting unique identifier.

c. Cost deltaCost (Mandatory)

The cost difference between the current and the alternate route. A negative value indicates
a flight improvement. The delta cost is computed at group rerouting execution time.

d. SignedDurationHourMinuteSecond deltaDelay (Optional)

The delta delay expresses the difference between the flight delay known at group rerouting
execution time with the flight delay of the alternate route. A negative value indicates a
flight improvement. The delta delay indicator is computed at group rerouting execution
time.

2. Used by: Flight

20.9.78. HorizontalReroutingSourcesAndConstraints (new 27.0)

Edition: 27.0 6 1438

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Sources/constraints that a horizontal rerouting shall use/satisfy.

Alternative routes can be generated for a flight by the following sources:

• City Pair Statistics

Alternative routes are selected from the set of "city pair" routes flown in the last 12 AIRAC
cycles. A city pair route is a route from ADEP till ADES without SID/STAR. The SID/STAR will be
chosen as part of the route generation.

• Flights Currently in System

Alternative routes are generated starting from the field15 of the flights that are currently
present in the system.

• Path Generator

Dynamically generates alternative routes by exploring the network of Air Routes, FRA DCT
segments.

• Mixer

Dynamically generates alternative routes for a flight from ADEP to ADES by mixing "city pair"
routes departing from ADEP with city pair routes arriving at ADES. To be mixable, the
departure city pair route and the arrival city pair route must have a common crossing point.

1. Attributes:

a. boolean freezeOutsideZone (Mandatory)

Indicates whether the Freeze Outside IFPZ option is set.

b. FreezeTP freezeTP (Mandatory)

The Freeze Terminal Procedures kind.

Edition: 27.0 6 1439

Document Title: NM 27.0 - NM B2B Reference Manual

c. boolean useDctAsReference (Mandatory)

Indicates whether DCT has to be used as the reference route (to compute the horizontal
reroutings) rather than the flight current route.

d. ReferenceRequestedFlightLevel referenceRequestedFlightLevel (Mandatory)

The reference requested flight level to use.

e. ReroutingLengthLimit lengthLimit (Optional)

Documentation last updated: 27.0 - Edition 3

An estimation of the limit that the route length should not exceed.

If not provided by the client application, the NM system uses the following
default values to compute the route length limit:
NOTE
▪ fixedPart = 100 NM

▪ referenceLengthPercentage = 130%

f. boolean useCityPairStatisticsSource (Mandatory)

Indicates whether the City Pair Statistics shall be used as rerouting source.

i. Constraints:

▪ HorizontalReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

g. boolean useFlightsCurrentlyInSystemSource (Mandatory)

Indicates whether the Flights Currently in System shall be used as rerouting source.

i. Constraints:

▪ HorizontalReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

h. boolean usePathGeneratorSource (Mandatory)

Indicates whether the Path Generator shall be used as rerouting source.

i. Constraints:

▪ HorizontalReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

i. boolean useMixerSource (Mandatory)

Indicates whether the Mixer shall be used as rerouting source.

i. Constraints:

▪ HorizontalReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

2. Constraints:

Edition: 27.0 6 1440

Document Title: NM 27.0 - NM B2B Reference Manual

a. AT_LEAST_ONE_SOURCE_MUST_BE_SET

At least one use…Source shall be set to true.

Constrained attributes: useCityPairStatisticsSource, useFlightsCurrentlyInSystemSource,

usePathGeneratorSource, useMixerSource

Constrained requests: any using request

3. Used by: ReroutingSourcesAndConstraints

20.9.79. Hotspot
<<class>>

The hotspot is used to indicate a period when there is too much traffic in a traffic volume according
to occupancy counts or complexity analysis for a specific occupancy traffic count duration.

1. Attributes:

a. HotspotId hotspotId (Mandatory)

The identifier of the hotspot.

Note that hotspot id is not immutable as it contains the applicability period and the
applicability period of a hotspot can change depending on traffic evolution.

b. HotspotSeverity severity (Mandatory)

The severity of the hotspot.

c. HotspotStatus status (Mandatory)

The status of the hotspot.

d. string remark (Optional)

Free text used for remarks and notes

i. Constraints:

▪ Pattern: (ALPHA|DIGIT|'|\(|\)|+|,|=|?|.|/|:| ){0,255}

e. string trafficVolumeDescription (Contextual)

The traffic volume description to which the hotspot applies.

i. Presence:

▪ Must be null in HotspotPlanUpdateRequest

▪ Optional otherwise

2. Used by: HotspotPlans, FlightHotspotLocation

Edition: 27.0 6 1441

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.80. HotspotId
<<class>>

The identifier of an hotspot.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The applicability period of the hotspot.

The applicability period of a hotspot indicates that in the corresponding occupancy traffic
counts ( step = 1 minute, duration of the HotspotId ), for the count periods/intervals that start
in the applicabilityPeriod there is a capacity/complexity problem.

b. TrafficVolumeId trafficVolume (Mandatory)

Traffic volume to which this hotspot applies.

c. DurationHourMinute duration (Mandatory)

The duration of this hotspot.

2. Used by: FlightListByHotspotRequest, Measure, Hotspot, FlightAtfcmMeasureLocation

20.9.81. HotspotKind
<<enumeration>>

Identifies the kind of hotspot.

1. Values:

a. LOCATION_OF_INTEREST

Location of interest hotspots are used raise awareness about potential hotspots or problems
in the context of the daily plan: For example weather or special events (a.o. Soyuz rocket
launches that imply a closure of some airspaces for a period of time).

Location of interest hotspots are transferred from the FORECAST to

IMPORTANT the OPERATIONAL dataset. However they are not
maintained/updated in the OPERATIONAL dataset.

b. PROBLEM

Problem hotspots are STAM related hotspots and are linked to a demand-capacity
imbalance. Typically a Location of interest hotspot can evolve into a problem hotspot if the
potential risk happens and introduces a real demand-capacity imbalance for a specific
period.

Edition: 27.0 6 1442

Document Title: NM 27.0 - NM B2B Reference Manual

The existing information in NM data concerning the problem hotspot

IMPORTANT is not for operational usage. The subject is under discussion and not
covered under any operational instruction or NM process.

2. Used by: HotspotPlans, HotspotListRequest

20.9.82. HotspotListReplyData
<<class>>

The HotspotListReply payload.

1. Attributes:

a. HotspotPlans plans (Mandatory)

All hotspots for a given (traffic volume, duration) pair on a given day.

2. Used by: HotspotListReply

20.9.83. HotspotPlans
<<class>>

Hotspot plan for a given traffic volume and day.

1. Attributes:

a. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of this hotspot plan.

b. Dataset dataset (Mandatory)

Dataset to which the hotspot plan belongs.

c. DateYearMonthDay day (Mandatory)

Day for which this hotspot plan is valid.

d. boolean planTransferred (Optional)

Indicates if the plan has been transferred to the OPERATIONAL dataset. When false, it means
that the most up-to-date data can be found in the FORECAST dataset.

e. boolean planCutOffReached (Optional)

Indicates if the plan can still be updated in the FORECAST dataset, i.e. if the forecast cut-off
time has been reached or not.

f. HotspotKind hotspotKind (Mandatory)

Edition: 27.0 6 1443

Document Title: NM 27.0 - NM B2B Reference Manual

The kind of hotspot.

g. map< TrafficVolumeId, map< DurationHourMinute, set< Hotspot > > > schedules (Mandatory)

(Pre-)tactical hotspots associated to their applicability period for a set of specific traffic
volumes and duration. The schedule exposes the complete time partition of the hotspots for
the day. Missing periods in the time partition correspond to not having any hotspot for that
period.

i. Constraints:

▪ map size range : [0, 1000]

▪ item size range : [0, 1000]

▪ item size range : [0, 1000]

▪ HotspotPlans.INVALID_SCHEDULE

▪ HotspotPlans.ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_SCHEDULE

2. Constraints:

a. INVALID_SCHEDULE

The duration key used in each of the schedule s map attribute has to be equal to the duration
of all hotspots linked to that duration key.

Constrained attributes: schedules

Constrained requests: any using request

b. ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_SCHEDULE

Only one entry in each of the schedule s map attribute can be updated (i.e., for one duration).

Constrained attributes: schedules

Constrained requests: HotspotPlanUpdateRequest

3. Used by: HotspotPlanUpdateRequest, HotspotPlanUpdateReplyData, HotspotListReplyData

20.9.84. HotspotPlanUpdateReplyData
<<class>>

The HotspotPlanUpdateReply payload.

1. Attributes:

a. HotspotPlans plans (Mandatory)

The complete hotspot plans for the given (traffic volume, duration) pairs on a given day,
resulting from the update.

2. Used by: HotspotPlanUpdateReply

Edition: 27.0 6 1444

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.85. HotspotSeverity
<<enumeration>>

Enumeration of possible severity levels for a hotspot.

1. Values:

a. HIGH

The hotspot is/was(depending on the hotspot state) considered very severe/problematic.

b. MEDIUM

The hotspot is/was considered +/- severe/problematic.

c. LOW

There is/was a hotspot. But it is/was not considered very severe/problematic.

2. Used by: Hotspot

20.9.86. HotspotStatus
<<enumeration>>

Enumeration of possible severity levels for a hotspot.

1. Values:

a. DRAFT

A potential problem (peak) has been identified and it is still needed to verify if it is a real
problem or not.

b. ACTIVE

The problem is confirmed and must be solved (e.g. by a STAM)

c. SOLVED

The problem has been solved (e.g. by a STAM)

d. ACCEPTABLE

After analysis it appeared that the problem was not a real problem and does not require
action to be solved. Note that if a Hotspot is really no longer required it is simply removed
completely.

The ACCEPTABLE state is solely intended to indicate that a Hotspot has been accepted as a
problem that can be tolerated (e.g. no resolution action such as a STAM needs to be applied).

2. Used by: Hotspot

Edition: 27.0 6 1445

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.87. KindOfRestriction
<<enumeration>>

Enumeration of possible restriction locations (e.g. rerouting reference location context: i.e. reroute
those flights crossing this restriction).

1. Values:

a. RAD

The restriction location concerns a "ROUTE AVAILABILITY DOCUMENT" restriction.

b. AC

The restriction location concerns an "Aircraft Type Classification" restriction (SID/STAR

availability by aircraft type)

c. DCT

The restriction location concerns a DCT/"DIRECT ROUTING" limit Restriction: Defines the
maximum length for a DCT segment.

d. CF

The restriction location concerns a "Conditional Flow" restriction (i.e. a Profile Tuning
Restriction: PTR).

e. SC

The restriction location concerns a "SSR CODE RESTRICTION" restriction (SSR Code
Restrictions (CCAMS) define which SSR codes are eligible for a flight).

2. Used by: RestrictionLocation

20.9.88. LevelAndSpeedReroutingConstraint
<<class>>

Describes a level and speed rerouting constraint.

1. Inherits from: ReroutingConstraint

2. Attributes:

a. DBEOrPublishedPointId fromPoint (Optional)

From this point onwards the level and/or speed needs to be adapted.

If not present, the level and/or speed is updated from the departure aerodrome.

b. DBEOrPublishedPointId untilPoint (Optional)

The level and/or speed needs to be adapted until untilPoint.

Edition: 27.0 6 1446

Document Title: NM 27.0 - NM B2B Reference Manual

If not present, the level and/or speed is updated until the arrival aerodrome or until the next
flightlevel constraint.

c. FlightLevel level (Mandatory)

The new flight level that is applied for the concerned portion for a generated alternative
flight/route.

d. AirSpeed airSpeed (Optional)

If not present, then the speed of the flights is not updated.

20.9.89. LevelConstraintKind
<<enumeration>>

For the concerned scenario level constraint, describes if the flight should fly above or below the
suggested flightlevel in ScenarioLevelConstraint.

1. Values:

a. ABOVE

The flight should fly above (or at) the suggested flightlevel.

b. BELOW

The flight should fly below (or at) the suggested flightlevel.

2. Used by: ScenarioLevelConstraint

20.9.90. LifeCycleEvent
<<class>>

Describes when and by whom an object has been last updated.

1. Attributes:

a. DateTimeSecond eventTime (Mandatory)

The time at which the last update was done (by a user explicitly or by the system).

If this is the first event for this measure, then it is the time when the measure was created

b. DateTimeSecond userUpdateEventTime (Optional)

If the eventTime is the event time of a system triggered event, then the userUpdateEventTime
indicates the time at which the last user triggered update was done.

If this is the first event for this measure, then it is the time when the measure was created.

c. LifeCycleEventType userUpdateType (Mandatory)

Edition: 27.0 6 1447

Document Title: NM 27.0 - NM B2B Reference Manual

The update type of the last user update.

d. UserId userId (Mandatory)

Id of the user who created, last updated or deleted the object.

2. Used by: Measure

20.9.91. LifeCycleEventType
<<enumeration>>

Lifecycle event type. It describes the update type of the last update that happened to a measure.

1. Values:

a. CREATION

The last update was the creation of the measure.

b. UPDATE

The last update was the modification of a measure.

c. DELETION

The last update was the deletion of a measure. Note that DELETION for a regulation in fact
means that the regulation was cancelled.

2. Used by: LifeCycleEvent

20.9.92. Location

<<abstract class>>

Ancestor structure for all locations.

1. Used by: Rerouting

20.9.93. MCDMApprovalState
<<enumeration>>

Enumeration of possible types for a MCDM approval state (e.g. after casting a vote).

In regulation proposal context, the NMOC actor can have any of the 4 different states. The initiator
can only be in UNKNOWN (default) or REJECTED (when the B2B client revokes a proposal)

Edition: 27.0 6 1448

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. UNKNOWN

Default state, no response has been given by the actor.

b. APPROVED

Actor approves the measure.

c. REJECTED

Actor disapproves the measure.

d. ACKNOWLEDGED

Actor acknowledges the request and starts thinking about the response.

2. Used by: RegulationProposalListRequest, MCDMUserRoleAndApprovalState, RegulationProposal

20.9.94. MCDMCoordinationLevel
<<enumeration>>

The MCDM coordination level. It describes (as part of a MCDMRoleUserCategory) if the category (e.g.
AO) have a role on either the flight level and/or measure level (e.g. does the concerned AOs need to
e.g. approve the individual flights(one-by-one) and/or rather the measure).

1. Values:

a. FLIGHT

The concerned users have a role for the individual flights.

b. MEASURE

The concerned users have a role on the measure.

2. Used by: MCDMRoleUserCategory

20.9.95. MCDMDeadlines
<<class>>

All measure deadlines.

The usage of measure deadlines is subject to prior coordination with NM Customer

NOTE Support and should follow the description from the Operational Instruction or the
ATFCM Operations Manual.

1. Attributes:

a. DateTimeMinute timeToCoordinate (Optional)

Edition: 27.0 6 1449

Document Title: NM 27.0 - NM B2B Reference Manual

The deadline to finish the coordination activities.

i. Constraints:

▪ MCDMDeadlines.AT_LEAST_ONE_DEADLINE_MUST_BE_SET

b. DateTimeMinute timeToStartImplement (Optional)

The deadline to start the implementation activities.

i. Constraints:

▪ MCDMDeadlines.AT_LEAST_ONE_DEADLINE_MUST_BE_SET

c. DateTimeMinute timeToImplement (Optional)

The deadline to finish the implementation activities.

i. Constraints:

▪ MCDMDeadlines.AT_LEAST_ONE_DEADLINE_MUST_BE_SET

2. Constraints:

a. AT_LEAST_ONE_DEADLINE_MUST_BE_SET

At least one deadline must be set.

Constrained attributes: timeToCoordinate, timeToStartImplement, timeToImplement

Constrained requests: MCDMTopicUpdateRequest

3. Used by: MCDMMeasureTopic

20.9.96. MCDMFlightTopic

Edition: 27.0 6 1450

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Represents a flight MCDM topic.

NOTE In regulation proposal context, only cherry picked flights have MCDMFlightTopic.

1. Inherits from: MCDMStatefulTopic

2. Attributes:

a. FlightKeys flightKeys (Mandatory)

The flight keys.

Note: The keys are not unique and have to be used together with the topicId .

b. IFPLId ifplId (Optional)

The IFPL id.

c. EhelpDeskTicketChoice ticket (Contextual)

Contains the EhelpdeskTicketdetails from EhelpdeskTickets created via the

CreateEhelpdeskTicket service (or equivalent via NM B2C)

For example, it shows the details : a.o.:

▪ For force/unforce the new CTOT, or

Edition: 27.0 6 1451

Document Title: NM 27.0 - NM B2B Reference Manual

▪ For include/exclude the flight from one or more regulations: the concerned regulation.

i. Presence:

▪ Must be null in MCDMTopicUpdateRequest

▪ Optional otherwise

3. Used by: MCDMTopicListReplyData, MCDMMeasureTopic, MCDMMessagePayload

20.9.97. MCDMMeasureTopic

<<class>>

Represents a measure MCDM topic.

1. Inherits from: MCDMStatefulTopic

2. Attributes:

a. set< MCDMRoleUserCategory > userCategories (Optional)

A set of user categories (actor and role) of the given topic.

Present if MCDMTopicField.userCategories has been requested. Note that it can be an empty

set when in transient state i.e. when the measure has been created but the topic has not
been updated yet via MCDMTopicUpdateRequest.

i. Constraints:

▪ set size range : [0, 1000]

b. MCDMDeadlines deadlines (Optional)

The measure’s deadlines.

Present if MCDMTopicField.deadlines has been requested.

Edition: 27.0 6 1452

Document Title: NM 27.0 - NM B2B Reference Manual

c. set< MCDMFlightTopic > flightTopics (Optional)

An optional set of MCDM flight topics related to this MCDM measure topic (i.e. the flights
involved in the cherry picked regulation or rerouting).

i. Constraints:

▪ set size range : [1, 1000]

▪ MCDMMeasureTopic.SAME_MEASURE_ID_MUST_BE_SET_IN_FLIGHT_TOPICS

d. set< MCDMUserAndRole > predefinedUsersForFlightCoordinationLevel (Optional)

The predefined actors (and their role) for the per-flight coordination. Normally the flight
actors (and their role) are computed based on the given userCategories and the profiles of
the flights.

However if the user wants to control explicitly which actors should be involved in the flight
coordination process, then he can define PredefinedUsersForFlightCoordinationLevel. If
userCategories indicates that no flight coordination is needed, then NM systems will
compute flight-by-flight the involved flight-coordination actors (and their role) based on the
PredefinedUsersForFlightCoordinationLevel.

e. string remark (Optional)

Contains the MCDM related remark.

In output in scenario context, it contains with who coordination has to be done and under
what conditions (NMOC entered text).

In input (e.g. proposal regulation context), it can contain additional info with who pre-
coordination has been done already (e.g.via phone) or additional coordination related
remarks (.e.g. NMOC, please coordinate with FMP Y as well).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,1000}

f. string proposalNote (Optional)

Contains additional (informal textual) information given by the FMP when creating the
proposal regulation for NMOC to review via RegulationProposalFilingRequest (e.g. linked
regulation, window width, or maybe questions for NMOC like proposal regulation to be
applied before proposal regulation or more detailed contextual info why the regulation is
needed).

The proposalNote can only be set by fileRegulationProposal and updateRegulationProposal

services.

The proposalNote cannot be present in updateMCDM input ( fileRegulationProposal and

updateRegulationProposal : following the RegulationProposal workflow).

i. Constraints:

Edition: 27.0 6 1453

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Pattern: MULTILINE_TEXT{1,1000}

g. string proposalFeedback (Optional)

Contains additional information given by NMOC when accepting/rejecting the proposal

regulation wrt the reason.

Not present in updateMCDM input.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,1000}

3. Constraints:

a. SAME_MEASURE_ID_MUST_BE_SET_IN_FLIGHT_TOPICS

The measureId of all MCDM flight topic from flightTopics must be the same as the measureId
of this MCDM measure topic.

Constrained attributes: flightTopics

Constrained requests: any using request

4. Used by: MCDMTopicListReplyData, Measure, MCDMMessagePayload

20.9.98. MCDMMessageFilter (new 27.0)

<<class>>

The message filter for subscription topic SubscriptionTopic.MCDM.

It must be provided within a MCDM subscription to specify which notifications to receive.

1. Attributes:

a. set< AirNavigationUnitId > anuIds (Optional)

The set of actors (air navigation unit ids). It can contains FMP anuIds, and/or AO anuIds,
and/or TWR anuIds.

This corresponds to the ANU’s found in the MCDMStatefulTopic.userRolesAndApprovalStates

(actors with role NOT_INVOLVED are not considered).

i. Constraints:

▪ set size range : [1, 500]

ii. Access control:

▪ set anuIds=null requires read access to /mcdmTopics?actors=null

b. boolean includeMCDMRegulationTopics (Mandatory)

Documentation last updated: 27.0 - Edition 4

Edition: 27.0 6 1454

Document Title: NM 27.0 - NM B2B Reference Manual

If true, includes MCDMMeasureTopic of kind regulation.

Note that if the MCDMMeasureTopic also involves MCDMFlightTopic 's, then those MCDMFlightTopic
's will be also published in MCDMMessage 's with payload type nonStandaloneMcdmFlight.

i. Constraints:

▪ MCDMMessageFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_TRUE

c. boolean includeMCDMReroutingTopics (Mandatory)

Documentation last updated: 27.0 - Edition 4

If true, includes MCDMMeasureTopic of kind rerouting.

Note that if the MCDMMeasureTopic also involves MCDMFlightTopic 's, then those MCDMFlightTopic
's will be also published in MCDMMessage 's with payload type nonStandaloneMcdmFlight.

i. Constraints:

▪ MCDMMessageFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_TRUE

d. boolean includeStandaloneMCDMFlightTopics (Mandatory)

If true, includes standalone MCDMFlightTopic (not linked to a measure).

Those MCDMFlightTopic 's will be published in MCDMMessage 's with payload type
STANDALONE_MCDM_FLIGHT.

i. Constraints:

▪ MCDMMessageFilter.AT_LEAST_ONE_ATTRIBUTE_MUST_BE_TRUE

2. Constraints:

a. AT_LEAST_ONE_ATTRIBUTE_MUST_BE_TRUE

At least one attribute of includeMCDMRegulationTopics or includeMCDMReroutingTopics or

includeStandaloneMCDMFlightTopics must be true.

Constrained attributes: includeMCDMRegulationTopics, includeMCDMReroutingTopics,

includeStandaloneMCDMFlightTopics

Constrained requests: any using request

3. Used by: MCDMSubscriptionCreationRequest, MCDMSubscriptionUpdateRequest, MCDMSubscription

20.9.99. MCDMMessagePayload (new 27.0)

<<union>>

Payload of a MCDMMessage.

It represents either a MCDMMeasureTopic or a non-standalone MCDMFlightTopic (linked to a

measure) or a standalone MCDMFlightTopic (not linked to a measure).

Edition: 27.0 6 1455

Document Title: NM 27.0 - NM B2B Reference Manual

1. Choices:

a. MCDMMeasureTopic mcdmMeasure

Documentation last updated: 27.0 - Edition 4

The MCDM measure topic.

Note that inside the MCDM measure topic, there is no MCDM flight topic (
MCDMMeasureTopic.flightTopics is empty). The MCDM flight topic linked to a MCDM measure
topic are published within a MCDMMessage with nonStandaloneMcdmFlight payload.

b. MCDMFlightTopic nonStandaloneMcdmFlight

The non-standalone MCDM flight topic (linked to a measure). This concerns mainly the MCP
Regulations and (e.g. NCAP) STAM RRP GRRT related requests. For example, the cherry
picked flights are published as nonStandaloneMcdmFlights when the MCP measure (wrt. it’s
MCDM info) is published as an McdmMeasureTopic

c. MCDMFlightTopic standaloneMcdmFlight

The standalone MCDM flight topic (not linked to a measure).

This concerns mainly eHelpDesk related requests.

2. Used by: MCDMMessage

20.9.100. MCDMPayloadConfiguration (new 27.0)

<<class>>

A payload configuration for subscription topic SubscriptionTopic.MCDM .

1. Attributes:

a. set< MCDMTopicField > mcdmTopicFields (Mandatory)

The MCDMMessage will contain only the MCDM topic fields present in this set, and only if the
values of these requested fields are available at NM. Note that the topic id is always
returned.

2. Used by: MCDMSubscriptionCreationRequest, MCDMSubscriptionUpdateRequest, MCDMSubscription

20.9.101. MCDMRole
<<enumeration>>

Enumeration of possible roles for an actor working with MCDM topic.

In regulation proposal context, only a subset of the roles are used: APPROVAL, INITIATOR and
NOT_INVOLVED are the only ones that can occur. NMOC is implicitely considered the implementer.

Edition: 27.0 6 1456

Document Title: NM 27.0 - NM B2B Reference Manual

1. Values:

a. INFO

The user is informed about the MCDM.

b. ROLE_INFO

There are multiple ANUs found for a specific IMPLEMENTER / APPROVAL (AO/tower). The first one
was selected as for approval or for implementation. The others have the ROLE_INFO . They
need to manually check that the correct ANU gets the APPROVAL or IMPLEMENTER role.

c. APPROVAL

The user needs to approve.

d. IMPLEMENTER

The user needs to implement the measure/action on a flight.

e. INITIATOR

The user is the initiator of the measure/action on a flight.

f. NOT_INVOLVED

The user is not involved in the measure/action on a flight.

2. Used by: MCDMUserRoleAndApprovalState, MCDMRoleUserCategory, MCDMUserAndRole

20.9.102. MCDMRoleUserCategory
<<class>>

Documentation last updated: 27.0 - Edition 4

Structure that contains mapping of a MCDM user category and its associated role.

In the MCDM process, actor categories also have roles. They pilot how NM systems computes the
default actors and their role. For example having ALL_FMP with role for INFO for the measure
means that all the FMP concerned (by the flights of the measure) will be inside the
MCDMUserRoleAndApprovalState for the measure with a default role for INFO.

1. Attributes:

a. MCDMUserCategory category (Mandatory)

The user category.

b. MCDMCoordinationLevel coordinationLevel (Mandatory)

The coordination level (flight or measure).

Edition: 27.0 6 1457

Document Title: NM 27.0 - NM B2B Reference Manual

c. MCDMRole role (Mandatory)

The role for a category.

i. Constraints:

▪ MCDMRoleUserCategory.NOT_INVOLVED_ROLE_NOT_ALLOWED

2. Constraints:

a. NOT_INVOLVED_ROLE_NOT_ALLOWED

The role cannot be NOT_INVOLVED .

Constrained attributes: role

Constrained requests: MCDMTopicListRequest

3. Used by: MCDMMeasureTopic

20.9.103. MCDMState
<<enumeration>>

Enumeration of possible types for a MCDM state.

In regulation proposal or EhelpdeskTicket context, FINISHED does not occur.

The nominal finite state transaction flows for the trial related MCDM process (not the regulation
proposal/EhelpdeskTicket subset) are pictured below.

Edition: 27.0 6 1458

Document Title: NM 27.0 - NM B2B Reference Manual

Figure 40. MCDM transition diagram

1. Values:

a. DRAFT

A measure/EhelpdeskTicket is being created to solve a hotspot/problem area. It is too early

to start MCDM approval: the solution is in the process of being evaluated by the initiator.
The measure/flight is draft even while it is incomplete, for example the FMP has selected
that there will be cherry picking but has not yet selected the flights.

The measure/flight may be reset from subsequent states to Draft when the proposed
measure/proposed action on a flight cannot is not sufficient and it needs to be changed (for
example in regulation proposal context : when additional flights need to be added, or when
the CTOT of a flight needs to be modified).).

If required, the measure/flight may also be forced by the Initiator to Abandoned state (e.g.
via the revokeEhelpdeskTicket service) at this stage (for example: in regulation proposal
context when revoking a proposal).

b. PROPOSED

The measure/flight is being shown via B2 or NOP to all concerned actors in order to get their
agreement that the measure should/could occur or that the flight should be included in the
measure.

Note that in regulation proposal/EhelpddeskTicket context, it means that the B2B client
wants NMOC to review the proposal but NMOC has not started looking at it yet.

Edition: 27.0 6 1459

Document Title: NM 27.0 - NM B2B Reference Manual

c. COORDINATED

In full MCDM context : All the concerned actors have agreed that:

1. the measure should/could occur

2. or that a flight should be included in the measure and that the proposed action is
accepted.

However the initiator is waiting for the for the expected capacity problem to materialize.

In regulation proposal/EhelpdeskTicket context : COORDINATED means that NMOC has

acknowledged the regulation proposal of flight request and started handling the request.

d. IMPLEMENTING

When the Initiator decides the measure/flight action is really needed, the measure/flight is
moved from Coordinated to For Implementation and the job of implementation can begin.

In the context of regulation proposals, it is a temporary state required by NM systems to

indicate that the transformation of proposal (flight) CTOT into normal flight CTOT has
started, but not all flights have been processed yet.

e. IMPLEMENTED

The actor who should implement the measure/flight action has agreed to implement it at the
relevant time - that is at or before the implementation time limit.

Implemented may mean that an action will be taken, for example ATC may do something
when the flight appears, or implemented may mean that the action has already been taken,
for example the aircraft operator may have submitted a change to his flight plan.

In the context of regulation proposals/EhelpdeskTicket, it means that the proposal has been
accepted and that the "real" flight (i.e. non-proposal flight) has received a CTOT or CTOT
update.

For information related EhelpdeskTickets, IMPLEMENTED means that NMOC has responded
(inside the responseText inside the MCDMTopicListReply )

f. ABANDONED

The measure will not occur or the flight will not be included in the measure. The measure
was forced to abandon by a manual user action performed by the initiator (e.g. a revoke of a
proposal regulation by the initiator).

g. INTERRUPTED

The measure will not occur or the flight became excluded from the measure.

The measure was forced to abandoned by the system or by NMOC after it had been accepted
(for example: a measure could get interrupted after NMOC cancelled the measure ater

Edition: 27.0 6 1460

Document Title: NM 27.0 - NM B2B Reference Manual

having accepted the proposal to create it).

Alternatively the aircraft operator refiled and avoided a cherry pick regulation.

The MCDMState of a flight is set to INTERRUPTED because this flight specifically has been rejected
by NMOC (a.o. due to RAD violations)

h. FINISHED

This state is a simple combination of Implemented and the end time of the hotspot being in
the past.

Note that in regulation proposal/EhelpdeskTicket context, this state does not occur.

2. Used by: FlightMCDMInfo, EhelpDeskTicketResponseDetails, RegulationProposal,

MCDMStateUpdateReplyData, MCDMStateUpdateRequest, FlightAtfcmMeasureLocation,
MCDMStatefulTopic

20.9.104. MCDMStatefulTopic

<<abstract class>>

Defines the common attributes of MCDM topics that have state (measure and flight).

Edition: 27.0 6 1461

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: MCDMTopic

2. Attributes:

a. MeasureId measureId (Contextual)

The related measure.

Note that for an exclusion/re_inclusion EhelpdeskTicket, in case the flight is to be

excluded/re_included from/in multiple regulations, the measureId is the first regulation to
exclude/re_include from/in.

Note that it is not always present in output : e.g. information request EhelpdeskTickets for
non regulated flights.

i. Presence:

▪ Must be null in MCDMTopicUpdateRequest

▪ Optional otherwise

b. MCDMState state (Contextual)

The MCDM Topic state.

i. Presence:

▪ Optional in MCDMTopicUpdateReply MCDMTopicUpdateRequest

▪ Mandatory otherwise

ii. Constraints:

▪ MCDMStatefulTopic.INTERRUPTED_MCDM_STATE_NOT_ALLOWED

c. AirNavigationUnitId initiator (Optional)

The initiator.

Present if MCDMTopicField.initiator was requested.

d. boolean initiatorIsImplementer (Optional)

Flag indicating whether the initiator is also the implementer or not.

Present if MCDMTopicField.initiator was requested.

i. Constraints:

▪ MCDMStatefulTopic.INITIATOR_IS_IMPLEMENTER_MUST_BE_NULL

e. set< MCDMUserRoleAndApprovalState > userRolesAndApprovalStates (Optional)

A set of user with their role and optionally an approval state.

In regulation proposal context, the NM systems maintain this: there is the intiator and
NMOC actor and in case of cherry picked regulations, also all other potentially impacted

Edition: 27.0 6 1462

Document Title: NM 27.0 - NM B2B Reference Manual

FMP are present (with NOT_INVOLVED role).

When NMOC accepts/rejects a measure or flight, the corresponding NMOC approval state
becomes accepted or rejected.

When the FMP afterwards changes the MCDMState of the regulation back to DRAFT, the
NMOC actor approvalState is reset to UNKNOWN.

Present if MCDMTopicField.userRolesAndApprovalStates has been requested. Can be null if no

actors are defined yet.

i. Constraints:

▪ set size range : [1, unbounded[

3. Constraints:

a. INTERRUPTED_MCDM_STATE_NOT_ALLOWED

The attribute state cannot be INTERRUPTED .

Constrained attributes: state

Constrained requests: MCDMTopicUpdateRequest

b. INITIATOR_IS_IMPLEMENTER_MUST_BE_NULL

The attribute initiatorIsImplementer must be null when the topic to be updated is a

MCDMFlightTopic.

Constrained attributes: initiatorIsImplementer

Constrained requests: MCDMTopicUpdateRequest

20.9.105. MCDMStateUpdateReplyData
<<class>>

The MCDMStateUpdateReply payload.

1. Attributes:

a. MCDMState newMCDMState (Mandatory)

The resulting MCDM state.

2. Used by: MCDMStateUpdateReply

20.9.106. MCDMSubscription (new 27.0)

Edition: 27.0 6 1463

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic MCDM.

1. Inherits from: Subscription

2. Attributes:

a. MCDMMessageFilter messageFilter (Mandatory)

It defines how messages should be filtered.

b. MCDMPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: MCDMSubscriptionUpdateReplyData, MCDMSubscriptionRetrievalReplyData,

MCDMSubscriptionCreationReplyData

20.9.107. MCDMSubscriptionCreationReplyData (new 27.0)

<<class>>

The MCDMSubscriptionCreationReply payload.

1. Attributes:

a. MCDMSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: MCDMSubscriptionCreationReply

20.9.108. MCDMSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The MCDMSubscriptionRetrievalReply payload.

Edition: 27.0 6 1464

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. MCDMSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: MCDMSubscriptionRetrievalReply

20.9.109. MCDMSubscriptionUpdateReplyData (new 27.0)

<<class>>

The MCDMSubscriptionUpdateReply payload.

1. Attributes:

a. MCDMSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: MCDMSubscriptionUpdateReply

20.9.110. MCDMTopic

Edition: 27.0 6 1465

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

An abstract object that defines the common attributes of MCDM topics (measure, flight).

1. Attributes:

a. MCDMTopicId topicId (Mandatory)

The unique identifier of the topic.

b. PlanDataId dataId (Optional)

An opaque identifier, representing the version of this MCDM topic.

Mandatory if this topic is a MCDMMeasureTopic.

Must be null if this topic is a MCDMFlightTopic.

See MCDM Update pattern.

i. Constraints:

▪ MCDMTopic.DATA_ID_MANDATORY_IF_MCDM_MEASURE_TOPIC

Edition: 27.0 6 1466

Document Title: NM 27.0 - NM B2B Reference Manual

▪ MCDMTopic.DATA_ID_MUST_BE_NULL_IF_MCDM_FLIGHT_TOPIC

2. Constraints:

a. DATA_ID_MANDATORY_IF_MCDM_MEASURE_TOPIC

The dataId is mandatory if this topic is a MCDMMeasureTopic .

Constrained attributes: dataId

Constrained requests: any using request

b. DATA_ID_MUST_BE_NULL_IF_MCDM_FLIGHT_TOPIC

The dataId must be null if this topic is a MCDMFlightTopic .

Constrained attributes: dataId

Constrained requests: any using request

3. Used by: MCDMTopicUpdateReplyData, MCDMTopicUpdateRequest

20.9.111. MCDMTopicField
<<enumeration>>

Enumerates the fields that the caller may request to be returned in MCDMTopic objects when
returned by MCDMTopicListRequest.

As a rule, client applications should never request topic fields that they do not need. Client
applications typically implement a query/retrieve pattern:

1. Query the small number of most relevant topic fields to display to the end user

2. Retrieve more details for a given topic when the end user has selected a topic from the list

Note that the MCDM deadlines field is trial related (STAM): it is only accessible (authorized) during
specific trials or on specific test platforms.

1. Values:

a. initiator

Light

b. userRolesAndApprovalStates

Light

c. userCategories

Light

d. deadlines

Edition: 27.0 6 1467

Document Title: NM 27.0 - NM B2B Reference Manual

Light

e. predefinedUsersForFlightCoordinationLevel

Light

f. remark

Light

g. eHelpDeskTopic

Light (pilots the fields proposalNote , proposalFeedback , ticket )

2. Used by: MCDMPayloadConfiguration, MCDMTopicListRequest

20.9.112. MCDMTopicId
<<typedef[string]>>

A unique identifier of a MCDM topic.

1. Pattern: (M|F|S)_(ALPHA|DIGIT|_){1,300}

2. Used by: MCDMTopicListRequestSelector, NetworkImpactAssessmentFlightChanges,

EhelpDeskTicketResponseDetails, EhelpDeskFlightId, EhelpDeskTicket, MCDMTopic,
EhelpDeskTicketRevocationReplyData

20.9.113. MCDMTopicListReplyData
<<class>>

The MCDMTopicListReply payload.

1. Attributes:

a. set< MCDMMeasureTopic > measures (Optional)

A set of measure topic details, MCDMTopicListRequest criteria.

Can be empty (meaning that no such measure topics matched the criteria).

i. Constraints:

▪ set size range : [1, unbounded[

b. set< MCDMFlightTopic > standaloneFlights (Optional)

A set of flight related topic details, that matched the MCDMTopicListRequest criteria.

These flights are the flights that are not involved in a measure MCDM process, only
standalone flight MCDM (So, not the flights involved in a cherry pick regulation proposal for
NM approval, nor the flights involved in a rerouting. So, typically, one will find a.o.
individual slot improvement requests for NMOC approval/processing i.e. standalone

Edition: 27.0 6 1468

Document Title: NM 27.0 - NM B2B Reference Manual

EhelpdeskTickets).

Can be empty (meaning that no such measure topics matched the criteria).

i. Constraints:

▪ set size range : [1, unbounded[

2. Used by: MCDMTopicListReply

20.9.114. MCDMTopicListRequestSelector
<<union>>

Selector used in MCDMTopicListRequest.

1. Choices:

a. set< MCDMTopicId > topics

Selects the topics that match one of the topic identifiers in this set.

b. set< MeasureId > measures

Selects the topics with a measure that matches an entry in this set.

c. set< AirNavigationUnitId > actors

Selects the topics with an actor that matches an entry in this set.

2. Used by: MCDMTopicListRequest

20.9.115. MCDMTopicUpdateReplyData
<<class>>

The MCDMTopicUpdateReply payload.

1. Attributes:

a. MCDMTopic topic (Mandatory)

The updated MCDM topic details.

2. Used by: MCDMTopicUpdateReply

20.9.116. MCDMUserAndRole
<<class>>

A user and its role.

1. Attributes:

a. AirNavigationUnitId user (Mandatory)

Edition: 27.0 6 1469

Document Title: NM 27.0 - NM B2B Reference Manual

The user.

b. MCDMRole role (Contextual)

The role.

i. Presence:

▪ Optional in MCDMTopicUpdateRequest

▪ Mandatory otherwise

ii. Constraints:

▪ MCDMUserAndRole.MCDM_ROLE_IS_MANDATORY

2. Constraints:

a. MCDM_ROLE_IS_MANDATORY

MCDMRole is mandatory.

Constrained attributes: role

Constrained requests: MCDMTopicUpdateRequest

3. Used by: MCDMMeasureTopic

20.9.117. MCDMUserCategory
<<enumeration>>

Enumeration of possible categories of actors working with MCDM measure topics.

For STAM rerouting measures, MCDM addressing based on user categories, can be used
operationally. Note that, for regulations, MCDM addressing based on user categories, can not be
used operationally. But on NMVP (e.g. SESAR trials), the feature can be used, both for regulation and
reroutings.

1. Values:

a. IMPACTED_FMP

In a SESAR trial context, impacted FMP can mean for a rerouting (depending on the specific
trial configuration settings, other definitions of IMPACTED_FMP might apply):

1. address those FMPs (ANUs) where there are differences in the airspace profile
before/after the rerouting (and that are adjacent to initiator FMP).

In an OPS context, impacted FMP means for a STAM rerouting:

1. address those FMPs (ANUs) where there are differences in airspace profile (wrt crossing
an (e.g. elementary) airspace or not) before/after the rerouting (irrespective wrt. if they
are actually adjacent to the initiator FMP).

Edition: 27.0 6 1470

Document Title: NM 27.0 - NM B2B Reference Manual

For a regulation (i.e. a cherry pick regulation) : impacted FMP means : address those FMPs
where there is a problem hotspot defined. Note that, in an OPS context, there are normally
no problem hotspots (NMVP/SESAR only).

b. ALL_FMP

ALL_FMP means for a regulation/rerouting : address all FMP’s crossed by FTFM/RTFM flight
profiles (e.g. before or after a rerouting).

Note that, even if the B2B client did not request to have ALL_FMP to be addressed, ALL_FMP
MCDM addressing is still computed/returned (but with role NOT_INVOLVED). This allows the
B2B client e.g. to present to the end-user a list of crossed FMP from which the user can
choose which ones should be made e.g. FOR_APPROVAL or FOR_INFORMATION (in any case
the B2B client can still force to include other FMP (or ANUs) into the MCDM addressing, even
if according to NM systems the flights are not crossing the FMP (or alternatively, for
measure level addressing : the measure has no flights that cross that FMP))

Note that ALL_FMP includes also addressing the FMP responsible for the departure and
arrival aerodromes.

Note that on NMVP/SESAR trials, depending on the specific trial configuration settings, other
definitions of ALL_FMP might apply.

c. TOWER

TOWER means for a regulation/rerouting : address the towers (ANUs) for the departure and
arrival aerodromes (not conerning alternate/diverted aerodromes). Note that if an
aerodrome (inside the IFPZ zone), does not have a dedicated tower ANU, the responsible
FMP (ANU) well be addressed.

d. AIRCRAFT_OPERATOR

AIRCRAFT_OPERATOR means for a regulation/rerouting : address the AO(ANU) for the

individual flights (or alternatively, for measure level addressing : the AOs of the flights that
the measure impacts/changes).

Note that in case a flight has more than one aircraft operator (e.g. if a flight has a different
aircraft operator and operational aircraft operator (e.g. wet lease vs dry lease or a flight
being operated by multiple AOs (from the same 'group') or there are copy/move
relationships defined in NM between AOs), then the first AO (AOCC ANU) will get the
requested role (e.g. FOR_APPROVAL), while the others will get the role : FOR_ROLE_INFO (i.e.
: the concerned AOs need to determine/indicate/change_MCDM_roles to indicate to NM/FMPs
who is really in charge of the flight)

e. NMOC

NMOC means for a regulation/rerouting/flights : address NMOC (with the requested role: e.g.
FOR_INFORMATION/FOR_APPROVAL)

2. Used by: MCDMRoleUserCategory

Edition: 27.0 6 1471

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.118. MCDMUserRoleAndApprovalState
<<class>>

A user, its role and its optional approval state.

1. Attributes:

a. AirNavigationUnitId user (Mandatory)

The user.

b. MCDMRole role (Contextual)

The role.

i. Presence:

▪ Optional in MCDMTopicUpdateRequest

▪ Mandatory otherwise

c. MCDMApprovalState approvalState (Contextual)

The approval state.

i. Presence:

▪ Optional in MCDMTopicUpdateRequest

▪ Mandatory otherwise

2. Used by: MCDMStatefulTopic

20.9.119. Measure

Edition: 27.0 6 1472

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Abstract ancestor of a measure.

1. Attributes:

a. PlanDataId dataId (Contextual)

Documentation last updated: 27.0 - Edition 5

In a measure, this identifier represents the version of the measure and it can be used to sort
the various occurrences or states of a measure (for example as returned via pub/sub
messages or as replies to SOAP requests) to identify the latest version.

The caller shall always keep this value unchanged.

See Update Pattern.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

ReroutingCreationRequest
▪ Optional otherwise

b. DateTimeMinutePeriod applicability (Contextual)

The period of time during which the measure affects the flights entering the traffic volumes
of this regulation.

This period extends to maximum 24 hours.

When requested, this attribute is never left null.

Edition: 27.0 6 1473

Document Title: NM 27.0 - NM B2B Reference Manual

For cherry picked regulation, NM adapts the applicability based on the

NOTE
flights in the regulation.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

ii. Constraints:

▪ Measure.APPLICABILITY_PERIOD_CANNOT_BE_GREATER_THAN_24_HOURS

c. boolean measureCherryPicked (Contextual)

Indicates if this regulation was created for flight cherry picking (only the selected cherry
picked flights are subject to the measure, e.g., will have a delay).

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

ReroutingCreationRequest
▪ Must be null in RegulationProposalUpdateRequest RegulationUpdateRequest
ReroutingUpdateRequest
▪ Optional otherwise

d. LifeCycleEvent lastUpdate (Contextual)

Provides the last update life cycle event.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

e. boolean externallyEditable (Contextual)

Indicates that the FMP is entitled to modify the regulation, either because the regulation is
part of a regulation proposal, or because NMOC flagged this regulation as being externally
editable.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest

Edition: 27.0 6 1474

Document Title: NM 27.0 - NM B2B Reference Manual

ReroutingUpdateRequest
▪ Optional otherwise

f. MeasureSubType subType (Contextual)

The specific type of this measure.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

ReroutingCreationRequest
▪ Must be null in RegulationProposalUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ Measure.INVALID_SUBTYPE

g. boolean createdByFMP (Contextual)

Indicates if the measure has been created by an FMP himself or not.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

h. boolean mcdmRequired (Contextual)

Documentation last updated: 27.0 - Edition 2

Indicates if full MCDM is required for this regulation.

mcdmRequired is False in case of proposal regulation MCDM workflow.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in RegulationCreationRequest ReroutingCreationRequest

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

i. HotspotId sourceHotspot (Optional)

If this regulation was created from a hotspot resolution, id of that hotspot.

Note that this is typically not a real hotspot (as created/retrieved via de hotspots services

Edition: 27.0 6 1475

Document Title: NM 27.0 - NM B2B Reference Manual

(like queryHotspots)).

It is a regulation/rerouting attribute, indicating the source/reason for the measure (e.g. the
regulation period typically is larger than the pure problem (aka hotspot) itself.

j. MeasureFromScenarioRepository scenarioReference (Optional)

In measure list context, indicates if this measure is a measure from the scenario repository
and if so this field indicates from which scenario and which measure inside that scenario.

In create/update context, indicates on which scenario and measure to base the new/updated
measure on (for example: to get the rerouting cost criteria to guide profile generation.)

k. MCDMMeasureTopic mcdmInfo (Optional)

Documentation last updated: 27.0 - Edition 1

When requesting scenario measures, (via ScenarioRegulationRetrievalRequest or

ScenarioReroutingRetrievalRequest), the MCDMInfo can optionally be present (if the measure
needs to be coordinated via MCDM on application).

2. Constraints:

a. APPLICABILITY_PERIOD_CANNOT_BE_GREATER_THAN_24_HOURS

The applicability period must be smaller or equal to 24 hours.

Constrained attributes: applicability

Constrained requests: any using request

b. INVALID_SUBTYPE

Documentation last updated: 27.0 - Edition 5

Attribute subType must be equals to GROUND_DELAY when filing a regulation proposal.

Constrained attributes: subType

Constrained requests: any using request

20.9.120. MeasureFromScenarioRepository

Edition: 27.0 6 1476

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Indicates if the measure originated from an NM scenario repository measure (e.g. the NM scenario
repostory (as can be querried by ScenarioListRequest)). Note in operational or forecast regulations,
it could also point to the daily archived measures (i.e. each night NM systems archive and store the
measures in a scenario file inside the daily archived scenario repository)

1. Attributes:

a. ScenarioId scenarioId (Mandatory)

The id of the scenario file that contains the measure. Note that if the first 3 letters are SCN, it
means that it is a measure from the NM scenario repostory (as can be querried by
ScenarioListRequest).

b. MeasureId measureId (Mandatory)

The measureId of the measure inside the scenario file.

2. Used by: Measure

20.9.121. MeasureId
<<union>>

Represents a regulation or rerouting identifier.

1. Choices:

a. RegulationId REGULATION

The regulation unique identifier.

b. ReroutingId REROUTING

The rerouting unique identifier.

2. Used by: FlightMCDMInfo, MeasureOpLogRetrievalRequest, FlightListByMeasureRequest,

MCDMTopicListRequestSelector, NetworkImpactAssessmentRetrievalRequest, MeasureIdAndTV,
SimulationMeasureRevertRequest, MCDMStateUpdateRequest, MeasureFromScenarioRepository,
TrafficCountsByMeasureRequest, MCDMStatefulTopic

Edition: 27.0 6 1477

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.122. MeasureIdAndTV
<<class>>

Documentation last updated: 27.0 - Edition 4

Represents a summary of a measure inside a scenario: it gives the measureId and the traffic volume
id on which the measure is. In addition it describes for a rerouting measure, the (indirectly) off-
loaded airspaces.

1. Attributes:

a. MeasureId measureId (Mandatory)

The measure id of one of the measures in a scenario.

b. TrafficVolumeId tvId (Optional)

The traffic volume of corresponding to the concerned measure (i.e. with id : measureId).

c. set< AirspaceId > offLoadAirspaces (Mandatory)

The airspaces that the rerouting off-loads (only present for rerouting measures). Note that
typically, the results will not contain overlapping airspaces (e.g. if a collapsed sector is off-
loaded, then the different individual composing elementary airspaces will not be repeated)

2. Used by: ScenarioAttributes

20.9.123. MeasureListReplyData
<<class>>

Abstract reply data associated to the reply of the RegulationOrMCDMOnlyListRequest or

ReroutingListRequest.

1. Attributes:

a. boolean planTransferred (Optional)

Indicates if the plan has been transferred to the OPERATIONAL dataset.

When false , it means that the most up-to-date data can be found in the FORECAST dataset.
(See also Forecast and Operational Datasets)

Must be present if the dataset is OPERATIONAL , must be null otherwise.

b. boolean planCutOffReached (Optional)

Indicates if the plan can still be updated in the FORECAST dataset, i.e. if the forecast cut-off
time has been reached or not.

Must be present if the dataset is FORECAST , must be null otherwise.

Edition: 27.0 6 1478

Document Title: NM 27.0 - NM B2B Reference Manual

c. Dataset dataset (Mandatory)

Dataset on which the regulations are requested.

20.9.124. MeasureListRequest

<<abstract class>>

Abstract request to query an NM measure list, as well as to retrieve the measure details.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset on which the measures are requested.

See Forecast and Operational Datasets and Simulation Datasets.

i. Constraints:

▪ MeasureListRequest.INVALID_QUERY_PERIOD_RANGE

b. DateTimeMinutePeriod queryPeriod (Mandatory)

Selects the measures of which the applicability period overlaps this queryPeriod . The

Edition: 27.0 6 1479

Document Title: NM 27.0 - NM B2B Reference Manual

MeasureListRequest provides the measure list for:

1. The tactical day: up-to-date view of the set of measures that exist for today in the NM
system, at the time of the request

2. One pre-tactical day (tomorrow): the request returns the up-to-date view of the set of
measures applying tomorrow in the NM system (hence including cross-midnight
measures), at the time of the request.

3. 21 post-operations days (yesterday down to 21 days in the past): the request returns the
set of measures in the system for that day, as they existed at the end of the day:
consequently, a request for a post-ops day always returns the same result regardless of
the time at which it is issued in the day.

i. Constraints:

▪ MeasureListRequest.INVALID_QUERY_PERIOD_RANGE

▪ MeasureListRequest.MAX_QUERY_PERIOD_DURATION_IS_2_DAYS

c. set< TrafficVolumeIdWildcard > tvs (Optional)

Selects the regulations applying to the given traffic volumes.

The logical OR operator is meant between the items in the set.

By default, all traffic volumes are considered.

i. Constraints:

▪ set size range : [1, 100]

d. set< TrafficVolumeSetIdWildcard > tvSets (Optional)

Selects the regulations applying to a traffic volume belonging to at least one of the given
traffic volume sets.

The logical OR operator is meant between the items in the set.

By default, all traffic volumes of all traffic volume sets are considered.

i. Constraints:

▪ set size range : [1, 100]

3. Constraints:

a. MAX_QUERY_PERIOD_DURATION_IS_2_DAYS

The maximum duration of queryPeriod is 2 days

Constrained attributes: queryPeriod

Constrained requests: any using request

b. INVALID_QUERY_PERIOD_RANGE

Edition: 27.0 6 1480

Document Title: NM 27.0 - NM B2B Reference Manual

The dataset.type on which the measures are requested and the queryPeriod must be set
according to the following rules:

1. if the DatasetType is equals to OPERATIONAL the queryPeriod shall be defined within the
range [ today-21d .. today+2d ]

2. if the DatasetType is equals to FORECAST the queryPeriod shall be defined within the range [
today-21d .. today+6d ]

Constrained attributes: queryPeriod, dataset

Constrained requests: any using request

20.9.125. MeasureOpLogRetrievalReplyData
<<class>>

The MeasureOpLogRetrievalReply payload.

1. Attributes:

a. set< FlightOperationalLogEntry > opLogs (Mandatory)

A set of operational log entries that matched the MeasureOpLogRetrievalRequest criteria.

Can be empty (meaning that no opLog matched the criteria).

The result can contain a mix of operational logs concerning the measure as a whole ( etfmsId
= 0) or concerning individual flights ( etfmsId > 0). In addition, for the flight related
operational logs, the IFPL id is not always set.

i. Constraints:

▪ set size range : [0, 10000]

2. Used by: MeasureOpLogRetrievalReply

20.9.126. MeasureSubType
<<enumeration>>

Documentation last updated: 27.0 - Edition 1

The result of the application of a measure.

The MeasureSubType encompasses the possible results of any concrete measure.

NOTE
For clarity, the document of each possible value indicates whether it can be used
with regulation, rerouting or both.

1. Values:

a. GROUND_DELAY

Edition: 27.0 6 1481

Document Title: NM 27.0 - NM B2B Reference Manual

Documentation last updated: 27.0 - Edition 1

Usable with regulation only.

The regulation measure gives delay/CTOTs to flights for non airborne flights.

b. TAKE_OFF_NOT_BEFORE

Documentation last updated: 27.0 - Edition 1

Usable with regulation only.

The STAM cherry picked regulation measure gives take off not before constraints for
selected flights, e.g. a CTOT for this type of measure actually means: take of not before
(anything after is OK).

NOTE This value is NMVP/SESAR trial specific.

c. TAKE_OFF_NOT_AFTER

Documentation last updated: 27.0 - Edition 1

Usable with regulation only.

The STAM cherry picked regulation measure gives take off not after constraints for selected
flights, e.g. a CTOT for this type of measure actually means: take of not after (anything before
is OK).

NOTE This value is NMVP/SESAR trial specific.

d. MINIMUM_DEPARTURE_INTERVAL

Documentation last updated: 27.0 - Edition 1

Usable with regulation only.

The STAM cherry picked regulation measure gives minimum departure interval constraints
for selected flights (a flight needs to depart X minutes after the previous flight).

In this case, a CTOT means: depart exactly at that CTOT.

NOTE This value is NMVP/SESAR trial specific.

e. MILES_MINUTES_IN_TRAIL

Documentation last updated: 27.0 - Edition 1

Usable with regulation or rerouting.

The STAM cherry picked regulation measure gives miles in trail or minutes in trail

Edition: 27.0 6 1482

Document Title: NM 27.0 - NM B2B Reference Manual

constraints: i.e. the selected flights need to arrive in the measure’s traffic volume in a
sequence and the flights need to be separated by at least X minutes/miles. It is the up-stream
FMP(s) that has to make this happen by reducing the speed of the airborne flights to assure
the separation.

This value is NMVP/SESAR trial specific.

NOTE In such a trial, typically this is an airborne MCDM_only measure where the
initiator FMP, uses MCDM text on the measure (and optionally on individual
flights) to describe what an up-stream FMP needs to do.

f. GROUND_LEVEL_CAP

Documentation last updated: 27.0 - Edition 1

Usable with rerouting only.

The rerouting measure, e.g. a STAM cherry picked rerouting, requests the AOs to level cap
selected flights (and refile), while the flights are still on the ground.

g. AIRBORNE_LEVEL_CAP

Documentation last updated: 27.0 - Edition 1

Usable with rerouting only.

The STAM cherry picked rerouting measure indicates/requests to other FMP that selected
flights will be level capped by ATC (while the flights are airborne).

NOTE This value is NMVP/SESAR trial specific.

h. GROUND_HORIZONTAL_REROUTING

Documentation last updated: 27.0 - Edition 1

Usable with rerouting only.

The rerouting measure, e.g. a STAM cherry picked rerouting, requests the AOs to
horizontally reroute the selected flights around the traffic volume of the measure (and
refile), while the flights are still on the ground.

i. AIRBORNE_HORIZONTAL_REROUTING

Documentation last updated: 27.0 - Edition 1

Usable with rerouting only.

The STAM cherry picked rerouting measure indicates/requests to other FMP that the cherry
picked flights will be horizontally rerouted (to avoid the TV of the measure) by ATC (while
the flight is airborne).

Edition: 27.0 6 1483

Document Title: NM 27.0 - NM B2B Reference Manual

NOTE This value is NMVP/SESAR trial specific.

j. TERMINAL_PROCEDURE_CHANGE

Documentation last updated: 27.0 - Edition 1

Usable with rerouting only.

The rerouting measure, e.g. a STAM cherry picked rerouting, indicates(via RRP/MCDM_only)
to other FMP/TWR/AO that the selected flights will need to change their SID/STAR to avoid
overloading certain sectors.

k. OTHER_KIND_OF_STAM_MEASURE

Documentation last updated: 27.0 - Edition 1

Usable with regulation or rerouting.

The rerouting measure, e.g. a STAM cherry picked rerouting, indicates(via RRP/MCDM_only)
to other users that the selected flights will need to change for reasons described in the
rerouting/MCDM_only measure.

2. Used by: Measure, FlightAtfcmMeasureLocation

20.9.127. NetworkImpactAssessmentFilter
<<class>>

NetworkImpactAssementRetrievalRequest filter.

1. Attributes:

a. set< TrafficVolumeSetId > tvSets (Optional)

Documentation last updated: 27.0 - Edition 1

In the NetworkImpactAssessmentReply for the counts, only returns the traffic volumes
belonging to at least one of the given traffic volume sets (or the explicitly given traffic
volumes).

When no filter is specified on tvSets or tvs, then all impacted traffic volumes are returned.

b. set< TrafficVolumeId > tvs (Optional)

Documentation last updated: 27.0 - Edition 1

In the NetworkImpactAssessmentReply for the counts, only returns the traffic volumes
belonging to at least one of the given traffic volumes (or the given traffic volume sets).

When no filter is specified on tvSets or tvs, then all impacted traffic volumes are returned.

c. set< TrafficVolumeId > additionalTvs (Optional)

Edition: 27.0 6 1484

Document Title: NM 27.0 - NM B2B Reference Manual

By default, only traffic volumes that are at least partially active are returned (during the
impacted periods returned), as typically capacity and OTMV values are only relevant when a
traffic volume is active. note that typically monitoring values are always active. With this
option one can specify additional traffic volumes (e.g., completely inactive) to be considered.

Note that even if a traffic volume is to be additionally considered, it does not mean it will be
returned (i.e., when before and after counts are below capacity and OTMV thresholds).

2. Used by: NetworkImpactAssessmentRetrievalRequest

20.9.128. NetworkImpactAssessmentFlightChanges
<<class>>

Network Impact Assessment flight changes.

This shows for the changed flights: what are the the changes (flight-per-flight) (a.o. before/after:
CTOT, concerned regulations, IFPS restriction violations)

1. Attributes:

a. FlightKeys flightId (Mandatory)

The flight keys of the changed flight concerned.

b. MCDMTopicId mcdmUid (Optional)

If the flight has still not fully processed EhelpdeskTickets (i.e. MCDM state
draft/proposed/coordinated), then this represent the MCDMTopicId of the most recent one.

For example, when evaluating the NetworkImpact for Ehelpdesk tickets, this mcdmUid
allows to retrieve the full details about this conerned EhelpdeskTicket (a.o. is it an exclusion
or a slot_extension ticket).

c. NetworkImpactFlightData beforeFlightData (Mandatory)

The network impact assesment relevant flightData before the change (like CTOT, IFPS
restriction violations).

d. NetworkImpactFlightData afterFlightData (Mandatory)

The relevant flightData after the change.

e. set< NetworkImpactFlightRegulationChange > concernedRegulations (Optional)

The Regulation profile (before & after the change). It contains o.a. :

1. Calculated time over (entry & exit times) in the concerned regulations

2. Position in the regulation (before or inside or after the regulation period)

3. Errors/warnings like : Insufficient RVR or Zero rate violations

Edition: 27.0 6 1485

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: NetworkImpactAssessmentRetrievalReplyData

20.9.129. NetworkImpactAssessmentKind
<<enumeration>>

Describes the kind of network impact assessment(NIA) requested: either for the last measure
modification (of forMeasure ) or else for the currently outstanding EhelpdeskTickets (i.e., standalone
flight MCDM requests/topics in draft/proposed MCDM state).

1. Values:

a. FOR_MEASURE_MODIFICATION

The NIA requested is for the last measure modification.

b. FOR_EHELPDESK_TICKETS

The NIA requested is for outstanding Ehelpdesk tickets.

c. FROM_INITIAL_SIMULATION_STATE

The NIA is computed by comparing all flights between the initial simulation state and the
current/latest simulation state.

2. Used by: NetworkImpactAssessmentRetrievalRequest

20.9.130. NetworkImpactAssessmentPayload
<<class>>

NetworkImpactAssementRetrievalRequest payload.

1. Attributes:

a. boolean computeOtmvAlerts (Mandatory)

Indicates if OTMV alerts need to be computed (e.g., is the flight in an OTMV peak and during
what count periods; see OtmvAlert) or not.

b. boolean computeFlightsChanges (Mandatory)

Indicates if flight changes need to be computed (a.o., is the flight’s calculated time over
before/after in the flights concerned regulations) or not.

2. Used by: NetworkImpactAssessmentRetrievalRequest

20.9.131. NetworkImpactAssessmentRetrievalReplyData
<<class>>

The NetworkImpactAssessmentRetrievalReply payload.

Edition: 27.0 6 1486

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. DateTimeSecond lastUpdated (Mandatory)

Last updated.

b. DeltaATFCMSituation atfcmSituationChanges (Optional)

Describes the diff/delta between the ATFCM Situation before/after the changes (e.g. includes
the impact/changes in a.o. delays in the other (e.g. linked) regulations). Only the relevant
changes are returned.

c. map< TrafficVolumeId, map< CountsCalculationTypeAndInterval, map<

DateTimeMinutePeriodWithUFN, DeltaCounts > > > countsChanges (Optional)

Describes the delta counts, grouped by concerned traffic volume (see also
NetworkImpactAssessmentRetrievalRequest) for which counts/traffic volumes are returned)
and CountsCalculationTypeAndInterval (basically entry or occupancy) and counts period.

The countsChanges contains the OTMV alerts before/after and a list of before/after counts.

Note that in case there is only 1 single e.g. entry count impacted, the Date-
TimeMinutePeriodWithUFN is not a period but the unt time is null. Otherwise e.g. for a period
[10:00, 11:20[ with entry counts (step is 20 minutes, duration is 60 minutes : See
CountsInterval) then there are 5 delta counts : the first one representing the count [10:00 ,
11:00] the second one : [10:20, 11:20[ .. and the last one [ 11:20, 12:20[

d. set< NetworkImpactAssessmentFlightChanges > flightsChanges (Optional)

Flights changes.

2. Used by: NetworkImpactAssessmentRetrievalReply

20.9.132. NetworkImpactFlightData
<<class>>

Network impact relevant flight data for either the before or after flight for a changed flight.

1. Attributes:

a. DateTimeMinute readyEstimatedOffBlockTime (Mandatory)

The readyEstimatedOffBlockTime (See B2B flightlist readyEstimatedOffBlockTime for more

details)

b. DateTimeMinute calculatedTakeOffTime (Optional)

The CTOT of the before or after flight.

c. RegulationId mostPenalisingRegulation (Optional)

Edition: 27.0 6 1487

Document Title: NM 27.0 - NM B2B Reference Manual

The most penalising regulation (if any)

d. SuspensionStatus suspensionStatus (Mandatory)

The suspension status of the before or after flight.

e. list< string > errorsAndWarnings (Optional)

Errors/warnings (typically only set for the after flight) like :

1. The flight’s CTOT is being improved although the AO has requested to not get direct CTOT
improvements (only SIP messages requested) : The CTOT is improved for a Non RFI/REA
flight (not expected by the AO).

2. The flight’s new CTOT is before the Minimum Take Off Time (taking into account a.o. the
current time and TIS/TRS and DPI info).

i. Constraints:

▪ Item pattern: MULTILINE_TEXT{0,10000}

f. set< IFPSError > ifpsErrors (Optional)

The ifps errors according to the highest model point profile (for the before/after flight).

2. Used by: NetworkImpactAssessmentFlightChanges

20.9.133. NetworkImpactFlightRegulationChange
<<class>>

Network impact flight regulation change.

It contains the Regulation profile for a flight (combined list of before & after concerned regulation
changes). It contains o.a. :

1. Calculated time over (entry & exit times) in the concerned regulations (before & after).

2. Position in the regulation (before or inside or after the regulation period).

3. Regulation specific errors/warnings like : Insufficient RVR or Zero rate violations.

1. Attributes:

a. RegulationId regulationId (Mandatory)

The concerned regulation (for this specific regulation: from the list of concerned
regulations).

b. ConcernedRegulationTimeOver beforeTimeOver (Optional)

The calculated time over (CTO) in the concerned regulation before the change. It includes :

1. Calculated time over (entry & exit times) in the concerned regulation

Edition: 27.0 6 1488

Document Title: NM 27.0 - NM B2B Reference Manual

2. Position in the regulation (before or inside or after the regulation period)

3. Is the before flight exempted or excluded from the regulation

c. ConcernedRegulationTimeOver afterTimeOver (Optional)

The calculated time over (CTO) in the concerned regulation after the change (and associated
relevant information (same info as in the beforeTimeOver)).

d. list< string > beforeRegulationSpecificErrorsAndWarnings (Optional)

Regulation specific errors/warnings for the before flight in the concerned regulation like :

1. Insufficient RVR

2. Zero rate violations

i. Constraints:

▪ Item pattern: MULTILINE_TEXT{0,10000}

e. list< string > afterRegulationSpecificErrorsAndWarnings (Optional)

Regulation specific errors/warnings for the after flight(i.e. after change) in the concerned
regulation like :

1. Insufficient RVR

2. Zero rate violations

3. The change is forcing the flight in it’s most penalising regulation but it’s forcing the flight
outside the regulation period (error : a different most penalising regulation is needed or
the flight needs to be excluded from the regulation)

i. Constraints:

▪ Item pattern: MULTILINE_TEXT{0,10000}

2. Used by: NetworkImpactAssessmentFlightChanges

20.9.134. NMOCManagedSimulation
<<class>>

Documentation last updated: 27.0 - Edition 2

The simulation is managed (start/stop) and prepared by NMOC for the other users (B2B & B2C) to
have a look at the results.

Optionally the users can modify the measures and tactical updates to evaluate the effect.

The simulation type associated to the dataset’s simulation is NMOC_MANAGED_SIMULATION.

1. Inherits from: Simulation

2. Attributes:

Edition: 27.0 6 1489

Document Title: NM 27.0 - NM B2B Reference Manual

a. DatasetReference datasetReference (Optional)

The reference on which this simulation is based (i.e. from which environment data has been
copied and where initially the flights and measures have been copied from).

Note that if the datasetReference is none, then it concerns a standalone simulation (typically
for a future date with specifically prepared environment and flight data) without a
reference.

i. Constraints:

▪ NMOCManagedSimulation.INVALID_DATASET_REFERENCE_TYPE

3. Constraints:

a. INVALID_DATASET_REFERENCE_TYPE

DatasetReference.type must be OPERATIONAL or FORECAST .

Constrained attributes: datasetReference

Constrained requests: any using request

b. INVALID_SIMULATION_IDENTIFIER_TYPE

SimulationIdentifier.simulationType must be NMOC_MANAGED_SIMULATION .

Constrained attributes: dataset

Constrained requests: any using request

20.9.135. OtherReroutingConstraint
<<class>>

Describes a rerouting constraint not already listed.

1. Inherits from: ReroutingConstraint

20.9.136. OTMV
<<class>>

Definition of an OTMV.

1. Attributes:

a. TrafficVolumeId trafficVolume (Mandatory)

Traffic volume to which this OTMV applies.

b. DurationHourMinute otmvDuration (Mandatory)

The duration of this OTMV.

Edition: 27.0 6 1490

Document Title: NM 27.0 - NM B2B Reference Manual

c. OTMVPeak peak (Optional)

The peak configuration of this OTMV.

d. OTMVSustained sustained (Optional)

The sustained configuration of this OTMV.

e. string remark (Optional)

Optional extra comments/remarks. Note that this is present, if it has been set via
OTMVPlanUpdateRequest.

i. Constraints:

▪ Pattern: TEXT{1,255}

2. Used by: PlannedOTMV

20.9.137. OtmvAlert
<<class>>

OTMV alert for a date time period. This indicates which count periods/intervals are involved in an
OTMV peak or an OTMV sustained alert: all count periods that start in OtmvAlert.period are
considered to have an OTMV alert with OtmvStatus.

1. Attributes:

a. DateTimeMinutePeriod period (Mandatory)

Period of the OTMV alert.

b. OtmvStatus status (Mandatory)

Status of the OTMV alert.

2. Used by: TrafficCountsReplyData, DeltaCounts

20.9.138. OTMVPeak
<<class>>

OTMV peak data.

1. Attributes:

a. OTMVThreshold threshold (Mandatory)

Peak threshold of an OTMV.

2. Used by: OTMV

Edition: 27.0 6 1491

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.139. OTMVPlan
<<class>>

OTMV plan for a given traffic volume on a given day.

An OTMV plan is a special plan in the sense that for a given traffic volume there can be multiple
OTMV durations. For each of these durations there exists a plan covering the full day (completely
independent of any other duration). In update mode, only one duration can be updated in a single
request. For a specific (traffic volume, OTMV duration) plan, there can be cases where there is no
data known. So there are (traffic volume, OTMV duration) pairs where there is NO_DATA at all or
only for some periods.

In a retrieval context, the plan for a (traffic volume, OTMV duration) is said to be 'complete' in the
sense that it contains all the plan entries from all involved data sources (including NO_DATA data
source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values) or limited to the (full list) of (pre-)tactical updates with the gaps marked as
AIRSPACE (meaning in update context: either NO_DATA or CACD) datasource (to obtain a complete
time partition).

In any case, periods in the time partition marked with datasource AIRSPACE correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the CACD
definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. TrafficVolumeId trafficVolume (Mandatory)

Traffic volume to which this OTMV plan applies.

b. map< DurationHourMinute, OTMVPlanForDuration > otmvPlans (Mandatory)

The set of durations for which there are OTMV updates and for each duration, the OTMV
plan.

If only one specific duration was requested, then the map will only contain the OTMV plan
for that duration.

i. Constraints:

▪ OTMVPlan.INCOMPLETE_SCHEDULE

▪ OTMVPlan.INVALID_SCHEDULE

▪ OTMVPlan.ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_PLAN

3. Constraints:

a. INCOMPLETE_SCHEDULE

Edition: 27.0 6 1492

Document Title: NM 27.0 - NM B2B Reference Manual

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: otmvPlans

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,
SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

b. ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_PLAN

Only one entry in the otmvPlans map attribute can be updated (i.e., for one duration).

Constrained attributes: otmvPlans

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,
SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

c. INVALID_SCHEDULE

The duration key used in the otmvPlans map attribute has to be equal to the duration of all
OTMVs linked to that duration key.

Constrained attributes: otmvPlans

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,
SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

20.9.140. OTMVPlanForDuration
<<class>>

The OTMV plan for a specific duration.

1. Attributes:

a. set< PlannedOTMV > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

The possible values of dataSource are limited to NO_DATA, AIRSPACE and TACTICAL.

Edition: 27.0 6 1493

Document Title: NM 27.0 - NM B2B Reference Manual

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

b. set< PlannedOTMV > clientSchedule (Mandatory)

(Pre-)tactical OTMVs associated to their applicability period, as maintained by the client.

This plan contains only the updated configurations together with an indication that the
default CACD values (AIRSPACE datasource) apply when not updated (see PlanDataSource).
The actual CACD values for these CACD periods can be found in the nmSchedule

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
CACD defaults. This is a B2B client designer’s decision and depends on how CACD wants to
be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the CACD defaults, then the clientschedule still needs to contain
the full list of (pre-) tactical updates and for the non (pre-) tactically updated periods, an
explicit indication that the CACD values need to be used (but without repeating the CACD
values themselves). So in any case, the clientschedule needs to be a complete time partition
for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD or
that there is no data defined in the CACD), and the TACTICAL value meaning that this plan
entry corresponds to the explicit tactical update expressed via otmv.

2. Used by: OTMVPlans, OTMVPlan

20.9.141. OTMVPlanRetrievalReplyData
<<class>>

The OTMVPlanRetrievalReply payload.

1. Attributes:

a. OTMVPlans plans (Mandatory)

The complete OTMV plan for a given (traffic volume, OTMV duration) pair on a given day.

2. Used by: OTMVPlanRetrievalReply

20.9.142. OTMVPlans
<<class>>

Edition: 27.0 6 1494

Document Title: NM 27.0 - NM B2B Reference Manual

OTMV plans for one or more traffic volumes on a given day.

An OTMV plan is a special plan in the sense that for a given traffic volume there can be multiple
OTMV durations. For each of these durations there exists a plan covering the full day (completely
independent of any other duration). In update mode, only one duration can be updated in a single
request. For a specific (traffic volume, OTMV duration) plan, there can be cases where there is no
data known. So there are (traffic volume, OTMV duration) pairs where there is NO_DATA at all or
only for some periods.

In a retrieval context, the plan for a (traffic volume, OTMV duration) is said to be 'complete' in the
sense that it contains all the plan entries from all involved data sources (including NO_DATA data
source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values) or limited to the (full list) of (pre-)tactical updates with the gaps marked as
AIRSPACE (meaning in update context: either NO_DATA or CACD) datasource (to obtain a complete
time partition).

In any case, periods in the time partition marked with datasource AIRSPACE correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the CACD
definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. map< TrafficVolumeId, map< DurationHourMinute, OTMVPlanForDuration > > tvsOTMVs

(Mandatory)

For each traffic volume, it contains the OTMV plans for the different (occupancy count)
durations. Note that this field also allows to determine if there are occupancy counts
used/applicable for traffic volumes (and their different durations, in case occupancy counts
are monitored using multiple durations).

i. Constraints:

▪ OTMVPlans.INCOMPLETE_SCHEDULE

▪ OTMVPlans.INVALID_SCHEDULE

▪ OTMVPlans.ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_PLAN

3. Constraints:

a. INCOMPLETE_SCHEDULE

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: tvsOTMVs

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,

Edition: 27.0 6 1495

Document Title: NM 27.0 - NM B2B Reference Manual

SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

b. ONLY_ONE_ENTRY_CAN_BE_UPDATED_IN_PLAN

Only one entry in the otmvPlans map attribute can be updated (i.e., for one duration).

Constrained attributes: tvsOTMVs

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,
SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

c. INVALID_SCHEDULE

The duration key used in the otmvPlans map attribute has to be equal to the duration of all
OTMVs linked to that duration key.

Constrained attributes: tvsOTMVs

Constrained requests: CapacityPlanUpdateRequest, OTMVPlanUpdateRequest,

RestrictionActivationPlanUpdateRequest, RunwayConfigurationPlanUpdateRequest,
SectorConfigurationPlanUpdateRequest, TrafficVolumeActivationPlanUpdateRequest

4. Used by: OTMVPlanUpdateReplyData, OTMVPlanRetrievalReplyData, OTMVPlanUpdateRequest

20.9.143. OTMVPlanUpdateReplyData
<<class>>

The OTMVPlanUpdateReply payload.

1. Attributes:

a. OTMVPlans plans (Mandatory)

The complete OTMV plan for a given (traffic volume, OTMV duration) pair on a given day,
resulting from the update.

2. Used by: OTMVPlanUpdateReply

20.9.144. OtmvStatus
<<enumeration>>

Status of a OTMV alert.

1. Values:

a. PEAK

Above the peak value

b. SUSTAINED

Edition: 27.0 6 1496

Document Title: NM 27.0 - NM B2B Reference Manual

"Above" the sustained value (taking into account OTMVSustained.crossingOccurrences and

OTMVSustained.elapsed .

2. Used by: LoadStateAtReferenceLocation, OtmvAlert

20.9.145. OTMVSustained
<<class>>

OTMV sustained data.

1. Attributes:

a. OTMVThreshold threshold (Mandatory)

Sustained threshold of an OTMV.

b. int crossingOccurrences (Mandatory) (altered 27.0)

Number of crossing occurrences of the sustained threshold within elapsed , before this
OTMV triggers an alert.

i. Constraints:

▪ range : [1, 9999]

c. DurationHourMinute elapsed (Mandatory)

Duration of the time window on which crossingOccurrences are counted.

2. Used by: OTMV

20.9.146. OTMVThreshold
<<typedef[int]>>

Threshold type used in OTMVs, in flights per user-defined OTMV duration.

1. range : [0, 9998[

2. Used by: OTMVSustained, OTMVThresholds, OTMVPeak

20.9.147. OTMVThresholds (new 27.0)

<<class>>

1. Attributes:

a. OTMVThreshold peakThreshold (Optional)

The peak threshold.

b. OTMVThreshold sustainedThreshold (Optional)

Edition: 27.0 6 1497

Document Title: NM 27.0 - NM B2B Reference Manual

The sustained threshold.

c. DurationHourMinute sustainedElapsedDuration (Optional)

The duration of the time window on which sustainedCrossingOccurrences are counted.

d. int sustainedCrossingOccurences (Optional)

The number of crossing occurrences of the sustained threshold within sustained elapsed
duration, before this OTMV triggers an alert.

i. Constraints:

▪ range : [1, 9999]

2. Used by: TrafficCountsReplyData

20.9.148. OTMVWithDuration
<<class>>

Composite object which contains trafficVolume and duration .

1. Attributes:

a. TrafficVolumeId trafficVolume (Mandatory)

The traffic volume for which the OTMV plan is requested.

b. DurationHourMinute otmvDuration (Optional)

Selects the OTMVs applying for the given traffic volume according to their OTMV duration.

When not specified, all duration are considered.

2. Used by: OTMVPlanRetrievalRequest

20.9.149. PlanDataSource
<<strict enumeration>>

A source of data for a plan, within or outside NM.

1. Values:

a. NO_DATA

There is no data defined in NM.

b. AIRSPACE

Data from the NM Airspace system (CACD), the data is either baselined with the AIRAC or
results from a live update.

Edition: 27.0 6 1498

Document Title: NM 27.0 - NM B2B Reference Manual

c. TACTICAL

Following a tactical update, typically, from the NOP user (B2B or B2C).

d. MEASURE

Data resulting from the application of a measure in the NM system.

2. Used by: PlannedRestrictionActivation, PlannedOTMV, PlannedCapacity, RunwayConfiguration,

PlannedTrafficVolumeActivation, PlannedSectorConfigurationActivation,
PlannedRunwayConfigurations

20.9.150. PlannedCapacities
<<class>>

Planned Capacities for to be mapped on TrafficVolumeId element in Map .

1. Attributes:

a. set< PlannedCapacity > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

The possible values of dataSource are limited to NO_DATA, AIRSPACE, TACTICAL and MEASURE - the
MEASURE value being used to express that the capacity is derived from a regulation.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

b. set< PlannedCapacity > clientSchedule (Mandatory)

(Pre-)tactical capacities associated to their applicability period, as maintained by the client.

This plan contains only the updated configurations together with an indication that the
default CACD values apply when not updated (see PlanDataSource). The actual CACD values
for these CACD periods can be found in the nmSchedule

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
CACD defaults. This is a B2B client designer’s decision and depends on how CACD wants to

Edition: 27.0 6 1499

Document Title: NM 27.0 - NM B2B Reference Manual

be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the CACD defaults, then the clientschedule still needs to contain
the full list of (pre-) tactical updates and for the non (pre-) tactically updated periods, an
explicit indication that the CACD values need to be used (but without repeating the CACD
values themselves). So in any case, the clientschedule needs to be a complete time partition
for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD or
that there is no data defined in the CACD), and the TACTICAL value meaning that this plan
entry corresponds to the explicit tactical update expressed via capacity.

2. Used by: CapacityPlans

20.9.151. PlannedCapacity
<<class>>

An entry within a capacity plan.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

b. PlanDataSource dataSource (Mandatory)

The data source of this entry in the plan.

i. Constraints:

▪ PlannedCapacity.INVALID_DATASOURCE

▪ PlannedCapacity.VALUE_CANNOT_BE_NULL

▪ PlannedCapacity.VALUE_MUST_BE_NULL

c. Capacity capacity (Optional)

Capacity

i. Constraints:

▪ PlannedCapacity.VALUE_CANNOT_BE_NULL

▪ PlannedCapacity.VALUE_MUST_BE_NULL

2. Constraints:

a. VALUE_CANNOT_BE_NULL

capacity cannot be null if dataSource is TACTICAL .

Edition: 27.0 6 1500

Document Title: NM 27.0 - NM B2B Reference Manual

For nmSchedule : capacity cannot be null if dataSource is different from NO_DATA .

Constrained attributes: dataSource, capacity

Constrained requests: any using request

b. VALUE_MUST_BE_NULL

capacity must be null if dataSource is NO_DATA .

For clientSchedule : capacity must be null if dataSource is not TACTICAL .

Constrained attributes: dataSource, capacity

Constrained requests: any using request

c. INVALID_DATASOURCE

Documentation last updated: 27.0 - Edition 2

NO_DATA is not a valid dataSource in an update context.

MEASURE is not a valid dataSource in an update context.

Constrained attributes: dataSource

Constrained requests: any using request

3. Used by: PlannedCapacities

20.9.152. PlannedOTMV
<<class>>

An entry within an OTMV plan.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

b. PlanDataSource dataSource (Mandatory)

The data source of this entry in the plan.

i. Constraints:

▪ PlannedOTMV.INVALID_DATASOURCE

▪ PlannedOTMV.VALUE_CANNOT_BE_NULL

▪ PlannedOTMV.VALUE_MUST_BE_NULL

c. OTMV otmv (Optional)

Edition: 27.0 6 1501

Document Title: NM 27.0 - NM B2B Reference Manual

OTMV

i. Constraints:

▪ PlannedOTMV.VALUE_CANNOT_BE_NULL

▪ PlannedOTMV.VALUE_MUST_BE_NULL

2. Constraints:

a. VALUE_CANNOT_BE_NULL

otmv cannot be null if dataSource is TACTICAL .

For nmSchedule : otmv cannot be null if dataSource is different from NO_DATA .

Constrained attributes: dataSource, otmv

Constrained requests: any using request

b. VALUE_MUST_BE_NULL

otmv must be null if dataSource is NO_DATA .

For clientSchedule : otmv must be null if dataSource is not TACTICAL .

Constrained attributes: dataSource, otmv

Constrained requests: any using request

c. INVALID_DATASOURCE

Documentation last updated: 27.0 - Edition 2

NO_DATA is not a valid dataSource in an update context.

MEASURE is not a valid dataSource in an update context.

Constrained attributes: dataSource

Constrained requests: any using request

3. Used by: OTMVPlanForDuration

20.9.153. PlannedRestrictionActivation
<<class>>

Denotes whether a restriction is active or not during a period.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

Edition: 27.0 6 1502

Document Title: NM 27.0 - NM B2B Reference Manual

b. PlanDataSource dataSource (Mandatory)

The data source of this entry in the plan.

i. Constraints:

▪ PlannedRestrictionActivation.INVALID_DATASOURCE

▪ PlannedRestrictionActivation.VALUE_CANNOT_BE_NULL

▪ PlannedRestrictionActivation.VALUE_MUST_BE_NULL

c. boolean active (Optional)

Indicates if the restriction is active or not during applicabilityPeriod .

i. Constraints:

▪ PlannedRestrictionActivation.VALUE_CANNOT_BE_NULL

▪ PlannedRestrictionActivation.VALUE_MUST_BE_NULL

2. Constraints:

a. VALUE_CANNOT_BE_NULL

active cannot be null if dataSource is TACTICAL .

For nmSchedule : active must be true if dataSource is AIRSPACE .

Constrained attributes: dataSource, active

Constrained requests: any using request

b. VALUE_MUST_BE_NULL

For clientSchedule : active must be null if dataSource is not TACTICAL .

Constrained attributes: dataSource, active

Constrained requests: any using request

c. INVALID_DATASOURCE

Documentation last updated: 27.0 - Edition 2

NO_DATA is not a valid dataSource in context.

MEASURE is not a valid dataSource in context.

Constrained attributes: dataSource

Constrained requests: any using request

3. Used by: RestrictionActivationPlan, PlannedRestrictionActivations

Edition: 27.0 6 1503

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.154. PlannedRestrictionActivations
<<class>>

PlannedRestrictionActivations contains two sets of PlannedRestrictionActivation called client and

nm schedules.

1. Attributes:

a. set< PlannedRestrictionActivation > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

In nmSchedule the possible values of dataSource are limited to AIRSPACE and TACTICAL.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Optional otherwise

b. set< PlannedRestrictionActivation > clientSchedule (Mandatory)

(Pre-)tactical restriction activations associated to their applicability period, as maintained by

the client. This plan contains only the updated configurations together with an indication
(AIRSPACE datasource) that the default CACD values apply when not updated (see
PlanDataSource). The actual activity for these airspace datasource periods can be found in
the nmSchedule.

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
AIRSPACE defaults. This is a B2B client designer’s decision and depends on how CACD wants
to be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the AIRSPACE defaults, then the clientschedule still needs to
contain the full list of (pre-) tactical updates and for the non (pre-) tactically updated
periods, an explicit indication that the AIRSPACE values need to be used (but without
repeating the CACD values themselves). So in any case, the clientschedule needs to be a
complete time partition for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD values in that period.

Edition: 27.0 6 1504

Document Title: NM 27.0 - NM B2B Reference Manual

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD),
and the TACTICAL value meaning that this plan entry corresponds to the explicit tactical
update expressed via active.

2. Used by: RestrictionActivationPlans

20.9.155. PlannedRunwayConfigurations
<<class>>

An entry within an aerodrome runway configuration plan.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

b. PlanDataSource dataSource (Mandatory)

The data source of this entry in the plan.

c. set< RunwayConfiguration > runwayConfigurations (Optional)

Full set of runway configurations for an aerodrome within applicabilityPeriod

2. Used by: RunwayConfigurationPlan

20.9.156. PlannedSectorConfigurationActivation
<<class>>

An entry within a sector configuration plan - its presence in the plan denotes the activation of the
associated sector configuration.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

b. PlanDataSource dataSource (Mandatory)

The data source of this entry in the plan.

i. Constraints:

▪ PlannedSectorConfigurationActivation.INVALID_DATASOURCE

▪ PlannedSectorConfigurationActivation.VALUE_CANNOT_BE_NULL

▪ PlannedSectorConfigurationActivation.VALUE_MUST_BE_NULL

c. SectorConfigurationId sectorConfigurationId (Optional)

Edition: 27.0 6 1505

Document Title: NM 27.0 - NM B2B Reference Manual

Unique Id of the sector configuration, as known in the NM system.

i. Constraints:

▪ PlannedSectorConfigurationActivation.VALUE_CANNOT_BE_NULL

▪ PlannedSectorConfigurationActivation.VALUE_MUST_BE_NULL

2. Constraints:

a. VALUE_CANNOT_BE_NULL

sectorConfigurationId cannot be null if dataSource is TACTICAL .

This is applicable for both nmSchedule and clientSchedule .

Constrained attributes: dataSource, sectorConfigurationId

Constrained requests: any using request

b. VALUE_MUST_BE_NULL

sectorConfigurationId must be null if dataSource is not TACTICAL .

This is only applicable for the clientSchedule .

Constrained attributes: dataSource, sectorConfigurationId

Constrained requests: any using request

c. INVALID_DATASOURCE

NO_DATA is not a valid dataSource in an update context.

MEASURE is not a valid dataSource in an update context.

Constrained attributes: dataSource

Constrained requests: any using request

3. Used by: SectorConfigurationPlan

20.9.157. PlannedTrafficVolumeActivation
<<class>>

Denotes whether a traffic volume is active or not during a period.

1. Attributes:

a. DateTimeMinutePeriod applicabilityPeriod (Mandatory)

The time period in the plan to which this entry applies.

b. PlanDataSource dataSource (Mandatory)

Edition: 27.0 6 1506

Document Title: NM 27.0 - NM B2B Reference Manual

The data source of this entry in the plan.

i. Constraints:

▪ PlannedTrafficVolumeActivation.INVALID_DATASOURCE

▪ PlannedTrafficVolumeActivation.VALUE_CANNOT_BE_NULL

▪ PlannedTrafficVolumeActivation.VALUE_MUST_BE_NULL

c. boolean active (Optional)

Indicates if the traffic volume is active or not during applicabilityPeriod

i. Constraints:

▪ PlannedTrafficVolumeActivation.VALUE_CANNOT_BE_NULL

▪ PlannedTrafficVolumeActivation.VALUE_MUST_BE_NULL

2. Constraints:

a. VALUE_CANNOT_BE_NULL

active cannot be null if dataSource is TACTICAL .

For nmSchedule : active must be true if dataSource is AIRSPACE .

Constrained attributes: dataSource, active

Constrained requests: any using request

b. VALUE_MUST_BE_NULL

active must be null if dataSource is NO_DATA .

For clientSchedule : active must be null if dataSource is not TACTICAL .

Constrained attributes: dataSource, active

Constrained requests: any using request

c. INVALID_DATASOURCE

NO_DATA is not a valid dataSource in an update context.

MEASURE is not a valid dataSource in an update context.

Constrained attributes: dataSource

Constrained requests: any using request

3. Used by: PlannedTrafficVolumeActivations, TrafficVolumeActivationPlan

Edition: 27.0 6 1507

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.158. PlannedTrafficVolumeActivations
<<class>>

PlannedTrafficVolumeActivations contains two sets of PlannedTrafficVolumeActivation called client

and nm schedules.

1. Attributes:

a. set< PlannedTrafficVolumeActivation > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

In nmSchedule the possible values of dataSource are limited to NO_DATA, AIRSPACE, TACTICAL and
MEASURE.

Note that NO_DATA in nmClientSchedule means either inactive or that no data has been
specified.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

b. set< PlannedTrafficVolumeActivation > clientSchedule (Mandatory)

(Pre-)tactical traffic volume activations associated to their applicability period, as

maintained by the client. This plan contains only the updated configurations together with
an indication (AIRSPACE datasource) that the default CACD/sector config derived values
apply when not updated (see PlanDataSource). The actual activity for these airspace
datasource periods can be found in the nmSchedule

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
AIRSPACE defaults. This is a B2B client designer’s decision and depends on how CACD wants
to be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the AIRSPACE defaults, then the clientschedule still needs to
contain the full list of (pre-) tactical updates and for the non (pre-) tactically updated
periods, an explicit indication that the AIRSPACE values need to be used (but without
repeating the NO_DATA/CACD/sector config derived values themselves). So in any case, the
clientschedule needs to be a complete time partition for the full day.

Edition: 27.0 6 1508

Document Title: NM 27.0 - NM B2B Reference Manual

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD/sector config derived values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD or
the TV activation derived from a sector configuration or that there is no data defined in
CACD), and the TACTICAL value meaning that this plan entry corresponds to the explicit
tactical update expressed via active.

2. Used by: TrafficVolumeActivationPlans

20.9.159. PointLocation
<<class>>

Point location.

1. Inherits from: Location

20.9.160. ReferenceRequestedFlightLevel (new 27.0)

<<enumeration>>

The reference requested flight level to be used in a rerouting context.

1. Values:

a. ORIGINAL

Documentation last updated: 27.0 - Edition 3

Use the RFL sequence of the frozen and non frozen portions.

b. HIGHEST

Documentation last updated: 27.0 - Edition 3

Use the highest reached RFL in the non frozen portion.

c. LONGEST

Documentation last updated: 27.0 - Edition 3

Use the longest flown RFL in the non frozen portion.

2. Used by: HorizontalReroutingSourcesAndConstraints

20.9.161. Regulation

Edition: 27.0 6 1509

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Regulation.

1. Inherits from: RegulationOrMCDMOnly

2. Attributes:

a. RegulationState regulationState (Contextual)

Current state of the regulation.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationUpdateRequest

▪ Optional otherwise

3. Used by: RegulationCreationReplyData, RegulationMessage,

ScenarioRegulationRetrievalReplyData, RegulationUpdateRequest, RegulationListReplyData,
RegulationCancelReplyData, RegulationCreationRequest, RegulationUpdateReplyData

20.9.162. RegulationCancelReplyData
<<class>>

The RegulationCancelReply payload.

1. Attributes:

a. Regulation regulation (Mandatory)

The regulation that has been cancelled.

Edition: 27.0 6 1510

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RegulationCancelReply

20.9.163. RegulationCause
<<class>>

Describes the cause of a regulation.

1. Attributes:

a. RegulationReason reason (Mandatory)

The reason of the regulations due to this regulation cause.

b. RegulationLocationCategory locationCategory (Mandatory)

The location category of the regulations due to this regulation cause.

c. int iataDelayCode (Mandatory)

The IATA delay code of the regulations due to this regulation cause.

i. Constraints:

▪ range : [0, unbounded[

2. Used by: Flight

20.9.164. RegulationCreationReplyData
<<class>>

The RegulationCreationReply payload.

1. Attributes:

a. Regulation regulation (Mandatory)

The regulation with fields set by the NM system.

2. Used by: RegulationCreationReply

20.9.165. RegulationExceptionalConstraint
<<class>>

Groups all exceptional constraints expressed by a regulation for a specific initial constraint period.

In an initial constraint period, flights can either:

1. Be suspended if the flight is not confirmed (and FCM is mandatory) or if the flight has an
insufficient minimum runway visible range

2. Be shifted

Edition: 27.0 6 1511

Document Title: NM 27.0 - NM B2B Reference Manual

3. Use a slot inside the initial constraint period (corresponding to the rates of that period)

1. Attributes:

a. DistanceM runwayVisualRange (Optional)

For departure/arrival regulations: minimum visible range in meters for a flight to use slots
in the corresponding constraint period. If the flight has an insufficient runway visual range,
the flight is either shifted at the end of the constraint period (if shift is true and the flight has
a minimum runwayVisualRange), or is suspended (if shift is false or if the flight has no
minimum runwayVisualRange)

Constraint
Range: [0,999[ .

i. Constraints:

▪ RegulationExceptionalConstraint.INCONSISTENT_RUNWAY_VISUAL_RANGE_AND_FCM_MANDATOR
Y
b. boolean fcmMandatory (Mandatory)

Indicates if the flight must be confirmed in this regulation before trying to find a slot for this
flight in the associated constraint period. If the flight is not confirmed in this exceptional
constraint, the flight is suspended.

i. Constraints:

▪ RegulationExceptionalConstraint.INCONSISTENT_RUNWAY_VISUAL_RANGE_AND_FCM_MANDATOR
Y
c. boolean shift (Mandatory)

If the flight is not suspended due to fcmMandatory and no minimum visible range is required,
flights affected by this constraint must be shifted to the end of the constraint period when
trying to find a slot (and possibly further, depending on next constraint periods). If the flight
is not suspended due to fcmMandatory but a minimum visible range is required, the flight is
shifted if it has an insufficient runwayVisualRange .

2. Constraints:

a. INCONSISTENT_RUNWAY_VISUAL_RANGE_AND_FCM_MANDATORY

If fcmMandatory is true then runwayVisualRange must be null

Constrained attributes: fcmMandatory, runwayVisualRange

Constrained requests: RegulationCreationRequest, RegulationProposalFilingRequest,

RegulationUpdateRequest, RegulationProposalUpdateRequest

3. Used by: RegulationInitialConstraint

Edition: 27.0 6 1512

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.166. RegulationField
<<enumeration>>

Enumerates the fields that the caller may request to be returned in Regulation objects when
returned by RegulationListRequest.

As a rule, client applications should never request regulation fields that they do not need. Client
applications typically implement a query/retrieve pattern:

1. Query the small number of most relevant regulation fields to display to the end user

2. Retrieve more details for a given regulation when the end user has selected a regulation from
the list

1. Values:

a. applicability

See Measure.applicability attribute.

b. autolink

See RegulationOrMCDMOnly.autolink attribute.

c. measureCherryPicked

See Measure.measureCherryPicked attribute.

d. calculationType (new 27.0)

See RegulationOrMCDMOnly.calculationType attribute.

e. initialConstraints

See RegulationOrMCDMOnly.initialConstraints attribute.

f. occupancyConstraints (new 27.0)

See RegulationOrMCDMOnly.occupancyConstraints attribute.

g. linkedRegulations

See RegulationOrMCDMOnly.linkedRegulations attribute.

h. location

See RegulationOrMCDMOnly.location attribute.

i. protectedLocation

See RegulationOrMCDMOnly.protectedLocation attribute.

j. reason

Edition: 27.0 6 1513

Document Title: NM 27.0 - NM B2B Reference Manual

See RegulationOrMCDMOnly.reason attribute.

k. remark

See RegulationOrMCDMOnly.remark attribute.

l. regulationState

See Regulation.regulationState attribute.

m. supplementaryConstraints

See RegulationOrMCDMOnly.supplementaryConstraints attribute.

n. lastUpdate

See Measure.lastUpdate attribute.

o. noDelayWindow

See RegulationOrMCDMOnly.noDelayWindow attribute.

p. occupancyDuration (new 27.0)

See RegulationOrMCDMOnly.occupancyDuration attribute.

q. updateCapacityRequired

See RegulationOrMCDMOnly.updateCapacityRequired attribute.

r. updateTVActivationRequired

See RegulationOrMCDMOnly.updateTVActivationRequired attribute.

s. externallyEditable

See Measure.externallyEditable attribute.

t. subType

See Measure.subType attribute.

u. delayTVSet

See RegulationOrMCDMOnly.delayTVSet attribute.

v. createdByFMP

See Measure.createdByFMP attribute.

w. sourceHotspot

See Measure.sourceHotspot attribute.

Edition: 27.0 6 1514

Document Title: NM 27.0 - NM B2B Reference Manual

x. mcdmRequired

See Measure.mcdmRequired attribute.

y. dataId

See Measure.dataId attribute.

z. scenarioReference

See Measure.scenarioReference attribute.

aa. delayConfirmationThreshold

See RegulationOrMCDMOnly.delayConfirmationThreshold attribute.

2. Used by: RegulationPayloadConfiguration, ScenarioRegulationRetrievalRequest,

RegulationListRequest

20.9.167. RegulationId
<<typedef[string]>>

Unique id of a regulation measure (inside a given month), allocated by NM or via the user.

Note that there can be 2 regulations with the same RegulationId over a 2 month period.

1. Pattern: UALPHA(UALPHA|DIGIT){0,5}DIGIT{2}UALPHA{0,1}

2. Max length: 8

3. Max length inclusive: true

4. Used by: UpdateFlightInMeasureChoice, ArrivalInformation,

NetworkImpactFlightRegulationChange, ExcludeReIncludeFlightInRegulation,
EhelpDeskForceFlightsInRegulation, TargetTakeOffAPIRequest, ATFCMSituationRegulation,
EhelpDeskTicketFlightInfo, ForceFlightInRegulation, RegulationCancelRequest,
RegulationOrMCDMOnly, MeasureId, RouteInfo, Flight, FlightRegulationLocation,
NetworkImpactFlightData, TargetTime, EhelpDeskExcludeReIncludeFlightInRegulation,
FlightAtfcmMcdmOnlyLocation, FlightAtfcmRegulationLocation, FlightConfirmationRequest,
RegulationProposalRevocationRequest

20.9.168. RegulationIdWildcard
<<typedef[string]>>

Either a full regulation id, or a simple wildcard for regulation ids.

1. Pattern: (UALPHA|DIGIT){1,8}|(UALPHA|DIGIT){0,7}*

2. Used by: RegulationOrMCDMOnlyListRequest

Edition: 27.0 6 1515

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.169. RegulationInitialConstraint
<<class>>

Groups all the rate information and exceptional constraints expressed by a regulation for a specific
initial constraint period.

All rate values are expressed as number of slots per hour.

1. Attributes:

a. DateTimeMinutePeriod constraintPeriod (Mandatory)

Applicability period of this constraint.

b. int normalRate (Mandatory)

Normal rate.

i. Constraints:

▪ range : [0, unbounded[

c. int pendingRate (Mandatory)

Pending rate.

i. Constraints:

▪ range : [0, unbounded[

d. int equipmentRate (Optional)

Equipment rate.

Must be null or 0 in RegulationProposalFilingRequest and RegulationProposalUpdateRequest

contexts.

If, for RegulationProposal , a value different from null or 0 is needed, then phone
coordination is required.

i. Constraints:

▪ range : [0, unbounded[

▪ RegulationInitialConstraint.EQUIPMENT_RATE_MUST_BE_ZERO_OR_NULL

e. RegulationExceptionalConstraint exceptionalConstraint (Optional)

Exceptional constraints expressed by a regulation for a specific initial constraint period.

Must be null in RegulationProposalFilingRequest and RegulationProposalUpdateRequest

contexts.

If, for RegulationProposal , a value different from null is needed, then phone coordination is
required.

Edition: 27.0 6 1516

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ RegulationInitialConstraint.EXCEPTIONAL_CONSTRAINT_MUST_BE_NULL

2. Constraints:

a. EQUIPMENT_RATE_MUST_BE_ZERO_OR_NULL

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, the

attribute equipmentRate must be null or equals to zero ( 0 ).

Constrained attributes: equipmentRate

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

b. EXCEPTIONAL_CONSTRAINT_MUST_BE_NULL

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, the

attribute exceptionalConstraint must be null.

Constrained attributes: exceptionalConstraint

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

3. Used by: RegulationOrMCDMOnly

20.9.170. RegulationListReplyData
<<class>>

The RegulationListReply payload.

1. Inherits from: RegulationOrMCDMOnlyListReplyData

2. Attributes:

a. set< Regulation > regulations (Mandatory)

Set of regulations that matched the RegulationListRequest criteria.

Can be empty (meaning that no regulation matched the criteria).

i. Constraints:

▪ set size range : [0, 10000]

3. Used by: RegulationListReply

20.9.171. RegulationLocationCategory
<<enumeration>>

Enumeration of possible location categories for a regulation.

1. Values:

Edition: 27.0 6 1517

Document Title: NM 27.0 - NM B2B Reference Manual

a. ARRIVAL

The concerned regulation is an arrival regulation.

b. DEPARTURE

The concerned regulation is a departure regulation.

c. ENROUTE

The concerned regulation is an en route regulation.

2. Used by: RegulationCause

20.9.172. RegulationMessageFilter (new 27.0)

<<class>>

The SubscriptionTopic.REGULATIONS message filter.

The two attributes tvs and tvSets are combined with a logical OR.

1. Attributes:

a. set< TrafficVolumeIdWildcard > tvs (Optional)

Selects the regulations that apply to a traffic volume that matches with at least one set entry.

By default, all traffic volumes are considered.

i. Constraints:

▪ set size range : [1, 20]

b. set< TrafficVolumeSetIdWildcard > tvSets (Optional)

Selects the regulations that apply to a traffic volume belonging to at least one traffic volume
set that matches one set entry.

By default, all traffic volumes of all traffic volume sets are considered.

i. Constraints:

▪ set size range : [1, 20]

2. Used by: RegulationSubscription, RegulationSubscriptionUpdateRequest,

RegulationSubscriptionCreationRequest

20.9.173. RegulationOccupancyConstraint (new 27.0)

<<class>>

The occupancy capacity constraint expressed by a regulation for a specific period.

1. Attributes:

Edition: 27.0 6 1518

Document Title: NM 27.0 - NM B2B Reference Manual

a. DateTimeMinutePeriod constraintPeriod (Mandatory)

The applicability period of this constraint.

b. int occupancyRate (Mandatory)

The occupancy rate (in number of flights inside the regulated area).

i. Constraints:

▪ range : [0, unbounded[

▪ RegulationOccupancyConstraint.INVALID_CAPACITIES

c. int peakCapacity (Mandatory)

The peak capacity (in number of flights inside the regulated area).

i. Constraints:

▪ range : [0, unbounded[

▪ RegulationOccupancyConstraint.INVALID_CAPACITIES

d. int pendingCapacityPercentage (Mandatory)

The pending capacity, expressed in percent of the sustained capacity.

i. Constraints:

▪ range : [0, 100]

2. Constraints:

a. INVALID_CAPACITIES

The peakCapacity must be greater than the occupancyRate.

Constrained attributes: occupancyRate, peakCapacity

Constrained requests: any using request

3. Used by: RegulationOrMCDMOnly

20.9.174. RegulationOrMCDMOnly

Edition: 27.0 6 1519

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Documentation last updated: 27.0 - Edition 2

Common ancestor of Regulation and RegulationProposal.

The initialConstraints, supplementaryConstraints and occupancyConstraints attributes group all the

rate information and exceptional constraints expressed by a regulation:

1. initialConstraints is applicable to an entry regulation or a cherry-picked regulation.

2. supplementaryConstraints is applicable to an entry regulation only.

3. occupancyConstraints is applicable to an occupancy regulation only.

A regulation rate (for an entry regulation) describes how many slots per hour the regulation can
accept, i.e. the maximal number of flights per hour accepted in the regulation. The regulation
applicability period is partitioned into one or more regulation "initial constraint periods": different
rates and exceptional constraints apply in each initial constraint period. The superset of initial
constraint periods must cover the full applicability period, and cannot overlap - it is indeed a time
partition.

An entry regulation can also have different supplementary rates, each defined on a "supplementary
period" (i.e. the period associated to a supplementary rate). The supplementary period can overlap
partly or fully with one or more initial constraint periods, and with zero or more other
supplementary periods. Within the NM system, the supplementary rate is added to the normal rates
for the duration of the supplementary period.

There are different kinds of regulation rates:

1. Normal rates: nominal rate

2. Pending rate: rate reserved for late updater, i.e. when a flight changes significantly its profile
close to the departure time, the flight has access to pending rate slots (to limit excessive delay
deteriorations). Note that pending rate slots are transformed into normal rate slots at some time
before the start of the applicability period of the regulation.

3. Equipment rate: rate reserved for flights containing the required MLS equipment in their
aircraft equipment set.

An occupancy capacity (for an occupancy regulation) describes how many flights the regulation can
accept in occupancy, i.e. the maximal number of flights in the regulation at the same time. Like
entry regulations, the regulation applicability period is partitioned into one or more regulation
"occupancy constraint periods": different capacities apply in each constraint period, and the
superset of constraint periods must also cover the full applicability period, and cannot overlap. Like
entry regulations, the pending capacity of an "occupancy constraint period" is reserved for late
updater.

Note that when submitting a regulation to NMOC to review (RegulationProposalFilingRequest and

RegulationProposalUpdateRequest contexts), there are some constraints that apply (like for example
linked regulations can not added/updated) : See below. However when creating regulations in
simulations (RegulationCreationRequest context), these constraints do not apply.

Edition: 27.0 6 1520

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Measure

2. Attributes:

a. RegulationId regulationId (Mandatory)

The unique id of the regulation. Regulation ids are unique within an AIRAC cycle and
contain at least the day (of the month) of the start date of the regulation. Note that the
regulation id is immutable.

b. RegulationReason reason (Contextual)

Reason that triggered the creation of the regulation.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

▪ Optional otherwise

ii. Constraints:

▪ RegulationOrMCDMOnly.INVALID_REASON_DEICING

c. TrafficVolumeLocation location (Contextual)

Information related to the location to which this regulation applies.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

▪ Optional otherwise

d. ReferenceLocation protectedLocation (Contextual)

Specifies the reference location that the regulation is meant to protect, when the protected
reference location is not the reference location specified in location. The protectedLocation
value is left null if it is the regulation reference specified in location.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest

▪ Optional otherwise

e. CountsCalculationType calculationType (Contextual) (new 27.0)

The count calculation type (entry count or occupancy count) of this (non cherry-pick)
regulation.

NOTE This attribute is irrelevant for cherry-pick regulations.

i. Presence:

Edition: 27.0 6 1521

Document Title: NM 27.0 - NM B2B Reference Manual

▪ Must be null in RegulationProposalUpdateRequest RegulationUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ RegulationOrMCDMOnly.INVALID_CALCULATION_TYPE

▪ RegulationOrMCDMOnly.INVALID_INITIAL_CONSTRAINTS

▪ RegulationOrMCDMOnly.INVALID_OCCUPANCY_CONSTRAINTS

▪ RegulationOrMCDMOnly.INVALID_OCCUPANCY_DURATION

▪ RegulationOrMCDMOnly.INVALID_SUPPLEMENTARY_CONSTRAINTS

▪ RegulationOrMCDMOnly.NO_DELAY_WINDOW_MUST_BE_NULL

▪ RegulationOrMCDMOnly.OCCUPANCY_DURATION_MUST_BE_NULL

f. RegulationInitialConstraint[] initialConstraints (Optional)

Initial constraints.

When requested, this attribute is never left null.

i. Constraints:

▪ array size range : [0, 24]

▪ RegulationOrMCDMOnly.INCONSISTENT_CHERRY_PICKED_INITIAL_CONSTRAINTS

▪ RegulationOrMCDMOnly.INVALID_INITIAL_CONSTRAINTS

▪ RegulationOrMCDMOnly.UPDATE_CAPACITY_REQUIRED_MUST_BE_FALSE

g. RegulationSupplementaryConstraint[] supplementaryConstraints (Optional)

Supplementary constraints.

When requested, this attribute is never left null.

No/null supplementaryConstraints means removing them all (zero supplementaryConstraints )

in RegulationProposalFilingRequest / RegulationProposalUpdateRequest context.

i. Constraints:

▪ array size range : [0, 24]

▪ RegulationOrMCDMOnly.INVALID_SUPPLEMENTARY_CONSTRAINTS

h. RegulationOccupancyConstraint[] occupancyConstraints (Optional) (new 27.0)

The occupancy constraints.

i. Constraints:

▪ array size range : [0, 24]

▪ RegulationOrMCDMOnly.INVALID_OCCUPANCY_CONSTRAINTS

▪ RegulationOrMCDMOnly.UPDATE_CAPACITY_REQUIRED_MUST_BE_FALSE

Edition: 27.0 6 1522

Document Title: NM 27.0 - NM B2B Reference Manual

i. string remark (Contextual)

Remark made by the NM operations, as provided in the Initial Network Plan. This remark
typically provides some more details about the reason of the regulation and refers to any
NOTAM if applicable.

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

▪ Optional otherwise

ii. Constraints:

▪ Pattern: MULTILINE_TEXT{0,128}

▪ Max length: 128

▪ Max length inclusive: true

j. boolean autolink (Contextual)

Indicates if the local delay given by this regulation is taken into account to compute the
delay in other regulations.

When requested, this attribute is never left null.

In the context of RegulationProposalFilingRequest to update an existing regulation, the value

of autolink can not be changed (i.e. needs to null).

If a value different than the existing regulation (or false for a new regulation proposal) is
needed, then the RegulationProposal.proposalNote text field can be used to request
coordination for this.

i. Presence:

▪ Mandatory in RegulationCreationRequest

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

k. set< RegulationId > linkedRegulations (Contextual)

Documentation last updated: 27.0 - Edition 3

The set of regulations which are linked to this regulation.

When requested, this attribute is never left null but it can be returned empty.

To keep the linked regulation set unchanged in the context of a regulation update, the client
application shall file the linkedRegulations with the currently linked regulations.

This attribute shall not be used in the context of regulation proposal filing or update. In such
contexts, the linked regulation set shall be declared in plain text in the
RegulationProposal.proposalNote.

Edition: 27.0 6 1523

Document Title: NM 27.0 - NM B2B Reference Manual

When the B2B client wants to remove linked regulations, it needs to provide an empty set.

Refer to the ATFCM Operations Manual for more information on link

NOTE
regulations.

i. Presence:

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ set size range : [0, 10]

l. DurationHourMinute noDelayWindow (Optional)

Defines a time window (a.k.a. "window width") around the ETO within which the regulation
does not delay the flight.

In certain cases, the window is applied around the minimum CTO.

In the context of RegulationProposalFilingRequest to create or update a regulation, it needs

to be null.

If a value different than the existing regulation (or 0010 minutes for a new regulation
proposal) is needed, then the RegulationProposal.proposalNote text field can be used to
request coordination for this (otherwise NMOC will assess as well what is the optimal no
delay window).

i. Constraints:

▪ RegulationOrMCDMOnly.INVALID_WINDOW_WIDTH

▪ RegulationOrMCDMOnly.NO_DELAY_WINDOW_MUST_BE_NULL

m. DurationHourMinute occupancyDuration (Optional) (new 27.0)

The duration to be added to the elapsed time of the flight inside the regulation when
calculating delays based on occupancy counts.

i. Constraints:

▪ RegulationOrMCDMOnly.INVALID_OCCUPANCY_DURATION

▪ RegulationOrMCDMOnly.OCCUPANCY_DURATION_MUST_BE_NULL

n. boolean updateCapacityRequired (Contextual)

Indicates that a capacity update will be automatically applied according to the rates of the
regulation.

When requested, this attribute is never left null.

In the context of RegulationProposalFilingRequest , it should typically always be true : see

detailed B2B proposal regulation guidelines document.

Edition: 27.0 6 1524

Document Title: NM 27.0 - NM B2B Reference Manual

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

▪ Optional otherwise

ii. Constraints:

▪ RegulationOrMCDMOnly.UPDATE_CAPACITY_REQUIRED_MUST_BE_FALSE

o. boolean updateTVActivationRequired (Contextual)

Indicates that a traffic volume activation will be achieved according to the applicability
period of the regulation.

When requested, this attribute is never left null.

In RegulationProposalFilingRequest context, it has to be true .

i. Presence:

▪ Mandatory in RegulationCreationRequest RegulationProposalFilingRequest

▪ Optional otherwise

ii. Constraints:

▪ RegulationOrMCDMOnly.UPDATE_TV_ACTIVATION_REQUIRED_MUST_BE_TRUE

p. TrafficVolumeSetId delayTVSet (Contextual)

The traffic volume set to which the delay of this regulation is associated.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest

▪ Optional otherwise

q. DurationHourMinute delayConfirmationThreshold (Optional)

If present, then the regulation has a delayConfirmationThreshold : all flights that have more
delay than the delayConfirmationThreshold get suspended at EOBT - 2H.

Must be null in RegulationProposalFilingRequest and RegulationProposalUpdateRequest

contexts.

In the context of RegulationProposalFilingRequest to update an existing regulation, setting

no (i.e. null) delayConfirmationThreshold value means that the current
delayConfirmationThreshold value of the existing regulation is kept.

In the context of RegulationProposalFilingRequest to update an existing regulation, if a value

different than the current value of the regulation is needed, then the
RegulationProposal.proposalNote text field can be used to request coordination for that.

Edition: 27.0 6 1525

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ RegulationOrMCDMOnly.DELAY_CONFIRMATION_THRESHOLD_MUST_BE_NULL

3. Constraints:

a. INVALID_CALCULATION_TYPE (new 27.0)

If Measure.measureCherryPicked is true, then calculationType must be null.

Constrained attributes: calculationType

Constrained requests: any using request

b. INVALID_INITIAL_CONSTRAINTS (new 27.0)

If calculationType is OCCUPANCY, then initialConstraints must be null. If

Measure.measureCherryPicked is false and calculationType is ENTRY, then initialConstraints
cannot be null.

Constrained attributes: calculationType, initialConstraints

Constrained requests: any using request

c. INVALID_SUPPLEMENTARY_CONSTRAINTS (new 27.0)

If Measure.measureCherryPicked is true, or if calculationType is OCCUPANCY, then

supplementaryConstraints must be null.

Constrained attributes: calculationType, supplementaryConstraints

Constrained requests: any using request

d. INVALID_OCCUPANCY_CONSTRAINTS (new 27.0)

If calculationType is ENTRY, then occupancyConstraints must be null. If calculationType is

OCCUPANCY, then occupancyConstraints cannot be null.

Constrained attributes: calculationType, occupancyConstraints

Constrained requests: any using request

e. INCONSISTENT_CHERRY_PICKED_INITIAL_CONSTRAINTS

If Measure.measureCherryPicked is true then, for each sub-period of initialConstraints ,

pendingRate and equipmentRate must be zero, and exceptionalConstraint must be null.

Constrained attributes: measureCherryPicked, initialConstraints

Constrained requests: RegulationProposalFilingRequest, RegulationCreationRequest,

RegulationProposalUpdateRequest, RegulationUpdateRequest

f. INVALID_REASON_DEICING

Edition: 27.0 6 1526

Document Title: NM 27.0 - NM B2B Reference Manual

The Measure.reason value cannot be DEICING .

Constrained attributes: reason

Constrained requests: RegulationCreationRequest, RegulationProposalFilingRequest,

RegulationUpdateRequest, RegulationProposalUpdateRequest

g. INVALID_WINDOW_WIDTH

The Measure.noDelayWindow value cannot be 0000 .

Constrained attributes: noDelayWindow

Constrained requests: RegulationCreationRequest, RegulationProposalFilingRequest,

RegulationUpdateRequest, RegulationProposalUpdateRequest

h. NO_DELAY_WINDOW_MUST_BE_NULL (altered 27.0)

Documentation last updated: 27.0 - Edition 1

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, or in any

context if calculationType is OCCUPANCY, the attribute noDelayWindow must be null.

Constrained attributes: calculationType, noDelayWindow

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

i. OCCUPANCY_DURATION_MUST_BE_NULL (new 27.0)

Documentation last updated: 27.0 - Edition 2

If calculationType is ENTRY then the attribute occupancyDuration must be null.

Constrained attributes: calculationType, occupancyDuration

Constrained requests: any using request

j. INVALID_OCCUPANCY_DURATION (new 27.0)

If calculationType is OCCUPANCY then occupancyDuration must be greater or equal than 1

minute.

Constrained attributes: calculationType, occupancyDuration

Constrained requests: any using request

k. UPDATE_TV_ACTIVATION_REQUIRED_MUST_BE_TRUE

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, the

attribute updateTVActivationRequired must be true .

Constrained attributes: updateTVActivationRequired

Edition: 27.0 6 1527

Document Title: NM 27.0 - NM B2B Reference Manual

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

l. DELAY_CONFIRMATION_THRESHOLD_MUST_BE_NULL

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, the

attribute delayConfirmationThreshold must be null.

Constrained attributes: delayConfirmationThreshold

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

m. UPDATE_CAPACITY_REQUIRED_MUST_BE_FALSE (altered 27.0)

Documentation last updated: 27.0 - Edition 1

In RegulationProposalFilingRequest and RegulationProposalUpdateRequest contexts, when

both attributes initialConstraints and occupancyConstraints are null, the attribute
updateCapacityRequired must be false.

Constrained attributes: updateCapacityRequired, initialConstraints, occupancyConstraints

Constrained requests: RegulationProposalFilingRequest, RegulationProposalUpdateRequest

20.9.175. RegulationOrMCDMOnlyListReplyData
<<class>>

Abstract reply data associated to the reply of the abstract RegulationOrMCDMOnlyListRequest.

1. Inherits from: MeasureListReplyData

20.9.176. RegulationOrMCDMOnlyListRequest

<<abstract class>>

Abstract request to query an NM regulation list, as well as to retrieve the regulation details. This

Edition: 27.0 6 1528

Document Title: NM 27.0 - NM B2B Reference Manual

query method allows the caller to select the regulation fields requested in the reply (see
requestedRegulationFields ). NM kindly requests its customers to apply the following strategy:

1. As a rule, client applications should never request regulation fields that they do not need

2. Client applications typically implement a query/retrieve pattern:

a. Query the small number of most relevant regulation fields to display to the end user (using
this RegulationListRequest )

b. Retrieve more details for a given regulation when the end user has selected a regulation
from the list (also using this RegulationListRequest , but with other requested fields)

The logical AND operator applies between all the query fields described below.

1. Inherits from: MeasureListRequest

2. Attributes:

a. set< RegulationIdWildcard > regulations (Optional)

The set of regulation ids or wildcards.

If specified, the reply returns only the requested regulations.

The logical OR operator is meant between the items in the set.

i. Constraints:

▪ set size range : [1, 100]

b. set< RegulationReason > reasons (Optional)

Selects the regulations with a reason that matches an entry in this set.

By default, regulations are selected regardless to their reason.

i. Constraints:

▪ set size range : [1, unbounded[

20.9.177. RegulationPayloadConfiguration (new 27.0)

<<class>>

The SubscriptionTopic.REGULATIONS payload configuration.

1. Attributes:

a. set< RegulationField > regulationFields (Mandatory)

The published message contains only the regulation fields in this set, and only if the values
of these requested fields are available at NM.

The regulation id is always returned.

Edition: 27.0 6 1529

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RegulationSubscription, RegulationSubscriptionUpdateRequest,

RegulationSubscriptionCreationRequest

20.9.178. RegulationProposal

<<class>>

Documentation last updated: 27.0 - Edition 4

Regulation proposals are proposals to NM for creation/modification/cancellation of a regulation

(see RegulationProposalListRequest).

A tailored MCDM process (a subset of the full MCDM process) is used in the proposal regulation and
corresponding coordination process.

There are 2 types of proposal regulations:

1. With proposal flights (only supported for cherry picked regulations where the user selects the
flights and the delay to attribute to flights): the user proposes a regulation, the MCDM state will
be automatically set to draft. Once the regulation has been set to applied (asynchronously by
NM systems) , the user can add flights to the regulation (includes giving the desired
CalculatedTakeOffTime or CalculatedTimeOver).

Once the flights have been added (synchronously), the user can inspect the desired result in the
flightlist and counts (with includeProposalFlights).

If the user is not satisfied with the result, he can remove some flights or add some more flights
or modify/revoke the proposal (via updateRegulationProposal or revokeRegulationProposal).

Once the user is happy with the results, he should modify the MCDM state to proposed so that it
becomes visible to NM.

Once NMOC starts assessing the proposal, the NM actor approvalState is set to standby (i.e.
acknowledged) and the MCDMState is set to COORDINATED.

When NM accepts (and has implemented the regulation), the NM actor approvalState is set to

Edition: 27.0 6 1530

Document Title: NM 27.0 - NM B2B Reference Manual

approved. In addition the MCDM state is set to IMPLEMENTED.

If NM rejects the proposal, the NM actor state is set to rejected and the MCDM state is set to
INTERRUPTED. In this case the user can file a new regulation proposal (resetting the MCDM
state to DRAFT).

2. Without proposal flights:

When the user proposes a regulation, the MCDM state will be automatically set to PROPOSED
(visible to NM). Once NMOC starts assessing the proposal, the NM actor approvalState is set to
STANDBY (i.e. ACKNOWLEDGED).

When NM accepts (and has implemented the regulation), the NM actor approvalState is set to
APPROVED. In addition the MCDM state is set to IMPLEMENTED.

If NM rejects the proposal, the NM actor state is set to rejected and the MCDM state is set to
INTERRUPTED. In this case the user can file a new regulation proposal (resetting the MCDM
state to PROPOSED).

1. Inherits from: RegulationOrMCDMOnly

2. Attributes:

a. RegulationProposalKind kind (Mandatory)

Documentation last updated: 27.0 - Edition 4

Type of proposal regulation (with or without proposal flights).

b. RegulationProposalAction action (Contextual)

Describes whether the proposal is to create a new regulation, or to update or cancel an

existing one.

Once created, the action of the regulation proposal is immutable.

In order to replace an update by a cancellation, the proposal must be revoked and a new
proposal must be filed or alternatively NMOC needs to first accept or reject the proposal.

Note that the revoked proposal remains in the NM system (as revoked), until a new proposal
is made for the same regulation, in which case the revoked proposal is replaced.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

c. MCDMApprovalState approvalState (Contextual)

Describes the measure approval state (not to be confused with the regulation state) of the

Edition: 27.0 6 1531

Document Title: NM 27.0 - NM B2B Reference Manual

MCDM NMOC actor: a.o did NM accept (and implement) the regulation proposal.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

d. MCDMState mcdmState (Contextual)

Describes the regulation proposal MCDM state: a.o is the measure in draft (not visible to NM
yet) or proposed or implemented or interrupted (a.o. the measure was cancelled after it had
been implemented).

When requested, this attribute is never left null.

When a regulation proposal is filed, the MCDM state is (re-)set by the system.

When the client has filed the request (and optionally added flights to the cherry picked
regulation) and the client is happy with the results, then he should set the mcdmState to
proposed (to make the proposal visible to NM)): for RegulationProposalWithProposalFlights
only.

NM will then accept or reject the regulationProposal and the MCDM state will go to
implemented (in case of accept)/interrupted (in case of reject).

Note that even though the regulation proposal can be accepted by NM, it does not mean that
all of the individual flights have been accepted (in case of cherry picked regulation
proposal). In order to retrieve for each individual flight, its MCDM state and the NMOC actor
approval state, the queryMCDM service can be used.

In addition, interrupted or abandoned MCDM state for a flight (i.e. in a cherry picked
regulation) means that the flight got "un-picked" from that regulation (e.g. due to changes in
the flight such that it’s forced slot could not be kept).

i. Presence:

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

e. RegulationState regulationState (Contextual)

Current state of the regulation.

When requested, this attribute is null when kind =

ProposalRegulationWithoutProposalFlights .

i. Presence:

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

Edition: 27.0 6 1532

Document Title: NM 27.0 - NM B2B Reference Manual

f. string proposalNote (Optional)

Proposal note.

Contains additional (informal textual) information given by the FMP when creating the
proposal regulation for NMOC to review (e.g. linked regulation, window width, or maybe
questions for NMOC like proposal regulation 1 to be applied before proposal regulation 2 or
more detailed contextual info why the regulation is needed).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1000}

g. string proposalFeedback (Contextual)

Proposal feedback.

Contains additional information given by NMOC when accepting/rejecting the proposal

regulation wrt the reason.

i. Presence:

▪ Must be null in RegulationProposalFilingRequest RegulationProposalUpdateRequest

▪ Optional otherwise

ii. Constraints:

▪ Pattern: MULTILINE_TEXT{0,1000}

3. Used by: RegulationProposalRevocationReplyData, RegulationProposalFilingRequest,

RegulationProposalUpdateRequest, RegulationProposalFilingReplyData,
RegulationProposalUpdateReplyData, RegulationProposalListReplyData

20.9.179. RegulationProposalAction
<<enumeration>>

Action requested by a regulation proposal.

1. Values:

a. CREATION

The regulation proposal requests NMOC to create a regulation

b. UPDATE

The regulation proposal requests NMOC to update a regulation

c. CANCELLATION

The regulation proposal requests NMOC to cancel a regulation. When NMOC accepts this will
result in a cancelled regulation and all the concerned flights will be unforced or de-
regulated.

Edition: 27.0 6 1533

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RegulationProposal

20.9.180. RegulationProposalField
<<enumeration>>

Enumerates the fields that the caller may request to be returned in RegulationProposal objects
when returned by RegulationProposalListRequest.

As a rule, client applications should never request regulation proposal fields that they do not need.
Client applications typically implement a query/retrieve pattern: . Query the small number of most
relevant regulation proposal fields to display to the end user

1. Retrieve more details for a given regulation proposal when the end user has selected a
regulation proposal from the list

1. Values:

a. applicability

See Measure.applicability attribute.

b. autolink

See RegulationOrMCDMOnly.autolink attribute.

c. measureCherryPicked

See Measure.measureCherryPicked attribute.

d. calculationType (new 27.0)

See RegulationOrMCDMOnly.calculationType attribute.

e. initialConstraints

See RegulationOrMCDMOnly.initialConstraints attribute.

f. occupancyConstraints (new 27.0)

See RegulationOrMCDMOnly.occupancyConstraints attribute.

g. linkedRegulations

See RegulationOrMCDMOnly.linkedRegulations attribute.

h. location

See RegulationOrMCDMOnly.location attribute.

i. protectedLocation

See RegulationOrMCDMOnly.protectedLocation attribute.

Edition: 27.0 6 1534

Document Title: NM 27.0 - NM B2B Reference Manual

j. reason

See RegulationOrMCDMOnly.reason attribute.

k. remark

See RegulationOrMCDMOnly.remark attribute.

l. action

See RegulationProposal.action attribute.

m. supplementaryConstraints

See RegulationOrMCDMOnly.supplementaryConstraints attribute.

n. lastUpdate

See Measure.lastUpdate attribute.

o. noDelayWindow

See RegulationOrMCDMOnly.noDelayWindow attribute.

p. occupancyDuration (new 27.0)

See RegulationOrMCDMOnly.occupancyDuration attribute.

q. updateCapacityRequired

See RegulationOrMCDMOnly.updateCapacityRequired attribute.

r. updateTVActivationRequired

See RegulationOrMCDMOnly.updateTVActivationRequired attribute.

s. externallyEditable

See Measure.externallyEditable attribute.

t. subType

See Measure.subType attribute.

u. delayTVSet

See RegulationOrMCDMOnly.delayTVSet attribute.

v. createdByFMP

See Measure.createdByFMP attribute.

w. sourceHotspot

Edition: 27.0 6 1535

Document Title: NM 27.0 - NM B2B Reference Manual

See Measure.sourceHotspot attribute.

x. mcdmRequired

See Measure.mcdmRequired attribute.

y. dataId

See Measure.dataId attribute.

z. approvalState

See RegulationProposal.approvalState attribute.

aa. mcdmState

See RegulationProposal.mcdmState attribute.

ab. regulationState

See RegulationProposal.regulationState attribute.

ac. scenarioReference

See Measure.scenarioReference attribute.

ad. delayConfirmationThreshold

See RegulationOrMCDMOnly.delayConfirmationThreshold attribute.

ae. proposalNote

See RegulationProposal.proposalNote attribute.

af. proposalFeedback

See RegulationProposal.proposalFeedback attribute.

2. Used by: RegulationProposalListRequest

20.9.181. RegulationProposalFilingReplyData
<<class>>

The RegulationProposalFilingReply payload.

1. Attributes:

a. RegulationProposal proposal (Mandatory)

The regulation proposal with fields set by the NM system.

For RegulationProposalWithoutProposalFlights , the resulting MCDM state will be set to

Edition: 27.0 6 1536

Document Title: NM 27.0 - NM B2B Reference Manual

PROPOSED.

For RegulationProposalWithProposalFlights , the resulting MCDM state will be set to DRAFT.

2. Used by: RegulationProposalFilingReply

20.9.182. RegulationProposalKind
<<enumeration>>

The type of proposal regulation (see RegulationProposal).

1. Values:

a. RegulationProposalWithProposalFlights

Proposal regulation with proposal flights : only supported for cherry picked regulations
where the user selects the flights and the delay to attribute to flights.

b. RegulationProposalWithoutProposalFlights

Proposal regulation without proposal flights : the user proposes a regulation to NMOC to
implement. All the flights inside the traffic volume within the given regulation period are
conerned.

2. Used by: RegulationProposal

20.9.183. RegulationProposalListReplyData
<<class>>

The RegulationProposalListReply payload.

1. Inherits from: RegulationOrMCDMOnlyListReplyData

2. Attributes:

a. set< RegulationProposal > proposals (Mandatory)

Set of regulation proposals that matched the RegulationProposalListRequest criteria.

Can be empty (meaning that no regulation proposal matched the criteria).

i. Constraints:

▪ set size range : [0, 10000]

3. Used by: RegulationProposalListReply

20.9.184. RegulationProposalRevocationReplyData
<<class>>

The RegulationProposalRevocationReply payload.

Edition: 27.0 6 1537

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. RegulationProposal proposal (Optional)

Documentation last updated: 27.0 - Edition 5

The regulation proposal that has been revoked if forceDelete was set to false. Null otherwise.

If forceDelete was set to false, the resulting MCDM state will be set to
NOTE ABANDONED. If forceDelete was set to true, the associated MCDM will be
deleted.

2. Used by: RegulationProposalRevocationReply

20.9.185. RegulationProposalUpdateReplyData
<<class>>

The RegulationProposalUpdateReply payload.

1. Attributes:

a. RegulationProposal proposal (Mandatory)

The updated regulation proposal.

For RegulationProposalWithoutProposalFlights , the resulting MCDM state will be set to

proposed.

For RegulationProposalWithProposalFlights , the resulting MCDM state will be set to draft.

2. Used by: RegulationProposalUpdateReply

20.9.186. RegulationReason
<<enumeration>>

Enumeration of possible reasons for a regulation (See the ATFCM reference manual for more
details).

1. Values:

a. ACCIDENT_INCIDENT

The regulation is required because an accident or incident occured.

b. ATC_CAPACITY

The regulation is required to balance capacity vs demand.

c. AERODROME_SERVICES

The regulation is required for e.g. aerodrome de-icing.

Edition: 27.0 6 1538

Document Title: NM 27.0 - NM B2B Reference Manual

d. AERODROME_CAPACITY

The regulation is required to balance capacity (a.o. available aircraft stands) vs demand.

e. ATC_INDUSTRIAL_ACTION

The regulation is required because inductrial actions (e.g. strike) are ongoing at the ATC
center

f. NON_ATC_INDUSTRIAL_ACTION

The regulation is required because inductrial actions (e.g. strike) are ongoing (not at the ATC
center).

g. WEATHER

The regulation is required because of weather conditions.

h. AIRSPACE_MANAGEMENT

The regulation is required because of airspace management reasons (e.g. military exercises).

i. SPECIAL_EVENT

The regulation is required because of special events (e.g. airshows occuring).

j. ATC_ROUTINGS

The regulation is required because of special ATC routings.

k. ATC_STAFFING

The regulation is required because of reduced capacity because of ATC staffing reasons.

l. ATC_EQUIPMENT

The regulation is required because of reduced capacity because of ATC equipment reasons
(e.g. radar maintenance).

m. ENVIRONMENTAL_ISSUES

The regulation is required because of environmental issues (e.g. noise abatement

restrictions on RWY usage).

n. OTHERS

The regulation is required because of other reasons (e.g. disabled aircraft on RWY).

2. Used by: ATFCMSituationDelays, RegulationOrMCDMOnly, DeltaATFCMSituationDelays,

RegulationOrMCDMOnlyListRequest, RegulationCause, ATFCMSituationRegulation

Edition: 27.0 6 1539

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.187. RegulationState
<<enumeration>>

Enumerates the possible states of a regulation in the NM system.

When created, a regulation starts in the APPLYING state. Once all the flights have been successfully
updated, the regulation goes to the APPLIED state. Any subsequent modification to the regulation will
put it back to the APPLYING state. Again, once all the flights have been successfully updated, the
regulation will go again to the APPLIED state. Once the applicability period is passed, the regulation
goes to the TERMINATED state. If the regulation is no longer needed while the applicability period is
still in the future (partly or completely), then the regulation state is set to CANCELLING . Once all the
flights have been successfully updated, the regulation is set to CANCELLED . CANCELLED and TERMINATED
are final regulation states.

1. Values:

a. APPLYING

The regulation is activated but the subsequent flight recalculation is not finished yet

b. APPLIED

The regulation is activated and the subsequent flight recalculation is finished

c. CANCELLING

The regulation is cancelled but the subsequent flight recalculation is not finished yet

d. CANCELLED

The regulation is cancelled and the subsequent flight recalculation is finished

e. TERMINATED

The regulation is terminated

2. Used by: RegulationProposal, Regulation, RegulationListRequest, ATFCMSituationRegulation

20.9.188. RegulationSubscription (new 27.0)

Edition: 27.0 6 1540

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic REGULATIONS.

1. Inherits from: Subscription

2. Attributes:

a. RegulationMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. RegulationPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: RegulationSubscriptionRetrievalReplyData, RegulationSubscriptionCreationReplyData,

RegulationSubscriptionUpdateReplyData

20.9.189. RegulationSubscriptionCreationReplyData (new 27.0)

<<class>>

The RegulationSubscriptionCreationReply payload.

1. Attributes:

a. RegulationSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: RegulationSubscriptionCreationReply

20.9.190. RegulationSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The RegulationSubscriptionRetrievalReply payload.

Edition: 27.0 6 1541

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. RegulationSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: RegulationSubscriptionRetrievalReply

20.9.191. RegulationSubscriptionUpdateReplyData (new 27.0)

<<class>>

The RegulationSubscriptionUpdateReply payload.

1. Attributes:

a. RegulationSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: RegulationSubscriptionUpdateReply

20.9.192. RegulationSupplementaryConstraint
<<class>>

Supplementary rate information expressed by a regulation for a specific supplementary period,

expressed as number of slots per hour.

1. Attributes:

a. DateTimeMinutePeriod constraintPeriod (Mandatory)

Applicability period of this constraint.

b. int supplementaryRate (Mandatory)

Supplementary rate.

2. Used by: RegulationOrMCDMOnly

20.9.193. RegulationUpdateReplyData
<<class>>

The RegulationUpdateReply payload.

1. Attributes:

a. Regulation regulation (Mandatory)

The updated regulation with all fields set by the NM system.

2. Used by: RegulationUpdateReply

Edition: 27.0 6 1542

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.194. Rerouting

<<class>>

Reroutings are measures to level cap or reroute flights to avoid an airspace/point or to find
shorter/cheaper routes. Typically they are used for ATFCM reasons (for example to avoid a zero rate
regulation) or for STAM or for Flight Efficiency (to find more efficient routes) or to handle forecast
expected flows (for example NAT traffic). Rerouting can either create a proposal flight (containing a
proposed route) or they can modify the FTFM/RTFM point profile directly (used in forecast and
simulations) or they can generate proposed routes in operational log messages.

1. Inherits from: Measure

2. Attributes:

a. ReroutingId reroutingId (Mandatory)

The unique id of the rerouting.

b. Location location (Contextual)

The type of location used to select the flights.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in ReroutingCreationRequest

▪ Optional otherwise

ii. Constraints:

▪ Rerouting.ONLY_TRAFFIC_VOLUME_LOCATION_TYPE_PERMITTED

c. FlowId flowId (Optional)

Documentation last updated: 27.0 - Edition 5

The traffic flow to/from the CountLocation to which this rerouting applies.

If null it applies to all the traffic for the CountLocation .

Event if Flow is requested, it can be that no filtering flow is used.

Edition: 27.0 6 1543

Document Title: NM 27.0 - NM B2B Reference Manual

When requested, this attribute is never left null.

d. ReroutingApplyKind reroutingApplyKind (Contextual)

The apply kind of the rerouting.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in ReroutingCreationRequest

▪ Optional otherwise

e. ReroutingPurpose reroutingPurpose (Contextual)

The rerouting purpose.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in ReroutingCreationRequest

▪ Optional otherwise

f. ReroutingMeasureState reroutingState (Contextual)

Documentation last updated: 27.0 - Edition 5

The state of the rerouting.

When requested, this attribute is never left null.

i. Presence:

▪ Must be null in ReroutingCreationRequest ReroutingUpdateRequest

▪ Optional otherwise

g. ReroutingSourcesAndConstraints sourcesAndConstraints (Contextual)

Describes the rerouting constraints.

When requested, this attribute is never left null.

i. Presence:

▪ Mandatory in ReroutingCreationRequest

▪ Optional otherwise

h. string remark (Optional)

Documentation last updated: 27.0 - Edition 5

Remark made by the NM or FMPs. This remark typically provides some more details about
the reason and the description of the rerouting.

Edition: 27.0 6 1544

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ Pattern: TEXT{1,128}((WHITESPACE)(TEXT{1,128})){0,1}

▪ Max length: 128

▪ Max length inclusive: true

i. set< RestrictionId > disabledRestrictions (Optional)

RAD restrictions that need to be disabled (ENV) before the scenario can be applied.

j. set< RestrictionId > ignoredRestrictions (Optional)

Documentation last updated: 27.0 - Edition 2

RAD restrictions that need to be ignored (IFPS) before the scenario can be applied.

3. Constraints:

a. ONLY_TRAFFIC_VOLUME_LOCATION_TYPE_PERMITTED

Only the TrafficVolumeLocation type is permitted in ReroutingCreationRequest and

ReroutingUpdateRequest.

Note that when retrieving reroutings, there can be other types of location.

Constrained attributes: location

Constrained requests: any using request

4. Used by: ScenarioReroutingRetrievalReplyData, ReroutingUpdateRequest,

ReroutingCreationRequest, ReroutingListReplyData, ReroutingMessage, ReroutingCancelReplyData,
ReroutingUpdateReplyData, ReroutingCreationReplyData

20.9.195. ReroutingApplyKind
<<enumeration>>

Rerouting apply kind. Indicates if it concerns a rerouting for indication or not.

If it concerns a rerouting for indication, the generated proposed routes can be found in the
operational log messages. In addition, in the flight list, the field FlightField.bestReroutingIndicator
can be used to determine if the rerouting succeed to find a new (interesting) route or not.

1. Values:

a. EXECUTE

Indicates it concerns an execute rerouting.

In this case either the FTFM or RTFM are replaced by the rerouting.

No proposal flights are created.

Edition: 27.0 6 1545

Document Title: NM 27.0 - NM B2B Reference Manual

This rerouting applies to flights in a simulation or flights in status planned ( typically all
flights on the pre-tactical dataset)

b. FOR_INDICATION_WITHOUT_AUTOMATIC_PROPOSAL_FLIGHT

Indicates it concerns a rerouting for indication.

No proposal flights are created.

c. FOR_INDICATION_WITH_AUTOMATIC_RRP

Indicates it concerns a rerouting for indication.

In addition proposal flights are created and the corresponding RRP messages are or will be
sent.

d. FOR_INDICATION_WITH_AUTOMATIC_RRN

Indicates it concerns a rerouting for indication.

In addition proposal flights are created and the corresponding RRN messages are or will be
sent.

2. Used by: FlightAtfcmReroutingLocation, Rerouting

20.9.196. ReroutingCancelReplyData
<<class>>

The ReroutingCancelReply payload.

1. Attributes:

a. Rerouting rerouting (Mandatory)

The rerouting that has been cancelled.

2. Used by: ReroutingCancelReply

20.9.197. ReroutingConstraint

<<abstract class>>

Ancestor structure for all rerouting constraints.

1. Used by: ReroutingConstraintSet

Edition: 27.0 6 1546

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.198. ReroutingConstraintSet (new 27.0)

<<class>>

A set of constraints, correlated by the AND operator, that a rerouting shall satisfy.

1. Attributes:

a. set< ReroutingConstraint > constraints (Mandatory)

The set of constraints. NOTE: The constraints are ordered while evaluating the rerouting,
according to their order of crossing by the flight.

2. Used by: ReroutingSourcesAndConstraints

20.9.199. ReroutingCreationReplyData
<<class>>

The ReroutingCreationReply payload.

1. Attributes:

a. Rerouting rerouting (Mandatory)

The rerouting with fields set by the NM system.

2. Used by: ReroutingCreationReply

20.9.200. ReroutingField
<<enumeration>>

Enumerates the fields that the caller may request to be returned in Rerouting objects when
returned by ReroutingListRequest.

As a rule, client applications should never request rerouting fields that they do not need. Client
applications typically implement a query/retrieve pattern:

1. Query the small number of most relevant rerouting fields to display to the end user

2. Retrieve more details for a given rerouting when the end user has selected a rerouting from the
list

1. Values:

a. location

See Rerouting.location attribute.

b. flowId

See Rerouting.flowId attribute.

Edition: 27.0 6 1547

Document Title: NM 27.0 - NM B2B Reference Manual

c. reroutingApplyKind

See Rerouting.reroutingApplyKind attribute.

d. reroutingPurpose

See Rerouting.reroutingPurpose attribute.

e. constraints

See Rerouting.constraints attribute.

f. applicability

See Measure.applicability attribute.

g. measureCherryPicked

See Measure.measureCherryPicked attribute.

h. lastUpdate

See Measure.lastUpdate attribute.

i. externallyEditable

See Measure.externallyEditable attribute.

j. subType

See Measure.subType attribute.

k. createdByFMP

See Measure.createdByFMP attribute.

l. sourceHotspot

See Measure.sourceHotspot attribute.

m. mcdmRequired

See Measure.mcdmRequired attribute.

n. reroutingState

See Rerouting.reroutingState attribute.

o. dataId

See Measure.dataId attribute.

p. remark

Edition: 27.0 6 1548

Document Title: NM 27.0 - NM B2B Reference Manual

See Rerouting.remark attribute.

q. scenarioReference

See Measure.scenarioReference attribute.

r. disabledRestrictions

See Rerouting.disabledRestrictions attribute.

s. ignoredRestrictions

See Rerouting.ignoredRestrictions attribute.

2. Used by: ReroutingPayloadConfiguration, ReroutingListRequest,

ScenarioReroutingRetrievalRequest

20.9.201. ReroutingId
<<typedef[string]>>

Unique id of a rerouting measure (for a given day), allocated by NM or via the user.

Note that there can be 2 reroutings with the same ReroutingId over a 2 day period.

1. Pattern: (UALPHA|DIGIT|SPECIAL_CHARACTER){1,8}

2. Used by: EhelpDeskRemoveFlightsFromFmpStamRerouting, UpdateFlightInMeasureChoice,

ReroutingOpportunities, FlightAtfcmReroutingLocation, MeasureId, ProposalInformation,
ReroutingFeedback, Rerouting, ReroutingCancelRequest, GroupReroutingSummary,
EhelpDeskAddFlightsInFmpStamRerouting

20.9.202. ReroutingIdWildcard
<<typedef[string]>>

Either a full rerouting id, or a simple wildcard for rerouting ids.

1. Pattern: (UALPHA|DIGIT|*){1,8}

2. Used by: ReroutingListRequest

20.9.203. ReroutingLengthLimit (new 27.0)

<<class>>

An estimation of the limit that the route length should not exceed. In order to be usable in a routing
assistance and GRRT contexts, this limit is computed on the basis of a fixed part and a percentage of
the reference route length:

lengthLimit = fixedPart + referenceRouteLength * referenceLengthPercentage/100

Edition: 27.0 6 1549

Document Title: NM 27.0 - NM B2B Reference Manual

This limit does represent a strict maximum. It might be interpreted by the various
NOTE sources in a slightly different manner to exclude routes. Therefore, it might happen
that a source returns a route of which length slightly exceeds the limit.

1. Attributes:

a. int fixedPart (Mandatory)

The fixed part (in NM) used to compute the length limit.

i. Constraints:

▪ range : [-5000, 5000]

b. int referenceLengthPercentage (Mandatory)

The reference route length percentage used to compute the maximum length.

i. Constraints:

▪ range : [10, 300]

2. Used by: HorizontalReroutingSourcesAndConstraints

20.9.204. ReroutingListReplyData
<<class>>

The ReroutingListReply payload.

1. Inherits from: MeasureListReplyData

2. Attributes:

a. set< Rerouting > reroutings (Mandatory)

Set of reroutings that matched the ReroutingListRequest criteria.

Can be empty (meaning that no rerouting matched the criteria).

i. Constraints:

▪ set size range : [0, 10000]

3. Used by: ReroutingListReply

20.9.205. ReroutingManualConstraints
<<class>>

Describes a manual only rerouting constraint.

1. Attributes:

a. set< string > manualField15OrField15Portions (Mandatory)

Edition: 27.0 6 1550

Document Title: NM 27.0 - NM B2B Reference Manual

Describes the Field15 s or Partial Field15 s that are ORed together with the other rerouting
constraints: for each concerned flight, each of different Field15 are evaluated together with
the other applicable rerouting constraints and the best solution is selected (according to cost
criteria)

The manual routes are in ICAO field 15 syntax. Either a complete field15abc can be entered
which will replace the original flight route or a (partial) field15c only can be entered. In the
latter case the new entered portion will replace the matching portion of the original flight
route. The begin and end point (reconnection points) of this portion must be present in the
correct order in the original flight route otherwise an error is shown for a flight if none of
the given F15 reconnection points match this specific flight. The system will use the RFLs
and RSPs specified in the input ICAO field 15, during the profile calculation for the
alternative (both for complete field15abc and partial field15c.

When for a partial field15, the reconnection point is either ADEP or ADES, then the special
point indicator "ADEP" or "ADES" can be used. If the reconnection point is both ADEP and
ADES, then a complete field15abc needs to be entered. When for a partial field15, the speed
of the flight does not need to be updated, then the special point indicator "NOSPEED" can be
used to indicate that the speeds indicators of the manual F15 do not need to be taken into
account. The NOSPEED indicator needs to be the first word of the partial F15. If the ADEP
indicator is specified, then the NOSPEED needs to be the second keyword of the F15.

2. Used by: ReroutingSourcesAndConstraints

20.9.206. ReroutingMeasureState
<<enumeration>>

Enumerates the possible state of a rerouting in the NM system.

1. Values:

a. ACTIVATING

The rerouting is being activated but not all flights have been processed yet.

b. APPLIED

The rerouting has been activated (all flights have been processed).

c. CANCELLING

The rerouting is being cancelled but not all flights have been processed yet.

d. CANCELLED

The rerouting is cancelled (all flights have been processed).

2. Used by: Rerouting, ReroutingListRequest

Edition: 27.0 6 1551

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.207. ReroutingMessageFilter (new 27.0)

<<class>>

The SubscriptionTopic.REROUTINGS message filter.

The two attributes tvs and tvSets are combined with a logical OR.

1. Attributes:

a. set< TrafficVolumeIdWildcard > tvs (Optional)

Selects the reroutings that apply to a traffic volume that matches with at least one set entry.

By default, all traffic volumes are considered.

i. Constraints:

▪ set size range : [1, 20]

b. set< TrafficVolumeSetIdWildcard > tvSets (Optional)

Selects the reroutings that apply to a traffic volume belonging to at least one traffic volume
set that matches one set entry.

By default, all traffic volumes of all traffic volume sets are considered.

i. Constraints:

▪ set size range : [1, 20]

2. Used by: ReroutingSubscription, ReroutingSubscriptionUpdateRequest,

ReroutingSubscriptionCreationRequest

20.9.208. ReroutingPayloadConfiguration (new 27.0)

<<class>>

The SubscriptionTopic.REROUTINGS payload configuration.

1. Attributes:

a. set< ReroutingField > reroutingFields (Mandatory)

The published message contains only the rerouting fields in this set, and only if the values of
these requested fields are available at NM.

The rerouting id is always returned.

2. Used by: ReroutingSubscription, ReroutingSubscriptionUpdateRequest,

ReroutingSubscriptionCreationRequest

20.9.209. ReroutingPurpose
<<enumeration>>

Edition: 27.0 6 1552

Document Title: NM 27.0 - NM B2B Reference Manual

Description of a rerouting purpose for a rerouting measure. Note that there is a relationship
between the flight’s ReroutingIndicator.reason (shown in the flightlist under reroutingIndicator
field) and this rerouting measure’s purpose (shown in the flightlist under atfcmMeasureLocations
field) : see the details about the relationship/mapping: ReroutingReason.

1. Values:

a. ATFCM

Atfcm (Air Traffic Control Management and demand-capacity related).

b. FLIGHT_EFFICIENCY

Flight efficiency.

c. STAM

Stam

d. AOLO_REROUTING

Aolo rerouting : NMOC AO Liason Officer created rerouting.

e. ATC_ROUTING

ATC rerouting (AirTrafficControl related).

f. CDR_OPPORTUNITY

Proposal flight generated due to a CDR Opportunity.

2. Used by: ReroutingOpportunities, FlightAtfcmReroutingLocation, Rerouting

20.9.210. ReroutingSourcesAndConstraints

<<class>>

Documentation last updated: 27.0 - Edition 2

Sources/constraints that a rerouting shall use/satisfy.

1. Attributes:

a. HorizontalReroutingSourcesAndConstraints horizontalReroutingSourcesAndConstraints

Edition: 27.0 6 1553

Document Title: NM 27.0 - NM B2B Reference Manual

(Optional) (new 27.0)

The sources and constraints that a horizontal rerouting shall use/satisfy.

i. Constraints:

▪ ReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

b. boolean useVerticalOrSpeedReroutingSource (Mandatory)

Indicates weather the constraints is for a non horizontal rerouting (i.e. vertical/or speed
adaptations).

i. Constraints:

▪ ReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

c. ReroutingManualConstraints manualReroutingConstraints (Optional)

Documentation last updated: 27.0 - Edition 2

Manual only rerouting constraints

i. Constraints:

▪ ReroutingSourcesAndConstraints.AT_LEAST_ONE_SOURCE_MUST_BE_SET

d. set< ReroutingConstraintSet > reroutingConstraintSets (Optional) (new 27.0)

The set of satisfactory rerouting constraint sets. NOTE: A valid rerouting shall satisfy at least
one constraint set.

2. Constraints:

a. AT_LEAST_ONE_SOURCE_MUST_BE_SET (new 27.0)

At least one source shall be set.

Constrained attributes: horizontalReroutingSourcesAndConstraints,

useVerticalOrSpeedReroutingSource, manualReroutingConstraints

Constrained requests: any using request

3. Used by: RoutingAssistanceRequest, Rerouting

20.9.211. ReroutingSubscription (new 27.0)

Edition: 27.0 6 1554

Document Title: NM 27.0 - NM B2B Reference Manual

<<class>>

Subscription of topic REROUTINGS.

1. Inherits from: Subscription

2. Attributes:

a. ReroutingMessageFilter messageFilter (Optional)

It defines how messages should be filtered.

b. ReroutingPayloadConfiguration payloadConfiguration (Mandatory)

It defines the messages' payload.

3. Used by: ReroutingSubscriptionUpdateReplyData, ReroutingSubscriptionRetrievalReplyData,

ReroutingSubscriptionCreationReplyData

20.9.212. ReroutingSubscriptionCreationReplyData (new 27.0)

<<class>>

The ReroutingSubscriptionCreationReply payload.

1. Attributes:

a. ReroutingSubscription subscription (Mandatory)

Instance of the newly created subscription.

2. Used by: ReroutingSubscriptionCreationReply

20.9.213. ReroutingSubscriptionRetrievalReplyData (new 27.0)

<<class>>

The ReroutingSubscriptionRetrievalReply payload.

Edition: 27.0 6 1555

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. ReroutingSubscription subscription (Mandatory)

Instance of the requested subscription.

2. Used by: ReroutingSubscriptionRetrievalReply

20.9.214. ReroutingSubscriptionUpdateReplyData (new 27.0)

<<class>>

The ReroutingSubscriptionUpdateReply payload.

1. Attributes:

a. ReroutingSubscription subscription (Mandatory)

Instance of the newly updated subscription.

2. Used by: ReroutingSubscriptionUpdateReply

20.9.215. ReroutingUpdateReplyData
<<class>>

The ReroutingUpdateReply payload.

1. Attributes:

a. Rerouting rerouting (Mandatory)

The updated rerouting with all fields set by the NM system.

2. Used by: ReroutingUpdateReply

20.9.216. RestrictionActivationPlan
<<class>>

Activation plan for a given restriction on a given day.

A RestrictionActivation plan is a special plan in the sense that, there can be cases where there is no
data known. So there exist restrictions for which there is no data at all or only for some periods. In
addition, non-activation is not defined in CACD. Therefore the absence of CACD data (NO_DATA
datasource) means either no data known or in-active. Either way, the absence of data is considered
by NM systems as an in-active restriction. In addition, sector configuration activations (tactically
updated or CACD defined) also over-rule CACD activations of a restriction. They can activate or de-
activate a restriction (also marked by AIRSPACE datasource). The above activations can be over-
ruled (set active or in-active) by the tactical updates (B2B or HMI). In addition regulation measures
can activate a restriction (over-ruling either CACD or B2B/HMI updates). The consolidated info can
be found back in the nmSchedule attribute.

Edition: 27.0 6 1556

Document Title: NM 27.0 - NM B2B Reference Manual

So the (de-)activation of a restriction is determined hierarchically by NO_DATA (least priority),

CACD (including derived from sector config), tactical updates (a.o. via B2B) , regulation measures
(highest priority). In the client schedule the non regulated restrictions activations are maintained
(just in case the regulation can be cancelled before the end of its applicability period).

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources (including NO_DATA data source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values/sector configuration derived activation) or limited to the (full list) of (pre-
)tactical updates with the gaps marked as AIRSPACE (meaning in update context: NO_DATA or CACD
or derived from sector config) datasource (to obtain a complete time partition).

In any case, periods marked with datasource AIRSPACE in the time partition correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the
NO_DATA/CACD/"derived from sector config" definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. RestrictionId restriction (Mandatory)

Restriction to which this activation plan applies.

b. set< PlannedRestrictionActivation > nmSchedule (Mandatory)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

In nmSchedule the possible values of dataSource are limited to NO_DATA, AIRSPACE, TACTICAL and
MEASURE.

Note that NO_DATA in nmClientSchedule means either inactive or that no data has been
specified.

c. set< PlannedRestrictionActivation > clientSchedule (Mandatory)

(Pre-)tactical restriction activations associated to their applicability period, as maintained by

the client. This plan contains only the updated configurations together with an indication
(AIRSPACE datasource) that the default CACD/sector config derived values apply when not
updated (see PlanDataSource). The actual activity for these airspace datasource periods can
be found in the nmSchedule

Edition: 27.0 6 1557

Document Title: NM 27.0 - NM B2B Reference Manual

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
AIRSPACE defaults. This is a B2B client designer’s decision and depends on how CACD wants
to be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the AIRSPACE defaults, then the clientschedule still needs to
contain the full list of (pre-) tactical updates and for the non (pre-) tactically updated
periods, an explicit indication that the AIRSPACE values need to be used (but without
repeating the NO_DATA/CACD/sector config derived values themselves). So in any case, the
clientschedule needs to be a complete time partition for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD/sector config derived values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD or
the TV activation derived from a sector configuration or that there is no data defined in
CACD), and the TACTICAL value meaning that this plan entry corresponds to the explicit
tactical update expressed via active.

i. Constraints:

▪ RestrictionActivationPlan.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: clientSchedule

Constrained requests: any using request

20.9.217. RestrictionActivationPlanRetrievalReplyData
<<class>>

The RestrictionActivationPlanRetrievalReply payload.

1. Attributes:

a. RestrictionActivationPlans plans (Mandatory)

The complete activation plans for a given restrictions on a given day.

2. Used by: RestrictionActivationPlanRetrievalReply

20.9.218. RestrictionActivationPlans
<<class>>

Edition: 27.0 6 1558

Document Title: NM 27.0 - NM B2B Reference Manual

Activation plans for one or more restrictions on a given day.

So the (de-)activation of a restriction is determined hierarchically by CACD and tactical updates (a.o.
via B2B).

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources.

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values) or limited to the (full list) of (pre-)tactical updates with the gaps marked as
AIRSPACE (meaning in update context: CACD) datasource (to obtain a complete time partition).

In any case, periods marked with datasource AIRSPACE in the time partition correspond to re-
moving any potential (pre-)tactical update and hence reset the corresponding values to the CACD
definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. map< RestrictionId, PlannedRestrictionActivations > restrictionActivations (Mandatory)

A map of restrictions as keys mapped to its capacities.

i. Constraints:

▪ RestrictionActivationPlans.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

PlannedRestrictionActivations.clientSchedule has gaps and/or overlaps in the time partition

or is not covering exactly one day.

Constrained attributes: restrictionActivations

Constrained requests: any using request

4. Used by: RestrictionActivationPlanUpdateRequest, RestrictionActivationPlanUpdateReplyData,

RestrictionActivationPlanRetrievalReplyData

20.9.219. RestrictionActivationPlanUpdateReplyData
<<class>>

The RestrictionActivationPlanUpdateReply payload.

1. Attributes:

a. RestrictionActivationPlans plans (Mandatory)

The complete restriction activation plans for a given restrictions on a given day, resulting
from the update.

Edition: 27.0 6 1559

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RestrictionActivationPlanUpdateReply

20.9.220. RestrictionLocation
<<class>>

Restriction location.

1. Inherits from: Location

2. Attributes:

a. KindOfRestriction kindOfRestriction (Mandatory)

The kind of restriction.

20.9.221. RunwayConfiguration
<<class>>

A runway configuration at some point in time.

1. Attributes:

a. RunwayId runway (Mandatory)

Runway to which this configuration applies.

b. RunwayUsage usage (Optional)

Usage of the runway in this configuration.

c. PlanDataSource runwayUsageDataSource (Mandatory)

Documentation last updated: 27.0 - Edition 1

The data source of the runwayUsage for this entry in the plan.

The AIRSPACE runway usage values are not updated daily. Therefore,
IMPORTANT for profile calculations, if no TACTICAL runway usage value is defined,
the NM system uses the AIRSPACE default runway.

d. DurationHourMinute departureTaxiTime (Optional)

Departure taxi time.

Note that the departure taxi time must be specified even if the usage is ARRIVAL or INACTIVE ,
so that in the exceptional case where the runway would be used in another way (indicated
via DPI ) the NM system could still use this taxi time for computing the flight.

e. PlanDataSource departureTaxiTimeDataSource (Mandatory)

Edition: 27.0 6 1560

Document Title: NM 27.0 - NM B2B Reference Manual

The data source of the departureTaxiTime for this entry in the plan.

f. DurationHourMinute timeToInsertInSequence (Optional)

Time to insert aircraft in sequence at the aerodrome of departure.

Note that the timeToInsertInSequence must be specified even if the usage is ARRIVAL or
INACTIVE , so that in the exceptional case where the runway would be used in another way
(indicated via DPI ) the NM system could still use this taxi time for computing the flight.

g. PlanDataSource timeToInsertInSequenceDataSource (Mandatory)

The data source of the timeToInsertInSequence for this entry in the plan.

h. DurationHourMinute timeToRemoveFromSequence (Optional)

Time to remove aircraft from sequence at the aerodrome of departure.

Note that the timeToRemoveFromSequence must be specified even if the usage is ARRIVAL or
INACTIVE , so that in the exceptional case where the runway would be used in another way
(indicated via DPI ) the NM system could still use this taxi time for computing the flight.

i. PlanDataSource timeToRemoveFromSequenceDataSource (Mandatory)

The data source of the timeToRemoveFromSequence for this entry in the plan.

j. DurationHourMinute arrivalTaxiTime (Optional)

Arrival taxi time.

Note that the departure taxi time must be specified even if the usage is DEPARTURE or INACTIVE
.

k. PlanDataSource arrivalTaxiTimeDataSource (Mandatory)

The data source of the arrivalTaxiTime for this entry in the plan.

2. Used by: PlannedRunwayConfigurations

20.9.222. RunwayConfigurationPlan
<<class>>

Documentation last updated: 27.0 - Edition 6

Runway configuration plan for a given aerodrome on a given day.

A RunwayConfiguration plan is a special plan in the sense that all known runways need to be
specified for a given period (PlannedRunwayConfiguration) or else the entire period needs to be
marked CACD (AIRSPACE PlanDataSource). In addition, for a (pre-)tactically updated period it is
possible to (pre-)tactically update selected runway attributes for selected runways. So each runway
attribute (usage, departureTaxTime, …) has an associated dataSource attribute allowing to indicate

Edition: 27.0 6 1561

Document Title: NM 27.0 - NM B2B Reference Manual

if that attribute needs to be updated or if CACD data is to be used for that attribute, for that runway
and for that specific period. The only constraint is: if a period (PlannedRunwayConfiguration) is
marked as TACTICAL updated, then at least one of the attributes of one of the runways needs to be
TACTICAL updated (otherwise INVALID_INPUT replyStatus).

In addition the RunwayUsage attribute is special in the sense that all runways for a specific
TACTICAL updated period need to be either all CACD, or all non CACD.

In an update context:

• The plan is complete (if the client application overwrites all AIRSPACE values for all runways)
or limited to the (full list) of (pre-)tactical updates with the gaps marked as AIRSPACE (meaning
in update context: CACD) datasource (to obtain a complete time partition).

• Periods in the time partition marked with datasource AIRSPACE, correspond to removing any
potential (pre-)tactical update and hence reset the corresponding values to the CACD definition
for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. AerodromeICAOId aerodrome (Mandatory)

Aerodrome to which this runway configuration plan belongs.

b. set< RunwayId > knownRunwayIds (Mandatory)

The list of runways that NM knows for the aerodrome, regardless to their usage, e.g. an
inactive runway is part of this set.

c. set< PlannedRunwayConfigurations > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

d. set< PlannedRunwayConfigurations > clientSchedule (Mandatory)

(Pre-)tactical runway configuration of the aerodrome associated to their applicability period,

Edition: 27.0 6 1562

Document Title: NM 27.0 - NM B2B Reference Manual

as maintained by the client. This plan contains only the updated configurations together
with an indication that the default CACD values apply when not updated (see
PlanDataSource). The actual CACD values for these CACD periods can be found in the
nmSchedule .

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
CACD defaults. This is a B2B client designer’s decision and depends on how CACD wants to
be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the CACD defaults, then the clientschedule still needs to contain
the full list of (pre-) tactical updates and for the non (pre-) tactically updated periods, an
explicit indication that the CACD values need to be used (but without repeating the CACD
values themselves). So in any case, the clientschedule needs to be a complete time partition
for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period):

1. Must be complete in the sense that all the aerodrome runways must be present in the
entry

2. The runway configuration values provided for that period overwrite all CACD values for
that same period

i. Constraints:

▪ RunwayConfigurationPlan.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: clientSchedule

Constrained requests: any using request

4. Used by: RunwayConfigurationPlanUpdateRequest, RunwayConfigurationPlanUpdateReplyData,

RunwayConfigurationPlanRetrievalReplyData

20.9.223. RunwayConfigurationPlanRetrievalReplyData
<<class>>

The RunwayConfigurationPlanRetrievalReply payload.

1. Attributes:

a. RunwayConfigurationPlan plan (Mandatory)

The complete runway configuration plan for a given aerodrome on a given day.

Edition: 27.0 6 1563

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: RunwayConfigurationPlanRetrievalReply

20.9.224. RunwayConfigurationPlanUpdateReplyData
<<class>>

The RunwayConfigurationPlanUpdateReply payload.

1. Attributes:

a. RunwayConfigurationPlan plan (Mandatory)

The complete runway configuration plan for a given aerodrome on a given day.

2. Used by: RunwayConfigurationPlanUpdateReply

20.9.225. RunwayUsage
<<enumeration>>

Possible usages of a runway.

1. Values:

a. DEPARTURE

The runway is used for departures only.

b. ARRIVAL

The runway is used for arrivals only.

Note that an arrival runway is not considered by the NM system for departure when
processing flights, but DPI (Departure Planning Information) messages are still able to use an
arrival runway.

c. DEPARTURE_ARRIVAL

The runway is used for both departures and arrivals.

d. INACTIVE

The runway is neither used for depatures or arrivals.

Note that an inactive runway is not considered by the NM system for departure when
processing flights, but DPI (Departure Planning Information) messages are still able to use an
inactive runway.

2. Used by: RunwayConfiguration

Edition: 27.0 6 1564

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.226. ScenarioAttributes

<<class>>

Scenario attributes.

1. Attributes:

a. string publicationId (Mandatory)

The published scenarioId. For AR,RR,FL type of scenario it is typically the traffic volume
name of the scenario.

i. Constraints:

▪ Pattern: TEXT{1,10000}

b. ScenarioId scenarioId (Mandatory)

The id of the scenario (inside the NM scenario repository).

c. set< ScenarioEvent > scenarioEvents (Optional)

The events associated by the user to this scenario: typically Strike, SKI, ConingencyMUAC

d. ScenarioType scenarioType (Mandatory)

The type of scenario.

e. set< TrafficVolumeId > scenarioPublishedTrafficVolumes (Optional)

The trafic volumes(s) of the scenario: i.e. the traffic volume(s) to avoid. For RR/FL type of
scenario, it is typically the traffic volume of the scenario measures (but not always: in some

Edition: 27.0 6 1565

Document Title: NM 27.0 - NM B2B Reference Manual

cases the scenario measures use a larger traffic volume to avoid/protect some other traffic
volume).

f. set< ReferenceLocation > scenarioPublishedLocations (Optional)

The reference location(s) of the scenario: i.e. the location(s) to avoid. For RR/FL type of
scenario, it is typically the reference location of the traffic volume of the scenario (but not
always: in some cases the scenario intends to avoid/protect some other reference location).

g. set< AirNavigationUnitId > ownerFMPs (Optional)

The FMP(s) that are the owner of the scenario (e.g. it could happen that the location of the
scenario overlaps with multiple ACC/FMP).

h. set< AirspaceId > onLoad (Optional)

The list of published airspaces that will be on-loaded when the scenario is applied.

i. set< AirspaceId > offLoad (Optional)

The list of published airspace that will be off-loaded when the scenario is applied.

j. WeeklySchedule weeklyApplicability (Optional)

If the scenario can only be applied during certain periods, this weekly schedule represents
this.

Tyical usage is: scenario that are already included in certain RAD restrictions that are
always applied during the weekend. So the scenario should be applied during the periods
when this RAD is dis-abled (in CACD)

k. string from (Optional)

The textual representation of the flows (upstream) of the traffic volume of the scenario.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,10000}

l. string to (Optional)

The textual representation of the flows (downsteam) of the traffic volume of the scenario.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,10000}

m. set< RestrictionId > scenarioIncludedInRestrictions (Optional)

RAD restrictions (if enabled) that incorporates this scenario: e.g. some RR/FL scenario are
included in some RAD.

n. set< RestrictionId > disabledRestrictions (Optional)

Edition: 27.0 6 1566

Document Title: NM 27.0 - NM B2B Reference Manual

RAD restrictions that need to be disabled (CACD) before the scenario can be applied.

o. set< RestrictionId > ignoredRestrictions (Optional)

RAD restrictions that need to be ignored (IFPS) before the scenario can be applied.

p. set< string > alternativeIcaoRoutePortions (Optional)

Each suggestedAlternativeRoute represents one possible alternative (partial F15) AR/RR/FL

scenario contains examples on how an AO could fly to get around the location to avoid.

i. Constraints:

▪ Item pattern: MULTILINE_TEXT{0,10000}

q. set< ScenarioLevelConstraint > levelConstraints (Optional)

Each levelConstraints represents one possible level constraint. Typically it states something
like: file below FL240 until clear of sector.

r. ScenarioPublicationStatus publicationStatus (Mandatory)

The textual representation of the flows (upstream) of the traffic volume of the scenario.

s. DateTimeMinutePeriodWithUFN applicabilityPeriod (Mandatory)

Describes when the scenario is considered applicable: when applicabilityPeriod is in the

past, the scenario is considered an archived scenario no longer applicable.

t. string comments (Optional)

Any relevent comment (e.g. only to be used when … to acomplish …).

i. Constraints:

▪ Pattern: MULTILINE_TEXT{0,10000}

u. DateTimeSecond lastModifiedTimeStamp (Mandatory)

The timestamp when the scenario was last modified/saved.

v. string scenarioValidationErrorsOrWarnings (Optional)

If there are validation errors or warnings with a scenario, the

scenarioValidationErrorsOrWarnings will be present.

i. Constraints:

▪ Pattern: MULTILINE_TEXT{1,10000}

w. set< MeasureIdAndTV > scenarioMeasures (Optional)

Gives a summary of all the measures inside the scenario and their traffic volume id on
which they are based. In addition it describes per rerouting measure, the off-loaded traffic
volumes.

Edition: 27.0 6 1567

Document Title: NM 27.0 - NM B2B Reference Manual

x. set< File > scenarioImageFiles (Optional)

Scenario image files.

2. Used by: ScenarioListReplyData

20.9.227. ScenarioEvent
<<typedef[string]>>

1. Pattern: TEXT{1,10000}

2. Used by: ScenarioAttributes

20.9.228. ScenarioId
<<typedef[string]>>

1. Pattern: TEXT{1,255}

2. Used by: ScenarioMeasureRetrievalRequest, MeasureFromScenarioRepository, ScenarioListRequest,

TrafficVolumeScenarios, ScenarioAttributes

20.9.229. ScenarioImpact
<<class>>

Describes the scenario impact: if a scenario measure is applied to solve a problem on a traffic
volume, then this scenario impacts the traffic in that problem traffic volume. This class describes
the impact (see TrafficVolumeScenarios).

1. Attributes:

a. CountsValue totalCommonFlightCount (Mandatory) (new 27.0)

The total number of common flight between the problem traffic volume and the solution
(scenario) traffic volume.

This corresponds to the total number of flights inside the flow counts for this scenario traffic
volume flow.

b. CountsValue totalOtherFlightCount (Mandatory) (new 27.0)

The total number of flights captured by the solution (scenario) traffic volume that are not
captured by the queried ("problem") TrafficVolume. i.e. when the user would apply a
relevant scenario measure, then this measure would correctly offload
numberCommonFlights from the 'problem' Traffic volume, but additionally it would
"penalise" numberOtherFlights that are not even crossing the "problem" Traffic volume.

c. DateTimeMinutePeriod scenarioTrafficVolumeEntryPeriod (Optional)

The (smallest entry count based) period that would be needed for the measure on

Edition: 27.0 6 1568

Document Title: NM 27.0 - NM B2B Reference Manual

scenarioTrafficVolume to capture all the common flights. In addition when the measure is
applied (with a scenarioTrafficVolumeEntryPeriod), then it will also capture additionally
totalOtherFlights.

2. Used by: Flow

20.9.230. ScenarioLevelConstraint

<<class>>

Represents one level constraint (scenario publication context : FL type of scenario). Typically it
states something like: file below FL240 until clear of sector. Note that in the rerouting itself, one can
find the actual/formal rerouting (level) constraint. Note that the rerouting constraints might simply
say: avoid vertically the airspace. In this case, the scenario publication level constraint indicate the
implications/what the AO should do: refile below e.g. FL240.

1. Attributes:

a. set< DBEOrPublishedPointId > from (Mandatory)

Indicates from which points (from the main traffic flows), the aircrafts needs to change
level. Note that the list of points can be empty (if it is not considered relevant for
publication/clarification)

b. LevelConstraintKind levelConstraintKind (Mandatory)

Indicates if the FL scenario is in fact a level cap or rather that the flights need to avoid the
traffic volume by flying above it (e.g. late descend).

c. FlightLevel_DataType flightLevel (Mandatory)

Indicates the flightlevel that the aircrafts should respect.

d. set< DBEOrPublishedPointId > until (Mandatory)

Indicates from which points (from the main traffic flows), the aircrafts can climb again to
it’s optimal RFL. Note that the list of points can be empty (if it is not considered relevant for
publication/clarification).

2. Used by: ScenarioAttributes

Edition: 27.0 6 1569

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.231. ScenarioListReplyData

<<class>>

The ScenarioListReply payload.

Reply data containing scenario attributes from the scenario repository.

1. Attributes:

a. set< ScenarioAttributes > attributes (Optional)

List of scenario attributes.

2. Used by: ScenarioListReply

20.9.232. ScenarioMeasureRetrievalRequest

<<class>>

Abstract request to query an NM measure list for a scenario, as well as to retrieve the measure
details.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset for which the retrieve scenario measure is requested. See Forecast and Operational
Datasets.

Edition: 27.0 6 1570

Document Title: NM 27.0 - NM B2B Reference Manual

b. set< ScenarioId > scenarios (Mandatory)

Selects the measures contained in the given list of scenarioId.

c. DateTimeMinutePeriod adaptedMeasureApplicability (Optional)

When specified, the measures applicabliy period is adapted to match

AdaptedMeasureApplicablity.

When not specified, the measures returned have their applicability un-changed wrt what is
in the scenario repository (this could for example be many years in the past).

20.9.233. ScenarioName
<<typedef[string]>>

1. Pattern: TEXT{1,255}

2. Used by: ScenarioListRequest

20.9.234. ScenarioPublicationStatus
<<enumeration>>

Scenario Publication status

1. Values:

a. DRAFT

The scenario is under preparation/undergoing changes or is not to be published in the NM

B2C applications.

b. PUBLISHED

The scenario ready and published in the NM B2C applications.

2. Used by: ScenarioAttributes

20.9.235. ScenarioRegulationRetrievalReplyData

<<class>>

The ScenarioRegulationRetrievalReply payload.

Reply data.

1. Attributes:

Edition: 27.0 6 1571

Document Title: NM 27.0 - NM B2B Reference Manual

a. set< Regulation > regulations (Mandatory)

The regulation(s) contained in the scenario from the scenario repository.

2. Used by: ScenarioRegulationRetrievalReply

20.9.236. ScenarioReroutingRetrievalReplyData

<<class>>

The ScenarioReroutingRetrievalReply payload.

Reply data.

1. Attributes:

a. set< Rerouting > reroutings (Mandatory)

The rerouting(s) contained in the scenario from the scenario repository.

2. Used by: ScenarioReroutingRetrievalReply

20.9.237. ScenarioTrafficVolumeMatchingKind
<<enumeration>>

Typically when the end-user has an overload on a "problem" traffic volume (i.e. the queried traffic
volume to off-load), then he wants to see which scenarios (solutions) can be applied to off-load that
"problem" traffic volume.

1. Values:

a. SAME_TRAFFIC_VOLUME

Solution Traffic Volume is equal to the "problem" traffic volume.

b. SAME_REFERENCE_LOCATION

Solution Traffic Volume is based on the same reference location as the problem traffic
volume.

c. OVERLAPPING_REFERENCE_LOCATION

Solution Traffic Volume is overlapping with the "problem" traffic volume

d. INDIRECT_OFFLOAD

Solution Traffic Volume is indirectly off-loading the "problem" traffic volume.

Edition: 27.0 6 1572

Document Title: NM 27.0 - NM B2B Reference Manual

For example when applying a level cap on a sector, often some of the upstream sectors are
also impacted (and indirectly off-loaded).

2. Used by: TrafficVolumeScenarios

20.9.238. ScenarioType
<<enumeration>>

1. Values:

a. FL

The scenario type FL stands for Flight Level Capping scenario: i.e. a scenario with 2
measures in it: a (zero rate) regulation and normally a vertical rerouting.

b. RR

The scenario type RR stands for Flight Level Capping scenario: i.e. a scenario with 2
measures in it: a (zero rate) regulation and normally a horizontal rerouting.

c. AR

The scenario type AR stands for an alternate route scenario: i.e. a scenario with 2 measures
in it: a (low rate) regulation for a "non-standard" route and normally a horizontal rerouting
to reroute flights into the new "route".

d. MIXED

The scenario type Mixed represents all other scenario: for example contingency scenario
containing a set of regulations. When such a scenario is aplied, one or more measures of the
scenario are applied (but not necessarily all of them).

e. STAM

The scenario type STAM stands for STAM scenario : i.e. typically a scenario with 1 measure
in it: either a cherry picked regulation or a cherry picked level-cap or horizontal rerouting
or an MCDM-only measure.

Note that in some cases we could have multiple cherry picked measures inside 1 STAM level
cap scenario to describe the different options of where to decent and where to climb up
again.

f. RAD

The scenario type Restriction stands for a scenario describing what a flight should do if it
gets caught by a restriction (typically EU RAD restrictions).The scenario contains 1 rerouting
measure.

2. Used by: ScenarioAttributes

Edition: 27.0 6 1573

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.239. SectorConfigurationId
<<typedef[string]>>

Unique id of a sector configuration.

1. Pattern: (UALPHA|DIGIT|.){1,6}

2. Used by: SectorConfigurationPlan, PlannedSectorConfigurationActivation

20.9.240. SectorConfigurationPlan
<<class>>

Sector configuration plan for a given AUA or sector cluster on a given day.

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources.

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values) or limited to the (full list) of (pre-)tactical updates with the gaps marked as
AIRSPACE datasource (to obtain a complete time partition).

In any case, periods in the time partition marked with datasource AIRSPACE correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the CACD
definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. AirspaceId airspace (Mandatory)

AUA or sector cluster to which these sector configurations belong.

b. map< SectorConfigurationId, set< AirspaceId > > knownConfigurations (Contextual)

The set of sector configuration ids that NM knows for the AUA or sector cluster, and for each
sector configuration, the set of sectors that compose it.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

c. set< PlannedSectorConfigurationActivation > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.

Edition: 27.0 6 1574

Document Title: NM 27.0 - NM B2B Reference Manual

the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one, and the
TACTICAL value meaning that this plan entry corresponds to the explicit tactical update
expressed via sectorConfigurationId.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

d. set< PlannedSectorConfigurationActivation > clientSchedule (Mandatory)

(Pre-)tactical sector configuration activations of the AUA or sector cluster associated to their
applicability period, as maintained by the client. This plan contains only the updated
configurations together with an indication that the default CACD values apply when not
updated (see PlanDataSource). The actual CACD values for these CACD periods can be found
in the nmSchedule

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
CACD defaults. This is a B2B client designer’s decision and depends on how CACD wants to
be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the CACD defaults, then the clientschedule still needs to contain
the full list of (pre-) tactical updates and for the non (pre-) tactically updated periods, an
explicit indication that the CACD values need to be used (but without repeating the CACD
values themselves). So in any case, the clientschedule needs to be a complete time partition
for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one, and the
TACTICAL value meaning that this plan entry corresponds to the explicit tactical update
expressed via sectorConfigurationId.

i. Constraints:

▪ SectorConfigurationPlan.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

Edition: 27.0 6 1575

Document Title: NM 27.0 - NM B2B Reference Manual

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: clientSchedule

Constrained requests: any using request

4. Used by: SectorConfigurationPlanUpdateReplyData, SectorConfigurationPlanRetrievalReplyData,

SectorConfigurationPlanUpdateRequest

20.9.241. SectorConfigurationPlanRetrievalReplyData
<<class>>

The SectorConfigurationPlanRetrievalReply payload.

1. Attributes:

a. SectorConfigurationPlan plan (Mandatory)

The complete sector configuration plan for a given AUA or sector cluster on a given day.

2. Used by: SectorConfigurationPlanRetrievalReply

20.9.242. SectorConfigurationPlanUpdateReplyData
<<class>>

The SectorConfigurationPlanUpdateReply payload.

1. Attributes:

a. SectorConfigurationPlan plan (Mandatory)

The complete sector configuration plan for a given AUA or sector cluster on a given day,
resulting from the update.

2. Used by: SectorConfigurationPlanUpdateReply

20.9.243. SegmentLocation
<<class>>

Segment location: i.e. a part of a route or of a direct route.

1. Inherits from: Location

20.9.244. SetOfAerodromesLocation
<<class>>

Set of aerodromes location.

Edition: 27.0 6 1576

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: Location

20.9.245. SignificantDeltaCount
<<class>>

Compares a before and after situation and indicates if the change is significant. An insignificant
change is a change that is considered not relevant.

1. Attributes:

a. CountsValue beforeCount (Mandatory)

The count corresponding to the before situation.

b. CountsValue afterCount (Mandatory)

The count corresponding to the after situation.

c. boolean isSignificantChange (Mandatory)

Is there a significant change (e.g. an insignificant change is typically due to flights/counts

constantly changing (e.g. due to DPI) in the background, while e.g. a regulation is being
created.

2. Used by: DeltaATFCMSituationCounts

20.9.246. SignificantDeltaDuration
<<class>>

Compares a before and after situation and indicates if the change is significant. An insignificant
change is a change that is considered not relevant.

1. Attributes:

a. LongDurationHourMinute beforeCount (Mandatory)

The duration corresponding to the before situation (e.g. total delay of a regulation).

b. LongDurationHourMinute afterCount (Mandatory)

The duration corresponding to the after situation.

c. boolean isSignificantChange (Mandatory)

Is there a significant change (e.g. an insignificant change is typically due to flights/counts

constantly changing (e.g. due to DPI) in the background, while e.g. a regulation is being
created.

2. Used by: DeltaATFCMSituationDelays

Edition: 27.0 6 1577

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.247. Simulation

<<abstract class>>

Common ancestor of the different types of simulation.

1. Attributes:

a. SimulationName name (Mandatory)

The given name of the simulation.

b. string description (Mandatory)

The description of the simulation.

i. Constraints:

▪ Max length: 1000

▪ Max length inclusive: true

c. DateTimeMinute publicationTime (Contextual)

The time when the simulation became published. For a USER_MANAGED_SIMULATION , it is the
time when the simulation was started.

i. Presence:

▪ Mandatory in SimulationListReply SimulationStartReply

▪ Must be null in SimulationStartRequest

▪ Optional otherwise

d. string simulationEngineId (Contextual)

The Id of the simulation engine running the simulation (also known as simulation_ID in
B2C). It is mainly needed by NMOC to find back the simulation in case of questions.

i. Presence:

▪ Mandatory in SimulationListReply SimulationStartReply

▪ Must be null in SimulationStartRequest

▪ Optional otherwise

Edition: 27.0 6 1578

Document Title: NM 27.0 - NM B2B Reference Manual

e. DateTimeMinutePeriod simulationPeriod (Mandatory)

The period that is being simulated (e.g. flights have been loaded that are
departing/arriving/flying within that period).

When starting a USER_MANAGED_SIMULATION , the simulationPeriod needs to be exactly 1 day

and it needs to be contained inside the simulation period of the reference. For example, a
simulation for an operational datasetReference can either have as period [D, D-1 00:00[ or
[D-1 00:00, D-2 00:00[ (See also OPERATIONAL and FORECAST datasets, and SIMULATION
datasets.)

f. Dataset dataset (Contextual)

The dataset of the simulation. This dataset needs to be used in any query on that simulation
(for example in the flightlist and regulationlist)

i. Presence:

▪ Mandatory in SimulationListReply SimulationStartReply

▪ Must be null in SimulationStartRequest

▪ Optional otherwise

ii. Constraints:

▪ Simulation.DATASET_TYPE_MUST_BE_SIMULATION

2. Constraints:

a. DATASET_TYPE_MUST_BE_SIMULATION

Dataset must be SIMULATION type.

Constrained attributes: dataset

Constrained requests: any using request

3. Used by: SimulationListReplyData

20.9.248. SimulationAvailability
<<class>>

Shows the available (free) user managed simulations and the used user managed simulation for a
reference dataset

1. Attributes:

a. DateTimeMinutePeriod simulatablePeriod (Mandatory)

The period within a simulation period needs to be.

For STANDALONE_SIMEX simulations, it is typically a 7 day period relatively far in the future.

Edition: 27.0 6 1579

Document Title: NM 27.0 - NM B2B Reference Manual

b. int availableSimulations (Mandatory)

The number of currently available (free) user managed simulations.

c. int simulationsInUse (Mandatory)

The number of user managed simulations currently in use.

2. Used by: SimulationAvailabilityReplyData

20.9.249. SimulationAvailabilityReplyData
<<class>>

The SimulationAvailabilityReply payload.

1. Attributes:

a. map< DatasetReference, set< SimulationAvailability > > simulationAvailabilities (Optional)

The simulation availability per reference dataset.

2. Used by: SimulationAvailabilityReply

20.9.250. SimulationListReplyData
<<class>>

The SimulationListReply payload.

1. Attributes:

a. set< Simulation > simulations (Optional)

Set of simulations that matched the SimulationListRequest criteria.

Can be empty (meaning that no simulation matched the criteria).

2. Used by: SimulationListReply

20.9.251. SimulationMeasureRevertReplyData
<<class>>

The SimulationMeasureRevertReply payload.

1. Used by: SimulationMeasureRevertReply

20.9.252. SimulationName
<<typedef[string]>>

1. Pattern: TEXT{1,40}

Edition: 27.0 6 1580

Document Title: NM 27.0 - NM B2B Reference Manual

2. Used by: Simulation

20.9.253. SimulationResetReplyData
<<class>>

The SimulationResetReply payload.

1. Used by: SimulationResetReply

20.9.254. SimulationStartReplyData
<<class>>

The SimulationStartReply payload.

1. Attributes:

a. UserManagedSimulation startedSimulation (Mandatory)

The started simulation : containing a.o. the new dataset (and it’s corresponding simulation
id). Note that each time a simulation is started, it gets a new dataset/simulation_id.

2. Used by: SimulationStartReply

20.9.255. SimulationStopReplyData
<<class>>

The SimulationStopReply payload.

1. Used by: SimulationStopReply

20.9.256. StandaloneSimex
<<class>>

Documentation last updated: 27.0 - Edition 2

The simulation is a standalone SIMulation Experiment (SIMEX).

It can be used as a reference for other simulations.

The simulation type associated to the dataset’s simulation is STANDALONE_SIMEX.

1. Inherits from: Simulation

20.9.257. SubTotalsRegulationDetailedType
<<enumeration>>

Documentation last updated: 27.0 - Edition 1

Edition: 27.0 6 1581

Document Title: NM 27.0 - NM B2B Reference Manual

Enumerates the possible sub totals count types for showing influencing regulation details (for
counts on a target regulation). These influencing regulation details show how required/impacting a
regulation is (e.g. when simulating a new reg creation or when monitoring if a regulation still
performs as expected):

• if a regulation results in most flights having a different MPR (Most Penalizing Regulation), then
the regulation is maybe not that required. So, e.g. the periods/sub-periods might be changed to
restrict the regulation when it is really needed.

• If a regulation results in most flights having zero delay, then then the regulation is maybe not
that required.

• If a regulation results in most flights having no delay because they are already
airborne/exempted, then the regulation is maybe not that required.

Some usage examples:

+ Sometimes a set of regulations is needed to solve some overloads. Sometimes, some of those
regulations are not really needed (e.g. because already covered by some of the other regulations).
These influencing regulation details subtotals allow to detect if some regulations are not needed.

+ FMPs should be able to compare between different DCB mitigation solutions (e.g. Regulations vs
Scenarios or Regulation A+B vs Regulation B+C). One aspect of this comparison is: how well do the
individual regulations perform - is the regulation needed/already covered by other regulations,
should the rate be changed, should sub-periods be introduced, should the period be
extended/reduced, etc.

"Airborne" in the following enumeration values shall be interpreted as "Supposed

NOTE
Airborne (TACT Activated) or Confirmed Airborne (ATC Activated or Terminated)".

The different components (DELAYED_FLIGHTS*, ZERO_DELAY_FLIGHTS*

,OTHER_MPR_DELAYED_FLIGHTS*) are split between NOT_YET_AIRBORNE and
ALREADY_AIRBORNE. This split is useful because when an FMP considers creating or modifying a
regulation, typically the Already_Airborne flights will not be impacted.

1. Values:

a. DELAYED_FLIGHTS_NOT_YET_AIRBORNE

The count of not yet airborne delayed (delay > 0) flights of which most penalising regulation
is the target regulation.

b. DELAYED_FLIGHTS_ALREADY_AIRBORNE

The count of airborne delayed (delay > 0) flights of which most penalising regulation is the
target regulation.

c. ZERO_DELAY_FLIGHTS_NOT_YET_AIRBONE

The count of not yet airborne zero (0) delay flights of which most penalising regulation is the
target regulation or any other regulation.

Edition: 27.0 6 1582

Document Title: NM 27.0 - NM B2B Reference Manual

d. ZERO_DELAY_FLIGHTS_ALREADY_AIRBORNE

The count of airborne zero (0) delay flights of which most penalising regulation is the target
regulation or any other regulation.

e. NOT_REGULATED_BUT_REGULATABLE_FLIGHTS

Documentation last updated: 27.0 - Edition 1

The count of not yet airborne flights with no most penalising regulation that are regulatable.
These flights are typically in the extended periods around the regulation. When extending
the regulation period, these flights will be impacted.

f. NOT_REGULATED_AIRBORNE_OR_EXEMPTED_FLIGHTS

Documentation last updated: 27.0 - Edition 1

The count of airborne flights with no most penalising regulation or, any exempted/excluded
flights from the target regulation (airborne or not, regulated or not). When
creating/modifying a regulation, these flights cannot be impacted.

g. OTHER_MPR_DELAYED_FLIGHTS_NOT_YET_AIRBORNE

The count of not yet airborne delayed (delay > 0) flights of which most penalising regulation
is not the target regulation, excluding target regulation exempted flights.

h. OTHER_MPR_DELAYED_FLIGHTS_ALREADY_AIRBORNE

The count of airborne delayed (delay > 0) flights of which most penalising regulation is not
the target regulation, excluding target regulation exempted flights.

2. Used by: Counts

20.9.258. SubTotalsTrafficCountsType
<<enumeration>>

Enumerates the possible sub totals counts types.

1. Values:

a. PFD

Predicted flights (See Forecast and Operational Datasets) that are not suspended

b. IFPL

Flights created from a flight plan filed to IFPS that are not suspended, nor ATC_ACTIVATED ,
nor TACT_ACTIVATED_WITH_FSA , nor TACT_ACTIVATED_WITHOUT_FSA .

c. SUSPENDED

Edition: 27.0 6 1583

Document Title: NM 27.0 - NM B2B Reference Manual

Suspended Flights. Note that suspended flights are not considered part of the
TrafficType.LOAD.

d. ATC_ACTIVATED

ATC activated flights. Note that this also includes terminated flights that were ATC activated.

e. TACT_ACTIVATED_WITH_FSA

TACT activated with FSA message expected (but not yet received). Note that this also
includes terminated flights that were TACT_ACTIVATED_WITH_FSA .

f. TACT_ACTIVATED_WITHOUT_FSA

TACT activated with no FSA message expected. Note that this also includes terminated flights
that were TACT_ACTIVATED_WITHOUT_FSA .

2. Used by: Counts

20.9.259. TacticalConfigurationPlan
<<abstract class>>

Common information for all configuration plans on a given day.

1. Attributes:

a. PlanDataId dataId (Mandatory)

Opaque identifier representing the version of this plan.

i. Constraints:

▪ TacticalConfigurationPlan.INCONSISTENT_DATAID_AND_DATASET_TYPE

b. Dataset dataset (Mandatory)

Dataset to which the plan belongs.

i. Constraints:

▪ TacticalConfigurationPlan.INCONSISTENT_DATAID_AND_DATASET_TYPE

▪ TacticalConfigurationPlan.INCONSISTENT_DAY_AND_DATASET_TYPE

c. DateYearMonthDay day (Mandatory)

Day for which this plan is valid.

i. Constraints:

▪ TacticalConfigurationPlan.INCONSISTENT_DAY_AND_DATASET_TYPE

d. boolean planTransferred (Optional)

Indicates if the plan has been transferred to the OPERATIONAL dataset. When false, it means

Edition: 27.0 6 1584

Document Title: NM 27.0 - NM B2B Reference Manual

that the most up-to-date data can be found in the FORECAST dataset.

e. boolean planCutOffReached (Optional)

Indicates if the plan can still be updated in the FORECAST dataset, i.e. if the forecast cut-off
time has been reached or not.

2. Constraints:

a. INCONSISTENT_DATAID_AND_DATASET_TYPE

The dataId must match the one returned by the corresponding retrieval request for the
given dataset .

Constrained attributes: dataId, dataset

Constrained requests: any using request

b. INCONSISTENT_DAY_AND_DATASET_TYPE

Documentation last updated: 27.0 - Edition 1

Depending on dataset type:

1. day must be in must be in [D-5, D] in a FORECAST context

2. day must be in must be in [D-1, D] in an OPERATIONAL context

3. day is not constrained in a SIMULATION context

Constrained attributes: day, dataset

Constrained requests: any using request

20.9.260. TacticalConfigurationRetrievalRequest

<<abstract class>>

Abstract request to retrieve a tactical configuration (runway, sector, capacity, TV, OTMV) on a given
day.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset for which the tactical configuration is requested.

Edition: 27.0 6 1585

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ TacticalConfigurationRetrievalRequest.INCONSISTENT_DAY_AND_DATASET_TYPE

b. DateYearMonthDay day (Mandatory)

Day for which the tactical configuration is requested.

i. Constraints:

▪ TacticalConfigurationRetrievalRequest.INCONSISTENT_DAY_AND_DATASET_TYPE

3. Constraints:

a. INCONSISTENT_DAY_AND_DATASET_TYPE

Documentation last updated: 27.0 - Edition 1

Depending on dataset type:

1. day must be in must be in [D-5, D] in a FORECAST context

2. day must be in must be in [D-1, D] in an OPERATIONAL context

3. day is not constrained in a SIMULATION context

Constrained attributes: day, dataset

Constrained requests: any using request

20.9.261. TrafficCountsByAerodromeReplyData
<<class>>

The TrafficCountsByAerodromeReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByAerodromeReply

20.9.262. TrafficCountsByAerodromeSetReplyData
<<class>>

The TrafficCountsByAerodromeSetReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByAerodromeSetReply

20.9.263. TrafficCountsByAircraftOperatorReplyData
<<class>>

The TrafficCountsByAircraftOperatorReply payload.

Edition: 27.0 6 1586

Document Title: NM 27.0 - NM B2B Reference Manual

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByAircraftOperatorReply

20.9.264. TrafficCountsByAirspaceReplyData
<<class>>

The TrafficCountsByAirspaceReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByAirspaceReply

20.9.265. TrafficCountsByMeasureReplyData
<<class>>

The TrafficCountsByMeasureReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByMeasureReply

20.9.266. TrafficCountsByPointReplyData
<<class>>

The TrafficCountsByPointReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByPointReply

20.9.267. TrafficCountsByTrafficVolumeReplyData
<<class>>

The TrafficCountsByTrafficVolumeReply payload.

1. Inherits from: TrafficCountsReplyData

2. Used by: TrafficCountsByTrafficVolumeReply

20.9.268. TrafficCountsReplyData

Edition: 27.0 6 1587

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Abstract reply returned in response to an abstract TrafficCountsRequest.

1. Attributes:

a. DateTimeMinutePeriod effectiveTrafficWindow (Mandatory)

The effective period of time for which counts were requested.

Flights from within this period have been used in the counts (see
TrafficCountsRequest.trafficWindow.

b. set< Flow > flows (Optional)

The flows for which the traffic counts are requested.

This attribute is set only when requested, i.e.

TrafficCountsByTrafficVolumeRequest.computeFlowCounts has been set to true.

i. Constraints:

▪ set size range : [1, 100]

c. map< DateTimeMinutePeriod, map< TrafficType, Counts > > counts (Optional)

The traffic counts by period (interval) and by requested traffic type.

i. Constraints:

▪ map size range : [0, 1440]

▪ item size range : [1, 3]

d. map< TrafficType, set< OtmvAlert > > otmvAlerts (Optional)

The OTMV alerts by traffic type for OTMV duration

TrafficCountsRequest.countsInterval.duration.

Edition: 27.0 6 1588

Document Title: NM 27.0 - NM B2B Reference Manual

All count periods(intervals) that start in OtmvAlert.period are considered to have an OTMV
alert with OtmvStatus.

This attribute is set only when requested, i.e.

TrafficCountsByTrafficVolumeRequest.computeOtmvAlerts has been set to true.

i. Constraints:

▪ map size range : [0, 3]

▪ item size range : [1, 1440]

e. map< DateTimeMinutePeriod, CountsValue > effectiveCapacities (Optional) (new 27.0)

Documentation last updated: 27.0 - Edition 5

The effective traffic capacities, returned only if the following conditions are satisfied:

▪ Entry counts were demanded (calculationType=ENTRY)

▪ The provided count duration was equal to 1 hour (countsInterval.duration=01:00)

To lighten the map, adjacent periods associated to the same effective

capacity value are merged in a single map entry.

IMPORTANT For example, if the effective capacity is 20 for the adjacent periods
[08:00, 09:00[, [08:10, 09:10[, [08:20, 09:20[, …, [09:10, 10:10[,
then only one map entry is returned with key (merged period)
[08:00, 10:10[ and value (effective capacity) 20.

i. Constraints:

▪ map size range : [0, 1440]

f. map< DateTimeMinutePeriod, OTMVThresholds > effectiveOTMVs (Optional) (new 27.0)

The effective OTMVs, returned only if the following conditions are satisfied:

▪ Occupancy counts were demanded (calculationType=OCCUPANCY)

▪ The counts were demanded for a traffic volume defined on an airspace

▪ An OTMV is defined for this traffic volume and for the requested counts interval
duration

i. Constraints:

▪ map size range : [0, 1440]

20.9.269. TrafficCountsRequest

Edition: 27.0 6 1589

Document Title: NM 27.0 - NM B2B Reference Manual

<<abstract class>>

Abstract request to query traffic counts.

1. Inherits from: Request

2. Attributes:

a. Dataset dataset (Mandatory)

Dataset for which the runway configuration plan is requested.

See Forecast and Operational Datasets and Simulation Datasets.

i. Constraints:

▪ TrafficCountsRequest.INVALID_QUERY_PERIOD_RANGE

b. DateTimeMinutePeriod trafficWindow (Mandatory)

The period of time for which traffic counts are requested.

Typically in a traffic counts reply, more than one traffic count period/interval is returned.
For each such period, count values are returned. Each such count period has a duration of
countsInterval.duration . The start of the count periods is are separated by
countsInterval.step .

The last count period (for which counts are returned) is the count period that starts before
trafficWindow.Unt (but the end of that last count period can extend beyond the
trafficWindow.Unt , as the duration of that count period is countsInterval.duration ).

Note that the first count period can start before trafficWindow.Wef as the count period start

Edition: 27.0 6 1590

Document Title: NM 27.0 - NM B2B Reference Manual

is rounded down to a multiple of countsInterval.step .

The effectiveTrafficWindow indicates the real traffic window for which flights have been
taken into account to compute the different count periods and count values.

See CountsInterval.

i. Constraints:

▪ TrafficCountsRequest.INVALID_QUERY_PERIOD_RANGE

▪ TrafficCountsRequest.PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

c. boolean includeProposalFlights (Mandatory)

Determines if the selected traffic must include the proposal flights, or only the real flights. If
the proposal flights are included, they replace their corresponding real flights.

See Proposal Flights.

i. Access control:

▪ set includeProposalFlights=true requires read access to /flights?proposal=true

d. boolean includeForecastFlights (Mandatory)

Determines if the selected traffic must include the "forecast" flights.

In the OPERATIONAL dataset (or in a simulation on OPERATIONAL), a "forecast" flight is a

predicted flight (cfmuFlightType = PREDICTED_FLIGHT).

In the FORECAST dataset (or in a simulation on FORECAST), a "forecast" flight is a predicted

flight with no intention data.

e. set< TrafficType > trafficTypes (Mandatory)

Requested traffic types. For each traffic type, the count values will be returned.

i. Constraints:

▪ set size range : [1, unbounded[

▪ TrafficCountsRequest.ONLY_ONE_TRAFFIC_TYPE_IF_FLOW_COUNTS

▪ TrafficCountsRequest.ONLY_ONE_TRAFFIC_TYPE_IF_SUB_TOTALS_BY_REGULATION_DETAILS

f. CountSubTotalComputeMode subTotalComputeMode (Mandatory)

Documentation last updated: 27.0 - Edition 1

Determines if for each traffic type selected, a single total is returned, or rather detailed sub-
totals(and which kind of sub-totals).

The sub-totals traffic counts types are defined in SubTotalsTrafficCountsType or

SubTotalsRegulationDetailedType.

Edition: 27.0 6 1591

Document Title: NM 27.0 - NM B2B Reference Manual

i. Constraints:

▪ TrafficCountsRequest.INVALID_SUB_TOTAL_COMPUTE_MODE

▪ TrafficCountsRequest.ONLY_ONE_TRAFFIC_TYPE_IF_SUB_TOTALS_BY_REGULATION_DETAILS

g. CountsInterval countsInterval (Mandatory)

Determines how many count periods need to be returned in the trafficWindow and
determines the duration of each period.

3. Constraints:

a. PERIOD_EXTENSION_CANNOT_BE_GREATER_THAN_24_HOURS

The period extension must be smaller or equal to 24 hours.

Constrained attributes: trafficWindow

Constrained requests: any using request

b. ONLY_ONE_TRAFFIC_TYPE_IF_FLOW_COUNTS

Only one traffic type can be requested in trafficTypes when

TrafficCountsByTrafficVolumeRequest.computeFlowCounts or
TrafficCountsByMeasureRequest.computeFlowCounts is set to true.

Constrained attributes: trafficTypes

Constrained requests: any using request

c. ONLY_ONE_TRAFFIC_TYPE_IF_SUB_TOTALS_BY_REGULATION_DETAILS

Only one traffic type can be requested in trafficTypes when subTotalComputeMode is

SUB_TOTALS_BY_REGULATION_DETAILS .

Constrained attributes: trafficTypes, subTotalComputeMode

Constrained requests: any using request

d. INVALID_QUERY_PERIOD_RANGE

The DatasetType from which the traffic counts are requested and the trafficWindow must be
set according to the following rules:

1. if the DatasetType is equals to FORECAST the trafficWindow shall be defined within the
range [ yesterday 21:00 UTC .. today+5d ]

2. if the DatasetType is equals to OPERATIONAL the trafficWindow shall be defined within

the range [ yesterday .. tomorrow ]

Constrained attributes: trafficWindow, dataset

Constrained requests: any using request

Edition: 27.0 6 1592

Document Title: NM 27.0 - NM B2B Reference Manual

e. INVALID_SUB_TOTAL_COMPUTE_MODE

The subTotalComputeMode can be set to SUB_TOTALS_BY_REGULATION_DETAILS only for

TrafficCountsByMeasureRequest and when TrafficCountsByMeasureRequest.measureId is of type
REGULATION.

Constrained attributes: subTotalComputeMode

Constrained requests: any using request

20.9.270. TrafficVolumeActivationPlan
<<class>>

Activation plan for a given traffic volume on a given day.

A TrafficVolumeActivation plan is a special plan in the sense that, there can be cases where there is
no data known. So there exist traffic volumes for which there is no data at all or only for some
periods. In addition, non-activation is not defined in CACD. Therefore the absence of CACD data
(NO_DATA datasource) means either no data known or in-active. Either way, the absence of data is
considered by NM systems as an in-active traffic volume. In addition, sector configuration
activations (tactically updated or CACD defined) also over-rule CACD activations of a traffic volume.
They can activate or de-activate a traffic volume (also marked by AIRSPACE datasource). The above
activations can be over-ruled (set active or in-active) by the tactical updates (B2B or HMI). In
addition regulation measures can activate a traffic volume (over-ruling either CACD or B2B/HMI
updates). The consolidated info can be found back in the nmSchedule attribute.

So the (de-)activation of a traffic volume is determined hierarchically by NO_DATA (least priority),

CACD (including derived from sector config), tactical updates (a.o. via B2B) , regulation measures
(highest priority). In the client schedule the non regulated traffic volumes activations are
maintained (just in case the regulation can be cancelled before the end of its applicability period).

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources (including NO_DATA data source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values/sector configuration derived activation) or limited to the (full list) of (pre-
)tactical updates with the gaps marked as AIRSPACE (meaning in update context: NO_DATA or CACD
or derived from sector config) datasource (to obtain a complete time partition).

In any case, periods marked with datasource AIRSPACE in the time partition correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the
NO_DATA/CACD/"derived from sector config" definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. TrafficVolumeId trafficVolume (Mandatory)

Traffic volume to which this activation plan applies.

Edition: 27.0 6 1593

Document Title: NM 27.0 - NM B2B Reference Manual

b. set< PlannedTrafficVolumeActivation > nmSchedule (Contextual)

The plan resulting from the superimposition of all constraints from all data sources, which
the NM system is using as plan for its own calculations.

The NM schedule exposes the complete time partition of the configurations for the day, i.e.
the data coming from the various data sources contributing to the NM view of the plan:
these data sources are defined in PlanDataSource.

The NM schedule cannot be updated directly by the caller; it is the outcome of updates via
the various data sources.

In nmSchedule the possible values of dataSource are limited to NO_DATA , AIRSPACE , TACTICAL and
MEASURE.

Note that NO_DATA in nmClientSchedule means either inactive or that no data has been
specified.

i. Presence:

▪ Must be null in CapacityPlanUpdateRequest OTMVPlanUpdateRequest

RestrictionActivationPlanUpdateRequest RunwayConfigurationPlanUpdateRequest
SectorConfigurationPlanUpdateRequest TrafficVolumeActivationPlanUpdateRequest

▪ Mandatory otherwise

c. set< PlannedTrafficVolumeActivation > clientSchedule (Mandatory)

(Pre-)tactical traffic volume activations associated to their applicability period, as

maintained by the client. This plan contains only the updated configurations together with
an indication (AIRSPACE datasource) that the default CACD/sector config derived values
apply when not updated (see PlanDataSource). The actual activity for these airspace
datasource periods can be found in the nmSchedule

In an update context, the clientSchedule can be complete (if the B2B client designer decided
to overwrite the default CACD values) or limited to the actual differences with regards to the
AIRSPACE defaults. This is a B2B client designer’s decision and depends on how CACD wants
to be used in combination with the B2B. If the clientSchedule only contains the actual
differences with regards to the AIRSPACE defaults, then the clientschedule still needs to
contain the full list of (pre-) tactical updates and for the non (pre-) tactically updated
periods, an explicit indication that the AIRSPACE values need to be used (but without
repeating the NO_DATA/CACD/sector config derived values themselves). So in any case, the
clientschedule needs to be a complete time partition for the full day.

In any case, it is of drastic importance to understand that an entry in the schedule (i.e. a
period) overwrites all CACD/sector config derived values in that period.

The possible values of dataSource are limited to AIRSPACE and TACTICAL - the AIRSPACE value
meaning that the value associated to the applicabilityPeriod is the CACD one (i.e. CACD or
the TV activation derived from a sector configuration or that there is no data defined in
CACD), and the TACTICAL value meaning that this plan entry corresponds to the explicit

Edition: 27.0 6 1594

Document Title: NM 27.0 - NM B2B Reference Manual

tactical update expressed via active.

i. Constraints:

▪ TrafficVolumeActivationPlan.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

clientSchedule has gaps and/or overlaps in the time partition or is not covering exactly one
day.

Constrained attributes: clientSchedule

Constrained requests: any using request

20.9.271. TrafficVolumeActivationPlanRetrievalReplyData
<<class>>

The TrafficVolumeActivationPlanRetrievalReply payload.

1. Attributes:

a. TrafficVolumeActivationPlans plans (Mandatory)

The complete activation plans for a given traffic volumes on a given day.

2. Used by: TrafficVolumeActivationPlanRetrievalReply

20.9.272. TrafficVolumeActivationPlans
<<class>>

Activation plans for one or more traffic volumes on a given day.

A TrafficVolumeActivation plans contains a map of a special plan in the sense that, there can be
cases where there is no data known. So there exist traffic volumes for which there is no data at all
or only for some periods. In addition, non-activation is not defined in CACD. Therefore the absence
of CACD data (NO_DATA datasource) means either no data known or in-active. Either way, the
absence of data is considered by NM systems as an in-active traffic volume. In addition, sector
configuration activations (tactically updated or CACD defined) also over-rule CACD activations of a
traffic volume. They can activate or de-activate a traffic volume (also marked by AIRSPACE
datasource). The above activations can be over-ruled (set active or in-active) by the tactical updates
(B2B or HMI). In addition regulation measures can activate a traffic volume (over-ruling either
CACD or B2B/HMI updates). The consolidated info can be found back in the nmSchedule attribute.

So the (de-)activation of a traffic volume is determined hierarchically by NO_DATA (least priority),

CACD (including derived from sector config), tactical updates (a.o. via B2B) , regulation measures
(highest priority). In the client schedule the non regulated traffic volumes activations are
maintained (just in case the regulation can be cancelled before the end of its applicability period).

Edition: 27.0 6 1595

Document Title: NM 27.0 - NM B2B Reference Manual

In a retrieval context, the plan is said to be 'complete' in the sense that it contains all the plan
entries from all involved data sources (including NO_DATA data source in case no info is known).

In an update context, the plan can be complete (if the B2B client designer decided to overwrite the
default CACD values/sector configuration derived activation) or limited to the (full list) of (pre-
)tactical updates with the gaps marked as AIRSPACE (meaning in update context: NO_DATA or CACD
or derived from sector config) datasource (to obtain a complete time partition).

In any case, periods marked with datasource AIRSPACE in the time partition correspond to
removing any potential (pre-)tactical update and hence reset the corresponding values to the
NO_DATA/CACD/"derived from sector config" definition for that period.

1. Inherits from: TacticalConfigurationPlan

2. Attributes:

a. map< TrafficVolumeId, PlannedTrafficVolumeActivations > tvActivations (Mandatory)

A map of Traffic volumes as keys mapped to its capacities.

i. Constraints:

▪ TrafficVolumeActivationPlans.INCOMPLETE_SCHEDULE

3. Constraints:

a. INCOMPLETE_SCHEDULE

tvCapacities.clientSchedule has gaps and/or overlaps in the time partition or is not covering
exactly one day.

Constrained attributes: tvActivations

Constrained requests: any using request

4. Used by: TrafficVolumeActivationPlanUpdateReplyData,

TrafficVolumeActivationPlanRetrievalReplyData, TrafficVolumeActivationPlanUpdateRequest

20.9.273. TrafficVolumeActivationPlanUpdateReplyData
<<class>>

The TrafficVolumeActivationPlanUpdateReply payload.

1. Attributes:

a. TrafficVolumeActivationPlans plans (Mandatory)

The complete traffic volume activation plans for a given traffic volumes on a given day,
resulting from the update.

2. Used by: TrafficVolumeActivationPlanUpdateReply

Edition: 27.0 6 1596

Document Title: NM 27.0 - NM B2B Reference Manual

20.9.274. TrafficVolumeLocation
<<class>>

Details the location at which a measure applies.

1. Inherits from: Location

2. Attributes:

a. ReferenceLocation referenceLocation (Contextual)

The reference location of the traffic volume to which the measure applies.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

b. TrafficVolumeId id (Mandatory)

The traffic volume to which the measure applies.

c. FlightLevelRange flightLevels (Contextual)

Flight level range of the traffic volume to which this measure applies.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

d. string description (Contextual)

The traffic volume description to which the measure applies.

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

ii. Constraints:

▪ Max length: 500

▪ Max length inclusive: true

e. set< TrafficVolumeSetId > setIds (Contextual)

The set of traffic volume sets containing the traffic volume to which this measure applies.

Edition: 27.0 6 1597

Document Title: NM 27.0 - NM B2B Reference Manual

i. Presence:

▪ Must be null in RegulationCreationRequest RegulationProposalFilingRequest

RegulationProposalUpdateRequest RegulationUpdateRequest ReroutingCreationRequest
ReroutingUpdateRequest
▪ Optional otherwise

ii. Constraints:

▪ set size range : [1, 200]

3. Used by: RegulationOrMCDMOnly

20.9.275. TrafficVolumeScenarios
<<class>>

For a traffic volume, represents the scenario’s (from the NM scenario repository) that contain
measures (regulation or rerouting) based on that traffic volume.

Typically when the end-user has an overload on a "problem" traffic volume, then he wants to see
which scenarios (solutions) can be applied to off-load that "problem" traffic volume. Those
scenarios might be based on different traffic volumes that e.g. overlap with the "problem" traffic
volume (e.g. in case the current sector configuration has grouped some sectors together).

This class represents the different scenarios that have measures on one such scenario traffic
volume (i.e. solution traffic volume).

Note that a scenario can have multiple measures : for example a contingency scenario contains
multiple measures (on different traffic volumes) that can be used to handle the contingency. When
such a scenario is applied one or more measures of the scenario are applied (but not necessarily all
measures of the scenario).

The retrieveRegulationsFromScenario and retrieveReroutingsFromScenario services (flow) can

then be used to retrieve the applicable measures themselves from these scenarios.

The applicable measures are those measures that have as trafficVolumeId , the
solutionTrafficVolumeId . Those measures can then be applied via B2B in a NM simulation (to
evaluate the impact) or can be requested for implementation via the fileRegulationProposal ,
createRegulation and createRerouting service requests. (See general text on scenario repository in
flow (below))

The queryScenarioRepository can be used to retrieve the details about the scenarios.

The trafficVolumeMatchingKind describes how the solution traffic volume relates to the problem
traffic volume (e.g. they are both traffic volumes on the same reference location or they are
overlapping or … (see TrafficVolumeMatchingKind).

1. Attributes:

a. TrafficVolumeId solutionTrafficVolumeId (Mandatory)

Edition: 27.0 6 1598

Document Title: NM 27.0 - NM B2B Reference Manual

The (solution) traffic volume of the concerned scenario measures.

b. ScenarioTrafficVolumeMatchingKind trafficVolumeMatchingKind (Mandatory)

Describes how the solutionTrafficVolumeId relates to the problem traffic volume (e.g. they
are both traffic volumes on the same reference location or they are overlapping or …(See for
more info : ScenarioTrafficVolumeMatchingKind )).

c. set< ScenarioId > scenarios (Mandatory)

The list of scenarios that contain measures on solutionTrafficVolumeId .

i. Constraints:

▪ set size range : [1, unbounded[

2. Used by: Flight, Flow

20.9.276. UpdateFlightInMeasure
<<class>>

Add, remove or update a flight in a measure. flightUpdate describes the different kind of operations
supported on a flight.

1. Attributes:

a. FlightKeys flightKeys (Mandatory)

The flight keys.

b. UpdateFlightInMeasureChoice flightUpdate (Mandatory)

Updates a flight immediately (e.g., in a simulation)

For example, it allows to:

▪ force/unforce the CTOT, or

▪ include/exclude the flight from one or more regulations, or

▪ add/remove a flight to/from a measure.

i. Access control:

▪ set flightUpdate.forceFlightInRegulation requires write access to /flights#ctot

▪ set flightUpdate.unforceFlightInRegulation requires write access to /flights#ctot

▪ set flightUpdate.excludeFlightInRegulation requires write access to

/regulations#excluded_flights
▪ set flightUpdate.reincludeFlightInRegulation requires write access to
/regulations#excluded_flights
▪ set flightUpdate.addFlightToRerouting requires write access to
/reroutings#captured_flights

Edition: 27.0 6 1599

Document Title: NM 27.0 - NM B2B Reference Manual

▪ set flightUpdate.removeFlightFromRerouting requires write access to

/reroutings#captured_flights
2. Used by: UpdateFlightsInMeasureReplyData, UpdateFlightsInMeasureRequest

20.9.277. UpdateFlightInMeasureChoice
<<union>>

Describes the different kind of operations supported on a flight in the context of an

UpdateFlightInMeasure .

1. Choices:

a. ReroutingId addFlightToRerouting

Add a flight to a cherry picked rerouting.

b. ReroutingId removeFlightFromRerouting

Remove a flight from a rerouting.

c. ForceFlightInRegulation forceFlightInRegulation

Force a flight in a regulation or add a flight to a cherry picked regulation (by forcing).

d. RegulationId unforceFlightInRegulation

Unforce a forced flight in a regulation or remove a flight from a cherry picked regulation (by
unforcing it will become exempted again).

In simulations it directly unforces a forced flight.

Typically in operational dataset context, one needs to submit a proposal for NMOC to
review: in the context of a proposal cherry picked regulation (See fileRegulationProposal
service) or in the context of modifying the CTOT of a flight in a normal (non-cherry-picked)
regulation (using the createEhelpdeskTicket service).

e. ExcludeReIncludeFlightInRegulation excludeFlightFromRegulation

Exclude a flight from one or more regulations.

f. ExcludeReIncludeFlightInRegulation reIncludeFlightInRegulation

Re-include a flight in one or more regulations from which the flight is excluded.

2. Used by: UpdateFlightInMeasure

20.9.278. UpdateFlightsInMeasureReplyData
<<class>>

The UpdateFlightsInMeasureReply payload.

Edition: 27.0 6 1600

Document Title: NM 27.0 - NM B2B Reference Manual

1. Attributes:

a. set< UpdateFlightInMeasure > updatedFlights (Optional)

Flights added successfully to the measure.

i. Constraints:

▪ set size range : [1, 100]

b. map< FlightKeys, string > unsuccessfullyUpdatedFlights (Optional)

A reason description is given for every flight that was not updated successfully.

i. Constraints:

▪ map size range : [1, 100]

2. Used by: UpdateFlightsInMeasureReply

20.9.279. UserManagedSimulation
<<class>>

Documentation last updated: 27.0 - Edition 2

The simulation is managed (start/stop) and prepared by the users (via B2B & B2C) to simulate some
measures and evaluate their effect.

In addition the user can request other users or NMOC to have a look at proposed solution or to
contribute to the simulation.

The simulation type associated to the dataset’s simulation is USER_MANAGED_SIMULATION.

1. Inherits from: Simulation

2. Attributes:

a. DatasetReference datasetReference (Mandatory)

The reference on which this simulation is based (i.e. from which environment data has been
copied and where initially the flights and measures have been copied from).

i. Constraints:

▪ UserManagedSimulation.INVALID_DATASET_REFERENCE_TYPE

b. UserId creator (Optional)

The B2B or B2C user that created (started) the simulation.

c. AirNavigationUnitId creatorANUId (Optional)

The ANU identifier of the creator.

3. Constraints:

Edition: 27.0 6 1601

Document Title: NM 27.0 - NM B2B Reference Manual

a. INVALID_DATASET_REFERENCE_TYPE

DatasetReference.type must be OPERATIONAL or FORECAST .

Constrained attributes: datasetReference

Constrained requests: any using request

b. INVALID_SIMULATION_IDENTIFIER_TYPE

SimulationIdentifier.simulationType must be USER_MANAGED_SIMULATION .

Constrained attributes: dataset

Constrained requests: any using request

4. Used by: SimulationStartReplyData, SimulationStartRequest

Appendix N: AIRM Semantic Correspondence

• ATFCMSituationDelays.enRouteDelay

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:EnRouteDelay@del
ay

• ATFCMSituationRegulation.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• ATFCMSituationRegulation.period

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@startValidity

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@endValidity

• ATFCMSituationRegulation.trafficVolumeId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:TrafficVolume (additional)

• ATFCMSituationRegulation.regulationState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType

• ATFCMSituationRegulation.regulationReason

Edition: 27.0 6 1602

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType

• ATFCMSituationRegulation.protectedAerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• Counts.totalCounts

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount@countValue

• Counts.flowCounts

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount@countValue

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:Flow (additional)

• Counts.subTotalsCountsByTrafficType

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount@countValue

• CountsCalculationType.ENTRY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeC
ountCalculationType@ENTRY_COUNT

• CountsCalculationType.OCCUPANCY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeC
ountCalculationType@OCCUPANCY_COUNT

• CountsCalculationTypeAndInterval.calculationType

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeC
ountCalculationType

• EhelpDeskAddFlightsInFmpStamRerouting.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• EhelpDeskForceFlightInRegulation.newCto

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa

Edition: 27.0 6 1603

Document Title: NM 27.0 - NM B2B Reference Manual

pacityBalancing:ATFMDepartureSlot@ctot

• EhelpDeskForceFlightInRegulation.newCtot

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@ctot

• EhelpDeskForceFlightsInRegulation.mostPenalisingRegulation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation

• EhelpDeskForceFlightsInRegulation.flights

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMMeasure@concernedFlight

• EhelpDeskRemoveFlightsFromFmpStamRerouting.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• EhelpDeskTicketFlightInfo.ctot

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@ctot

• EhelpDeskTicketFlightInfo.mostPenalisingRegulation

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation

• EhelpDeskTicketResponseDetails.responseFlightInfo

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Flight

• FlightAtfcmMcdmOnlyLocation.mcdmOnlyMeasureId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• FlightAtfcmMeasureLocation.measureSubType

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType

• FlightAtfcmMeasureLocation.hotspotId

Edition: 27.0 6 1604

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMHotspot (additional)

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ae
rodromeHotSpot (additional)

• FlightAtfcmRegulationLocation.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• FlightAtfcmReroutingLocation.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• FlightAtfcmReroutingLocation.reroutingApplyKind

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingApplicationType

• FlightAtfcmReroutingLocation.reroutingPurpose

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:ATFMBehaviour@tacticalRero
utingReason

• FlightHotspotLocation.hotspot

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMHotspot

• FlightRegulationLocation.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• Flow.id

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:Flow (additional)

• FlowRoleSelection.INCLUDED

Edition: 27.0 6 1605

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeF
lowCombinationRoleType@INCLUDED

• FlowRoleSelection.EXCLUDED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeF
lowCombinationRoleType@EXCLUDED

• FlowRoleSelection.EXEMPTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeF
lowCombinationRoleType@EXEMPTED

• FlowRoleSelection.INCLUDED_AND_EXEMPTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeF
lowCombinationRoleType@INCLUDED_EXEMPTED

• FlowType.LINKED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeLinkedFlow@role

• ForceFlightInRegulation.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• ForceFlightInRegulation.newCtot

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@ctot

• GroupReroutingSummary.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• Hotspot.hotspotId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMHotspot (additional)

• Hotspot.severity

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code

Edition: 27.0 6 1606

Document Title: NM 27.0 - NM B2B Reference Manual

ATFMHotspotSeverityType

• Hotspot.status

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotStatusType

• Hotspot.remark

urn:aero:airm:1.0.0:LogicalModel:Abstract:LinguisticNote@note

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK
(additional)

• HotspotId.trafficVolume

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMHotspot@tfv

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume@designator (additional)

• HotspotSeverity.HIGH

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType@HIGH

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType (additional)

• HotspotSeverity.MEDIUM

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType@MEDIUM

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType (additional)

• HotspotSeverity.LOW

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType@LOW

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotSeverityType (additional)

• HotspotStatus.DRAFT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotStatusType@DRAFT

Edition: 27.0 6 1607

Document Title: NM 27.0 - NM B2B Reference Manual

• HotspotStatus.ACTIVE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotStatusType@ACTIVE

• HotspotStatus.SOLVED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotStatusType@SOLVED

• HotspotStatus.ACCEPTABLE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMHotspotStatusType@ACCEPTABLE

• LevelAndSpeedReroutingConstraint.level

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingConstraintType@LEVEL_ADAPT

• LevelAndSpeedReroutingConstraint.airSpeed

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:FlightEvent:SpeedChange@spe
ed

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:SpeedConstraint@r
equiredSpeedChange (additional)

• LifeCycleEventType.DELETION

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

• MCDMApprovalState.UNKNOWN

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationApprovalStatusType@APPROVAL_STATUS_UNKNOWN

• MCDMApprovalState.APPROVED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationApprovalStatusType@APPROVED

• MCDMApprovalState.REJECTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationApprovalStatusType@REJECTED

• MCDMCoordinationLevel.FLIGHT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationLevelType@ACTION_ON_FLIGHT

Edition: 27.0 6 1608

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationLevelType@ACTION_ON_FLIGHT?

• MCDMCoordinationLevel.MEASURE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationLevelType@MEASURE

• MCDMDeadlines.timeToCoordinate

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination@timeToCoordinate

• MCDMDeadlines.timeToStartImplement

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination@timeToStartImplementation

• MCDMDeadlines.timeToImplement

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination@timeToImplement

• MCDMMeasureTopic.remark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK

• MCDMRole.INFO

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@INFO

• MCDMRole.ROLE_INFO

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@ROLE_INFO

• MCDMRole.APPROVAL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@APPROVAL

• MCDMRole.IMPLEMENTER

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@IMPLEMENTER

• MCDMRole.INITIATOR

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@INITIATOR

Edition: 27.0 6 1609

Document Title: NM 27.0 - NM B2B Reference Manual

• MCDMRole.NOT_INVOLVED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@NOT_INVOLVED

• MCDMRoleUserCategory.coordinationLevel

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationLevelType

• MCDMRoleUserCategory.role

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@role

• MCDMState.DRAFT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@DRAFT

• MCDMState.PROPOSED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@PROPOSED

• MCDMState.COORDINATED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@COORDINATED

• MCDMState.IMPLEMENTING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@IMPLEMENTING

• MCDMState.IMPLEMENTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@IMPLEMENTED

• MCDMState.ABANDONED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@ABANDONNED

• MCDMState.INTERRUPTED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@INTERRUPTED

• MCDMState.FINISHED

Edition: 27.0 6 1610

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType@FINISHED

• MCDMStatefulTopic.measureId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• MCDMStatefulTopic.initiator

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationActorRoleType@INITIATOR

• MCDMStateUpdateReplyData.newMCDMState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationStatusType

• MCDMTopic.dataId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• MCDMUserAndRole.user

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit

• MCDMUserAndRole.role

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@role

• MCDMUserCategory.ALL_FMP

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Codelists:CodeUnitType@FMP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@userCategory (additional)

• MCDMUserCategory.TOWER

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Codelists:CodeUnitType@TWR

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@userCategory (additional)

• MCDMUserCategory.NMOC

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Codelists:CodeUnitType@NMOC

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@userCategory (additional)

• MCDMUserRoleAndApprovalState.user

Edition: 27.0 6 1611

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit

• MCDMUserRoleAndApprovalState.role

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordinationUserCategoryInvolvement@role

• MCDMUserRoleAndApprovalState.approvalState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationApprovalStatusType

• Measure.externallyEditable

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMMeasure@isExternallyEditable

• Measure.createdByFMP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMMeasure@isCreatedByFMP

• Measure.mcdmRequired

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMMeasure@isMCDMRequired

• Measure.sourceHotspot

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMHotspot (additional)

• Measure.mcdmInfo

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:MCDMCoordination

• MeasureFromScenarioRepository.measureId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• MeasureId.REGULATION

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:ATFMRegulation (additional)

• MeasureId.REROUTING

Edition: 27.0 6 1612

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• MeasureIdAndTV.measureId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• MeasureIdAndTV.tvId

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume@designator

• MeasureListRequest.tvs

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMHotspot@tfv

• MeasureListRequest.tvSets

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeSet

• MeasureSubType.GROUND_DELAY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@GROUND_DELAY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.TAKE_OFF_NOT_BEFORE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@TAKE_OFF_NOT_BEFORE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.TAKE_OFF_NOT_AFTER

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@TAKE_OFF_NOT_AFTER

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.MINIMUM_DEPARTURE_INTERVAL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code

Edition: 27.0 6 1613

Document Title: NM 27.0 - NM B2B Reference Manual

ATFMMeasureType@MINIMUM_DEPARTURE_INTERVALS

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.MILES_MINUTES_IN_TRAIL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@MILES_MINUTES_IN_TRAIL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.GROUND_LEVEL_CAP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@GROUND_LEVEL_CAP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.AIRBORNE_LEVEL_CAP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@AIRBORNE_LEVEL_CAP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.AIRBORNE_HORIZONTAL_REROUTING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@AIRBORNE_HORIZONTAL_REROUTING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• MeasureSubType.TERMINAL_PROCEDURE_CHANGE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType@TERMINAL_PROCEDURE_CHANGE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureType (additional)

• NetworkImpactAssessmentRetrievalReplyData.countsChanges

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount

• NetworkImpactFlightData.mostPenalisingRegulation

Edition: 27.0 6 1614

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMDepartureSlot@mostPenalisingRegulation

• NetworkImpactFlightRegulationChange.regulationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• OTMV.trafficVolume

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeSet@tfv

• OTMV.otmvDuration

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@elapsed

• OTMV.peak

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@peakThreshold

• OTMV.sustained

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@sustainedThreshold

• OTMV.remark

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK

• OtmvAlert.period

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@startValidity

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@endValidity

• OTMVPlan.trafficVolume

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeSet@tfv

• OTMVPlans.tvsOTMVs

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume@otmv

• OTMVThresholds.peakThreshold

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@peakThreshold

Edition: 27.0 6 1615

Document Title: NM 27.0 - NM B2B Reference Manual

• OTMVThresholds.sustainedThreshold

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@sustainedThreshold

• OTMVWithDuration.trafficVolume

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeSet@tfv

• OTMVWithDuration.otmvDuration

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:OccupancyTrafficMonitoringValue@elapsed

• PlannedCapacity.capacity

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCapacityBalancing:
Capacity

• PlannedOTMV.otmv

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume@otmv

• PlannedRestrictionActivation.dataSource

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@source

• PlannedRunwayConfigurations.runwayConfigurations

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:RunwayConfiguration

• PlannedSectorConfigurationActivation.sectorConfigurationId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:ATMBusinessTerms:EU:sector_configurati
on (additional)

• PlannedTrafficVolumeActivation.active

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeActivation

• Regulation.regulationState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType

• RegulationCause.reason

Edition: 27.0 6 1616

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@regulationCause

• RegulationCause.iataDelayCode

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@iataDelayCode

• RegulationExceptionalConstraint.runwayVisualRange

urn:aero:airm:1.0.0:LogicalModel:Subjects:Meteorology:RunwayVisualRange

• RegulationInitialConstraint.equipmentRate

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:RegulationRate@equipmentRate

• RegulationLocationCategory.ARRIVAL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseLocationCategoryType@ARRIVAL

• RegulationLocationCategory.DEPARTURE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseLocationCategoryType@DEPARTURE

• RegulationLocationCategory.ENROUTE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseLocationCategoryType@ENROUTE

• RegulationOrMCDMOnly.reason

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@regulationCause

• RegulationOrMCDMOnly.location

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ReferenceLocation

• RegulationOrMCDMOnly.remark

urn:aero:airm:1.0.0:LogicalModel:Abstract:LinguisticNote@note

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK
(additional)

• RegulationOrMCDMOnly.linkedRegulations

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa

Edition: 27.0 6 1617

Document Title: NM 27.0 - NM B2B Reference Manual

pacityBalancing:ATFMRegulation@linkedRegulation

• RegulationOrMCDMOnly.noDelayWindow

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@noDelayWindow

• RegulationOrMCDMOnly.updateCapacityRequired

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@isCapacityUpdateRequired

• RegulationOrMCDMOnly.updateTVActivationRequired

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@isTFVActivationUpdateRequired

• RegulationOrMCDMOnly.delayTVSet

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolumeSet

• RegulationOrMCDMOnlyListRequest.regulations

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@designator (additional)

• RegulationProposal.kind

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationProposal.approvalState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
MCDMCoordinationApprovalStatusType

• RegulationProposal.mcdmState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType

• RegulationProposal.regulationState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType

Edition: 27.0 6 1618

Document Title: NM 27.0 - NM B2B Reference Manual

• RegulationProposalAction.CANCELLATION

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeCoordinationRea
sonType@CANCELLATION

• RegulationReason.ACCIDENT_INCIDENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ACCIDENT_INCIDENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ATC_CAPACITY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ATC_CAPACITY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.AERODROME_SERVICES

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@DEICING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.AERODROME_CAPACITY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@AERODROME_CAPACITY

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ATC_INDUSTRIAL_ACTION

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ATC_INDUSTRIAL_ACTION

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.NON_ATC_INDUSTRIAL_ACTION

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@NON_ATC_INDUSTRIAL_ACTION

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR

Edition: 27.0 6 1619

Document Title: NM 27.0 - NM B2B Reference Manual

egulationCauseType (additional)

• RegulationReason.WEATHER

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@WEATHER

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.AIRSPACE_MANAGEMENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@AIRSPACE_MANAGEMENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.SPECIAL_EVENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@SPECIAL_EVENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ATC_ROUTINGS

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ATC_ROUTINGS

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ATC_STAFFING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ATC_STAFFING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ATC_EQUIPMENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ATC_EQUIPMENT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationReason.ENVIRONMENTAL_ISSUES

Edition: 27.0 6 1620

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType@ENVIRONMENTAL_ISSUES

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
egulationCauseType (additional)

• RegulationState.APPLYING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@APPLYING

• RegulationState.APPLIED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@APPLIED

• RegulationState.CANCELLING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@CANCELLING

• RegulationState.CANCELLED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@CANCELLED

• RegulationState.TERMINATED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@TERMINATED

• Rerouting.reroutingId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• Rerouting.flowId

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:Flow (additional)

• Rerouting.reroutingApplyKind

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting@tacticalReroutingApplicationType

• Rerouting.reroutingPurpose

Edition: 27.0 6 1621

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:ATFMBehaviour@tacticalRero
utingReason

• Rerouting.reroutingState

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingStatusType

• Rerouting.sourcesAndConstraints

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:LateralConstraint?

• Rerouting.remark

urn:aero:airm:1.0.0:LogicalModel:Abstract:LinguisticNote@note

urn:aero:airm:1.0.0:LogicalModel:Subjects:Common:Codelists:CodeNotePurposeType@REMARK
(additional)

• ReroutingApplyKind.EXECUTE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingApplicationType@EXECUTE

• ReroutingApplyKind.FOR_INDICATION_WITHOUT_AUTOMATIC_PROPOSAL_FLIGHT

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingApplicationType@FOR_INDICATION_WITHOUT_AUTOMATIC_PROPOSAL_FLIG
HT

• ReroutingApplyKind.FOR_INDICATION_WITH_AUTOMATIC_RRP

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingApplicationType@FOR_INDICATION_WITH_AUTOMATIC_RRP

• ReroutingApplyKind.FOR_INDICATION_WITH_AUTOMATIC_RRN

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingApplicationType@FOR_INDICATION_WITH_AUTOMATIC_RRN

• ReroutingCancelReplyData.rerouting

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting

• ReroutingCreationReplyData.rerouting

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting

• ReroutingListReplyData.reroutings

Edition: 27.0 6 1622

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting

• ReroutingMeasureState.ACTIVATING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@ACTIVATING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType (additional)

• ReroutingMeasureState.APPLIED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@APPLIED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType (additional)

• ReroutingMeasureState.CANCELLING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@CANCELLING

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType (additional)

• ReroutingMeasureState.CANCELLED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType@CANCELLED

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:Code
ATFMMeasureStatusType (additional)

• ReroutingPurpose.ATFCM

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingReasonType@ATFM

• ReroutingSourcesAndConstraints.horizontalReroutingSourcesAndConstraints

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:LateralConstraint

• ReroutingSourcesAndConstraints.useVerticalOrSpeedReroutingSource

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:SpeedConstraint

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:Movement:VerticalConstraint

• ReroutingSourcesAndConstraints.manualReroutingConstraints

Edition: 27.0 6 1623

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting@manualReroutingConstraint

• ReroutingSourcesAndConstraints.reroutingConstraintSets

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeT
acticalReroutingConstraintType

• ReroutingUpdateReplyData.rerouting

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting

• RunwayConfiguration.runway

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ru
nway (additional)

• RunwayConfiguration.departureTaxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

urn:aero:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:AerodromeOperations:Dep
artureOperations (additional)

• RunwayConfiguration.timeToInsertInSequence

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:RevisionTimes@timeToInsertI
nSequence

• RunwayConfiguration.timeToRemoveFromSequence

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:Flight:RevisionTimes@timeToRemov
eFromSequence

• RunwayConfiguration.arrivalTaxiTime

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfras
tructure:TaxiRoute@taxiTime

• RunwayConfigurationPlan.aerodrome

urn:aero:airm:1.0.0:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodr
ome@locationIndicatorICAO

• RunwayConfigurationPlan.knownRunwayIds

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

Edition: 27.0 6 1624

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:ConceptualModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Ru
nway (additional)

• RunwayUsage.DEPARTURE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
unwayDirectionOperationModeType@DEPARTURE_ONLY

• RunwayUsage.ARRIVAL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
unwayDirectionOperationModeType@ARRIVAL_ONLY

• RunwayUsage.DEPARTURE_ARRIVAL

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
unwayDirectionOperationModeType@MIXED_MODE

• RunwayUsage.INACTIVE

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:Codelists:CodeR
unwayDirectionOperationModeType@CLOSED

• ScenarioPublicationStatus.DRAFT

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

• ScenarioPublicationStatus.PUBLISHED

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@lifecycleStageStatus

• ScenarioRegulationRetrievalReplyData.regulations

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:ATFMRegulation@designator

• ScenarioReroutingRetrievalReplyData.reroutings

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

• SectorConfigurationPlan.airspace

urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Airspace:Airspace@designato
r

• SimulationAvailability.simulatablePeriod

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@startValidity

urn:aero:airm:1.0.0:LogicalModel:Abstract:TemporalEnabledEntity@endValidity

• SubTotalsTrafficCountsType.PFD

Edition: 27.0 6 1625

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@PFD

• SubTotalsTrafficCountsType.IFPL

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@IFPL

• SubTotalsTrafficCountsType.SUSPENDED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@SUS
PENDED

• SubTotalsTrafficCountsType.ATC_ACTIVATED

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@ATC
_ACTIVATED

• SubTotalsTrafficCountsType.TACT_ACTIVATED_WITH_FSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@TAC
T_ACTIVATED_WITH_FSA

• SubTotalsTrafficCountsType.TACT_ACTIVATED_WITHOUT_FSA

urn:aero:airm:1.0.0:LogicalModel:Subjects:Flight:Codelists:CodeFlightStatusForCountType@TAC
T_ACTIVATED_WITHOUT_FSA

• TrafficCountsReplyData.flows

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount@countLocation

• TrafficCountsReplyData.counts

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficCount

• TrafficVolumeActivationPlan.trafficVolume

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume

• TrafficVolumeLocation.id

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:TrafficVolume (additional)

• TrafficVolumeLocation.setIds

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

Edition: 27.0 6 1626

Document Title: NM 27.0 - NM B2B Reference Manual

urn:aero:ses:eurocontrol:airm:1.0.0:ConceptualModel:Subjects:AirTrafficOperations:DemandAn
dCapacityBalancing:TrafficVolumeSet (additional)

• TrafficVolumeScenarios.solutionTrafficVolumeId

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TrafficVolume

• UpdateFlightInMeasureChoice.addFlightToRerouting

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• UpdateFlightInMeasureChoice.removeFlightFromRerouting

urn:aero:airm:1.0.0:LogicalModel:Abstract:Entity@identifier

urn:aero:ses:eurocontrol:airm:1.0.0:LogicalModel:Subjects:AirTrafficOperations:DemandAndCa
pacityBalancing:TacticalRerouting (additional)

• UserManagedSimulation.creatorANUId

urn:aero:airm:1.0.0:LogicalModel:Subjects:Stakeholders:Stakeholder:Unit@designator

Appendix O: Default Settings

1. This section summarise the default settings currently applied by NM.

The threshold values provided in the tables below are subject to change
at any given time. Communication about threshold value’s change shall
be done via an announcement on the NM B2B services OneSky Team site.
This includes emails to all SPOCs having raised such an alert in the NM
IMPORTANT
B2B services OneSky Team site. NM reserves the right to modify these
threshold values in case critical operational services are jeopardised by
heavy usage, misuse or abuse, in order to ensure the continuity of these
essential services.

20.O.1. Request / Reply Settings

Table 59. Compression settings

Parameter (unit) Value Description

REPLY COMPRESSION THRESHOLD 4 The threshold value above which NM B2B
(KB) compresses a reply if demanded by the client
application

Edition: 27.0 6 1627

Document Title: NM 27.0 - NM B2B Reference Manual

20.O.2. Time Window Request / Reply Count Quotas

Table 60. TrafficCounts Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

TrafficCountsByAircraf 300 360 600

tOperatorRequest/Reply

TrafficCountsByAerodro 300 360 600

meRequest/Reply

TrafficCountsByAerodro 300 360 600

meSetRequest/Reply

TrafficCountsByAirspac 300 360 600

eRequest/Reply

TrafficCountsByPointRe 300 360 600

quest/Reply

TrafficCountsByTraffic 600 720 600

VolumeRequest/Reply

TrafficCountsByMeasure 600 720 600

Request/Reply

Table 61. Measures Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

RegulationListRequest/ 150 180 600

Reply

RegulationCreationRequ 30 36 60
est/Reply

RegulationUpdateReques 30 36 60
t/Reply

RegulationCancelReques 30 36 60
t/Reply

RegulationProposalList 30 36 60
Request/Reply

RegulationProposalFili 30 36 60
ngRequest/Reply

RegulationProposalUpda 30 36 60
teRequest/Reply

RegulationProposalRevo 30 36 60
cationRequest/Reply

ReroutingListRequest/R 150 180 600

eply

ReroutingCreationReque 30 36 60
st/Reply

Edition: 27.0 6 1628

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

ReroutingUpdateRequest 30 36 60
/Reply

ReroutingCancelRequest 30 36 60
/Reply

MeasureOpLogRetrievalR 30 36 60
equest/Reply

UpdateFlightsInMeasure 30 36 60
Request/Reply

SimulationMeasureRever 30 36 60
tRequest/Reply

ATFCMSituationRequest/ 30 36 60
Reply

NetworkImpactAssessmen 30 36 60
tRetrievalRequest/Repl
y

RegulationSubscription 30 36 60
CreationRequest/Reply

RegulationSubscription 30 36 60
UpdateRequest/Reply

RegulationSubscription 30 36 60
RetrievalRequest/Reply

ReroutingSubscriptionC 30 36 60
reationRequest/Reply

ReroutingSubscriptionU 30 36 60
pdateRequest/Reply

ReroutingSubscriptionR 30 36 60
etrievalRequest/Reply

Table 62. Mcdm Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

MCDMTopicListRequest/R 400 480 600

eply

MCDMTopicUpdateRequest 30 36 60
/Reply

MCDMStateUpdateRequest 30 36 60
/Reply

EhelpDeskTicketCreatio 30 36 60
nRequest/Reply

EhelpDeskTicketUpdateR 30 36 60
equest/Reply

Edition: 27.0 6 1629

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

EhelpDeskTicketRevocat 30 36 60
ionRequest/Reply

MCDMSubscriptionCreati 30 36 60
onRequest/Reply

MCDMSubscriptionUpdate 30 36 60
Request/Reply

MCDMSubscriptionRetrie 30 36 60
valRequest/Reply

Table 63. TacticalUpdates Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

SectorConfigurationPla 400 480 600

nRetrievalRequest/Repl
y

SectorConfigurationPla 30 36 60
nUpdateRequest/Reply

CapacityPlanRetrievalR 400 480 600

equest/Reply

CapacityPlanUpdateRequ 30 36 60
est/Reply

TrafficVolumeActivatio 500 600 600

nPlanRetrievalRequest/
Reply

TrafficVolumeActivatio 30 36 60
nPlanUpdateRequest/Rep
ly

OTMVPlanRetrievalReque 400 480 600

st/Reply

OTMVPlanUpdateRequest/ 30 36 60
Reply

RunwayConfigurationPla 400 480 600

nRetrievalRequest/Repl
y

RunwayConfigurationPla 30 36 60
nUpdateRequest/Reply

HotspotListRequest/Rep 300 360 600

ly

HotspotPlanUpdateReque 30 36 60
st/Reply

Edition: 27.0 6 1630

Document Title: NM 27.0 - NM B2B Reference Manual

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

RestrictionActivationP 500 600 600

lanRetrievalRequest/Re
ply

RestrictionActivationP 30 36 60
lanUpdateRequest/Reply

Table 64. Simulations Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

SimulationListRequest/ 30 36 60
Reply

SimulationAvailability 30 36 60
Request/Reply

SimulationStartRequest 30 36 60
/Reply

SimulationStopRequest/ 30 36 60
Reply

SimulationResetRequest 30 36 60
/Reply

Table 65. ScenarioRepository Count Quotas

Service Request Overbooking Request Max Request Count Time Window

Count Duration (in s)

ScenarioRegulationRetr 30 36 60
ievalRequest/Reply

ScenarioReroutingRetri 30 36 60
evalRequest/Reply

ScenarioListRequest/Re 30 36 60
ply

20.O.3. P/S Message Settings

NOTE The TTL values apply on both business and technical P/S messages.

Table 66. REGULATIONS

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the creation/update of the regulation

in the NM system

Edition: 27.0 6 1631

Document Title: NM 27.0 - NM B2B Reference Manual

Parameter (unit) Default Description

MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 67. REROUTINGS

Parameter (unit) Default Description

TTL (min) 360 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the creation/update of the rerouting

in the NM system
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Table 68. MCDM

Parameter (unit) Default Description

TTL (min) 5 Message TTL

PUBLICATION DELAY (sec) 5 Delay from the moment the MCDM topic was
updated in the NM systems
MAX SUBSCRIPTION COUNT 3 Max number of subscriptions per NM B2B
certificate
RE-INITIALISATION SUPPORTED false
COMPRESSION THRESHOLD (KB) 0.5 Message compression threshold

Edition: 27.0 6 1632

Document Title: NM 27.0 - NM B2B Reference Manual

Part IV: Appendixes

Edition: 27.0 6 1633

Document Title: NM 27.0 - NM B2B Reference Manual

References
Operational Manuals/Guides

▪ ATFCM Users Manual - Operational description of the NM ATFCM related actions, information
and message exchange.

▪ ATFCM Operations Manual - Intended to provide Flow Management Positions (FMPs) and
EUROCONTROL’s Network Manager (NM) with common understanding of their roles in
delivering the most effective Air Traffic Flow and Capacity Management (ATFCM) services to Air
Traffic Control (ATC) and Aircraft Operators (AOs).

▪ CHMI ATFCM Reference Guide - This reference guide is intended for the users of the ATFCM
Collaboration Human Machine Interface (CHMI) application.

▪ API Implementation Guide - Provides an overview and description of the available API services.

▪ DPI Implementation Guide - Provides an overview and description of the available DPI services.

▪ NM Flight Planning Requirements - Guidelines - This document outlines the necessary steps
needed to be taken in order to ensure the required level of compatibility with NMOC systems
for flight planning procedures. These provisions cover the most significant aspects that shall be
known by the NM Operational Stakeholders in support to flight planning.

▪ IFPS Users Manual - The manual is intended to contain all the necessary procedures and
information in order for users to be able to construct, transmit or when necessary to correct,
flight plan and associated update messages. Procedures for the distribution of such messages
after processing by the IFPS are also described.

▪ Flight Plan Guide and IFPS Errors Guide - The Flight Plan Guide allows users to search for the
correct format to be used for the different fields of the ICAO Flight Plan via an on-line database.
The IFPS Errors Guide is an electronic version of the error definitions published in the NM IFPS
User’s Manual.

▪ Flight Progress Messages Document - Contains a description of messages from and to systems
external to the NM which have been identified as Flight Progress Messages. It contains both
messages from/to the Integrated initial Flight Plan Processing System (IFPS) to/from the
Enhanced Tactical Flow Management System (ETFMS) and the Centralised SSR Code Assignment
and Management System (CCAMS).

▪ FUA - AMC/CADF Operations Manual - Provides guidance to the Airspace Management Cell
(AMC) and the EUROCONTROL/NM Centralised Airspace Data Function (CADF) personnel to help
them perform their daily tasks and to prepare and release the consolidated European Airspace
Use Plan (EAUP) and European Updated Airspace Use Plan(s) (EUUP(s) daily.

▪ CHMI ASM Function Reference Guide - User guide for the ASM users of the CHMI.

▪ NOP Portal User Manual - Reference source for using the NOP Portal.

▪ CCAMS Users Manual - Frames the support of the CCAMS operations and explains all procedures
applicable for CCAMS operations.

▪ NMIR Users Guide - This document contains information for new users, the list of NMIR
dashboards, their contents in term of available reports and the mapping between the migrated

Edition: 27.0 6 1634

Document Title: NM 27.0 - NM B2B Reference Manual

previous NMIR reports and the NMIR dashboards (Annex 1). The process to access the NMIR is
also detailed.

NM B2B Documents

▪ NM B2B Technical Resources - Folder of various technical documents related to the NM B2B,
most importantly the NM B2B Reference Manuals and Release Notes, for the currently
supported NM B2B versions.

▪ NM B2B Write Access Criteria - Contains the criteria specified for each NM B2B WRITE Service
to be fulfilled and followed during the operational validation, prior to enabling and agreeing
that a B2B client to use that NM B2B WRITE service in NM operations.

▪ ADR Extension Model - The ADR extension model.

Other Documents

▪ Network Operations Library - A collection of EUROCONTROL/NM documents related to Network

operations and operations planning.

▪ Web Service Contract Design and Versioning for SOA. Erl Thomas Prentice Hall September 2008

▪ AMQP 1.0 - The AMQP 1.0 web site.

▪ Aeronautical Information Exchange Model (AIXM) - The Aeronautical Information Exchange

Model enables the provision in digital format of the aeronautical information that is in the
scope of Aeronautical Information Services (AIS).

▪ Public Key Infrastructure (PKI) - A useful resource regarding PKI.

▪ GlobalSign - The GlobalSign web site.

▪ GlobalSign Repository - The GlobalSign Certificate Practices Statement (CPS) and Certificate
Policy.

▪ UUID - The wikipedia article.

▪ European Airport CDM - The European Airport CDM website.

▪ Flight Object Interface Control Description for ICOG IOP Interface Specification.

▪ DPI and FUM Implementation Road Map - The document describes the implementation Road
Map for DPI and FUM messages.

▪ Flight Information Exchange Model (FIXM) - The Flight Information Exchange Model (FIXM) is a
global exchange standard capturing Flight and Flow information.

▪ FIXM User Manual - The FIXM User Manual developed and maintained by the FIXM Community.

▪ Flight Plan and Flight Data Evolution Group (FPFDE) - The project coordinates the gradual
implementation, in a harmonised way, of the processes, procedures and systems adaptations
required to elaborate and to share 4D trajectory information for planning purposes, enabling
better quality air traffic management (ATM) planning across the European ATM network.

▪ Demand data repository - Future traffic forecast based on the knowledge of past traffic flows
and several thousands of flight intentions shared by airlines and airports.

▪ A Flight Plan for military Operational Air Traffic - A presentation of the iOAT (improved

Edition: 27.0 6 1635

Document Title: NM 27.0 - NM B2B Reference Manual

Operatoinal Air Traffic) Flight Plan concept.

Edition: 27.0 6 1636

Document Title: NM 27.0 - NM B2B Reference Manual

Main Abbreviations and Acronyms

ACC3 Air Cargo or Mail Carrier operating into the Union from a Third Country
Airport

A-CDM Airport-Collaborative Decision Making

A-R/R Asynchronous Request Reply

ACH ATC flight plan Change

ACK IFPS Acknowledgement Message

AD Airspace Data

ADR Airspace Data Repository

ADR-E ADR Extension to core AIXM

ADES Aerodrome of Destination

ADEXP ATS Data Exchange Presentation

A-DPI Airport-Departure Planning Information

ADS Automatic Dependent Surveillance

ADS NM Airspace Data Section

ADS Airspace Data Service

ADS-B Automatic Dependent Surveillance - Broadcast

AFP ATC Flight Plan

AFTN Aeronautical Fixed Telecommunication Network

AFUA Advanced Flexible Use of Airspace

AIP Aeronautical Information Publication

AIRAC Aeronautical Information, Regulation and Control

Edition: 27.0 6 1637

Document Title: NM 27.0 - NM B2B Reference Manual

AIRM ATM Information Reference Model

AIS Aeronautical Information Services

AIXM Aeronautical Information Exchange Model - See AIXM

AMA AMC Manageable Area

AMAN Arrival Manager

AMC Airspace Management Cell

AMQP Advanced Message Queuing Protocol - See AMQP 1.0

ANI Advanced Network Integrated airports

ANSP Air Navigation Service Provider

AO Aircraft Operator

AoI Area of Interest

AoP Area of Protection

AOP Airport Operations Plan

AoR Area of Responsibility

AOWIR Aircraft Operator What-if Reroute

API Arrival Planning Information

API Application Programming Interface

APL ATC Flight Plan

APOC Airport Operations Centre

APR Aircraft Position Report

ARO Air Traffic Services Reporting Office

ARR Arrival Message

Edition: 27.0 6 1638

Document Title: NM 27.0 - NM B2B Reference Manual

ASM Airspace Management

ATC Air Traffic Control

ATFCM Air Traffic Flow and Capacity Management

ATFM Air Traffic Flow Management

ATM Air Traffic Management

ATS Air Traffic Services

AU Airspace User

AUA ATC Unit Airspace

AUAG ATC Unit Airspace Group

AUP Airspace Use Plan

B2B Business-to-Business (understand: machine-to-machine)

B2C Business-to-Consumer (understand: graphical interface)

BADA Base of Aircraft Data

CAA Civil Aviation Authority

CACD NM Central Airspace and Capacity Database

CADF Centralized Airspace Data Function

CASA Computer Assisted Slot Allocation

CASTAR Computer Aided Synchronization Tool for Airspace Repositories

CBA Cross Border Area

CCAMS Centralised SSR Code Allocation and Management

CDA Client Defined Area

CDM Collaborative Decision Making

Edition: 27.0 6 1639

Document Title: NM 27.0 - NM B2B Reference Manual

C-DPI Cancel-Departure Planning Information

CDR Conditional Route

CDS Complete Data

CE Central Europe

CfC Closed for Cruising

CFSP Computerised flight plan service provider

CHG Change Message

CHMI Collaboration Human Machine Interface

CIAM Collaborative Interface for Airspace Management

CIAO Collaboration Interface for AO

CIFLO Collaboration Interface for Flow management position

CITO Collaboration Interface for Tower

CNL Cancellation Message

CNS Communications, Navigation, Surveillance

COM Communication

CPA Collaboration Portal Application

CPR Correlated Position Report

CR Change Request

CRSA Composed Manageable Airspace

CS Collapsed Sector

CSST Call-Sign Similarities Tool

CTFM Current Tactical Flight Model

Edition: 27.0 6 1640

Document Title: NM 27.0 - NM B2B Reference Manual

CTM Cooperative Traffic Management

CTO Calculated Time Over

CTOT Calculated Take-Off Time

CUA Common User Access

DCB Demand and Capacity Balancing

DCT Direct Route

DDR Demand Data Repository

DEP Departure message

DES De-Suspension Message

DLA Delay or Delay Message

DLE Delay or holding on route

DPI Departure Planning Information

DSU Division Support Unit

DWH NM Data Warehouse system

EAD European AIS Database

EAIMS European ATM Information Management Service

EASA European Union Aviation Safety Agency

EAUP European Airspace Use Plan

EC European Commission

ECAC European Civil Aviation Conference

EET Estimated Elapsed Time

EFD ETFMS Flight Data

Edition: 27.0 6 1641

Document Title: NM 27.0 - NM B2B Reference Manual

eFPL FF-ICE flight plan

EMR Error Management Restriction

ENV NM Environment System (former name of CACD)

ENVCOOR National Environment Coordinator

EOBT Estimated Off Block Time

ERNIP European Route Network Improvement Plan

ERR Error Message

ERSA Elementary Manageable Airspace

ES Elementary Sector

ETFMS NM Enhanced Tactical Flow Management System

EU European Union

EUROCONTROL European Organization for the Safety of Air Navigation

EUUP European Update airspace Use Plan

FAAS NM Flight Assessment and Alert System

FAB Functional Airspace Block

FAM Flight Activation Monitoring

FB Functional Block

FBZ FPL Buffer Zone

FCM Flight Confirmation Message

FF-ICE Flight and Flow Information for a Collaborative Environment

FPFDE Flight Plan and Flight Data Evolution

FIR Flight Information Region

Edition: 27.0 6 1642

Document Title: NM 27.0 - NM B2B Reference Manual

FIXM Flight Information Exchange Model

FL Flight Level

FLOS Flight Level Orientation Scheme

FLS Flight Suspension Message

FMP Flow Management Position

FPFDE Flight Plan and Flight Data Evolution

FPL Flight Plan message (ICAO format)

FPP Flight Plan Processing

FRA Free Route Airspace

FSA First System Activation message

FTFM Filed Tactical Flight Model

FUA Flexible Use of Airspace

GAI General Arrival Planning Information

GAT General Air Traffic

GRRT Group Re-Routing Tool

GUFI Globally Unique Flight Identifier

HMI Human-Machine Interface

I2 Incident Type 2

IAF Initial Approach Fix

IAP Instrument Approach Procedure

IATA International Air Transport Association

ICAO International Civil Aviation Organization

Edition: 27.0 6 1643

Document Title: NM 27.0 - NM B2B Reference Manual

ID Identifier

iDAP Integrated Digital ATFCM Platform

IDLA Individual Delay (message)

IFPS NM Initial Flight Plan Processing System

IFPZ IFPS Zone

IFPUV IFPS Unit for Validation

IFPZ IFPS Zone

IFR Instrument Flight Rule

iOAT improved Operational Air Traffic

IR Implementing Rule

IR Information Region

M&R Monitoring and Reporting

MCDM Measure Collaborative Decision Making

MEP Message Exchange Pattern

MIN Minimum

MoC Memorandum of Cooperation

MSG Message

N/A Not Applicable

NAM Non AMC manageable Area

NAS National Airspace

NAT Network Address Translation

NAV Navigation

Edition: 27.0 6 1644

Document Title: NM 27.0 - NM B2B Reference Manual

NCAP Network Collaborative Advance Planning (DSNA tool)

NIA Network Impact Assessment

NID Network Impact Display

NM Nautical Mile

NM Network Manager

NMIR NM Interactive Reporting

NMOC NM Operations Centre

NMP NM Portal

NMVP NM Validation Platform

NOP Network Operations Plan

NOP Network Operations Portal

NOTAM Notice to Airmen

NPP Network Performance Plan

NPZ No Planning Zone

NRC National RAD Coordinator

NSP Network Strategy Plan

OAI Target Time-Over Arrival Planning Information

OAR ATFM Rerouting

OAT Operational Air Traffic

ODSG Operations and Development Sub-Group

OPP Opportunity

OPS Operations

Edition: 27.0 6 1645

Document Title: NM 27.0 - NM B2B Reference Manual

OPT Operational Testing

ORGN Originator

ORM Operational Reply Message

OS Operating System

OTMV Occupancy Traffic Monitoring Value

P/S Publish/Subscribe

PC Provisional Council

PCP Pilot Common Project

PDI Predicted Departure Planning Information

P-DPI Predicted DPI

PENS Pan-European Network Service

PFD Planned Flight Data

PREDICT Variant of TACT used for Pre-Tactical Work

PSFD Publish/Subscribe Flight Data

PTR Profile Tuning Restriction

R/R Request/Reply

RAD Route Availability Document

RAS Regulated Airspace

REA Ready Message

RFI Ready For Improvement Message

RFR Re-route after reroute cancellation

RJT Rerouteing Rejection message

Edition: 27.0 6 1646

Document Title: NM 27.0 - NM B2B Reference Manual

RQS Requested Supplementary Information Message

RRM Rerouting Proposal Creation

RRN Rerouting Notification Message

RRP Rerouting Proposal Message

RSA Restricted Airspace

RSI CASA Revoke slot proposal

RTFM Regulated Tactical Flight Model

RWY Runway

S-R/R Synchronous Request Reply

SAFA Safety Assessment of Foreign Aircraft

SAM Slot Allocation Message

SB Study Block

SES Single European Sky

SESAR Single European Sky ATM Research

SIBT Scheduled In-Block Time

SID Standard Instrument Departure

SIP Slot Improvement Proposal Message

SITA Société Internationale de Télécommunications Aéronautiques

SLA Service Level Agreement

SLC Slot Cancellation message

SMM Slot Missed Message

SPA Slot Improvement Proposal Acceptance Message

Edition: 27.0 6 1647

Document Title: NM 27.0 - NM B2B Reference Manual

SRJ Slot Proposal Rejection message

SRM Slot Revision Message

SSP CASA STAM Proposal

SSR Secondary Surveillance Radar

STAM Short-Term ATFM Measures

STAR Standard Terminal Arrival Route

SWIM System-Wide Information Management

SWM SIP Wanted Message

TACT NM Tactical System

TAI Target Take-Off Arrival Planning Information

TB Technical Block

TCF Transponder Code Function

TCO Third Country Operator

TLS Transport Layer Security

TMA Terminal Manoeuvring Area

TOBT Target Off Block Time

TP Terminal Procedure

TP Transport Protocol

TP Trajectory Prediction

TTL Time Table List

TTL Time-To-Live

TTOT Target Take Off Time

Edition: 27.0 6 1648

Document Title: NM 27.0 - NM B2B Reference Manual

TV Traffic Volume

TWR Aerodrome Control Tower

UCD Update MCDM Data

UFN Until Further Notice

UIR Upper Information Region

URL Uniform Resource Locator

UTC Universal Time Coordinated

UUID Universally Unique Identifier - See UUID

UUP Updated Airspace Use Plan

VFR Visual Flight Rule

WKTRC Wake Turbulence Category

WTC Wake Turbulence Category

Edition: 27.0 6 1649

Document Title: NM 27.0 - NM B2B Reference Manual

Document Final Page

Edition: 27.0 6 1650