Service Definition Identification

service definition identification	title	Service definition for the Aeronautical Data Set Request Service
	edition	00.06.00
	reference date	2024-09-23

Service Identification

service identification	service name	Aeronautical Data Set Request Service

Service Abstract

service abstract

The Aeronautical Data Set Request Service allows the service consumer to request a data set, based on a set of filters, from a data set store.

The service is part of a series of services that supports the provision of digital data sets as defined by ICAO Annex 15.

Service Definition Provider

service definition provider	name	EUROCONTROL
	description	EUROCONTROL is an intergovernmental organisation with 41 Member and 2 Comprehensive Agreement States.
	point of contact	ais.aixm@eurocontrol.int

Geographical Extent of Information

geographical extent of information

The geographical extent of the information in the data set shall be:

stated in the data product specification;
stated in the metadata concerning the data set series and data set; and
expressed in terms of airspace, aerodrome and state.

Service Categories

service categories	category	category name	Information Domain
		value	AERONAUTICAL_INFORMATION
		scheme	https://reference.swim.aero/information-services/service-categories/CodeInformationDomainType
	category	category name	intended service provider
		value	AERONAUTICAL_INFORMATION_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	Business Activity
		value	INFORMATION_MANAGEMENT
		scheme	http://reference.swim.aero/information-services/service-categories/CodeBusinessActivityType
	category	category name	intended service consumer
		value	AERONAUTICAL_INFORMATION_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	AIR_TRAFFIC_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	CIVIL_AIRSPACE_USER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	MILITARY_AIRSPACE_USER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	CIVIL_AIR_NAVIGATION_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	MILITARY_AIR_NAVIGATION_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	NETWORK_MANAGER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	PROVIDER_OF_DATA_SERVICES
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	intended service consumer
		value	REGULATED_METEOROLOGICAL_SERVICE_PROVIDER
		scheme	http://reference.swim.aero/information-services/service-categories/CodeStakeholderType
	category	category name	service type
		value	AERONAUTICAL_DATA_PRODUCT_ACCESS_SERVICE
		scheme	http://reference.swim.aero/information-services/service-categories/CodeServiceType

Service Standard Reference

Explanatory note

This field is left empty.

service standard reference	reference
	implemented options
	deviations/additions

Operational Environment

operational environment

operational needs

ICAO Annex 15 details the aeronautical information products to be made available by Aeronautical Information Services. These include digital data sets. These are primarily to satisfy international requirements for the exchange of aeronautical information. The data sets can be used to populate a local database for use in applications.

capabilities

The service supports the discovery and retrieval of the aeronautical digital data sets as defined by ICAO Annex 15:

AIP data set;
Obstacle data set;
Terrain data set;
Aerodrome mapping data set;
Instrument flight procedure data set

The service supports the discovery and retrieval of customised digital data sets that are designed for specific purposes.

information exchange requirements

IER1	The content of the ICAO digital data sets as defined in PANS-AIM - Appendix 1 - Tables.
IER2	Metadata as outlined in the Minimal Metadata Requirements.
IER3	Customised digital data sets that are designed for specific purposes.

Service Functions

service functions	function	name	Request data set series list
		description	The service consumer shall be able to request a list of data set series that match the required criteria including type, geographical scope and title.
		real-world effect	The service consumer receives the list of matching data set series.
	function	name	Request data set list
		description	The service consumer shall be able to request a list of data sets that match the required criteria including data set series, period of validity, geographical scope, limitations on use and title.
		real-world effect	The service consumer receives the list of matching data sets.
	function	name	Request data set
		description	The service consumer shall be able to request a data set.
		real-world effect	The service consumer receives the data set.
	function	name	Request data product specification
		description	The service consumer shall be able to request a data product specification.
		real-world effect	The service consumer receives the data product specification.

Service Access and Use Conditions

service access and use conditions	legal constraints
	service policies	business policy	Billing functions should be handled by another service. It is not the intention of the service to support billing functions.
		operational policy
		technical policy
	service consumption constraints

Security Constraints

security constraints	authentication	The service may offer unauthenticated/public use. If the use is authenticated, the service shall ensure consumer authentication in accordance with the EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate or the use of a username/password (SASL). The service shall ensure provider authentication in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of a X.509 certificate.
	authorisation	The service shall ensure that satisfactory authorisation is put in place according to EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile requirement SWIM-TIYP-0070.
	confidentiality	The service shall ensure point-to-point confidentiality in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above.
	integrity	The service shall ensure point-to-point integrity in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile through the use of Transport Layer Security (TLS) 1.2 or above.

Quality of Service

quality of service	performance	capacity	The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
	performance	response time	The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
	reliability	availability	The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
	reliability	recoverability	The service shall achieve a quality that is sufficient to ensure the service is fit for purpose.
	security	confidentiality	The service shall ensure confidentiality by using SWIM Technical Infrastructure (TI) Yellow Profile bindings.
	security	integrity	The service shall ensure integrity by using SWIM Technical Infrastructure (TI) Yellow Profile bindings.

Quality of Data

quality of data	The data contained in the digital data set shall meet the data quality requirements outlined in ICAO Annex 15. The data contained in the digital data set shall meet the data quality requirements outlined in the PANS-AIM Data Catalogue. If the data quality requirements are not met, the data product specification shall record which requirements are not met.

Source of Information

source of information

source

The aeronautical data offered by the service shall be received from the appropriate authorised originating sources, e.g.,

AIRPORT_OPERATOR
CIVIL_AIR_NAVIGATION_SERVICE_PROVIDER
MILITARY_AIR_NAVIGATION_SERVICE_PROVIDER
COMMUNICATION_NAVIGATION_AND_SURVEILLANCE_SERVICE_PROVIDER
Government Agencies
Owners of Obstacles

modifications

The data received from the originating sources shall only be modified according to the regular AIS processes.

Service Validation Information

service validation information	validation performed	The service was prototyped in 2021.
	method used	USER_VALIDATION
	summary of the validation steps performed
	results achieved	The service operations and information definition were tested. However, the quality of service was not tested.
	how the service consumer may obtain the validation evidence	https://ext.eurocontrol.int/aixm_confluence/display/ADS/EUROCONTROL+prototype

Application Message Exchange Pattern

application message exchange pattern	SYNCHRONOUS_REQUEST_REPLY

Service Behaviour

service behaviour	typical behaviour	The service behaviour shall be in accordance with the patterns detailed in the Message Exchange Patterns: Identification Guidelines. A typical sequence is: The service consumer requests data set series based on a number of selection criteria, and receives back a list containing zero, one or more data set series. The service consumer analyses that list to identify the data set series of interest. The service consumer requests data sets from the selected data set series, possibly supplying additional selection criteria, and receives back a list containing zero, one or more data sets. The service consumer analyses that list to identify the data set(s) of interest. For each data set of interest The service consumer requests the file information of the selected data set, and receives back a list of one or more files. For each file, the service consumer retrieves the file, and receives back the file content.
service behaviour	exception handling	The service shall make use of the standard HTTP status codes.

Service Monitoring

Explanatory note

This field is left empty.

service monitoring

Service Interfaces

service interfaces

interface

name

SearchAndRetrieve

description

The interface groups the operations that allows querying metadata and retrieving files.

provider/consumer side

PROVIDER_SIDE_INTERFACE

SWIM TI Profile and Interface Bindings

SWIM TI profile and interface bindings	profile name	EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile
	profile version	1.1
	selected service interface binding	WS_LIGHT
	selected network interface binding	The service shall use the network bindings of the SWIM TIYP.
	description

Service Interface Protocols and Data Format

service interface protocols and data format	transport / messaging protocols	The service shall use TLS1.2 or later in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile.
service interface protocols and data format	data format	XML

Service Operations

service operations	operation	operation name	queryDataSets
		description	The operation accepts criteria about data sets and returns a list with the metadata about the corresponding data sets.
		messages	QueryDataSetsRequest, QueryDataSetsReply
		resources	Resource: /datasets Output: [0..*] dataset object
	operation	operation name	queryDataSetSeries
		description	The operation accepts criteria about data set series and returns a list with the metadata about the corresponding data set series.
		messages	QueryDataSetSeriesRequest, QueryDataSetSeriesReply
		resources	Resource: /datasetseries Output: [0..*] dataset series object
	operation	operation name	queryDataSetFiles
		description	The operation accepts the identifier of a data set and returns the list of file objects for that data set.
		messages	QueryDataSetFilesRequest, QueryDataSetFilesReply
		resources	Resource: /datasets/{ID}/files Output: [0..*] file object
	operation	operation name	queryDataSetSeriesDpsFiles
		description	The operation accepts the identifier of a data set series and returns the data product specification for that data set.
		messages	QueryDataSetSeriesDpsFilesRequest, QueryDataSetSeriesDpsFilesReply
		resources	Resource: /datasetseries/{ID}
	operation	operation name	retrieveDataSetFile
		description	The operation accepts a request for a data set file and returns the corresponding content of the file
		messages	RetrieveDataSetFileRequest, RetrieveDataSetFileReply
		resources	Resource: /files/{ID} Output: [0..1] file content
	operation	operation name	retrieveDPSFile
		description	The operation accepts a request for a data product specification file and returns the corresponding content of the file
		messages	RetrieveDPSFileRequest, RetrieveDPSFileReply
		resources	Resource: /datasetseries/{ID}/dps Output: [0..1] file content

Service Messages

QueryDataSetSeriesRequest

Message which provides the criteria for querying data set series based on their metadata

Property name	Type, Multiplicity	Definition
conformance	CodeEncodingStandardType [0..1]	Standard to which the data conforms.
form	CodeDataSetFormType [0..1]	Form of the data sets contained in the data set series.
geographicalExtent	Location [0..*]	Location defining the scope of the data set series.
identifier	IdentifierType [0..1]	Special unique identifier permanently assigned to a resource.
militaryOrCivilProvider	CodeProviderType [0..1]	Indication if the data sets in the data set series are produced by military or civil organisations.
subject	SubjectType [0..*]	Data subject covered by the data set series.
title	string [0..1]	Name by which the cited resource is known.

QueryDataSetSeriesReply

Message which responds to a previously sent QueryDataSetSeriesRequest message, with a status code, and a list of summary information about the data set series fulfilling the request criteria.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
dataSetSeries	DataSetSeries [0..*]	Data set series matching the query criteria.

QueryDataSetsRequest

Message which provides the criteria for querying data sets based on their metadata.

Property name	Type, Multiplicity	Definition
conformance	CodeEncodingStandardType [0..1]	Standard to which the data conforms.
dataSetSeriesIdentifier	IdentifierType [0..1]	Identifier of the data set series to which the data set belongs.
dataSetSeriesTitle	string [0..1]	Name of the data set series. Pattern allowed using %...%.
form	CodeDataSetFormType [0..1]	Form of the data set.
geographicalExtent	Location [0..*]	Location defining the scope of the data set.
identifier	IdentifierType [0..1]	Special unique identifier permanently assigned to a resource.
isAiracUpdate	boolean [0..1]	Indication that the data set has been updated according to the AIRAC System.
provider	string [0..1]	Name of the organisation that provided the data set.
publicationDate	date [0..1]	Date at which the data set became available.
startValidity	date [0..1]	Start of the validity period for the data set.
subject	SubjectType [0..*]	Data subject covered by the data set.
title	string [0..1]	Name by which the cited resource is known.

QueryDataSetsReply

Message which responds to a previously sent QueryDataSetsRequest message, with a status code, and a list of summary information about each available data set that fulfils the request criteria.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
dataSet	DataSet [0..*]	Metadata about the matching data set.

QueryDataSetFilesRequest

Message which provides the identifier of the data set for which the file objects are requested.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Special unique identifier permanently assigned to a resource.

QueryDataSetFilesReply

Message which responds to a previously sent QueryDataSetFilesRequest message, with a status code, and a list of file objects.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
file	File [0..*]	Metadata about the data set file.

RetrieveDataSetFiletRequest

Message which provides the identifier of the file to be retrieved.

Property name	Type, Multiplicity	Definition
identifier	IdentifierType [1]	Special unique identifier permanently assigned to a resource.

RetrieveDataSetFileReply

Message which responds to a previously sent RetrieveDataSetFileRequest message, with a status code, and the content of the file in case of success.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
fileContent	FileContent	The file retrieved.

RetrieveDPSFiletRequest

Message which provides the identifier of the data set series of the data product specification to be retrieved.

Property name	Type, Multiplicity	Definition
identifer	IdentifierType [1]	Special unique identifier permanently assigned to a resource.

RetrieveDPSFileReply

Message which responds to a previously sent RetrieveDPSFileRequest message, with a status code, and the content of the file in case of success.

Inherits from Reply message

Property name	Type, Multiplicity	Definition
fileContent	FileContent	The file retrieved.

Reply

Generic reply to a request.

Property name	Definition	Type, Multiplicity
status	Status of the reply to the service request (HTTP status code).	ReplyStatus [1]

Information Definition

information definition	Aeronautical Data Set Information Definition

Filter Encoding

filter encoding	The service shall support filtering based on logical, geographical and temporal operators including data set series, period of validity, geographical scope, limitations on use and title.

Machine-Readable Service Interface Definition

Explanatory note

This field is left empty.

machine-readable service interface definition

Model View

Explanatory note

This field is left empty.

model view

Abbreviations and Acronyms

abbreviations and acronyms	abbreviation	code	AIP
	abbreviation	term	Aeronautical Information Publication
	abbreviation	code	AIRAC
	abbreviation	term	Aeronautical Information Regulation and Control
	abbreviation	code	AIS
	abbreviation	term	Aeronautical Information Services
	abbreviation	code	AIM
	abbreviation	term	Aeronautical Information Management
	abbreviation	code	DPS
	abbreviation	term	Data Product Specification
	abbreviation	code	HTTP
	abbreviation	term	Hypertext Transfer Protocol
	abbreviation	code	ICAO
	abbreviation	term	International Civil Aviation Organisation
	abbreviation	code	IER
	abbreviation	term	Information Exchange Requirement
	abbreviation	code	PANS
	abbreviation	term	Procedures For Air Navigation Services
	abbreviation	code	SWIM
	abbreviation	term	System Wide Information Management
	abbreviation	code	TI
	abbreviation	term	Technical Infrastructure
	abbreviation	code	WS
	abbreviation	term	Web Service
	abbreviation	code	YP
	abbreviation	term	Yellow Profile

Appendix A: References

references	reference	title	Publish/Subscribe Push MEP: Implementation Guidance
		version	JULY 2nd, 2019
		description	Guidelines on implementing the publish subscribe message exchange patterns
		url	http://reference.swim.aero/technical-infrastructure/guidance-for-pub-sub-push-implementation.htm
		document type

Aeronautical Data Set Request Service - Service Definition

Service Definition Identification

Service Identification

Service Abstract

Service Definition Provider

Geographical Extent of Information

Service Categories

Service Standard Reference

Operational Environment

Service Functions

Service Access and Use Conditions

Security Constraints

Quality of Service

Quality of Data

Source of Information

Service Validation Information

Application Message Exchange Pattern

Service Behaviour

Service Monitoring

Service Interfaces

SWIM TI Profile and Interface Bindings

Service Interface Protocols and Data Format

Service Operations

Service Messages

QueryDataSetSeriesRequest

QueryDataSetSeriesReply

QueryDataSetsRequest

QueryDataSetsReply

QueryDataSetFilesRequest

QueryDataSetFilesReply

RetrieveDataSetFiletRequest

RetrieveDataSetFileReply

RetrieveDPSFiletRequest

RetrieveDPSFileReply

Reply

Information Definition

Filter Encoding

Machine-Readable Service Interface Definition

Model View

Abbreviations and Acronyms

Appendix A: References