The EUROCONTROL prototype has been created in order to verify the completeness and the correctness of the Service Definitions.
It allows users to test the service without having to invest effort in the implementation of a client service.
The prototype uses the fictitious "Donlon" data set and sample data sets made available by some AIS.
| Table of Contents |
|---|
Access
The Prototype provides two means to access the service:
- HMI - an "AeronauticalDatasetClient" that works in a web browser
- API - a B2B interface
Both methods are documented here.
Access via HMI
| Warning | ||
|---|---|---|
| ||
In order to access you must
|
Connect to the following web site using a Web browser: EUROCONTROL "AeronauticalDatasetClient" Prototype
The following picture shows one of the screens of the Eurocontrol Prototype, This example of a possible client application, working within a Web browser, interacts in fact with the service through the B2B service interfaces, which are implemented as specified in the Service Definition.
It shall be well understood that the client application functionality and human interface are not part of the service description! The prototype HMI is provided only in order to help understanding the service functionality, without the need to develop a client application.
Access via API
REST interface
| Warning | ||
|---|---|---|
| ||
A security certificate must be installed on the local application. This also applies in the case that a web browser is used for the REST calls described here. Please contact aim@eurocontrol.int in order to get the certificate and further instructions about it. |
The prototype service may be accessed through a REST interface. The Swagger documentation provided below contains further details.
URL for external access
In the swagger documentation, the base URL to call is provided as : http://webprisme-test.cfmu.eurocontrol.int/aeronautical_dataset/ . This is valid for the internal environment only. In the external environment, the user has to use https://ext-test.eurocontrol.int:10444/aeronautical_dataset/ and not the internal URL described in the documentation.
According to the Swagger documentation, as an example, in order to get airports, the following call is used:
- https://ext-test.eurocontrol.int:10444/aeronautical_dataset/location/airports (External environment)
API documentation
You can regenerate the documentation as a JSON file following this URL
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"swagger": "2.0",
"info": {
"description": "Api Documentation",
"version": "1.0",
"title": "Api Documentation",
"termsOfService": "urn:tos",
"contact": {},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
}
},
"host": "webprisme-test.cfmu.eurocontrol.int",
"basePath": "/aeronautical_dataset",
"tags": [
{
"name": "Aeronautical Dataset Manager",
"description": "Aeronautical Manager Rest Controller"
},
{
"name": "Aeronautical Dataset Provider",
"description": "Aeronautical Rest Controller"
},
{
"name": "Data Provider",
"description": "Data Controller"
},
{
"name": "Location",
"description": "Location Controller"
},
{
"name": "basic-error-controller",
"description": "Basic Error Controller"
}
],
"paths": {
"/data/encoding": {
"post": {
"tags": [
"Data Provider"
],
"summary": "Create a new encoding",
"operationId": "createDataEncoding",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "encoding",
"description": "encoding",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DataEncoding"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/encodings": {
"get": {
"tags": [
"Data Provider"
],
"summary": "Find all the data encodings",
"operationId": "findAllDataEncodings",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DataEncoding"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/subject": {
"post": {
"tags": [
"Data Provider"
],
"summary": "Create a new subject",
"operationId": "createDataSubject",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "subject",
"description": "subject",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DatasetSubject"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/subjects": {
"get": {
"tags": [
"Data Provider"
],
"summary": "Find all the data subjects",
"operationId": "findAllDataSubjects",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetSubject"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/type": {
"post": {
"tags": [
"Data Provider"
],
"summary": "Create a new type",
"operationId": "createDataType",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "typeName",
"description": "typeName",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DatasetType"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/types": {
"get": {
"tags": [
"Data Provider"
],
"summary": "Find all the dataset types",
"operationId": "findAllDatasetTypes",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetType"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/update_type": {
"post": {
"tags": [
"Data Provider"
],
"summary": "Create a new update type",
"operationId": "createDataUpdateType",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "updateTypeName",
"description": "updateTypeName",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DataUpdateType"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/data/update_types": {
"get": {
"tags": [
"Data Provider"
],
"summary": "Find all the update types",
"operationId": "findAllUpdateTypes",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DataUpdateType"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasetfiles": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Find the dataset files",
"operationId": "queryDatasetFiles",
"produces": [
"*/*"
],
"parameters": [
{
"name": "datasetCode",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "format",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetFile"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasets": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Find the datasets",
"operationId": "queryDatasets",
"produces": [
"*/*"
],
"parameters": [
{
"name": "airacUpdate",
"in": "query",
"description": "the value should be 'Y' or 'N'",
"required": false,
"type": "string"
},
{
"name": "airportDesignators",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportNames",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportsIataCodes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportsIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "airspaceDesignators",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspaceNames",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspaceTypes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspacesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "countriesCode",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "countriesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "countriesName",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "dataSubjectIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "datasetCode",
"in": "query",
"description": "Identifier of the element",
"required": false,
"type": "string"
},
{
"name": "datasetSeriesCode",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "datasetSeriesId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "dpsFileId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "effectiveDate",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "encodingId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "endValidity",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "operatorEffectiveDate",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "operatorPublicationDate",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "publicationDate",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "regionTerritoriesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "territoriesName",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "title",
"in": "query",
"description": "You can use the character '%' as a pattern (start with/end with)",
"required": false,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "updateTypeId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Dataset"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": [
"Aeronautical Dataset Manager"
],
"summary": "Create a new dataset",
"operationId": "createDataset",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"$ref": "#/definitions/CreateDatasetRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Dataset"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasets/upload": {
"post": {
"tags": [
"Aeronautical Dataset Manager"
],
"summary": "Upload a dataset file",
"operationId": "uploadDatasetFile",
"consumes": [
"multipart/form-data"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "file",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DatasetFile"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasetseries": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Find the dataset series",
"operationId": "queryDatasetSeries",
"produces": [
"*/*"
],
"parameters": [
{
"name": "airacUpdate",
"in": "query",
"description": "the value should be 'Y' or 'N'",
"required": false,
"type": "string"
},
{
"name": "airportDesignators",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportNames",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportsIataCodes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airportsIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "airspaceDesignators",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspaceNames",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspaceTypes",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "airspacesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "code",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "countriesCode",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "countriesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "countriesName",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "dataSubjectIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "dpsFileId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "encodingId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "regionTerritoriesIds",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"collectionFormat": "multi"
},
{
"name": "territoriesName",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "title",
"in": "query",
"description": "You can use the character '%' as a pattern (start with/end with)",
"required": false,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "usageLimit",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetSeries"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": [
"Aeronautical Dataset Manager"
],
"summary": "Create a new dataset series",
"operationId": "createDatasetSeries",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"$ref": "#/definitions/CreateDatasetSeriesRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DatasetSeries"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasetseries/dps/upload": {
"post": {
"tags": [
"Aeronautical Dataset Manager"
],
"summary": "Upload a DPS file",
"operationId": "uploadDPSFile",
"consumes": [
"multipart/form-data"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "file",
"required": true,
"type": "file"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DpsFile"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasetseries/files/dps": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Find the Dataset series DPS files",
"operationId": "queryDatasetSeriesDpsFiles",
"produces": [
"*/*"
],
"parameters": [
{
"name": "datasetSeriesCode",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "format",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DpsFile"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/datasetseries/{id}/dps": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Download a Data Product Specification (DPS) file",
"operationId": "queryDataProductSpecification",
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/error": {
"get": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"head": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingHEAD",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false
},
"post": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"put": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"delete": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingDELETE",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false
},
"options": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingOPTIONS",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false
},
"patch": {
"tags": [
"basic-error-controller"
],
"summary": "error",
"operationId": "errorUsingPATCH",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false
}
},
"/files/{id}": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Download a file",
"operationId": "retrieveFile",
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/location/airports": {
"get": {
"tags": [
"Location"
],
"summary": "Find all airports",
"operationId": "findAllAirports",
"produces": [
"*/*"
],
"parameters": [
{
"name": "startWith",
"in": "query",
"description": "startWith",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Airport"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/location/airspaces": {
"get": {
"tags": [
"Location"
],
"summary": "Find all airspaces",
"operationId": "findAllAirspaces",
"produces": [
"*/*"
],
"parameters": [
{
"name": "startWith",
"in": "query",
"description": "startWith",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Airspace"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/location/countries": {
"get": {
"tags": [
"Location"
],
"summary": "Find all countries",
"operationId": "findAllCountries",
"produces": [
"*/*"
],
"parameters": [
{
"name": "startWith",
"in": "query",
"description": "startWith",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/location/territories": {
"get": {
"tags": [
"Location"
],
"summary": "Find all territories",
"operationId": "findAllTerritories",
"produces": [
"*/*"
],
"parameters": [
{
"name": "startWith",
"in": "query",
"description": "startWith",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/paths": {
"get": {
"tags": [
"Aeronautical Dataset Provider"
],
"summary": "Get all paths from this service",
"operationId": "getAllPaths",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Paths"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
}
},
"definitions": {
"Airport": {
"type": "object",
"properties": {
"designator": {
"type": "string"
},
"fullName": {
"type": "string"
},
"iata": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "Airport"
},
"Airspace": {
"type": "object",
"properties": {
"designator": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"title": "Airspace"
},
"Country": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"territory": {
"type": "string"
}
},
"title": "Country"
},
"CreateDatasetRequest": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airportsIcao": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"airspacesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"countriesCode": {
"type": "array",
"items": {
"type": "string"
}
},
"countriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"dataSubjectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"datasetCode": {
"type": "string"
},
"datasetSeriesCode": {
"type": "string"
},
"datasetSeriesId": {
"type": "integer",
"format": "int64"
},
"effectiveDate": {
"type": "string"
},
"encodingId": {
"type": "integer",
"format": "int64"
},
"endValidity": {
"type": "string"
},
"files": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"limitationOfUse": {
"type": "string"
},
"publicationDate": {
"type": "string"
},
"regionTerritoriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"shortDescription": {
"type": "string"
},
"title": {
"type": "string"
},
"typeId": {
"type": "integer",
"format": "int64"
},
"updateTypeId": {
"type": "integer",
"format": "int64"
}
},
"title": "CreateDatasetRequest"
},
"CreateDatasetSeriesRequest": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airportsIcao": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"airspacesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"code": {
"type": "string"
},
"countriesCode": {
"type": "array",
"items": {
"type": "string"
}
},
"countriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"dataSubjectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"dpsFileId": {
"type": "integer",
"format": "int64"
},
"encodingId": {
"type": "integer",
"format": "int64"
},
"regionTerritoriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"title": {
"type": "string"
},
"typeId": {
"type": "integer",
"format": "int64"
},
"usageLimit": {
"type": "string"
}
},
"title": "CreateDatasetSeriesRequest"
},
"DataEncoding": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "DataEncoding"
},
"DataUpdateType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "DataUpdateType"
},
"Dataset": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airports": {
"type": "array",
"items": {
"$ref": "#/definitions/Airport"
}
},
"airspaces": {
"type": "array",
"items": {
"$ref": "#/definitions/Airspace"
}
},
"code": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
},
"dataSubjects": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetSubject"
}
},
"datasetSeriesCode": {
"type": "string"
},
"datasetSeriesId": {
"type": "integer",
"format": "int64"
},
"datasetSeriesTitle": {
"type": "string"
},
"effDate": {
"type": "string",
"format": "date"
},
"encoding": {
"$ref": "#/definitions/DataEncoding"
},
"endValidDate": {
"type": "string",
"format": "date"
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetFile"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"publicationDate": {
"type": "string",
"format": "date"
},
"regionTerritories": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
},
"shortDescription": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/definitions/DatasetType"
},
"updateType": {
"$ref": "#/definitions/DataUpdateType"
},
"usageLimit": {
"type": "string"
}
},
"title": "Dataset"
},
"DatasetFile": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "byte"
},
"datasetCode": {
"type": "string"
},
"datasetId": {
"type": "integer",
"format": "int64"
},
"datasetTitle": {
"type": "string"
},
"format": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
}
},
"title": "DatasetFile"
},
"DatasetRequest": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airportDesignators": {
"type": "array",
"items": {
"type": "string"
}
},
"airportNames": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIataCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"airspaceDesignators": {
"type": "array",
"items": {
"type": "string"
}
},
"airspaceNames": {
"type": "array",
"items": {
"type": "string"
}
},
"airspaceTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"airspacesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"countriesCode": {
"type": "array",
"items": {
"type": "string"
}
},
"countriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"countriesName": {
"type": "array",
"items": {
"type": "string"
}
},
"dataSubjectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"datasetCode": {
"type": "string"
},
"datasetSeriesCode": {
"type": "string"
},
"datasetSeriesId": {
"type": "integer",
"format": "int64"
},
"dpsFileId": {
"type": "integer",
"format": "int64"
},
"effectiveDate": {
"type": "string"
},
"encodingId": {
"type": "integer",
"format": "int64"
},
"endValidity": {
"type": "string"
},
"operatorEffectiveDate": {
"type": "string"
},
"operatorPublicationDate": {
"type": "string"
},
"publicationDate": {
"type": "string"
},
"regionTerritoriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"territoriesName": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"typeId": {
"type": "integer",
"format": "int64"
},
"updateTypeId": {
"type": "integer",
"format": "int64"
}
},
"title": "DatasetRequest"
},
"DatasetSeries": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airports": {
"type": "array",
"items": {
"$ref": "#/definitions/Airport"
}
},
"airspaces": {
"type": "array",
"items": {
"$ref": "#/definitions/Airspace"
}
},
"code": {
"type": "string"
},
"countries": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
},
"dataSets": {
"type": "array",
"items": {
"$ref": "#/definitions/Airspace"
}
},
"dataSubjects": {
"type": "array",
"items": {
"$ref": "#/definitions/DatasetSubject"
}
},
"dpsFile": {
"$ref": "#/definitions/DpsFile"
},
"encoding": {
"$ref": "#/definitions/DataEncoding"
},
"id": {
"type": "integer",
"format": "int64"
},
"regionTerritories": {
"type": "array",
"items": {
"$ref": "#/definitions/Country"
}
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/definitions/DatasetType"
},
"usageLimit": {
"type": "string"
}
},
"title": "DatasetSeries"
},
"DatasetSeriesRequest": {
"type": "object",
"properties": {
"airacUpdate": {
"type": "string"
},
"airportDesignators": {
"type": "array",
"items": {
"type": "string"
}
},
"airportNames": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIataCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"airportsIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"airspaceDesignators": {
"type": "array",
"items": {
"type": "string"
}
},
"airspaceNames": {
"type": "array",
"items": {
"type": "string"
}
},
"airspaceTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"airspacesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"code": {
"type": "string"
},
"countriesCode": {
"type": "array",
"items": {
"type": "string"
}
},
"countriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"countriesName": {
"type": "array",
"items": {
"type": "string"
}
},
"dataSubjectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"dpsFileId": {
"type": "integer",
"format": "int64"
},
"encodingId": {
"type": "integer",
"format": "int64"
},
"regionTerritoriesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"territoriesName": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"typeId": {
"type": "integer",
"format": "int64"
},
"usageLimit": {
"type": "string"
}
},
"title": "DatasetSeriesRequest"
},
"DatasetSubject": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "DatasetSubject"
},
"DatasetType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "DatasetType"
},
"DpsFile": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "byte"
},
"format": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"title": "DpsFile"
},
"ModelAndView": {
"type": "object",
"properties": {
"empty": {
"type": "boolean"
},
"model": {
"type": "object"
},
"modelMap": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"reference": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"view": {
"$ref": "#/definitions/View"
},
"viewName": {
"type": "string"
}
},
"title": "ModelAndView"
},
"Paths": {
"type": "object",
"properties": {
"datasetFiles": {
"type": "string"
},
"datasetSeries": {
"type": "string"
},
"datasets": {
"type": "string"
},
"retrieveDPSFile": {
"type": "string"
},
"retrieveFile": {
"type": "string"
}
},
"title": "Paths"
},
"View": {
"type": "object",
"properties": {
"contentType": {
"type": "string"
}
},
"title": "View"
}
}
} |
| Info | ||
|---|---|---|
| ||
Using the JSON file of the swagger documentation (from the confluence link), it is possible to generate a client application. For example, use this link : https://editor.swagger.io/, then upload the JSON file in the website and generate a client for the application (Java, Javascript, …). There are a lot of possibilities with swagger to generate a client. You can find all the possibilities on the official documentation : https://swagger.io/tools/swagger-codegen/ |