The ASM service enables the complete set of ASM functions necessary for the interactions between ASM Support System and External Users, when communicating relevant ASM process information at local/FAB level.
", "serviceIdentification": { "name": "ASM" }, "serviceDefinitionProvider": { "name": "EUROCONTROL", "description": "EUROCONTROL is an intergovernmental organization with 42 Member and 2 Comprehensive Agreement States.
", "type": [ "NETWORK_MANAGER" ] }, "serviceCategorisation": { "businessActivityType": [ "AIRSPACE_ORGANISATION_AND_MANAGEMENT" ], "intendedConsumer": [ "CIVIL_AIR_NAVIGATION_SERVICE_PROVIDER", "CIVIL_AIRSPACE_USER", "MILITARY_AIR_NAVIGATION_SERVICE_PROVIDER", "MILITARY_AIRSPACE_USER", "MILITARY_DEFENCE_CENTRE" ], "informationCategory": [ "AERONAUTICAL_INFORMATION_EXCHANGE" ], "applicationMessageExchangePattern": [ { "name": "PUBLISH_SUBSCRIBE" }, { "name": "PUBLISH_SUBSCRIBE_WITH_PUSH_MECHANISM" } ] }, "generalDescription": { "qualityOfData": [ { "name": "Quality of data", "description": "Service Providers should document the quality of data provided by the service" } ], "operationalEnvironment": { "operationalNeeds": [ { "name": "Operational Information Exchange Requirements", "description": "ASM Support Systems facilitate the exchange of pre-tactical and tactical ASM data between ASM Support Systems and External Users. This information exchange supports the optimisation of ASM operations from the beginning of the airspace planning cycle. Furthermore, a national ASM Support System will allow the creation of bookings in airspace structures managed by another national ASM Support System, according to the procedures defined in ERNIP Part 3 ASM Handbook and bilateral agreements between States.
" }, { "name": "Use of the service", "description": "
The ASM Service is designed to support data exchange between ASM Support Systems and External Users both within and across FAB boundaries.
In this configuration the ASM Support Systems can each act as a client to each other, though the relationship does not need to be bidirectional. This allows each ASM Support System privilege to distribute general information from the other system to its users. It also allows each ASM Support System to request and modify bookings in the other system and engage in coordination with the other system directly. It is the responsibility of the system providing the services to restrict the data shared with all or each client as appropriate. Equally, it is the responsibility of the client system to ensure booking, creation and editing is granted for the appropriate individual users.
In the case when the External User is an ATC system, the ASM system acts as the provider while the ATC system acts as the consumer. However, the consumer can notify that it has received activation data.
The interfaces defined within this document are supported by both a Synchronous Request/Reply mechanism and a Publish/Subscribe Push mechanism.
The Publish/Subscribe Push mechanism allows a client to subscribe to a topic and receive messages published on that topic. The Publish/Subscribe mechanism is supported by two procedures:
- subscription management: the client creates a new subscription and, in general, a corresponding message queue is allocated to collect messages related to the requested subscription topic. (see SubscriptionManagement interface)
- message consumption: the client consumes the messages from the message queue for the subscription topic. (see Publication interface)
The Publish/Subscribe mechanism is implemented using AMQP to support coordination between ASM Support Systems and External User to exchange the near real-time updates of their ASM data.
The Synchronous Request/Reply mechanism allows a client to request and to receive ASM data. It is used to retrieve the current ASM data of the other system either on the initial connection between ASM Support Systems and External Users or to re-establish synchronisation potentially after one has experienced downtime or due to network failures.
This Request/Reply mechanism may also be implemented by clients that are interested in a small subset of the ASM service where the data is subject to change infrequently or when using latest data is not crucial.
As two ASM Support Systems may not be fully synchronised all of the time, Request/Reply mechanism is implemented to re-establish synchronisation by exchanging the latest snapshot of the available ASM data. The systems are synchronised again and they can continue to be updated by using the Publish/Subscribe mechanism.
To avoid unnecessary processing of irrelevant messages on the client side some message filtering functionalities have to be implemented by both Request/Reply and Publish/Subscribe mechanisms through a combination of the following filter criteria for each ASM Service Interface:
- Activity,
- Airspace,
- Airspace Name,
- Airspace Feature Type,
- Change Period,
- Geometry,
- Interested Interval,
- Mission.
When using the Publish/Subscribe mechanism, the External User has to set the required message filtering criteria when creating the subscription so that the messages for each type of subscriptions can be filtered before they are published to the message queues allocated to that External User.
The Request/Reply mechanism requires the External Users to set the required message filtering criteria when generating the request.
To allow ASM data requests to be aligned with subscriptions a single abstract Filter definition is available for use by both mechanisms, in that the SubscriptionCreationRequest message is an extension to the basic FilteredRequest message as shown in the diagram below. Consequently, the same Filters can be used when requesting ASM data and subscribing for ASM data to ensure the same data is retrieved via both mechanisms. Specific filter implementations that have been deemed necessary for the services to be usable are defined in the specification document. The available filters may be extended beyond those specified in any implementation of this service. This allows for custom filtering to be defined by a provider of this service while still conforming to the interfaces defined in the specification document. It has to be noted that only the filters defined in the specification document are to be relied upon in order to create an implementation independent client.
The FilteredRequest is used throughout the service interfaces and is extended to form the SubscriptionCreationRequest. The FilteredRequest defines a series of Filters which will be applied using the logical OR operator. Filters may be combined with a logical \u201cAND\u201d using the \u201cAndFilter\u201d.
In the specification document, each service interface defines in detail the Filters it accepts.
ASM-INTF-FIL-010: All ASM service interfaces specified in this document shall implement a filtering functionality both for Synchronous Request/Reply and Publish/Subscribe Push application message exchange patterns.
" } ] }, "functionality": [ { "name": "Management of subscriptions", "description": "This functionality allows for creation, starting, stopping and deletion of subscriptions to consume data from the service.
", "realWorldEffect": "Creation, starting, stopping and\u00a0deletion of subscriptions" }, { "name": "Publication", "description": "This functionality enables the management of updates based on subscriptions by External Users.
", "realWorldEffect": "Notifying an External User of a change in the data according to the subscription topics that have been subscribed to." }, { "name": "Long-term planning", "description": "This functionality allows for the creation, modification and retrieval of long term planning data held within the ASM Support System.
", "realWorldEffect": "Creation of an Event, Update of an Event and submission of a Request for a List of Events." }, { "name": "Local airspace structure", "description": "This functionality allows for retrieval of airspace structures and activity data from within the ASM Support System by External Users.
", "realWorldEffect": "Obtaining access to static data and activity data by External Users from within the ASM Support System." }, { "name": "Booking", "description": "This functionality enables the creation, modification and retrieval of bookings, including details of conflicts between different bookings within the ASM Support System by External Users.
", "realWorldEffect": "Creation of a Booking, Update of a booking, obtaining access to Booking information, obtaining access to the actions that can be performed by the actor and obtaining access to the history of all actions that have been performed on a Booking. " }, { "name": "Booking conflicts", "description": "This functionality allows access to the Booking conflict information from within the ASM Support System.
", "realWorldEffect": "Obtaining access to booking conflict data from within the ASM Support System." }, { "name": "Mission", "description": "This functionality allows for the creation, modification and retrieval of missions held within the ASM Support System by External Users.
", "realWorldEffect": "Creation of a Mission, Update of a Mission and obtaining access to the Missions information from within the ASM Support System. " }, { "name": "Airspace negotiation", "description": "This functionality enables the retrieval and handling of proposals held within the ASM Support System by External Users.
", "realWorldEffect": "Creation of a Proposal, obtaining access to the Proposal information and acceptance or rejection of the Proposal. " }, { "name": "Airspace status", "description": "This functionality enables the retrieval of activation data held within the ASM Support System by External Users.
", "realWorldEffect": "Obtaining access to the activation data held within the ASM Support System by External Users." } ], "qualitiesOfService": { "performance": [ { "name": "Performance efficiency: capacity and time behaviour", "description": "The performance efficiency of the service is key to assessing the quality of the service. Performance requirements to be agreed between all interested parties cover the capacity of the service and its response times.
The capacity of the service, i.e. the expected maximum rate at which the service can process transactions and the maximum message size of responses must be specified. The requirement can include the number of items that can be stored, the number of concurrent users, the communication bandwidth, throughput of transactions, and size of messages.
The expected time bahaviour of the service, i.e. the processing/response time, must be specified. This can be expressed as an indication of a maximum time needed for the service provider to complete the request, measured from the time instant the service provider receives the request to the time instant the service provider sends the response or makes it available.
" } ], "reliability": [ { "name": "Reliability: availability and recoverability", "description": "The reliability of the service is how it performs its functions under specified conditions for a specified period of time. Two main requirements should be agreed between all interested parties: availability and recoverability.
The expected availability of the service is the degree to which it is operational and accessible when required for use. Whilst the ideal goal is a consistent 24/7/365 service provision, this is not always a realistic target due to the potential need for disaster recovery, maintenance or upgrades. As well as agreeing on the acceptable levels of (non)availability, contingency plans need also to be agreed in order that operations can continue seamlessly and safely when any downtime is required.
Recoverability concerns how the service is re-established in the event of an interruption or a failure.
Monitoring and measuring these characteristics provides a means to identify where improvements are required in terms of reliability.
" } ], "security": [ { "name": "Security: confidentiality and integrity", "description": "Information being managed within an ASM Support System is highly sensitive and is to be managed with utmost care in terms of security.
The expected security mechanisms should be agreed between all interested parties. Requirements should be expressed for confidentiality and integrity.
Confidentiality ensures that information is accessible only to those authorized to have access. Integrity is an assurance that unauthorized access to, or modification of, an information service interface or information is prevented.
Mechanisms and strategies for achieving confidentiality and ensuring integrity are numerous and various in nature. Whilst considering how best to achieve maximum levels of security, it is important also to consider that technology choices will not be so bespoke or idiosyncratic that they prevent potential future users from taking up the system.
" } ] }, "validation": { "description": "Self validation is complemented by COLLABORATIVE_VALIDATION with operational service consumers." } , "abbreviations": [ { "name": "Abbreviations and Acronyms", "description": "\r\n\r\n
| \r\n\t\t\t Abbreviation \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Term \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t A/B \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Air Base \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ACC \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Area Control Centre \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AIP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Aeronautical Information Publication \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ADEP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Aerodrome of Departure \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ADES \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Aerodrome of Destination \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AF \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t ATM Functionality (in the PCP regulation) \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AFUA \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Advanced Flexible Use of Airspace \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AIRM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t ATM Information Reference Model \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AIXM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Aeronautical Information Exchange Model \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AMQP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Advanced Message Queuing Protocol \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AO \r\n\r\n\t\t\tARES \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Aircraft Operator \r\n\r\n\t\t\tAirspace Reservation/Restriction \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ASM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Airspace Management \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ATC \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Air Traffic Control \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ATFCM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Air Traffic Flow and Capacity Management \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ATM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Air Traffic Management \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ATS \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Air Traffic Services \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t AUP/UUP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Airspace Use Plan / Updated Airspace Use Plan \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t B2B \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Business-to-Business \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t CBA \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Cross Border Area \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t CBO \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Cross Border Operations \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t CDM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Collaborative Decision Making \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t CDR \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Conditional Route \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t CR \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Change Request \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t eAMI \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Electronic ASM Information message \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t EC \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t European Commission \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ERAF \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t EUROCONTROL Advisory Framework \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t EU \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t European Union \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FAB \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Functional Airspace Block \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FBZ \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Flight Plan Buffer Zone \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ENV \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Environment \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FDPS \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Flight Data Processing System \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FF \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Fire and Forget \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FL \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Flight Level \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FMP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Flow Management Position \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t FUA \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Flexible Use of Airspace \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t GML \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Geographical Markup Language \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t HTTP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Hypertext Transport Protocol \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ICAO \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t International Civil Aviation Organisation \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ID \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Identifier \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t IP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Internet Protocol \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t MTBF \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Mean Time Between Failures \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t MTTR \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Mean Time To Recovery \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t NOP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Network Operations Plan \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t NM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Network Manager \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t NOTAM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Notice to Airmen \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t PCP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Pilot Common Project (EC Regulation) \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t POC \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Point of Contact \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t ERNIP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t European Route Network Improvement Plan \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t SES \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Single European Sky \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t SOAP \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Simple Object Access Protocol \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t sR/R \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Synchronous Request Reply \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t SWIM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t System Wide Information Management \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t TI \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Technical Infrastructure \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t TRA \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Temporary Reserved Area \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t TSA \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Temporary Segregated Area \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t UUID \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Universally Unique Identifier \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t UOM \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Unit of Measurement \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t WS \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Web Service \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t XML \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Extensible Markup Language \r\n\t\t\t | \r\n\t\t
| \r\n\t\t\t WSDL \r\n\t\t\t | \r\n\t\t\t\r\n\t\t\t Web Services Description Language \r\n\t\t\t | \r\n\t\t
\r\n" } ] }, "informationDescription": { "informationDefinition": [ { "name": "Information definition", "definition": "To be provided", "airmCorrespondence": "To be provided", "datatype": "Not applicable" } ] }, "technicalDescription": { "behaviour": [ { "name": "Subscription Behaviour", "description": "
Specified in Section 2.11.1
" }, { "name": "Booking and Booking Conflict Behaviour", "description": "Specified in Section 2.11.2
" }, { "name": "Airspace Negotiation Behaviour", "description": "Specified in Section 2.11.3
" }, { "name": "Local Airspace Structure Behaviour", "description": "Specified in Section 2.11.4
" }, { "name": "Airspace Status Behaviour", "description": "Specified in Section 2.11.5
" }, { "name": "Mission Behaviour", "description": "Specified in Section 2.11.6
" }, { "name": "Long Term Planning Behaviour", "description": "Specified in Section 2.11.7
" } ] }, "serviceInterface": [ { "name": "SubscriptionManagement ", "description": "Interface role
The Subscription Management interface allows the management of subscriptions to the other services by External Users. External Users are able to receive the information of their interest generated by the ASM Support Systems and provided via the interfaces. Each interface applies filtering options in order to ensure data provision aligned with the requirements of the External User.
The interface allows for the creation and deletion of subscriptions to consume data from all other ASM service interfaces. A client may create a subscription to a single topic with each request but only one subscription per topic may be created at a time. In response the client will receive the name of an AMQP message queue. The name can then be supplied when creating subscriptions for additional topics to use the same queue. The client can consume the messages from the queue with the given name.
Figure 7 in Section 2.4.2.1 provides an overview of the Subscription Management interface
The elements in the data model are described in full detail in section 2.7.4.
Information Exchange Flow
The diagram in Section 2.4.2.2 presents the information exchange flow for the Subscription Management interface.
Interface Functions
The Service interface performs the following functions:
o Creating a Subscription introduces a new Subscription into the ASM Support System.
o Starting a Subscription starts an existing Subscription in the ASM Support System.
o Stopping a Subscription stops an existing Subscription in the ASM Support System.
o Deleting a Subscription allows for deletion of an existing Subscription.
o Listing existing Subscriptions provides access to existing Subscriptions in the ASM Support System for the External User.
ASM-INTF-SUBS-010: ASM Service shall be supported by the Subscription Management interface to manage the subscriptions
ASM-INTF-SUBS-020: The Subscription Management interface shall support the following operations:
o createSubscription,
o startSubscription,
o stopSubscription,
o deleteSubscription,
o listSubscriptions.
", "provisionSide": "PROVIDER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "createSubscription", "description": "
This operation is intended to create a subscription in the ASM Support System in response to a request from an External User. As a result, a subscription is either created in the local ASM Support System and the External User is notified, or a subscription is not created and an appropriate error message is transmitted to the External User.
It is down to the implementation as to whether or not subscriptions need to be remade at any other subsequent connection.
Associated messages
ASM-INTF-SUBS-030: The createSubscription operation shall receive and process the SubscriptionCreationRequest message from an External User.
ASM-INTF-SUBS-040: If no queue name is provided in the SubscriptionCreationRequest message the service shall assign a queue name to the External User subscription.
ASM-INTF-SUBS-050: If an active queue name is provided in the SubscriptionCreationRequest message the service shall reuse this queue name for the External User subscription.
Note: The queue name allows for connection to an Advanced Message Queuing Protocol (AMQP) message queue.
ASM-INTF-SUBS-070: The service shall apply the filters defined in the SubscriptionCreationRequest to all data notified via the AMQP message queue.
ASM-INTF-SUBS-080: The createSubscription operation shall validate the SubscriptionCreationRequest message against the following criteria which must be met:
o All mandatory data for SubscriptionCreationRequest message are provided
o The requestor does not have an existing PAUSED or ACTIVE subscription for the same topic.
o If a queue name is set in the SubscriptionCreationRequest message it must match an existing queue name belonging to the requestor.
o The filters provided in the SubscriptionCreationRequest message must be applicable to the topic being subscribed for. Acceptable filters are defined by the query operation in this document that maps to the subscription topic.
ASM-INTF-SUBS-090: If the subscription request is valid, the createSubscription operation shall transmit the details of the newly created subscription, including the name of the AMQP queue to be used, in the SubscriptionCreationReply message to the requesting External User.
ASM-INTF-SUBS-100: The subscription shall always be created in the \u2018PAUSED\u2019 state.
ASM-INTF-SUBS-110: If the request or the resulting subscription is not valid, the createSubscription operation shall transmit an appropriate error in the SubscriptionCreationReply message to the requesting External User.
ASM-INTF-SUBS-115: The service provider should define a TTL (Time-To-Live) for messages of each subscription topic.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of the messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "startSubscription", "description": "This operation is intended to start a subscription process in the ASM Support System in response to a request from an External User. As a result, a subscription process is either started in the local ASM Support System and the External User starts receiving subscribed data, or a subscription is not started, and an appropriate error message is transmitted to the External User. Once the subscription has started HeartbeatTechnicalMessages may be sent by the ASM Support System.
Associated messages
ASM-INTF-SUBS-120: The startSubscription operation shall receive and process the SubscriptionCreationRequest message from an External User.
ASM-INTF-SUBS-130: The startSubscription operation shall validate the SubscriptionStartRequest message against the following criteria which must be met:
o All mandatory data for SubscriptionStartRequest message are provided,
o The identified subscription to be started must belong to the requestor,
o The identified subscription to be started must be PAUSED.
ASM-INTF-SUBS-140: If the request is valid, the startSubscription operation shall return the SubscriptionStartReply message to the requesting External User.
ASM-INTF-SUBS-150: The SubscriptionStartReply message shall contain the details of the subscription, including the name of the queue to be used and the state which will be \u2018ACTIVE\u2019.
ASM-INTF-SUBS-160: If the request is not valid, the startSubscription operation shall transmit an appropriate error in the SubscriptionStartReply message to the requesting External User.
ASM-INTF-SUBS-163: HeartbeatTechnicalMessages should be published at least every maximum-message-interval once the subscription is in state \u2018ACTIVE\u2019.
ASM-INTF-SUBS-165: HeartbeatTechnicalMessages should be postponed if a subscription message is sent to the queue before the maximum-message-interval expires.
ASM-INTF-SUBS-167: The service provider should define a maximum-message-interval defining the interval between HeartbeatTechnicalMessages published to the queue.
ASM-INTF-SUBS-168: The service provider shall pause a subscription and publish a SubscriptionTechnicalMessage if any message published to the queue expires.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of the messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "stopSubscription", "description": "This operation is intended to stop a subscription process in the ASM Support System in response to a request from an External User. As a result, a subscription process is either stopped in the local ASM Support System and the External User stops receiving subscribed data, or a subscription is not stopped and an appropriate error message is transmitted to the External User. Once the subscription has stopped HeartbeatTechnicalMessages can be stopped by the ASM Support System.
Associated messages
ASM-INTF-SUBS-170: The stopSubscription operation shall receive and process the SubscriptionStopRequest message from an External User.
ASM-INTF-SUBS-180: The stopSubscription operation shall validate the SubscriptionStopRequest message against the following criteria which must be met:
o All mandatory data for SubscriptionStopRequest message are provided,
o The identified subscription to be stopped must belong to the requestor,
o The identified subscription to be stopped must be \u2018ACTIVE'.
ASM-INTF-SUBS-190: If the request is valid, the stopSubscription operation shall return the SubscriptionStopReply message to the requesting External User.
ASM-INTF-SUBS-200: The SubscriptionStopReply message shall contain the details of the subscription, including the name of the queue to be used and the state which will be \u2018PAUSED\u2019.
ASM-INTF-SUBS-210: If the request is not valid, the stopSubscription operation shall transmit an appropriate error in the SubscriptionStopReply message to the requesting External User.
ASM-INTF-SUBS-215: The stopSubscription operation may optionally stop the HeartbeatTechnicalMessages while the subscription is in the state PAUSED by adding the attribute heartbeatEnabled with the value false to the StopSubscriptionRequest.
ASM-INTF-SUBS-217: The server should publish a SubscriptionTechnicalMessage to the subscription queue when the server itself has PAUSED the subscription, independent of the external user requesting to PAUSE the subscription via the stopSubscription operation.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of the messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "deleteSubscription", "description": "This operation is intended to delete a subscription in the ASM Support System in response to a request from an External User. As a result, a subscription is either deleted in the local ASM Support System and the External User is notified, or a subscription is not deleted and an appropriate error message is transmitted to the External User. If a subscription is deleted and no other subscriptions reference its message queue then the queue will be deleted.
Associated messages
ASM-INTF-SUBS-220: The deleteSubscription operation shall receive and process the SubscriptionDeletionRequest message from an External User.
ASM-INTF-SUBS-230: The deleteSubscription operation shall validate the SubscriptionDeletionRequest message against the following criteria which must be met:
o All mandatory data for SubscriptionDeletionRequest message are provided
o The identified subscription to be deleted must belong to the requestor.
ASM-INTF-SUBS-240: If the request is valid, the deleteSubscription operation shall return confirmation that the subscription has been deleted in the SubscriptionDeletionReply message to the requesting External User.
ASM-INTF-SUBS-250: If the request is valid and the subscription\u2019s queue is no longer in use by any other subscriptions, the queue shall be deleted.
ASM-INTF-SUBS-260: If the request is not valid, the deleteSubscription operation shall transmit an appropriate error in the SubscriptionDeletionReply message to the requesting External User.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of the messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "listSubscription", "description": "This operation is intended to allow the External User to list the subscriptions currently established for that specific External User.
This method returns all the subscriptions owned by the calling External User.
Associated messages
ASM-INTF-SUBS-270: The listSubscriptions operation shall receive and process the SubscriptionListRequestSubscriptionDeletionRequest message from an External User.
ASM-INTF-SUBS-280: The listSubscriptions operation shall validate the SubscriptionListRequest message to ensure that any subscriptionStates listed in the request are valid.
ASM-INTF-SUBS-290: If the request is valid, the listSubscriptions operation shall return a SubscriptionListReply containing:
- a list of subscriptions owned by the calling External User that match one of the subscription states listed in the SubscriptionListRequest,
- or all subscriptions owned by the calling External User if no subscription states were provided in the SubscriptionListRequest.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in section 2.7.3 Interface Messages.", "direction": "IN" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "Publication", "description": "Interface role
The Publication interface enables the management of updates based on subscriptions by External Users. External Users are able to receive notifications of updates of the information of their interest generated by the ASM Support Systems. Each interface applies filtering options in order to ensure data provision aligned with the requirements of the External User.
This interface publishes the data that would otherwise be directly requested from other interfaces. As such the data coming via this interface is contained within the notification messages defined in section 2.7.3 Interface Messages and containing data items described by each of the other interfaces. As a result, this interface does not define its own data model.
Information Exchange Flow
The following diagram presents the information exchange flow for the Publication interface. The diagram shows a change occurring within the ASM Support System, the changed data being passed to the Publication interface which applies the filters related to each subscription and the relevant data being published to subscribed consumers.
Figure 12 in Section 2.4.3.2 depicts the Publication interface information exchange flow
Interface Functions
The interface performs the following function:
ASM-INTF-PUB-010: ASM Service shall be supported by the Publication interface to manage the updates.
ASM-INTF-PUB-020: The Publication interface shall support the following operations:
- notifyStaticData
- notifyActivityData
- notifyBooking
- notifyBookingAction
- notifyBookingConflict
- notifyActivation
ASM-INTF-PUB-025: The Publication interface should support the following operations:
- notifyMission
- notifyProposal
- notifyEvent
ASM-INTF-PUB-030: Any data item considered for publication shall be published if:
- the data item was of interest to the subscriber before the change according to the filter defined at the time of subscription, or
- the data item is of interest to the subscriber post the change according to the filter defined at the time of subscription.
ASM-INTF-PUB-040: All notifications shall contain the full definition of the changed data item.
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "notifyStaticData", "description": "This operation is intended to notify an External User of a change in the definition of static data.
Associated messages
ASM-INTF-PUB-050: Any change to the definition of static data within the ASM Support System shall be considered for publication via an AirspaceNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "notifyActivityData", "description": "This operation is intended to notify an External User of a change in the definition of activity data.
Associated messages
ASM-INTF-PUB-060: Any change to the definition of activity data within the ASM Support System shall be considered for publication via an ActivityDataNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages", "direction": "OUT" } ] }, { "name": "notifyBooking", "description": "This operation is intended to notify an External User of a change in the definition of an existing booking.
Associated messages
ASM-INTF-PUB-070: Any change to the definition of a booking within the ASM Support System shall be considered for publication via a BookingNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": " notifyBookingAction", "description": "This operation is intended to notify an External User of an action that has been performed to an existing booking.
Associated messages
ASM-INTF-PUB-080: Any change to the definition of action data within the ASM Support System shall be considered for publication via a BookingActionNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "notifyBookingConflict", "description": "This operation is intended to notify an External User of conflict data related to an existing booking.
Associated messages
ASM-INTF-PUB-090: Any change to the definition of booking conflict data within the ASM Support System shall be considered for publication via a BookingConflictNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "notifyMission", "description": "This operation is intended to notify an External User of a change in the definition of mission data.
Associated messagews
ASM-INTF-PUB-100: Any change to the definition of mission data within the ASM Support System shall be considered for publication via a MissionNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "notifyProposal", "description": "This operation is intended to notify an External User of a change in the definition of proposal data.
Associated messages
ASM-INTF-PUB-110: Any change to the definition of proposal data within the ASM Support System shall be considered for publication via a BookingProposalNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "notifyEvent", "description": "This operation is intended to notify an External User of a change in the definition of event data.
Associated messages
ASM-INTF-PUB-120: Any change to the definition of event data within the ASM Support System shall be considered for publication via an EventNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "notifyActivation", "description": "This operation is intended to notify an External User of a change in the definition of activation data.
Associated messages
ASM-INTF-PUB-130: Any change to the definition of activation data within the ASM Support System shall be considered for publication via an ActivationNotification message.
Note: The definition of this message can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of this message can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "LongTermPlanning ", "description": "Interface role
The Long Term Planning interface allows for the creation, modification and retrieval of long term planning data held within the ASM Support System. It is not foreseen that one ASM Support System may create long term planning in another ASM Support System and so the creation and update mechanisms may be limited to External Users acting as a user of the ASM Support System under the External ASM User - ASM Support System use of the service case.
Figure 14 in Section 2.4.4.1 provides an overview of the Long Term Planning interface
Information Exchange Flow
Figure 15 in Section 2.4.4.2 depicts the information exchange flow for the Long Term Planning interface.
Interface Functions
The interface performs the following functions:
- Creating an Event - introduces a new Event into the ASM Support System
- Updating an Event - updates an existing Event in the ASM Support System
- Requesting a List of Events - allows access to the Event information from within the ASM Support System
ASM-INTF-LTPL-010: ASM Service should be supported by the Long Term Planning interface to manage the events.
ASM-INTF-LTPL-020: The Long Term Planning interface shall support the following operations:
- createEvent,
- updateEvent,
- queryEventList.
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": " createEvent", "description": "This operation is intended to introduce a new Event into the ASM Support System.
Associated messages
ASM-INTF-LTPL-030: The createEvent operation shall receive and process the EventCreationRequest message from an External User.
ASM-INTF-LTPL-040: If the event request is valid, the createEvent operation shall transmit the newly created event in the EventReply message to the requesting External Users.
ASM-INTF-LTPL-050: If for any reason the request or the resulting event is not valid, the createEvent operation shall transmit an appropriate error in the EventReply message to the requesting External Users.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "updateEvent", "description": "This operation is intended to update an existing Event in the ASM Support System.
Associated messages
ASM-INTF-LTPL-060: The updateEvent operation shall receive and process the EventUpdateRequest message from an External Users.
ASM-INTF-LTPL-070: If the event update is valid, the updateEvent operation shall transmit the updated event in the EventReply message to the requesting External User.
ASM-INTF-LTPL-080: If for any reason the request or the resulting updated event is not valid, the updateEvent operation shall transmit an appropriate error in the EventReply message to the requesting External User.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "queryEventList", "description": "This operation is intended to allow access to the Event information from within the ASM Support System.
Associated messages
ASM-INTF-LTPL-090: The queryEventList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-LTPL-100: If the request is valid, the queryEventList operation shall transmit the matching list of events in the EventListReply message to the requesting External User.
ASM-INTF-LTPL-110: If for any reason the request is not valid, the queryEventList operation shall transmit an appropriate error in the EventListReply message to the requesting External User.
ASM-INTF-LTPL-120: The queryEventList operation shall accept any combination of the
following filters in the FilteredRequest message:
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "LocalAirspaceStructure ", "description": "Interface role
The Local Airspace Structure interface allows for retrieval of airspace structures and activity data from within the ASM Support System by External Users.
Local ASM Support Systems maintain a local data base that contains national airspace structures. The interface allows External Users to obtain the definitions of the airspace structures, provided by the providing system in accordance with the provider requirements, as well as activity data, in order to follow their status and the reservations associated to them.
Figure 17 in Section 2.4.5.1 provides an overview of the Local Airspace Structure interface
The elements in the data model are described in full detail in section 2.7.3 Interface Messages.
Information Exchange Flow
Figure 18 in Section 2.4.5.2 depicts the information exchange flow for the Local Airspace Structure interface.
Interface Functions
The interface performs the following functions:
- Requesting Static Data - allows access to static data from within the ASM Support System
- Requesting Activity Data \u2013 allows access to activity data from within the ASM Support System
ASM-INTF-LAS-010: ASM Service shall be supported by the Local Airspace Structure interface to manage the access to local airspace static and activity data.
ASM-INTF-LAS-020: The LocalAirspaceStructure interface shall support the following operations:
This operation is intended to manage the access to static data from the ASM Support System.
Associated messages
ASM-INTF-LAS-030: The queryAirspaceList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-LAS-040: If the request is valid, the queryAirspaceList operation shall transmit the matching static data in the AirspaceListReply message to the requesting External User.
ASM-INTF-LAS-050: If for any reason the request is not valid, the queryAirspaceList operation shall transmit an appropriate error in the AirspaceListReply message to the requesting External User.
ASM-INTF-LAS-055: The queryAirspaceList operation shall accept any combination of the
following filters in the FilteredRequest message:
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "queryActivityDataList", "description": "This operation is intended to manage the access to activity data from the ASM Support System.
ASM-INTF-LAS-060: The queryActivityDataList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-LAS-070: If the request is valid, the queryActivityDataList operation shall transmit the matching activity data list in the ActivityDataListReply message to the requesting External User.
ASM-INTF-LAS-080: If for any reason the request is not valid, the queryActivityDataList operation shall transmit an appropriate error in the ActivityDataListReply message to the requesting External User.
ASM-INTF-LAS-085: The queryActivityDataList operation shall accept any combination of
the following filters in the FilteredRequest message:
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "Booking", "description": "Interface role
Booking is an interface that enables the creation, modification and retrieval of bookings, including details of conflicts between different bookings within the ASM Support System by External Users. The interface allows for continuous updates in real time of Booking information among authorised ASM Support Systems/External Users in order to enhance cross border coordination based on the most recent information.
The interface also enables booking of airspace structures across national borders; airspace users are able to book foreign airspace using their local ASM Support System. The process of a foreign booking follows the ASM process defined in dedicated LoAs between States.
The creation and modification of bookings is supported through the provision of \u2018Actions\u2019 by the interface. The Actions describe the allowed modifications that a user may take on a specific booking. Actions are subject to change based on the state of a booking and the current time.
Figure 20 in Section 2.4.6.1 provides an overview of the Booking interface
Information Exchange Flow
Figure 21 in Section 2.4.6.2 depicts the Booking interface information exchange flow
Interface Functions
The interface performs the following functions:
- Creating a Booking introduces a new Booking into the ASM Support System to be approved to be incorporated into the plan.
- Updating a Booking updates an existing Booking in the ASM Support System potentially as a result of a CDM process or simply to update the plan to reflect changes to planned activities.
- Requesting Booking List allows access to the Booking information from within the ASM Support System to allow for CDM processes.
- Requesting Actions allows access to the Actions that can performed by the actor. Identifying where they may contribute to the CDM process within the ASM Support System and which Airspace Reservation they can update to better inform the plan.
- Requesting History allows access to the history of all actions that have been performed on a Booking.
ASM-INTF-ARES-010: ASM Service shall be supported by the Booking interface to manage the reservations
ASM-INTF-ARES-020: The Booking interface shall implement synchronous Request-Reply application message exchange pattern.
ASM-INTF-ARES-030: The Booking interface shall support the following operations:
- createBooking,
- updateBooking,
- queryBookingList
- queryActionList
- queryBookingHistoryList
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "createBooking", "description": "This operation is intended to introduce a new booking in the ASM Support System in response to a request from an External User. As a result, the new booking is either created in the local ASM Support System and the External User is notified, or the booking is not created and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-040: The createBooking operation shall receive and process the BookingCreationRequest message from an External User.
ASM-INTF-ARES-050: The createBooking operation shall validate the BookingCreationRequest message against the following criteria which must be met:
- All mandatory data for the BookingCreationRequest message are provided
- The booking ID must be null/not set
- The start date and time of all AirspaceReservations must be in the future
- The end date and time of an AirspaceReservation must be after its start date and time
- The External User must have permission to book the airspace structures as defined by the ActivityData.
- The entire booked period must be within the life time of all booked airspace structures
- The booked flight levels must be within or equal to the flight level bounds of the airspace structures
- The booked lower flight level of an airspace structure must be below the booked upper flight level of the airspace structure
- The selected responsible unit must be common to all booked airspace structures as defined by the ActivityData.
ASM-INTF-ARES-060: If the booking is valid, the createBooking operation shall transmit the newly created booking in the BookingReply message to the requesting External User.
ASM-INTF-ARES-070: If the request or the resulting booking is not valid, the createBooking operation shall transmit an appropriate error in the BookingReply message to the requesting External User.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": " updateBooking", "description": "This operation is intended to introduce updates to an existing booking in the ASM Support System in response to a request from an External User. As a result, the booking is either updated in the local ASM Support System and the External User is notified, or the booking is not updated and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-080: The updateBooking operation shall receive and process the BookingUpdateRequest message from an External User.
ASM-INTF-ARES-090: The updateBooking operation shall validate the BookingUpdateRequest message against the following criteria which must be met:
- All mandatory data for the BookingUpdateRequest message are provided
- The booking ID must be set
- The lastChangeTime in the booking must match that held by the service
- The start date and time of all AirspaceReservations must be in the future; if the booking is active the start dates and times must match the original start dates and times and the end time should be in the future
- The end date and time of an AirspaceReservation must be after its start date and time
- The External User must have permission to book the airspace structures as defined by the ActivityData
- The entire booked period must be within the life time of all booked airspace structures
- The booked flight levels must be within or equal to the flight level bounds of the airspace structures
- The booked lower flight level of an airspace structure must be below the booked upper flight level of the airspace structure
- The selected responsible unit must be common to all booked airspace structures as defined by the ActivityData
ASM-INTF-ARES-100: If the booking update is valid, the updateBooking operation shall transmit the updated booking in the BookingReply message to the requesting External User.
ASM-INTF-ARES-110: If the request or the resulting updated booking is not valid, the updateBooking operation shall transmit an appropriate error in the BookingReply message to the requesting External User.
ASM-INTF-ARES-120: An updateBookingRequest should be rejected by the service if the user performing the update does not have the appropriate actions matching their update.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "queryBookingList", "description": "This operation is intended to introduce a query for the list of bookings in the ASM Support System in response to a request from an External User. As a result, the list of bookings is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-130: The queryBookingList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-140: The queryBookingList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for FilteredRequest message are provided
ASM-INTF-ARES-150: If the request is valid, the queryBookingList operation shall transmit the filtered list of bookings in the BookingListReply message to the requesting External User.
ASM-INTF-ARES-160: If the request is not valid, the queryBookingList operation shall transmit an appropriate error in the BookingListReply message to the requesting External User.
ASM-INTF-ARES-170: The queryBookingList operation shall accept any combination of the following filters in the FilteredRequest message:
- ActivityIDFilter
- ChangePeriodFilter
- InterestedIntervalFilter
- AndFilter
ASM-INTF-ARES-180: The queryBookingList operation should accept any combination of the following filters in the FilteredRequest message:
- AirspaceIDFilter
- GeometryFilter
- MissionIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "queryActionList", "description": "This operation is intended to introduce a query for the list of actions in the ASM Support System in response to a request from an External User. As a result, the list of actions is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-190: The queryActionList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-200: The queryActionList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for the FilteredRequest message are provided
ASM-INTF-ARES-210: If the request is valid, the queryActionList operation shall transmit the list of actions in the BookingActionListReply message to the requesting External User.
ASM-INTF-ARES-220: If the request is not valid, the queryActionList operation shall transmit an appropriate error in the BookingActionListReply message to the requesting External User.
ASM-INTF-ARES-230: The queryActionList operation shall accept the following filter in the FilteredRequest:
- ActivityIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "queryBookingHistoryList", "description": "This operation is intended to introduce a query for the list of history of actions performed on a booking in the ASM Support System in response to a request from an External User. As a result, the list of history of actions performed on a booking is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
Associated messages
ASM-INTF-ARES-240: The queryBookingHistoryList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-ARES-250: The queryBookingHistoryList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for the FilteredRequest message are provided
ASM-INTF-ARES-260: If the request is valid, the queryBookingHistoryList operation shall transmit the complete list of history of actions performed on a booking in the BookingHistoryListReply message to the requesting External User.
ASM-INTF-ARES-270: If the request is not valid, the queryBookingHistoryList operation shall transmit an appropriate error in the BookingHistoryListReply message to the requesting External User.
ASM-INTF-ARES-280: The queryBookingHistoryList operation shall accept the following filter in the FilteredRequest message:
- ActivityIDFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "BookingConflicts", "description": "Interface role
Requesting Conflict List allows access to the Booking conflict information from within the ASM Support System to enhance CDM processes.
Figure 23 in Section 2.4.7.1 provides an overview of the Booking conflicts interface
The elements in the data model are described in full detail in section 2.7.3 Interface Messages.
Information Exchange Flow
Figure 24 in Section 2.4.7.2 depicts the information exchange flow for the Booking Conflicts interface.
Interface Functions
The interface performs the following functions:
- Requesting booking conflict data \u2013 allows access to booking conflict data from within the ASM Support System
ASM-INTF-CON-010: ASM Service should be supported by the Booking Conflicts interface to manage booking conflicts.
ASM-INTF-CON-020: The Booking Conflicts interface shall support the following operation:
- queryConflictList
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "queryConflictList", "description": "This operation is intended to introduce a query for the list of conflicts between bookings in the ASM Support System in response to a request from an External User. As a result, the list of conflicts between bookings is either transmitted to the External User or not, and an appropriate error message is transmitted to the External User.
ASM-INTF-CON-030: The queryConflictList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-CON-040: The queryConflictList operation shall validate the FilteredRequest message against the following criteria which must be met:
- All mandatory data for the FilteredRequest message are provided
ASM-INTF-CON-050: If the request is valid, the queryConflictList operation shall transmit the list of conflicts in the BookingConflictListReply message to the requesting External User.
ASM-INTF-CON-060: If the request is not valid, the queryConflictList operation shall transmit an appropriate error in the BookingConflictListReply message to the requesting External User.
ASM-INTF-CON-070: The queryConflictList operation shall accept any combination of the following filters in the FilteredRequest:
- ActivityIDFilter
- AndFilter
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "Mission", "description": "Interface role
The Mission interface allows for the creation, modification and retrieval of missions held within the ASM Support System by External Users. This interface allows exchange of mission information between host and foreign ASM Support Systems.
Figure 26 in Section 2.4.8.1 provides an overview of the Mission interface.
Information Exchange Flow
Figure 27 in Section 2.4.8.2 depicts the Mission interface information exchange flow
Interface Functions
The interface performs the following functions:
- Creating a Mission - introduces a new Mission into the ASM Support System to be approved to be incorporated into the plan.
- Updating a Mission - updates an existing Mission in the ASM Support System potentially as a result of a CDM process or simply to update the plan to reflect real world changes to planned activities
- Requesting Missions - allows access to the Missions information from within the ASM Support System to allow for CDM processes.
ASM-INTF-MIS-010: ASM Service should be supported by the Mission interface to manage the exchange of mission information.
ASM-INTF-MIS-020: The Mission interface shall support the following operation:
- createMission,
- updateMission,
- queryMissionList
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "createMission", "description": "ASM-INTF-MIS-030: The createMission operation shall receive and process the MissionCreationRequest message from an External User.
ASM-INTF-MIS-040: If the mission is valid, the createMission operation shall transmit the newly created mission in the MissionReply message to the requesting External Users.
ASM-INTF-MIS-050: If for any reason the request or the resulting mission is not valid, the createMission operation shall transmit an appropriate error in the MissionReply message to the requesting External Users.
Note: The definition of these can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": " updateMission", "description": "ASM-INTF-MIS-060: The updateMission operation shall receive and process the MissionUpdateRequest message from an External User.
ASM-INTF-MIS-070: If the mission update is valid, the updateMission operation shall transmit the updated mission in the MissionReply message to the requesting External Users.
ASM-INTF-MIS-080: If for any reason the request or the resulting updated mission is not valid, the updateMission operation shall transmit an appropriate error in the MissionReply message to the requesting External Users.
ASM-INTF-MIS-090: A MissionUpdateRequest should be rejected by the service if the user performing the update does not have the appropriate actions matching their update.
Note: The definition of these can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "queryMissionList", "description": "ASM-INTF-MIS-100: The queryMissionList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-MIS-110: If the request is valid, the queryMissionList operation shall transmit the list of missions in the MissionListReply message to the requesting External Users.
ASM-INTF-MIS-120: If for any reason the request is not valid, the queryMissionList operation shall transmit an appropriate error in the MissionListReply message to the requesting External Users.
ASM-INTF-MIS-130: The queryMissionList operation shall accept any combination of the following filters in the FilteredRequest message:
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "AirspaceNegotiation ", "description": "Interface role
The Airspace Negotiation interface enables the retrieval and handling of proposals held within the ASM Support System by External Users.
A proposal refers to a specific reservation and effectively re-defines a subset of the reservation data. The Negotiation interface enables a proposal to be accepted or rejected as per the actions accessible through the service.
The Negotiation interface allows users managing the airspace to make proposals to booking requests introduced by foreign airspace requesters. The proposals could address the FLs, times, or even different area. These proposals could be accepted or rejected.
Figure 29 in Section 2.4.9.1 provides an overview of the Airspace negotiation interface
Information Exchange Flow
Figure 30 in Section 2.4.9.2 depicts the Airspace negotiation interface information exchange flow.
Interface Functions
The interface performs the following functions:
- Creating a Proposal - introduces a new Proposal into the ASM Support System.
- Requesting Proposal List - allows access to the Proposal information from within the ASM Support System to allow for CDM processes.
- Handling Proposals \u2013 accepts or rejects the Proposal
ASM-INTF-NEG-010: ASM Service should be supported by the Airspace Negotiation interface to manage the reservations.
ASM-INTF-NEG-020: The AirspaceNegotiation interface shall support the following operations:
- createBookingProposal,
- queryBookingProposalList
- handleBookingProposal
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "createBookingProposal", "description": "ASM-INTF-NEG-030: The createBookingProposal operation shall receive and process the BookingProposalRequest message from an External User.
ASM-INTF-NEG-040: If the proposal is valid, the createBookingProposal operation shall transmit the newly created proposal in the BookingProposalReply message to the requesting External Users.
ASM-INTF-NEG-050: If for any reason the request or the resulting proposal is not valid, the createBookingPrposal operation shall transmit an appropriate error in the BookingProposalReply message to the requesting External Users.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "IN" } ] }, { "name": "queryBookingProposalList", "description": "ASM-INTF-NEG-060: The queryBookingProposalList operation shall receive and process the FilteredRequest message from an External Users.
ASM-INTF-NEG-070: If the proposal list request is valid, the queryBookingProposalList operation shall transmit the list of proposals in the BookingProposalListReply message to the requesting External Users.
ASM-INTF-NEG-080: If for any reason the request is not valid, the queryBookingProposalList operation shall transmit an appropriate error in the BookingProposalListReply message to the requesting External Users.
ASM-INTF-NEG-085: The queryBookingProposalList operation shall accept any combination of the following filters in the FilteredRequest message:
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] }, { "name": "handleBookingProposal", "description": "ASM-INTF-NEG-090: The handleBookingProposal operation shall receive and process the HandleBookingProposalRequest message from an External User.
ASM-INTF-NEG-100: If the request is valid, the handleBookingProposal operation shall perform the requested action.
ASM-INTF-NEG-110: If for any reason the request is not valid, the updateBooking operation shall transmit an appropriate error in the HandleBookingProposalReply message to the requesting External User.
ASM-INTF-NEG-120: A HandleBookingProposalRequest should be rejected by the service if the user performing the update does not have the appropriate actions matching their update.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" }, { "name": "AirspaceStatus ", "description": "Interface role
The Airspace Status interface enables External Users (service consumers) to retrieve activation data on the status of airspace in the ASM system in real time.
An activation refers to the specific state of an airspace structure at the current time and until a specified end time. The end time of an activation is subject to change, it may be shortened or extended.
This interface allows consumers to see in real time the status of the airspace managed by the ASM Support System. The activation data provided contains the information known by the ASM system including the start time of the current activation state and the expected end time. Within the ASM system, the actual end time may be changed during the tactical phase. The changes to the current activation state are communicated immediately. The current activation state can be supplemented with the planned airspace usage information available from the Booking Interface in section 2.4.6, thus allowing visibility of the latest planned upcoming activations and deactivations within the ASM system.
This interface is treated as safety critical when used via the publish-subscribe mechanism detailed in the Publication Interface section 2.4.3. Under such use it requires that the External User acknowledges receipt and understanding of the activation data allowing the ASM system to detect in cases that a change in status is not received and processed by the External User. In contrast to the other interfaces defined in this service, subscribing to activation data will cause the current activation state to be automatically fully published to the subscriber. This ensures the initial state is always transmitted to External Users subscribing to activation data and also ensures that the initial state is acknowledged.
Figure 32 in Section 2.4.10.1 provides an overview of the Airspace status interface.
Information Exchange Flow
Figure 33 in Section 2.4.10.3 depicts the Airspace status interface information exchange flow.
Interface Functions
The interface performs the following function:
- Requesting Activations - Allows access to the activation data held within the ASM Support System by External Users.
ASM-INTF-STAT-010: ASM Service shall be supported by the Airspace Status interface to manage the retrieval of activation data held within the ASM Support System by external users.
ASM-INTF-STAT-020: The AirspaceStatus interface shall support the following operation:
- queryActivationList
", "provisionSide": "CONSUMER_SIDE", "swimTIProfile": { "name": "EUROCONTROL SWIM-TI Yellow Profile", "version": "1.1" }, "operations": [ { "name": "queryActivationList", "description": "ASM-INTF-STAT-030: The queryActivationList operation shall receive and process the FilteredRequest message from an External User.
ASM-INTF-STAT-040: If the activation list request is valid, the queryActivationList operation shall transmit the matching activation data in the ActivationListReply message to the requesting External User.
ASM-INTF-STAT-050: If for any reason the request is not valid, the queryActivationList operation shall transmit an appropriate error in the ActivationListReply message to the requesting External User.
ASM-INTF-STAT-055: The queryActivationList operation shall accept any combination of the
following filters in the FilteredRequest message:
ASM-INTF-STAT-060: The External User shall only make use of data returned in an ActivationListReply for non-safety critical information purposes.
ASM-INTF-STAT-070: The External User shall make use of the AMQP service for safety-relevant purposes.
ASM-INTF-STAT-080: The External User should acknowledge receipt of any valid ActivationNotification published onto an AMQP queue, by publishing an AcknowledgementReceiptRequest message onto the AMQP queue referenced in the ActivationNotification message.
ASM-INTF-STAT-090: The ASM Support System shall select an appropriate value for Activation acknowledgement-time and ensure that this value is appropriately documented for use by service consumers.
Note: The definition of these messages can be found in section 2.7.3 Interface Messages.
", "messages": [ { "name": "The definition of these messages can be found in Section 2.7.3 Interface Messages.", "direction": "OUT" } ] } ], "messageExchangePattern": "SYNCHRONOUS_REQUEST_RESPONSE" } ] } }