UCIS logo
Documentation Powered by Redocly

UCIS OpenApi (1.7.0)

Download OpenAPI specification:Download

UCIS Support: support.ucis@soprasteria.com URL: https://dev.ucis.io License: Sopra Steria

REST APIs offered by the UCIS solution

Authentication

ucis_auth

Information about how to use a token to authenticate with the UCIS APIs are available at UCIS Quickstart

Security Scheme Type OAuth2
password OAuth Flow
Token URL: ${AUTH_URL}/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
  • flight-planning.dops.read -

    Grants read access to Drone Operation Plans

  • flight-planning.dops.write -

    Grants write access to update Drone Operation Plans

  • flight-planning.dops.ack.write -

    Grants write access to acknowledge Drone Operation Plans

  • flight-planning.dops.activate.write -

    Grants write access to activate Drone Operation Plans

  • flight-planning.dops.approve.write -

    Grants write access to approve Drone Operation Plans

  • flight-planning.dops.cancel.write -

    Grants write access to cancel Drone Operation Plans

  • flight-planning.dops.close.write -

    Grants write access to close Drone Operation Plans

  • flight-planning.dops.reject.write -

    Grants write access to reject Drone Operation Plans

  • flight-planning.dops.submit.write -

    Grants write access to file Drone Operation Plans

  • geoawareness.uaszones.read -

    Grants read access to UASZone

  • geoawareness.uaszones.write -

    Grants write access to update UASZone

  • geoawareness.uaszones.submit.write -

    Grants write access to create UASZone

  • network.identification.read -

    Grants read access to Network Identification Data

  • dcm.hotspots.read -

    Grants read access to hotspots computed by Dynamic Capacity Management Service

  • discovery.ussps.read -

    Grants read access to U-Space Service Providers

  • discovery.airspace.read -

    Grants read access to U-Space Airspace

Discovery

Get U-Space Service Providers

Get a list of all U-Space Service Providers (USSP).

Authorizations:
ucis_auth (
  • discovery.ussps.read
)
query Parameters
offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

Array of MandatoryService (string) or AdditionalService (string) non-empty unique [ items ]

Find USpace Service Provider with all of these services. Comma separated list of statuses.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count U-Space Service Providers

Count U-Space Service Providers that match a request.

Authorizations:
ucis_auth (
  • discovery.ussps.read
)
query Parameters
Array of MandatoryService (string) or AdditionalService (string) non-empty unique [ items ]

Find USpace Service Provider with all of these services. Comma separated list of statuses.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get U-Space Airspaces

Get a list of all U-Space Airspaces.

Authorizations:
ucis_auth (
  • discovery.airspace.read
)
query Parameters
offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count U-Space Airspaces

Count U-Space Airspace that match a request.

Authorizations:
ucis_auth (
  • discovery.airspace.read
)

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Dynamic Capacity Management

Get Hotspots Deprecated

Get a list of Hotspots computed by the Dynamic Capacity Service depending on triggered date time or geographic area.

Temporal queries are applied on the time field of the DcmHotspot.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Hotspots are returned.

Authorizations:
ucis_auth (
  • dcm.hotspots.read
)
query Parameters
triggered_after
string <date-time> (DateTimeType)
Example: triggered_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all hotspots AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

triggered_before
string <date-time> (DateTimeType)
Example: triggered_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active hotspots BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count Hotspots Deprecated

Count Hotspots computed by the Dynamic Capacity Service depending on triggered date time or geographic area.

Temporal queries are applied on the time field of the DcmHotspot.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Hotspots are returned.

Authorizations:
ucis_auth (
  • dcm.hotspots.read
)
query Parameters
triggered_after
string <date-time> (DateTimeType)
Example: triggered_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all hotspots AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

triggered_before
string <date-time> (DateTimeType)
Example: triggered_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active hotspots BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get Hotspots

Get a list of Hotspots computed by the Dynamic Capacity Service depending on triggered date time or geographic area.

Temporal queries are applied on the time field of the DcmHotspot.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Hotspots are returned.

Authorizations:
ucis_auth (
  • dcm.hotspots.read
)
query Parameters
triggered_after
string <date-time> (DateTimeType)
Example: triggered_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all hotspots AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

triggered_before
string <date-time> (DateTimeType)
Example: triggered_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active hotspots BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

dop_uuid
string <uuid> (Uuid)
Example: dop_uuid=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Find Hotspots with a specific Drone Operation Plan Uuid.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count Hotspots

Count Hotspots computed by the Dynamic Capacity Service depending on triggered date time or geographic area.

Temporal queries are applied on the time field of the DcmHotspot.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Hotspots are returned.

Authorizations:
ucis_auth (
  • dcm.hotspots.read
)
query Parameters
triggered_after
string <date-time> (DateTimeType)
Example: triggered_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all hotspots AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

triggered_before
string <date-time> (DateTimeType)
Example: triggered_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active hotspots BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

dop_uuid
string <uuid> (Uuid)
Example: dop_uuid=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Find Hotspots with a specific Drone Operation Plan Uuid.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Flight Planning

API used to manage Drone Operation Plan

Count Drone Operation Plans

Count Drone Operation Plan that match a request. See the documentation of the Get Drone Operation Plan operation for more details about the request parameters.

Authorizations:
ucis_auth (
  • flight-planning.dops.read
)
query Parameters
filed_after
string <date-time> (DateTimeType)
Example: filed_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Drone Operation Plans filed AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

operate_after
string <date-time> (DateTimeType)
Example: operate_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active Drone Operation Plans AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

operate_before
string <date-time> (DateTimeType)
Example: operate_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active Drone Operation Plans BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

status
Array of strings (DroneOperationPlanStatus) [ 1 .. 7 ] items unique
Items Enum: "filed" "acknowledged" "approved" "approved_with_restrictions" "activated" "closed" "cancelled" "rejected"

Find Drone Operation Plans with one of these statuses. Comma separated list of statuses.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get Drone Operation Plans

Get a list of Drone Operation Plan depending on given unique Ids or status or submission date time or geographic area.

There is a limitation to geographical queries. Indeed, a circle-based geographical query is not fully operational due to a limitation of a third party tool: only the center of the DOP circular area is considered when looking for an intersection with a circle.

For temporal queries using operate_after and/or operate_before:

  • Temporal queries are applied to the [expected_start, expected_end] period.
  • If only operate_after is given: search for Drone Operation Plans that end after this datetime.
  • If only operate_before is given: search for Drone Operation Plans that start before this datetime.
  • If both operate_after and operate_before are given: search for Drone Operation Plans with [expected_start, expected_end] that intersect with the period [operate_after, operate_before].

For temporal queries using filed_after:

  • Temporal queries are applied to the metadata.created_at datetime.
  • Search for Drone Operation Plans created after the filed_after datetime.

If no filters are used, then the default values of the query fields are applied and all DOPs are returned.

Authorizations:
ucis_auth (
  • flight-planning.dops.read
)
query Parameters
dop_uuids
Array of strings <uuid> (Uuid) [ 1 .. 5 ] items unique
Example: dop_uuids=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Return only results that match the dop_uuid provided. If multiple IDs are provided, they must be unique and separated by commas.

filed_after
string <date-time> (DateTimeType)
Example: filed_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Drone Operation Plans filed AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

operate_after
string <date-time> (DateTimeType)
Example: operate_after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active Drone Operation Plans AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

operate_before
string <date-time> (DateTimeType)
Example: operate_before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active Drone Operation Plans BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

status
Array of strings (DroneOperationPlanStatus) [ 1 .. 7 ] items unique
Items Enum: "filed" "acknowledged" "approved" "approved_with_restrictions" "activated" "closed" "cancelled" "rejected"

Find Drone Operation Plans with one of these statuses. Comma separated list of statuses.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

File a Drone Operation Plan

File a Drone Operation Plan to be approved by the ATC/authority

Authorizations:
ucis_auth (
  • flight-planning.dops.submit.write
)
Request Body schema: application/json
expected_start
required
string <date-time>

Expected start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

expected_end
required
string <date-time>

Expected end datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

effective_start
string <date-time>

Effective start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is activated.

effective_end
string <date-time>

Effective datetime end of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is closed.

expected_flight_duration
integer >= 0

Expected duration of the Drone Operation Plan (minutes).

required
object (Operator)

Object that represents a drone operator.

required
object (Drone)

Object that represents a drone

swarm
boolean

Is a drone swarm

Array of objects (Pilot) non-empty [ items ]

Array of pilots involved in the Operation

operation_type
string (OperationType)
Enum: "VLOS" "BVLOS" "Both"

The type of operation:

  • VLOS - Visual Line Of Sight
  • BVLOS - Beyond Visual Line Of Sight
  • Both - VLOS and BVLOS
required
object (Category)

Category of the drone operation

operation_domain
string (OperationDomain)
Enum: "standard_delivery" "urgent_delivery" "photography_and_movie" "building_and_structure_inspection" "building_and_structure_inspection_in_ATM" "atm_systems_calibration" "agricultural_surface_inspection" "agricultural_spreading" "surveillance" "people_transportation" "military" "recreational_activity" "communication" "police_and_customs" "traffic_surveillance_and_pursuit" "environmental_control" "search_and_rescue" "medical_evacuations" "firefighting" "state_officials"

A non-exhaustive enumeration of drone operation domains. It will evolved with future needs:

  • standard_delivery - No priority merchandise, non critical delivery service
  • urgent_delivery - Operation with vital impact on people
  • photography_and_movie - Image capture for media
  • building_and_structure_inspection - Multi-sensors building and structure inspection (e.g. photo, infrared)
  • building_and_structure_inspection_in_ATM - Multi-sensors building and structure inspection in ATM environment (e.g. runway inspection)
  • atm_systems_calibration - Calibration of ATM systems
  • agricultural_surface_inspection - Multi-sensors agricultural surface inspection
  • agricultural_spreading - Agricultural spreading
  • surveillance - Whole type of surveillance operation
  • people_transportation - People transportation
  • military - Operation in military context (in the war sense)
  • recreational_activity - Recreational activity (e.g. race, free flight, entertainment)
  • communication - Operation in communication context (e.g. drone used a relay of communication, drone used to relay of Internet)
  • police_and_customs - Operation in police and customs context
  • traffic_surveillance_and_pursuit - Traffic surveillance and pursuit
  • environmental_control - Environmental control (e.g. pollution, radiation)
  • search_and_rescue - Search and rescue
  • medical_evacuations - Medical evacuations
  • firefighting - Firefighting
  • state_officials - Operation for state officials
additional_info_for_atc
string

Human-readable details of the operation which can be useful for ATC

required
Array of objects (GeospatialOccupancy) non-empty [ items ]

The geospatial occupancy planned for this drone operation. It is a list composed of Volume4D and/or Trajectory4D, both extending GeospatialOccupancy.

Array of objects (Contingency) [ items ]

List of hazard treatment and corresponding contingency strategies.

Responses

Request samples

Content type
application/json
{
  • "operation_id": "string",
  • "expected_start": "2017-07-21T17:32:28Z",
  • "expected_end": "2017-07-21T17:32:28Z",
  • "effective_start": "2017-07-21T17:32:28Z",
  • "effective_end": "2017-07-21T17:32:28Z",
  • "expected_flight_duration": 0,
  • "operator": {
    },
  • "drone": {
    },
  • "swarm": true,
  • "pilots": [
    ],
  • "operation_type": "VLOS",
  • "category": {
    },
  • "operation_domain": "standard_delivery",
  • "additional_info_for_atc": "string",
  • "geospatial_occupancy": [
    ],
  • "contingency_plan": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "operation_id": "string",
  • "expected_start": "2017-07-21T17:32:28Z",
  • "expected_end": "2017-07-21T17:32:28Z",
  • "effective_start": "2017-07-21T17:32:28Z",
  • "effective_end": "2017-07-21T17:32:28Z",
  • "expected_flight_duration": 0,
  • "operator": {
    },
  • "drone": {
    },
  • "swarm": true,
  • "pilots": [
    ],
  • "operation_type": "VLOS",
  • "category": {
    },
  • "operation_domain": "standard_delivery",
  • "additional_info_for_atc": "string",
  • "geospatial_occupancy": [
    ],
  • "status": "filed",
  • "status_detail": {
    },
  • "contingency_plan": [
    ],
  • "metadata": {
    }
}

Acknowledge a Drone Operation Plan

Acknowledge a Drone Operation Plan.

This operation has the following constraints:

  • Only a filed Drone Operation Plan can be acknowledged.
Authorizations:
ucis_auth (
  • flight-planning.dops.ack.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to acknowledge.

Request Body schema: application/json
operation_id
required
string (DroneOperationPlanOperationID) <= 30 characters

ID of the Drone Operation Plan given by ATC/authority.

Responses

Request samples

Content type
application/json
{
  • "operation_id": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Activate a Drone Operation Plan

Activate a Drone Operation Plan. The effective start datetime is updated on activation.

This operation has the following constraints:

  • Only the client that created a Drone Operation Plan can activate it.
  • Only an approved Drone Operation Plan can be activated.
Authorizations:
ucis_auth (
  • flight-planning.dops.activate.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to activate.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Approve a Drone Operation Plan

Approve a Drone Operation Plan.

This operation has the following constraints:

  • Only a acknowledged Drone Operation Plan can be approved.
Authorizations:
ucis_auth (
  • flight-planning.dops.approve.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to approve.

Request Body schema: application/json
authority_comments
required
string

Comments made by the ATC/authority about this approval. May contain the description of the constraints if approved with restrictions.

restricted
boolean
Default: false

Whether or not the Drone Operation Plan is approved with restrictions. If restricted, the constraints are described in the comments.

flight_conditions
string

Flight conditions given by ATC/authority about this approval.

approval_type
required
string (DroneOperationPlanApprovalType)
Enum: "auto" "semi_auto" "manual"

How the Drone Operation Plan is approved by the ATC/authority.

Responses

Request samples

Content type
application/json
{
  • "authority_comments": "string",
  • "restricted": false,
  • "flight_conditions": "string",
  • "approval_type": "auto"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Cancel a Drone Operation Plan

Cancel a Drone Operation Plan.

This operation has the following constraints:

  • A Drone Operation Plan can be cancelled only if it is in one of the following statuses: filed, acknowledged, approved, approved_with_restrictions, rejected
Authorizations:
ucis_auth (
  • flight-planning.dops.cancel.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to cancel.

Request Body schema: application/json
reason
string

A optional comment explaining why the Drone Operation Plan was cancelled.

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Close a Drone Operation Plan

Close a Drone Operation Plan. The effective end datetime is updated on closure.

This operation has the following constraints:

  • Only the client that created a Drone Operation Plan can close it.
  • Only an activated Drone Operation Plan can be closed.
Authorizations:
ucis_auth (
  • flight-planning.dops.close.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to close.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Reject a Drone Operation Plan

Reject a Drone Operation Plan.

This operation has the following constraints:

  • Only a acknowledged Drone Operation Plan can be rejected.
Authorizations:
ucis_auth (
  • flight-planning.dops.reject.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to reject.

Request Body schema: application/json
reason
required
string

A comment explaining why the Drone Operation Plan was rejected.

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Update a Drone Operation Plan

Update a Drone Operation Plan. When a Drone Operation Plan is updated, its status is automatically changed to acknowledged if it was previously in approved, approved_with_restrictions or rejected state.

This operation has the following constraints:

  • Only the client that created a Drone Operation Plan can update it.
  • A Drone Operation Plan can be updated only if it is in one of the following statuses: filed, acknowledged, approved, approved_with_restrictions, rejected
Authorizations:
ucis_auth (
  • flight-planning.dops.write
)
path Parameters
dop_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the Drone Operation Plan to update.

Request Body schema: application/json
expected_start
required
string <date-time>

Expected start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

expected_end
required
string <date-time>

Expected end datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

effective_start
string <date-time>

Effective start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is activated.

effective_end
string <date-time>

Effective datetime end of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is closed.

expected_flight_duration
integer >= 0

Expected duration of the Drone Operation Plan (minutes).

required
object (Operator)

Object that represents a drone operator.

required
object (Drone)

Object that represents a drone

swarm
boolean

Is a drone swarm

Array of objects (Pilot) non-empty [ items ]

Array of pilots involved in the Operation

operation_type
string (OperationType)
Enum: "VLOS" "BVLOS" "Both"

The type of operation:

  • VLOS - Visual Line Of Sight
  • BVLOS - Beyond Visual Line Of Sight
  • Both - VLOS and BVLOS
required
object (Category)

Category of the drone operation

operation_domain
string (OperationDomain)
Enum: "standard_delivery" "urgent_delivery" "photography_and_movie" "building_and_structure_inspection" "building_and_structure_inspection_in_ATM" "atm_systems_calibration" "agricultural_surface_inspection" "agricultural_spreading" "surveillance" "people_transportation" "military" "recreational_activity" "communication" "police_and_customs" "traffic_surveillance_and_pursuit" "environmental_control" "search_and_rescue" "medical_evacuations" "firefighting" "state_officials"

A non-exhaustive enumeration of drone operation domains. It will evolved with future needs:

  • standard_delivery - No priority merchandise, non critical delivery service
  • urgent_delivery - Operation with vital impact on people
  • photography_and_movie - Image capture for media
  • building_and_structure_inspection - Multi-sensors building and structure inspection (e.g. photo, infrared)
  • building_and_structure_inspection_in_ATM - Multi-sensors building and structure inspection in ATM environment (e.g. runway inspection)
  • atm_systems_calibration - Calibration of ATM systems
  • agricultural_surface_inspection - Multi-sensors agricultural surface inspection
  • agricultural_spreading - Agricultural spreading
  • surveillance - Whole type of surveillance operation
  • people_transportation - People transportation
  • military - Operation in military context (in the war sense)
  • recreational_activity - Recreational activity (e.g. race, free flight, entertainment)
  • communication - Operation in communication context (e.g. drone used a relay of communication, drone used to relay of Internet)
  • police_and_customs - Operation in police and customs context
  • traffic_surveillance_and_pursuit - Traffic surveillance and pursuit
  • environmental_control - Environmental control (e.g. pollution, radiation)
  • search_and_rescue - Search and rescue
  • medical_evacuations - Medical evacuations
  • firefighting - Firefighting
  • state_officials - Operation for state officials
additional_info_for_atc
string

Human-readable details of the operation which can be useful for ATC

required
Array of objects (GeospatialOccupancy) non-empty [ items ]

The geospatial occupancy planned for this drone operation. It is a list composed of Volume4D and/or Trajectory4D, both extending GeospatialOccupancy.

Array of objects (Contingency) [ items ]

List of hazard treatment and corresponding contingency strategies.

Responses

Request samples

Content type
application/json
{
  • "operation_id": "string",
  • "expected_start": "2017-07-21T17:32:28Z",
  • "expected_end": "2017-07-21T17:32:28Z",
  • "effective_start": "2017-07-21T17:32:28Z",
  • "effective_end": "2017-07-21T17:32:28Z",
  • "expected_flight_duration": 0,
  • "operator": {
    },
  • "drone": {
    },
  • "swarm": true,
  • "pilots": [
    ],
  • "operation_type": "VLOS",
  • "category": {
    },
  • "operation_domain": "standard_delivery",
  • "additional_info_for_atc": "string",
  • "geospatial_occupancy": [
    ],
  • "contingency_plan": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Geoawareness

API used to manage UAS Zone Version

Count UASZoneVersion

Count UASZoneVersion (see ED-269 standard) that match a request. See the documentation of the Get UASZoneVersions operation for more details about the request parameters.

Authorizations:
ucis_auth (
  • geoawareness.uaszones.read
)
query Parameters
country
string (CodeCountryISOType) 3 characters

The State that has the authority to declare the zone and define its attributes.

identifier
string (CodeZoneIdentifierType) <= 7 characters

A string of characters that uniquely identifies the UAS Zone within the State/Territory identified by the country attribute.

region
integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located.

  1. Identified with a digit between 0-65535 corresponding to a list of regions pre-defined for each State.
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions.
start_datetime
string <date-time> (DateTimeType)
Example: start_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active UASZoneVersions AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

end_datetime
string <date-time> (DateTimeType)
Example: end_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active UASZoneVersions BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

updated_after_datetime
string <date-time> (DateTimeType)
Example: updated_after_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to provide all UASZoneVersion updated AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get an UASZoneVersion

Get a list of UASZoneVersion (see ED-269 standard) depending on the filters chosen by the user. Several filters can be used with the AND operation.

There is a limitation to geographical queries. Indeed, a circle-based geographical query is not fully operational due to a limitation of a third party tool: only the center of the UASZoneVersion circular area is considered when looking for an intersection with a circle.

For temporal queries:

  • Temporal queries are applied to the TimePeriods from the applicability array.
  • A permanent UASZoneVersion always matches a temporal query.
  • If only start_datetime is given: search for UASZoneVersions with at least one TimePeriod that ends after this datetime.
  • If only end_datetime is given: search for UASZoneVersions with at least one TimePeriod that starts before this datetime.
  • If both start_datetime and end_datetime are given: search for UASZoneVersions with at least one TimePeriod that intersects with the period [start_datetime, end_datetime].

If no filters are used, then the default values of the query fields are applied and all UASZoneVersions are returned.

Authorizations:
ucis_auth (
  • geoawareness.uaszones.read
)
query Parameters
uaszone_uuids
Array of strings <uuid> (Uuid) [ 1 .. 5 ] items unique
Example: uaszone_uuids=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Return only results that match the uaszone_uuid provided. If multiple IDs are provided, they must be unique and separated by commas. uuid has priority over other filters, consequently if uuid is provided then the other filters are ignored.

country
string (CodeCountryISOType) 3 characters

The State that has the authority to declare the zone and define its attributes.

identifier
string (CodeZoneIdentifierType) <= 7 characters

A string of characters that uniquely identifies the UAS Zone within the State/Territory identified by the country attribute.

region
integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located.

  1. Identified with a digit between 0-65535 corresponding to a list of regions pre-defined for each State.
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions.
start_datetime
string <date-time> (DateTimeType)
Example: start_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active UASZoneVersions AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

end_datetime
string <date-time> (DateTimeType)
Example: end_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all active UASZoneVersions BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

updated_after_datetime
string <date-time> (DateTimeType)
Example: updated_after_datetime=1990-12-31T15:30:00.00Z

A single date-time value that will be used to provide all UASZoneVersion updated AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 100 ]
Default: 10

The maximum number or records to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an UASZoneVersion

Create an UASZoneVersion (see ED-269 standard).

Authorizations:
ucis_auth (
  • geoawareness.uaszones.submit.write
)
Request Body schema: application/json
name
string (TextShortType) <= 200 characters

A free text name by which the zone may be known by the public or by the UAS community

type
required
string (CodeZoneType)
Enum: "common" "customized"

An indication whether the zone is provided with its common definition or with a customised definition, for a particular user

restriction
required
string (CodeRestrictionType)
Enum: "prohibited" "req_authorisation" "conditional" "no_restriction"

An indication if flying in the zone is conditional, forbidden or unrestricted

restriction_conditions
string (ConditionExpressionType) <= 10000 characters

An indication of the conditions under which the zone can be used

region
integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located

  1. Identified with a digit between 0-65535 (16 bit) corresponding to a list of regions pre-defined for each State
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions
reason
Array of strings (CodeZoneReasonType) [ 0 .. 9 ] items
Items Enum: "air_traffic" "sensitive" "privacy" "population" "nature" "noise" "foreign_territory" "emergency" "other"

A coded indication for the reason that led to the establishment of the zone

other_reason_info
string (TextShortType) <= 200 characters

A free text description of the reason that led to the establishment of the zone, when not covered by a pre-defined coded value

regulation_exemption
string (CodeYesNoType)
Enum: "yes" "no"

This is an extension point. It allows adding additional attributes of national interest through this element

uspace_class
Array of strings (CodeUSpaceClassType) [ items <= 100 characters ]

A code that identifies the category or class of the zone applying a "USpace concept"

message
string (TextShortType) <= 200 characters

A message to be displayed to the user of the zone, typically on the RPS for the Remote Pilot, to make him/her aware about specific information associated with the zone (typically when it is not only a restriction to fly in the zone, thus not only an alert or an automatic limitation, for example "image capture prohibited in this zone", "frequent strong winds in the zone", "no landing or take-off in this zone"). This message is also used to indicate exemptions from regulation in a zone. Several information can be grouped in a message, separated by a "/".

required
Array of objects (Authority) non-empty [ items ]
Array of objects (TimePeriod) [ items ]
required
Array of objects (AirspaceVolume) non-empty [ items ]
object (UASZone)

An airspace of defined dimensions, above the land areas of territorial waters of a State, within which a particular restriction or condition for UAS flights applies (see ED-269 standard).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "common",
  • "restriction": "prohibited",
  • "restriction_conditions": "- CHARTYPE: Operator type; Acceptable CHARVAL values: Military/Police/Firefighting - CHARTYPE: Operator ID (registration number); Acceptable CHARVAL values: as per registration format - CHARTYPE: Operation type: A1 as per EASA Open Types or S1 (National standard scenario 1), STS01 (EASA Specific standard scenario) or ... - CHARTYPE: UTM operation type: Planned/Unplanned - CHARTYPE: Passengers on board: yes/no",
  • "region": 65535,
  • "reason": [
    ],
  • "other_reason_info": "string",
  • "regulation_exemption": "yes",
  • "uspace_class": [
    ],
  • "message": "string",
  • "zone_authority": [
    ],
  • "applicability": [
    ],
  • "geometry": [
    ],
  • "uas_zone": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "common",
  • "restriction": "prohibited",
  • "restriction_conditions": "- CHARTYPE: Operator type; Acceptable CHARVAL values: Military/Police/Firefighting - CHARTYPE: Operator ID (registration number); Acceptable CHARVAL values: as per registration format - CHARTYPE: Operation type: A1 as per EASA Open Types or S1 (National standard scenario 1), STS01 (EASA Specific standard scenario) or ... - CHARTYPE: UTM operation type: Planned/Unplanned - CHARTYPE: Passengers on board: yes/no",
  • "region": 65535,
  • "reason": [
    ],
  • "other_reason_info": "string",
  • "regulation_exemption": "yes",
  • "uspace_class": [
    ],
  • "message": "string",
  • "zone_authority": [
    ],
  • "applicability": [
    ],
  • "geometry": [
    ],
  • "metadata": {
    },
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "uas_zone": {
    }
}

Update an UASZoneVersion

Update an UASZoneVersion (see ED-269 standard). For that, it is necessary to fill in the uuid. This operation can update all fields except:

  • UASZone.identifier
  • UASZone.country

The "new" values of these two fields are ignored during the update (old values are kept or automatically modified).

Authorizations:
ucis_auth (
  • geoawareness.uaszones.write
)
path Parameters
uaszone_uuid
required
string <uuid> (Uuid)
Example: 678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Unique ID of the UASZoneVersion to update.

Request Body schema: application/json
name
string (TextShortType) <= 200 characters

A free text name by which the zone may be known by the public or by the UAS community

type
required
string (CodeZoneType)
Enum: "common" "customized"

An indication whether the zone is provided with its common definition or with a customised definition, for a particular user

restriction
required
string (CodeRestrictionType)
Enum: "prohibited" "req_authorisation" "conditional" "no_restriction"

An indication if flying in the zone is conditional, forbidden or unrestricted

restriction_conditions
string (ConditionExpressionType) <= 10000 characters

An indication of the conditions under which the zone can be used

region
integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located

  1. Identified with a digit between 0-65535 (16 bit) corresponding to a list of regions pre-defined for each State
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions
reason
Array of strings (CodeZoneReasonType) [ 0 .. 9 ] items
Items Enum: "air_traffic" "sensitive" "privacy" "population" "nature" "noise" "foreign_territory" "emergency" "other"

A coded indication for the reason that led to the establishment of the zone

other_reason_info
string (TextShortType) <= 200 characters

A free text description of the reason that led to the establishment of the zone, when not covered by a pre-defined coded value

regulation_exemption
string (CodeYesNoType)
Enum: "yes" "no"

This is an extension point. It allows adding additional attributes of national interest through this element

uspace_class
Array of strings (CodeUSpaceClassType) [ items <= 100 characters ]

A code that identifies the category or class of the zone applying a "USpace concept"

message
string (TextShortType) <= 200 characters

A message to be displayed to the user of the zone, typically on the RPS for the Remote Pilot, to make him/her aware about specific information associated with the zone (typically when it is not only a restriction to fly in the zone, thus not only an alert or an automatic limitation, for example "image capture prohibited in this zone", "frequent strong winds in the zone", "no landing or take-off in this zone"). This message is also used to indicate exemptions from regulation in a zone. Several information can be grouped in a message, separated by a "/".

required
Array of objects (Authority) non-empty [ items ]
Array of objects (TimePeriod) [ items ]
required
Array of objects (AirspaceVolume) non-empty [ items ]
object (UASZone)

An airspace of defined dimensions, above the land areas of territorial waters of a State, within which a particular restriction or condition for UAS flights applies (see ED-269 standard).

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "common",
  • "restriction": "prohibited",
  • "restriction_conditions": "- CHARTYPE: Operator type; Acceptable CHARVAL values: Military/Police/Firefighting - CHARTYPE: Operator ID (registration number); Acceptable CHARVAL values: as per registration format - CHARTYPE: Operation type: A1 as per EASA Open Types or S1 (National standard scenario 1), STS01 (EASA Specific standard scenario) or ... - CHARTYPE: UTM operation type: Planned/Unplanned - CHARTYPE: Passengers on board: yes/no",
  • "region": 65535,
  • "reason": [
    ],
  • "other_reason_info": "string",
  • "regulation_exemption": "yes",
  • "uspace_class": [
    ],
  • "message": "string",
  • "zone_authority": [
    ],
  • "applicability": [
    ],
  • "geometry": [
    ],
  • "uas_zone": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Network Identification

API used to manage Network Identification Data

Get Network Identification Data

Get Network Identification Data depending on given unique Drone Operation Plan (DOP) Id or measurement date time or geographic area. Access to these data is only possible for the DOP owner (i.e. the user that created the DOP in UCIS), the Air Navigation Service Providers (ANSPs) and the U-Space Service Providers (USSPs).

Temporal queries are applied on the measurement_timestamp field of the NetworkIdentificationData.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Network Identification Data are returned.

Authorizations:
ucis_auth (
  • network.identification.read
)
query Parameters
dop_uuid
string <uuid> (Uuid) unique
Example: dop_uuid=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Return only results that match the dop_uuid provided.

after
string <date-time> (DateTimeType)
Example: after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Network Identification positions AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

before
string <date-time> (DateTimeType)
Example: before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Network Identification positions BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

offset
integer <int32> >= 0
Default: 0

The index from which to begin the list of returned records.

limit
integer <int32> [ 1 .. 600 ]
Default: 100

The maximum number or records to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count Network Identification Data

Count Network Identification Data (i.e number of positions) depending on given unique Id or measurement date time or geographic area. Access to these data is only possible for the DOP owner (i.e. the user that created the DOP in UCIS), the Air Navigation Service Providers (ANSPs) and the U-Space Service Providers (USSPs).

Temporal queries are applied on the measurement_timestamp field of the NetworkIdentificationData.

For queries, all filters can be combined.

If no filters are used, then the default values of the query fields are applied and all Network Identification Data are returned.

Authorizations:
ucis_auth (
  • network.identification.read
)
query Parameters
dop_uuid
string <uuid> (Uuid) unique
Example: dop_uuid=678c5ba8-fc46-4f99-92e3-4ceaf5d48092

Return only results that match the dop_uuid provided.

after
string <date-time> (DateTimeType)
Example: after=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Network Identification positions AFTER that time. It must comply with the date-time notation as defined by RFC 3339.

before
string <date-time> (DateTimeType)
Example: before=1990-12-31T15:30:00.00Z

A single date-time value that will be used to find all Network Identification positions BEFORE that time. It must comply with the date-time notation as defined by RFC 3339.

reference_point2D
string <geojson-position>

A single point used to find all elements within some distance from that point. Match any elements that has any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. When distance is excluded and reference_point2D is included, uses default value (100m) for distance. Described as a GeoJSON position (WGS84 reference). The value is equivalent to what would be seen in the "coordinates" field for a GeoJSON Point object (see https://tools.ietf.org/html/rfc7946#section-3.1.1). Example would be reference_point2D=[-122.056364,37.414371] (URL safe: reference_point2D%3D%5B-122.056364%2C%2037.414371%5D).

distance
integer <int32> >= 1
Default: 100

Distance from reference_point2D to find elements. Ignored if reference_point2D is not provided. Units are meters. Returns all elements that have any volumes whose 2D horizontal dimensions intersect the 2D circle defined by distance and reference_point2D. Default value only has meaning when reference_point2D parameter is provided.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Common

Error

code
required
integer

Error's code

message
required
string

Error's message

{
  • "code": 0,
  • "message": "string"
}

Error405

refusalReason
required
string

The reason of the refusal

{
  • "refusalReason": "string"
}

Metadata

created_with
required
string

Unique name of the data provider referenced in UCIS that has been used to create the associated object.

created_at
required
string <date-time>

When the associated object has been created in UCIS.

last_modified_with
string

Unique name of the data provider referenced in UCIS that has been used to do the last modification of the associated object.

last_modified_at
string <date-time>

When the associated object has been last updated.

{
  • "created_with": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified_with": "string",
  • "last_modified_at": "2019-08-24T14:15:22Z"
}

Uuid

string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

"678c5ba8-fc46-4f99-92e3-4ceaf5d48092"

Contingency

AnyContingencyStrategyType

strategyType
required
string
ContainmentProcedureStrategy
ContainmentProcedureStrategy
ExecutionCommandStrategy
FlightProcedureStrategy
LandingProcedureStrategy
MitigationSystemStrategy
strategy_code
required
string
Value: "CP1"

An enumeration to describe the different containment procedures for the contingency plan:

  • CP1 - Activate contingency volume.
containment_volume
number

Displacement defined in meters.

Example
ContainmentProcedureStrategy
ContainmentProcedureStrategy
ExecutionCommandStrategy
FlightProcedureStrategy
LandingProcedureStrategy
MitigationSystemStrategy
{
  • "strategyType": "ContainmentProcedureStrategy",
  • "strategy_code": "CP1",
  • "containment_volume": 0
}

ContainmentProcedureStrategy

strategy_code
required
string
Value: "CP1"

An enumeration to describe the different containment procedures for the contingency plan:

  • CP1 - Activate contingency volume.
containment_volume
number

Displacement defined in meters.

{
  • "strategy_code": "CP1",
  • "containment_volume": 0
}

Contingency

Array
Array of objects (Phase) [ items ]

Hazard treatment for one or more phases.

hazard_type
string (HazardType)
Enum: "LoLL" "DoN"

An enumeration to describe the different types of hazards for the contingency plan:

  • LoLL - Loss of Landing Location.
  • DoN - Partial loss of navigation system.
Array of Array of objects (ContingencyStrategy) [ items[ items ] ]

one or more contingency strategy for a particular phase or hazard type.

[
  • {
    }
]

ContingencyStrategy

Array
strategyType
required
string
ContainmentProcedureStrategy
ContainmentProcedureStrategy
ExecutionCommandStrategy
FlightProcedureStrategy
LandingProcedureStrategy
MitigationSystemStrategy
strategy_code
required
string
Value: "CP1"

An enumeration to describe the different containment procedures for the contingency plan:

  • CP1 - Activate contingency volume.
containment_volume
number

Displacement defined in meters.

[
  • {
    },
  • {
    }
]

ExecutionCommandStrategy

strategy_code
required
string
Enum: "ET1" "ET2"

An enumeration to describe the different execution commands for the contingency plan:

  • ET1 - Execute immediately.
  • ET2 - Execute after timer out.
execution_timeout
number

Execution time out in seconds.

{
  • "strategy_code": "ET1",
  • "execution_timeout": 0
}

FlightProcedureStrategy

strategy_code
required
string
Enum: "FP1" "FP2" "FP3" "FP4"

An enumeration to describe the different flight procedures for the contingency plan:

  • FP1 - Return to base using previous nominal waypoints
  • FP2 - Return to base at contingency altitude
  • FP3 - Divert to alternate
  • FP4 - Climb to contingency altitude and hover
alternate_landing_coordinate
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

The alternate landing coordinate for a drone in case of contingency.

contingency_altitude
number

The value of contingency altitude in meters.

{
  • "strategy_code": "FP1",
  • "alternate_landing_coordinate": [
    ],
  • "contingency_altitude": 0
}

HazardTreatment

Array of objects (Phase) [ items ]

Hazard treatment for one or more phases.

hazard_type
string (HazardType)
Enum: "LoLL" "DoN"

An enumeration to describe the different types of hazards for the contingency plan:

  • LoLL - Loss of Landing Location.
  • DoN - Partial loss of navigation system.
Array of Array of objects (ContingencyStrategy) [ items[ items ] ]

one or more contingency strategy for a particular phase or hazard type.

{
  • "phase": [
    ],
  • "hazard_type": "LoLL",
  • "contingency_strategy": [
    ]
}

HazardType

string (HazardType)
Enum: "LoLL" "DoN"

An enumeration to describe the different types of hazards for the contingency plan:

  • LoLL - Loss of Landing Location.
  • DoN - Partial loss of navigation system.
"LoLL"

LandingProcedureStrategy

strategy_code
required
string
Enum: "LP1" "LP2" "LP3"

An enumeration to describe the different landing procedures for the contingency plan:

  • LP1 - Maintain nominal landing location
  • LP2 - Use alternative landing location
  • LP3 - Define current location as landing location
alternate_landing_coordinate
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

The alternate landing coordinate for a drone in case of contingency.

{
  • "strategy_code": "LP1",
  • "alternate_landing_coordinate": [
    ]
}

MitigationSystemStrategy

strategy_code
required
string
Enum: "MS1" "MS2" "MS3"

An enumeration to describe the different mitigation systems for the contingency plan:

  • MS1 - Backup navigation system (e.g. visual navigation) to compensate degraded system.
  • MS2 - Collaborative conflict management procedure.
  • MS3 - Revert automatic/autonomous system to manual control.
{
  • "strategy_code": "MS1"
}

Phase

initial_coord
required
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

Coordinate indicating start of a phase.

end_coord
required
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

Coordinate indicating end of a phase.

{
  • "initial_coord": [
    ],
  • "end_coord": [
    ]
}

Discovery/DataModel

USpaceAirspace

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

required
object (UASZone)

An airspace of defined dimensions, above the land areas of territorial waters of a State, within which a particular restriction or condition for UAS flights applies (see ED-269 standard).

required
Array of objects (AirspaceVolumes) [ items ]

List of volume which represent the U-space airspace.

object (USpaceServices)

Object that contains all possible services for an U-Space.

object (Weather)

Weather limitation for the use of the Uspace airspace.

uas_capacity
integer (UASCapacity) >= 0

Capacity of UAS traffic

Array of objects (Contingency) [ items ]

List of hazard treatment and corresponding contingency strategies.

object (ControlledAirspaceProcedure)

Object that represents procedure between the USSP and the relevant air traffic services units to coordinate the UAS flight auth request in controlled airspace.

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "uaszone": {
    },
  • "airspace_volumes": [
    ],
  • "uspace_services": {
    },
  • "weather": {
    },
  • "uas_capacity": 0,
  • "contengency_and_emergency": [
    ],
  • "controlled_airspace_procedure": {
    }
}

USpaceServiceProvider

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

name
required
string (Name)

Name of the USSP.

active
required
boolean (Active)

Indicates whether the USSP is active.

mandatory_services
required
Array of strings (MandatoryServices)
Items Enum: "uas_flight_authorization_service" "geoawareness_service" "network_identification_service" "traffic_information_service"

List of mandatory services.

additional_services
Array of strings (AdditionalServices)

List of additional services.

object (USSPContact)

Contact information for the USSP.

certification_limitation
string (CertificationLimitation)

Information about certification limitations.

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "name": "string",
  • "active": true,
  • "mandatory_services": [
    ],
  • "additional_services": [
    ],
  • "contact": {
    },
  • "certification_limitation": "string"
}

Discovery/DataType

AdditionalService

string (AdditionalService)

Additional service not known that the USSP must provide.

"string"

ControlledAirspaceProcedure

time_for_activation
integer (TimeForActivation) >= 0

Minimum time (in minutes) required before the activation of the Drone Operation Plan in the corresponding U-space airspace.

time_before_authorization
integer (TimeBeforeAuthorization) >= 0

Minimum time (in minutes) required before the approval of the Drone Operation Plan in the corresponding U-space airspace.

{
  • "time_for_activation": 0,
  • "time_before_authorization": 0
}

MandatoryService

string (MandatoryService)
Enum: "uas_flight_authorization_service" "geoawareness_service" "network_identification_service" "traffic_information_service"

Service that is mandatory for the USSP to provide.

"uas_flight_authorization_service"

USpaceServices

mandatory_services
Array of strings (MandatoryServices)
Items Enum: "uas_flight_authorization_service" "geoawareness_service" "network_identification_service" "traffic_information_service"

List of mandatory services.

additional_services
Array of strings (AdditionalServices)

List of additional services.

{
  • "mandatory_services": [
    ],
  • "additional_services": [
    ]
}

USSPContact

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

company_name
string

Company name of the drone operator.

main_contact_firstname
string

First name of the main contact for the drone operator.

main_contact_lastname
string

Last name of the main contact for the drone operator.

main_contact_phone_number
required
string

Phone number of the main contact for the drone operator.

main_contact_email
required
string

Email of the main contact for the drone operator.

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "company_name": "string",
  • "main_contact_firstname": "string",
  • "main_contact_lastname": "string",
  • "main_contact_phone_number": "string",
  • "main_contact_email": "string"
}

DynamicCapacity

CellID

string (CellID)

identifier of the cell in a defined grid.

"string"

DcmHotspot

cell_id
required
string (CellID)

identifier of the cell in a defined grid.

cell_coordinates
required
Array of Array of numbers (CellCoordinate) [ items [ 2 .. 3 ] items [ items ] ]

Cell shape at the surface of the Earth considered as the WGS-84 ellipsoid

datetime
required
string <date-time> (DateTimeType)

The timestamp when the hotspot is present. It must comply with the date-time notation as defined by RFC 3339.

criticality
string (Criticality)
Enum: "warning" "critical"

The criticality of a hotspot :

  • warning - the impact is acceptable but close to the critical impact value (no more drone in this area).
  • critical - the impact value has exceeded the acceptable value
object (ImpactType)

Density of persons exposed to noise within the area, weighted by degree of exposure

object (ImpactType)

Density of persons annoyed by noise within the area

object (ImpactType)

Density of persons visually exposed within the area, weighted by degree of exposure

object (ImpactType)

Density of persons visually annoyed within the area

{
  • "cell_id": "string",
  • "cell_coordinates": [
    ],
  • "datetime": "1990-12-31T15:30:00.00Z",
  • "criticality": "warning",
  • "noise_exposure": {
    },
  • "noise_annoyance": {
    },
  • "visual_exposure": {
    },
  • "visual_annoyance": {
    }
}

ImpactType

value
required
number <double> (Value)

Density of impacted persons

impacting_drones
required
Array of strings <uuid> (ImpactingDrones)

List of drone ids impacting the hotspot

{
  • "value": 0,
  • "impacting_drones": [
    ]
}

OverallVolume

integer (OverallVolume)

Number of drones in the cell

0

Geoawareness/DataModel

AirspaceVolume

uom_dimensions
required
string (UomDistance)
Enum: "M" "FT"

The unit of measurement used for the vertical dimensions and also for the horizontal_projection (if applicable, such as in the case of the radius of a circle)

lower_limit
integer

The lowest level included in the Zone. If not specified, it means that the zone starts from surface (ground)

lower_vertical_reference
required
string (CodeVerticalReferenceType)
Enum: "AGL" "AMSL"

The vertical reference system used for expressing the lower limit

upper_limit
integer

The highest level included in the Zone. If not specified, it means that the zone extends to any possible level (unlimited)

upper_vertical_reference
required
string (CodeVerticalReferenceType)
Enum: "AGL" "AMSL"

The vertical reference system used for expressing the upper limit

required
object (GeoShapeType)

The shape of the area in a projection at the surface of the Earth considered as the WGS-84 ellipsoid

{
  • "uom_dimensions": "M",
  • "lower_limit": 0,
  • "lower_vertical_reference": "AGL",
  • "upper_limit": 0,
  • "upper_vertical_reference": "AGL",
  • "horizontal_projection": {
    }
}

Authority

name
string (TextShortType) <= 200 characters

The official name of a public or private authority

service
string (TextShortType) <= 200 characters

The name of a specific department or service within the organisation

contact_name
string (TextShortType) <= 200 characters

The name or role of a specific person that needs to be contact within the organisation

site_url
string (TextShortType) <= 200 characters

The URL of the public internet site through which the organisation may be contacted

email
string (TextShortType) <= 200 characters

The e-mail address by which the organisation may be contacted

phone
string (TextShortType) <= 200 characters

A phone number at which the organisation may be contacted

required
object (AuthorityRequirements)

Indicates role of an Authority in relation with an UAS Zone and related requirements, such as the lead time before the actual use of the zone. Note that this enables to mandate an authorisation request superseding a conditional restriction, or to mandate a notification in any type of zone restriction.

{
  • "name": "string",
  • "service": "string",
  • "contact_name": "string",
  • "site_url": "string",
  • "email": "string",
  • "phone": "string",
  • "authority_requirements": {
    }
}

AuthorityRequirements

purpose
required
string (CodeAuthorityRole)
Enum: "authorization" "notification" "information"

The role of the Authority in relation with the zone

interval_before
string (TimeInterval) ^P[0-3][0-9]DT[012][0-9]H[0-5][0-9]M$

The minimal time interval required between notification or authorisation request and starting to operate in the zone

{
  • "purpose": "authorization",
  • "interval_before": "string"
}

DailyPeriod

day
required
Array of strings (CodeWeekDayType) [ 1 .. 7 ] items
Items Enum: "MON" "TUE" "WED" "THU" "FRI" "SAT" "SUN" "ANY"

The day of the week

start_time
required
string (TimeType) ^[012][0-9]:[0-5][0-9]S$

The daily start time

end_time
required
string (TimeType) ^[012][0-9]:[0-5][0-9]S$

The daily end time

{
  • "day": [
    ],
  • "start_time": "string",
  • "end_time": "string"
}

TimePeriod

permanent
required
string (CodeYesNoType)
Enum: "yes" "no"

An indication that the area is permanent if Yes. Permanent "Yes" means always active, no start nor end date. Permanent "No" means consider the start and end date provided just after

start_date_time
string <date-time> (DateTimeType)

The date and time when the area starts to exist

end_date_time
string <date-time> (DateTimeType)

The date and time when the area ceases to exist

Array of objects (DailyPeriod) [ items ]
{
  • "permanent": "yes",
  • "start_date_time": "1990-12-31T15:30:00.00Z",
  • "end_date_time": "1990-12-31T15:30:00.00Z",
  • "schedule": [
    ]
}

UASZone

identifier
required
string (CodeZoneIdentifierType) <= 7 characters

A string of characters that uniquely identifies the UAS Zone within the State/Territory identified by the country attribute

country
required
string (CodeCountryISOType) 3 characters

The State that has the authority to declare the zone

{
  • "identifier": "string",
  • "country": "str"
}

UASZoneVersion

name
string (TextShortType) <= 200 characters

A free text name by which the zone may be known by the public or by the UAS community

type
required
string (CodeZoneType)
Enum: "common" "customized"

An indication whether the zone is provided with its common definition or with a customised definition, for a particular user

restriction
required
string (CodeRestrictionType)
Enum: "prohibited" "req_authorisation" "conditional" "no_restriction"

An indication if flying in the zone is conditional, forbidden or unrestricted

restriction_conditions
string (ConditionExpressionType) <= 10000 characters

An indication of the conditions under which the zone can be used

region
integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located

  1. Identified with a digit between 0-65535 (16 bit) corresponding to a list of regions pre-defined for each State
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions
reason
Array of strings (CodeZoneReasonType) [ 0 .. 9 ] items
Items Enum: "air_traffic" "sensitive" "privacy" "population" "nature" "noise" "foreign_territory" "emergency" "other"

A coded indication for the reason that led to the establishment of the zone

other_reason_info
string (TextShortType) <= 200 characters

A free text description of the reason that led to the establishment of the zone, when not covered by a pre-defined coded value

regulation_exemption
string (CodeYesNoType)
Enum: "yes" "no"

This is an extension point. It allows adding additional attributes of national interest through this element

uspace_class
Array of strings (CodeUSpaceClassType) [ items <= 100 characters ]

A code that identifies the category or class of the zone applying a "USpace concept"

message
string (TextShortType) <= 200 characters

A message to be displayed to the user of the zone, typically on the RPS for the Remote Pilot, to make him/her aware about specific information associated with the zone (typically when it is not only a restriction to fly in the zone, thus not only an alert or an automatic limitation, for example "image capture prohibited in this zone", "frequent strong winds in the zone", "no landing or take-off in this zone"). This message is also used to indicate exemptions from regulation in a zone. Several information can be grouped in a message, separated by a "/".

required
Array of objects (Authority) non-empty [ items ]
Array of objects (TimePeriod) [ items ]
required
Array of objects (AirspaceVolume) non-empty [ items ]
object (Metadata)

Metadata associated to an object in order to facilitate data lineage

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

object (UASZone)

An airspace of defined dimensions, above the land areas of territorial waters of a State, within which a particular restriction or condition for UAS flights applies (see ED-269 standard).

{
  • "name": "string",
  • "type": "common",
  • "restriction": "prohibited",
  • "restriction_conditions": "- CHARTYPE: Operator type; Acceptable CHARVAL values: Military/Police/Firefighting - CHARTYPE: Operator ID (registration number); Acceptable CHARVAL values: as per registration format - CHARTYPE: Operation type: A1 as per EASA Open Types or S1 (National standard scenario 1), STS01 (EASA Specific standard scenario) or ... - CHARTYPE: UTM operation type: Planned/Unplanned - CHARTYPE: Passengers on board: yes/no",
  • "region": 65535,
  • "reason": [
    ],
  • "other_reason_info": "string",
  • "regulation_exemption": "yes",
  • "uspace_class": [
    ],
  • "message": "string",
  • "zone_authority": [
    ],
  • "applicability": [
    ],
  • "geometry": [
    ],
  • "metadata": {
    },
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "uas_zone": {
    }
}

Geoawareness/DataType

CodeAuthorityRole

string (CodeAuthorityRole)
Enum: "authorization" "notification" "information"

A coded list of values indicating the role that an authority has in relation with the UAS Zone.

  • authorization - The designated Authority shall be contacted to get an authorization before accessing the UAS Zone
  • notification - The designated Authority shall be notified of the UAS flight prior to accessing the UAS Zone
  • information - The designated Authority is a general purpose point of contact for the UAS in the Zone (out of authorization and notification)
"authorization"

CodeCountryISOType

string (CodeCountryISOType) 3 characters

A 3 letter identifier of a country or territory using the ISO 3166-1 alpha-3 standard.

"str"

CodeRestrictionType

string (CodeRestrictionType)
Enum: "prohibited" "req_authorisation" "conditional" "no_restriction"

A coded indicator of the restriction level for the zone.

  • prohibited - Indicates that the flight of UAS is prohibited during the applicability time
  • req_authorisation - Indicates that the flight of UAS is subject to explicit authorisation requirements during the time of applicability. Note that one Authority contact with role Authorization should be provided in this case
  • conditional - Indicates that access in the UAS Zone is allowed only to operators fulfilling a special condition, which is defined as a logical expression
  • no_restriction - Indicates that the zone may be used during the applicability time without any special permissions or restrictions
"prohibited"

CodeUSpaceClassType

string (CodeUSpaceClassType) <= 100 characters

A coded identifier for a category or class of the zone applying a USpace concept (In the current model version, there is no specific list of values. For example "X","Y","Z" types of zones as pear SESAR JU Corus project on USpace concept of operation could be used in a future version. Until a precise list of values is defined, this data type will be considered as string of characters of maximum 100 characters).

"string"

CodeVerticalReferenceType

string (CodeVerticalReferenceType)
Enum: "AGL" "AMSL"

A coded value that indicates a vertical reference system.

  • AGL - Height above ground/surface level
  • AMSL - Altitude above Mean Sea Level
"AGL"

CodeWeekDayType

string (CodeWeekDayType)
Enum: "MON" "TUE" "WED" "THU" "FRI" "SAT" "SUN" "ANY"

A coded value indicating a day of the week (ANY means any day of the week)

"MON"

CodeYesNoType

string (CodeYesNoType)
Enum: "yes" "no"

A coded value that indicates a choice between a positive (yes) or a negative (no) applicability.

  • yes - the situation is true, according to the property default definition
  • no - the situation is not true
"yes"

CodeZoneIdentifierType

string (CodeZoneIdentifierType) <= 7 characters

A coded identifier of an UAS Zone (a string of maximum 7 characters) that uniquely identifies the area within a geographical scope.

  1. This shall not include the country identifier, which is a separate attribute of the UAS Zone
  2. The length of this data type is limited to 7 characters for compatibility with ARINC 424 and AIXM, where an airspace designator may have maximum 10 characters. The 10 characters are the result of concatenating the UAS Zone attributes for country and identifier
"string"

CodeZoneReasonType

string (CodeZoneReasonType)
Enum: "air_traffic" "sensitive" "privacy" "population" "nature" "noise" "foreign_territory" "emergency" "other"

A coded indication of a reason that justifies the existence of an UAS Zone.

  • air_traffic - Due to the presence of air traffic
  • sensitive - Due to the presence of a sensitive site, in the vicinity of which the presence of drones could be considered a potential threat
  • privacy - Due to the presence of a site for which the presence of drones could rise privacy concerns
  • population - Due to the presence of a significantly populated area
  • nature - Due to the presence of a wildelife/nature sanctuary or another area with sensitive nature/fauna
  • noise - Due to noise abatement regulations
  • foreign_territory - Indicates a "fake" zone that is created automatically and which corresponds to the territory of a neighboring country ("restricted" by default)
  • emergency - Due to activity related to a situation that requires urgent intervention (such as an accident)
  • other - Due to another reason, which may be specified in the other_reason_info property
"air_traffic"

CodeZoneType

string (CodeZoneType)
Enum: "common" "customized"

A coded list of values which allows indicating that the definition of a UAS Zone is specifically customized for a particular UAS or operator.

  • common - The Zone is provided with its common definition, valid for any UAS and operator
  • customized - The Zone is provided with a customised definition, for a particular UAS or operator. This is a design provision that could be used for example to provide waivers to specific users with restrictions removed on given zones for example. This information enales then to identify it is not the common version which has been transferred. Exact usage of this feature goes beyond the scope of the current standard
"common"

ConditionExpressionType

string (ConditionExpressionType) <= 10000 characters

A coded expression that provides information about what is authorised/forbidden in a zone that has conditional access. By difference with the "Message" field per zone, this coded expression is made to be interpreted by the UAS while the "Message" is to interpreted by the remote pilot Condition definition language:

  • A list of relevant characteristics (CHARTYPE) has first to be established per state, and their finite list of acceptable values (CHARVAL)
  • Each chartype and charval fields are defined by a limited set of characters
  • A public document shall give the definitions of each, and provide the reference to legal or technical characteristics implied
  • The Geozone editor per state can use these characteristics, with the dedicated condition language defined below, to define exact conditions per zone
  • Each UAS Geofencing function shall be loaded with the corresponding characteristic status of the UAS for the intended flight, so as to be able to apply the conditions, either to generate alerts or to limit the flight
  • If the value of a given characteristic of the condition equation is not defined in the UAS, the UAS Geofencing function should inform the pilot in Geoawareness alerting or consider that the zone is forbidden, by default in automatic Geofencing
  • The UAS is PERMITTED XOR PROHIBITED (exclusive choice) to fly in this zone at this time IF (Characteristic1) CHARTYPE1 = (Value1) CHARVAL1 AND CHARTYPE2 = VALUE2 AND ... AND End IF OR (...) ... End OR
  • Only the fields in bold need to be edited in the character string, separated by "/". Others are implicit
"- CHARTYPE: Operator type; Acceptable CHARVAL values: Military/Police/Firefighting - CHARTYPE: Operator ID (registration number); Acceptable CHARVAL values: as per registration format - CHARTYPE: Operation type: A1 as per EASA Open Types or S1 (National standard scenario 1), STS01 (EASA Specific standard scenario) or ... - CHARTYPE: UTM operation type: Planned/Unplanned - CHARTYPE: Passengers on board: yes/no"

DateTimeType

string <date-time> (DateTimeType)

A date and time instant, in the form YYYY-MM-DDThh:mm:ss.ssZ

"1990-12-31T15:30:00.00Z"

GeoShapeType

object (Polygon)

A polygonal geographic shape on the surface of the earth.

https://tools.ietf.org/html/rfc7946#page-9
object (Circle)

A circular geographic shape on the surface of the earth.

{
  • "polygon": {
    },
  • "circle": {
    }
}

RegionIdentifierType

integer (RegionIdentifierType) [ 0 .. 65535 ]

Where applicable, identifies a region inside a State where the UAS Zone is located

  1. Identified with a digit between 0-65535 (16 bit) corresponding to a list of regions pre-defined for each State
  2. This attribute is intended to facilitate extracting sub-sets of data for specific regions
65535

TextShortType

string (TextShortType) <= 200 characters

A free text with a maximum length of 200 characters.

"string"

TimeInterval

string (TimeInterval) ^P[0-3][0-9]DT[012][0-9]H[0-5][0-9]M$

A period of time expressed according to the ISO 8601 rules for time intervals in the format PnnDTnnHnnM

  • P is a mandatory character that indicates that the value is a time interval
  • nnD is an optional block that indicates the number of days comprised in the interval
  • T is a mandatory character that indicates the start of the time block
  • nnH is an optional block that indicates the number of hours comprised in the interval
  • nnM is an optional block that indicates the number of minutes comprised int the interval
"string"

TimeType

string (TimeType) ^[012][0-9]:[0-5][0-9]S$

A time instant type in the form hh:mmS

"string"

UomDistance

string (UomDistance)
Enum: "M" "FT"

A list of units of measurement used for distances.

  • M - Metres
  • FT - Feet
"M"

GeoJSON

Circle

type
string
Value: "Feature"

The type of Geometry. In this case, must be 'Feature' per GeoJSON spec.

object
object (CircleProperties)

Different properties of circle. Currently contains radius only. Local extension of the GeoJSON specification to specify a circular area.

{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

CircleProperties

required
object (Radius)
{
  • "radius": {
    }
}

Geometry

type
required
string
Enum: "Point" "LineString" "Polygon" "MultiPoint" "MultiLineString" "MultiPolygon"

the geometry type

{
  • "type": "Point"
}

LongLatAlt

Array ([ 2 .. 3 ] items)
number
[
  • 0,
  • 0
]

Polygon

type
required
string
Enum: "Point" "LineString" "Polygon" "MultiPoint" "MultiLineString" "MultiPolygon"

the geometry type

coordinates
Array of Array of Array of numbers (LongLatAlt) [ items[ items [ 2 .. 3 ] items [ items ] ] ]
{
  • "type": "Point",
  • "coordinates": [
    ]
}

Radius

value
required
number <float>

Distance from the centerpoint of a circular area, along the WGS84 ellipsoid. It is a local extension of the GeoJSON specification to add a circular area.

units
required
string
Value: "M"

Units of radius (meters only available).

{
  • "value": 150.36,
  • "units": "M"
}

Geospatial

Altitude

value
required
number <double>

The numeric value of the altitude.

reference
required
string
Enum: "W84" "AGL"

A code indicating the reference for a vertical distance. See AIXM 5.1 and FIXM 4.2.0. Currently, UTM only allows WGS84 with no immediate plans to allow other options. FIXM and AIXM allow for 'SFC' which is equivalent to AGL.

units
required
string
Value: "M"

The reference quantities used to express the value of altitude. See FIXM 4.2. Currently, UTM only allows meters with no immediate plans to allow other options.

{
  • "value": 0,
  • "reference": "W84",
  • "units": "M"
}

GeospatialOccupancy

geospatialOccupancyType
required
string
Volume4D
Volume4D
Trajectory4D
required
object (Volume3D)

A three-dimensional geographic volume consisting of a vertically-extruded shape. Exactly one outline must be specified.

start
required
string <date-time>

Beginning date time of this volume. Must be before end. It must comply with the date-time notation as defined by RFC 3339.

end
required
string <date-time>

End date time of this volume. Must be after start. It must comply with the date-time notation as defined by RFC 3339.

object (Uncertainty)

Defines the uncertainty in time and geospatial variation.

Example
Volume4D
Volume4D
Trajectory4D
{
  • "geospatialOccupancyType": "Volume4D",
  • "volume": {
    },
  • "start": "2017-07-21T17:32:28Z",
  • "end": "2017-07-21T17:32:28Z",
  • "uncertainty": {
    }
}

Point4D

crossing_datetime
required
string <date-time>

The expected date time of the crossing point. It must comply with the date-time notation as defined by RFC 3339.

point3D
required
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

object (Uncertainty)

Defines the uncertainty in time and geospatial variation.

{
  • "crossing_datetime": "2017-07-21T17:32:28Z",
  • "point3D": [
    ],
  • "uncertainty": {
    }
}

SpatialVariation

Array ([ 2 .. 3 ] items)
number >= 0
[
  • 0,
  • 0
]

Trajectory4D

Array of objects (Point4D) [ items ]
{
  • "points4D": [
    ]
}

Uncertainty

time_variation
number

Time variation concerning a 'Volume4D' or 'Point4D' in seconds.

spatial_variation
Array of numbers (SpatialVariation) [ 2 .. 3 ] items [ items >= 0 ]

Uncertainty in x (east/west), y (north/south), z (altitude) axis (see WGS84 standard). The value for each axis is applied in both directions of this one.

{
  • "time_variation": 0,
  • "spatial_variation": [
    ]
}

Volume3D

object (Circle)

A circular geographic shape on the surface of the earth.

object (Polygon)

A polygonal geographic shape on the surface of the earth.

https://tools.ietf.org/html/rfc7946#page-9
object (Altitude)

Minimum bounding altitude of this volume. Must be less than altitude_upper, if specified.

required
object (Altitude)

Maximum bounding altitude of this volume. Must be greater than altitude_lower, if specified.

{
  • "outline_circle": {
    },
  • "outline_polygon": {
    },
  • "altitude_lower": {
    },
  • "altitude_upper": {
    }
}

Volume4D

required
object (Volume3D)

A three-dimensional geographic volume consisting of a vertically-extruded shape. Exactly one outline must be specified.

start
required
string <date-time>

Beginning date time of this volume. Must be before end. It must comply with the date-time notation as defined by RFC 3339.

end
required
string <date-time>

End date time of this volume. Must be after start. It must comply with the date-time notation as defined by RFC 3339.

object (Uncertainty)

Defines the uncertainty in time and geospatial variation.

{
  • "volume": {
    },
  • "start": "2017-07-21T17:32:28Z",
  • "end": "2017-07-21T17:32:28Z",
  • "uncertainty": {
    }
}

NetworkIdentification/DataModel

Angle

integer (Angle) [ 0 .. 360 ]

Number that represents an angle in degrees and clockwise from True North

360

FlightAcceleration

north_south_acceleration
required
number (GroundAcceleration)

The acceleration projected on north-south axis

east_west_acceleration
required
number (GroundAcceleration)

The acceleration projected on east-west axis

vertical_acceleration
required
number (GroundAcceleration)

The acceleration projected on vertical axis

{
  • "north_south_acceleration": 0,
  • "east_west_acceleration": 0,
  • "vertical_acceleration": 0
}

FlightSpeed

north_south_speed
required
number (GroundSpeed) >= 0

The speed projected on north-south axis

east_west_speed
required
number (GroundSpeed) >= 0

The speed projected on east-west axis

vertical_speed
required
number (GroundSpeed) >= 0

The speed projected on vertical axis

{
  • "north_south_speed": 0,
  • "east_west_speed": 0,
  • "vertical_speed": 0
}

NetworkIdentificationData

dop_uuid
string <uuid> (Uuid)

Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

measurement_timestamp
required
string <date-time> (DateTimeType)

The timestamp when the measurement was made. It must comply with the date-time notation as defined by RFC 3339.

required
object (Coordinate)

Object that represents the coordinates of an Unmanned Aircraft System (UAS).

required
object (FlightSpeed)

Object that represents the speed of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal speed (North/South speed and East/West speed)

object (FlightAcceleration)

Object that represents the acceleration of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal acceleration (North/South acceleration and East/West acceleration)

route_course
required
integer (Angle) [ 0 .. 360 ]

The cardinal direction in which the UAS is to be steered.

uncertainty
Array of numbers (SpatialVariation) [ 2 .. 3 ] items [ items >= 0 ]

Displacement in meters x (east/west), y (north/south), z (altitude) coordinates (see WGS84 standard). The value for each axis is applied in both directions of this one.

object (Metadata)

The metadata of the Network Identification Data.

operator_registration_number
required
string

The UAS operator registration number, identifying the operator not the drone itself.

uas_serial_number
required
string

The unique serial number of the unmanned aircraft or, if the unmanned aircraft is privately built, the unique serial number of the add-on.

remote_pilot_coordinates
required
Array of numbers (LongLatAlt) [ 2 .. 3 ] items [ items ]

The geographical position of the remote pilot or, if not available, the take-off point.

emergency_status
required
string
Enum: "NOMINAL" "EMERGENCY_1" "EMERGENCY_2"

The UAS emergency status.

notification_timestamp
required
string <date-time> (DateTimeType)

The datetime on which the notification is sent by UCIS

{
  • "dop_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "measurement_timestamp": "1990-12-31T15:30:00.00Z",
  • "uas_coordinates": {
    },
  • "speed": {
    },
  • "acceleration": {
    },
  • "route_course": 360,
  • "uncertainty": [
    ],
  • "metadata": {
    },
  • "operator_registration_number": "string",
  • "uas_serial_number": "string",
  • "remote_pilot_coordinates": [
    ],
  • "emergency_status": "NOMINAL",
  • "notification_timestamp": "1990-12-31T15:30:00.00Z"
}

NetworkIdentification/DataType

GroundAcceleration

number (GroundAcceleration)

Number that represents the ground acceleration in meters per second squared (m/s^2)

0

GroundSpeed

number (GroundSpeed) >= 0

Number that represents the ground speed in meters per second (m/s)

0

UTM

Category

category
required
string (Category)
Enum: "open" "certified" "specific"

Main category of the drone operation

subcategory
string (Subcategory)
Enum: "a1" "a2" "a3"

Subcategory of the drone operation

{
  • "category": "open",
  • "subcategory": "a1"
}

Drone

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

manufacturer
required
string [ 1 .. 256 ] characters

Manufacturer of the drone

weight
number <float>

Manufacturer's empty weight of the drone in kilograms (kg) including battery and embedded systems

payload_weight
number <float>

The payload weight in kilograms (kg) carried by the drone during the operation

drone_class
required
string (DroneClass)
Enum: "C0" "C1" "C2" "C3" "C4" "C5" "C6" "N/A"
drone_type
string (DroneType)
Enum: "autogyro" "aircraft" "model_aircraft_control_line" "model_aircraft_free_flight" "flapping_wings" "tethered_aerostat" "convertible" "airship" "helicopter" "hot_air_balloon" "multicopter" "parachute" "paramotor" "sailplane" "rocket" "ground_obstacle" "other"

The type of the drone

model_name
required
string [ 1 .. 256 ] characters

Commercial name of the model of the drone

serial_number
required
string <= 256 characters

Serial number of the drone

remote_id
string

Remote ID Number Registration as specified in ASTM F3411-22a (https://www.astm.org/f3411-22a.html).

diy
boolean

Is home made drone. In this case, the drone does not have a serial number

object (Windspeed)

Object that represents a wind speed

captive
boolean

Is the drone captive

ce_marked
boolean

Is the drone CE marked as specified in EASA 2019/945 regulation (https://eur-lex.europa.eu/legal-content/EN/TXT/?qid=1600678687216&uri=CELEX:32019R0945)

identification_mark
string <= 256 characters

Identification mark of the drone

design_attestation
string
Enum: "N/A" "individual" "type"

Design attestation of the drone

design_attestation_reference
string <= 256 characters

Design attestation reference of the drone

design_attestation_date
string <date>

Design attestation date of the drone

specific_authorisation
string
Value: "N/A"

Specific authorisation for the drone

specific_authorisation_reference
string <= 256 characters

Reference of drone's specific authorisation

specific_authorisation_date
string <date>

Date of drone's specific authorisation

label
string

Label of the drone

drone_registration_number
string <= 128 characters

Registration number of the drone (e.g registration number from AlphaTango for France)

drone_registration_status
string (DroneRegistrationStatus)
Enum: "valid" "invalid"

The drone registration number status:

  • valid - The registration number of the drone is valid on authority view
  • invalid - The registration number of the drone is invalid on authority view
last_overhaul_date
string <date>

Date of drone's last overhaul (concerns 'certified' drone)

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "manufacturer": "string",
  • "weight": 0,
  • "payload_weight": 0,
  • "drone_class": "C0",
  • "drone_type": "autogyro",
  • "model_name": "string",
  • "serial_number": "string",
  • "remote_id": "string",
  • "diy": true,
  • "windspeed_restriction": {
    },
  • "captive": true,
  • "ce_marked": true,
  • "identification_mark": "string",
  • "design_attestation": "N/A",
  • "design_attestation_reference": "string",
  • "design_attestation_date": "2019-08-24",
  • "specific_authorisation": "N/A",
  • "specific_authorisation_reference": "string",
  • "specific_authorisation_date": "2019-08-24",
  • "label": "string",
  • "drone_registration_number": "string",
  • "drone_registration_status": "valid",
  • "last_overhaul_date": "2019-08-24",
  • "metadata": {
    }
}

DroneClass

string (DroneClass)
Enum: "C0" "C1" "C2" "C3" "C4" "C5" "C6" "N/A"
"C0"

DroneOperationPlan

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

operation_id
string (DroneOperationPlanOperationID) <= 30 characters

ID of the Drone Operation Plan given by ATC/authority.

expected_start
required
string <date-time>

Expected start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

expected_end
required
string <date-time>

Expected end datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339.

effective_start
string <date-time>

Effective start datetime of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is activated.

effective_end
string <date-time>

Effective datetime end of the Drone Operation Plan. It must comply with the date-time notation as defined by RFC 3339. It is updated when the Drone Operation Plan is closed.

expected_flight_duration
integer >= 0

Expected duration of the Drone Operation Plan (minutes).

required
object (Operator)

Object that represents a drone operator.

required
object (Drone)

Object that represents a drone

swarm
boolean

Is a drone swarm

Array of objects (Pilot) non-empty [ items ]

Array of pilots involved in the Operation

operation_type
string (OperationType)
Enum: "VLOS" "BVLOS" "Both"

The type of operation:

  • VLOS - Visual Line Of Sight
  • BVLOS - Beyond Visual Line Of Sight
  • Both - VLOS and BVLOS
required
object (Category)

Category of the drone operation

operation_domain
string (OperationDomain)
Enum: "standard_delivery" "urgent_delivery" "photography_and_movie" "building_and_structure_inspection" "building_and_structure_inspection_in_ATM" "atm_systems_calibration" "agricultural_surface_inspection" "agricultural_spreading" "surveillance" "people_transportation" "military" "recreational_activity" "communication" "police_and_customs" "traffic_surveillance_and_pursuit" "environmental_control" "search_and_rescue" "medical_evacuations" "firefighting" "state_officials"

A non-exhaustive enumeration of drone operation domains. It will evolved with future needs:

  • standard_delivery - No priority merchandise, non critical delivery service
  • urgent_delivery - Operation with vital impact on people
  • photography_and_movie - Image capture for media
  • building_and_structure_inspection - Multi-sensors building and structure inspection (e.g. photo, infrared)
  • building_and_structure_inspection_in_ATM - Multi-sensors building and structure inspection in ATM environment (e.g. runway inspection)
  • atm_systems_calibration - Calibration of ATM systems
  • agricultural_surface_inspection - Multi-sensors agricultural surface inspection
  • agricultural_spreading - Agricultural spreading
  • surveillance - Whole type of surveillance operation
  • people_transportation - People transportation
  • military - Operation in military context (in the war sense)
  • recreational_activity - Recreational activity (e.g. race, free flight, entertainment)
  • communication - Operation in communication context (e.g. drone used a relay of communication, drone used to relay of Internet)
  • police_and_customs - Operation in police and customs context
  • traffic_surveillance_and_pursuit - Traffic surveillance and pursuit
  • environmental_control - Environmental control (e.g. pollution, radiation)
  • search_and_rescue - Search and rescue
  • medical_evacuations - Medical evacuations
  • firefighting - Firefighting
  • state_officials - Operation for state officials
additional_info_for_atc
string

Human-readable details of the operation which can be useful for ATC

required
Array of objects (GeospatialOccupancy) non-empty [ items ]

The geospatial occupancy planned for this drone operation. It is a list composed of Volume4D and/or Trajectory4D, both extending GeospatialOccupancy.

status
string (DroneOperationPlanStatus)
Enum: "filed" "acknowledged" "approved" "approved_with_restrictions" "activated" "closed" "cancelled" "rejected"

The drone operation plan status:

  • filed - The Drone Operation Plan is filed by an operator to be approved by ATC/authority
  • acknowledged - The Drone Operation Plan is acknowledged by ATC/authority
  • approved - The Drone Operation Plan is approved by ATC/authority
  • approved_with_restrictions - Same as approved but with some restrictions imposed by the ATC/authority
  • activated - The Drone Operation Plan is currently running between the expected time slot
  • closed - The Drone Operation Plan is closed after its completion
  • cancelled - The Drone Operation Plan is cancelled by the drone operator/owner
  • rejected - The Drone Operation Plan is rejected by ATC/authority

Here is the state diagram for the status. approved_with_restrictions has the same transitions as approved and is therefore hidden to improve readability.

object (DroneOperationPlanStatusDetail)

Additional information about the current status of the Drone Operation Plan.

Array of objects (Contingency) [ items ]

List of hazard treatment and corresponding contingency strategies.

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "operation_id": "string",
  • "expected_start": "2017-07-21T17:32:28Z",
  • "expected_end": "2017-07-21T17:32:28Z",
  • "effective_start": "2017-07-21T17:32:28Z",
  • "effective_end": "2017-07-21T17:32:28Z",
  • "expected_flight_duration": 0,
  • "operator": {
    },
  • "drone": {
    },
  • "swarm": true,
  • "pilots": [
    ],
  • "operation_type": "VLOS",
  • "category": {
    },
  • "operation_domain": "standard_delivery",
  • "additional_info_for_atc": "string",
  • "geospatial_occupancy": [
    ],
  • "status": "filed",
  • "status_detail": {
    },
  • "contingency_plan": [
    ],
  • "metadata": {
    }
}

DroneOperationPlanAcknowledgement

operation_id
required
string (DroneOperationPlanOperationID) <= 30 characters

ID of the Drone Operation Plan given by ATC/authority.

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "operation_id": "string",
  • "metadata": {
    }
}

DroneOperationPlanApproval

authority_comments
required
string

Comments made by the ATC/authority about this approval. May contain the description of the constraints if approved with restrictions.

restricted
boolean
Default: false

Whether or not the Drone Operation Plan is approved with restrictions. If restricted, the constraints are described in the comments.

flight_conditions
string

Flight conditions given by ATC/authority about this approval.

approval_type
required
string (DroneOperationPlanApprovalType)
Enum: "auto" "semi_auto" "manual"

How the Drone Operation Plan is approved by the ATC/authority.

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "authority_comments": "string",
  • "restricted": false,
  • "flight_conditions": "string",
  • "approval_type": "auto",
  • "metadata": {
    }
}

DroneOperationPlanApprovalType

string (DroneOperationPlanApprovalType)
Enum: "auto" "semi_auto" "manual"

How the Drone Operation Plan is approved by the ATC/authority.

"auto"

DroneOperationPlanCancellation

reason
string

A optional comment explaining why the Drone Operation Plan was cancelled.

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "reason": "string",
  • "metadata": {
    }
}

DroneOperationPlanOperationID

string (DroneOperationPlanOperationID) <= 30 characters

ID of the Drone Operation Plan given by ATC/authority.

"string"

DroneOperationPlanRejection

reason
required
string

A comment explaining why the Drone Operation Plan was rejected.

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "reason": "string",
  • "metadata": {
    }
}

DroneOperationPlanStatus

string (DroneOperationPlanStatus)
Enum: "filed" "acknowledged" "approved" "approved_with_restrictions" "activated" "closed" "cancelled" "rejected"

The drone operation plan status:

  • filed - The Drone Operation Plan is filed by an operator to be approved by ATC/authority
  • acknowledged - The Drone Operation Plan is acknowledged by ATC/authority
  • approved - The Drone Operation Plan is approved by ATC/authority
  • approved_with_restrictions - Same as approved but with some restrictions imposed by the ATC/authority
  • activated - The Drone Operation Plan is currently running between the expected time slot
  • closed - The Drone Operation Plan is closed after its completion
  • cancelled - The Drone Operation Plan is cancelled by the drone operator/owner
  • rejected - The Drone Operation Plan is rejected by ATC/authority

Here is the state diagram for the status. approved_with_restrictions has the same transitions as approved and is therefore hidden to improve readability.

"filed"

DroneOperationPlanStatusDetail

comments
string

Comments made by the initiator of the last change of status. The initiator may be the drone operator or an ATC/authority. Its content depends on the last transition: it may contain the description of the restrictions, the reason of the cancellation or of the rejection.

flight_conditions
string

Flight conditions given by ATC/authority when the Drone Operation Plan is approved.

approval_type
string (DroneOperationPlanApprovalType)
Enum: "auto" "semi_auto" "manual"

How the Drone Operation Plan is approved by the ATC/authority.

{
  • "comments": "string",
  • "flight_conditions": "string",
  • "approval_type": "auto"
}

DroneRegistrationStatus

string (DroneRegistrationStatus)
Enum: "valid" "invalid"

The drone registration number status:

  • valid - The registration number of the drone is valid on authority view
  • invalid - The registration number of the drone is invalid on authority view
"valid"

DroneType

string (DroneType)
Enum: "autogyro" "aircraft" "model_aircraft_control_line" "model_aircraft_free_flight" "flapping_wings" "tethered_aerostat" "convertible" "airship" "helicopter" "hot_air_balloon" "multicopter" "parachute" "paramotor" "sailplane" "rocket" "ground_obstacle" "other"

The type of the drone

"autogyro"

OperationDomain

string (OperationDomain)
Enum: "standard_delivery" "urgent_delivery" "photography_and_movie" "building_and_structure_inspection" "building_and_structure_inspection_in_ATM" "atm_systems_calibration" "agricultural_surface_inspection" "agricultural_spreading" "surveillance" "people_transportation" "military" "recreational_activity" "communication" "police_and_customs" "traffic_surveillance_and_pursuit" "environmental_control" "search_and_rescue" "medical_evacuations" "firefighting" "state_officials"

A non-exhaustive enumeration of drone operation domains. It will evolved with future needs:

  • standard_delivery - No priority merchandise, non critical delivery service
  • urgent_delivery - Operation with vital impact on people
  • photography_and_movie - Image capture for media
  • building_and_structure_inspection - Multi-sensors building and structure inspection (e.g. photo, infrared)
  • building_and_structure_inspection_in_ATM - Multi-sensors building and structure inspection in ATM environment (e.g. runway inspection)
  • atm_systems_calibration - Calibration of ATM systems
  • agricultural_surface_inspection - Multi-sensors agricultural surface inspection
  • agricultural_spreading - Agricultural spreading
  • surveillance - Whole type of surveillance operation
  • people_transportation - People transportation
  • military - Operation in military context (in the war sense)
  • recreational_activity - Recreational activity (e.g. race, free flight, entertainment)
  • communication - Operation in communication context (e.g. drone used a relay of communication, drone used to relay of Internet)
  • police_and_customs - Operation in police and customs context
  • traffic_surveillance_and_pursuit - Traffic surveillance and pursuit
  • environmental_control - Environmental control (e.g. pollution, radiation)
  • search_and_rescue - Search and rescue
  • medical_evacuations - Medical evacuations
  • firefighting - Firefighting
  • state_officials - Operation for state officials
"standard_delivery"

OperationType

string (OperationType)
Enum: "VLOS" "BVLOS" "Both"

The type of operation:

  • VLOS - Visual Line Of Sight
  • BVLOS - Beyond Visual Line Of Sight
  • Both - VLOS and BVLOS
"VLOS"

Operator

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

company_name
string

Company name of the drone operator.

main_contact_firstname
required
string

First name of the main contact for the drone operator.

main_contact_lastname
required
string

Last name of the main contact for the drone operator.

main_contact_phone_number
required
string

Phone number of the main contact for the drone operator.

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "company_name": "string",
  • "main_contact_firstname": "string",
  • "main_contact_lastname": "string",
  • "main_contact_phone_number": "string"
}

Pilot

uuid
string <uuid> (Uuid)

Universally-unique identifier (version 4) of an object in UCIS. It is auto-generated in UCIS.

firstname
required
string

First name of the pilot.

lastname
required
string

Last name of the pilot.

phone_number
required
string

Phone number of the pilot.

email
string

E-mail of the pilot.

function
string
Enum: "main_pilot" "technical_assistant" "observer"

Function of the pilot during an operation

manned_aircraft_pilot_licensed
boolean

Has the pilot a manned aircraft pilot license

object (Metadata)

Metadata associated to an object in order to facilitate data lineage

{
  • "uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092",
  • "firstname": "string",
  • "lastname": "string",
  • "phone_number": "string",
  • "email": "string",
  • "function": "main_pilot",
  • "manned_aircraft_pilot_licensed": true,
  • "metadata": {
    }
}

Weather

MinMax

minimum
integer (Minimum)

Minimum for this value

maximum
integer (Maximum)

Maximum for this value

{
  • "minimum": 0,
  • "maximum": 0
}

Weather

object (MinMax)

Object that define a minimum and maximum integer value.

temperature_unit
string (Unit)
Enum: "C" "F" "K"

The unit used to express temperature:

  • C - Celsius
  • F - Fahrenheit
  • K - kelvin
object (MinMax)

Object that define a minimum and maximum integer value.

wind_unit
string (Unit)
Enum: "Kt" "Km/H" "m/s" "mph"

The unit used to express windspeed:

  • Kt - Knots
  • Km/H - Kilometers per Hour
  • m/s - meters per seconds
  • mph - miles per hour
{
  • "temperature": {
    },
  • "temperature_unit": "C",
  • "wind": {
    },
  • "wind_unit": "Kt"
}

Windspeed

value
number

The value of windspeed

unit
string
Enum: "Kt" "Km/H" "m/s" "mph"

The unit used to express windspeed:

  • Kt - Knots
  • Km/H - Kilometers per Hour
  • m/s - meters per seconds
  • mph - miles per hour
{
  • "value": 0,
  • "unit": "Kt"
}