Unifly GCS API (1.3.2)

Download OpenAPI specification:

The Unifly GCS api provides means for a Ground Control Station to interact with the UTM platform, perform take offs and landings, and create a manage operations.

Flight Status

Notify flight status changes

Performs a takeoff

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200
409

Content type

application/json

{"flightId": "string",
"operationId": "string"
}

Indicate that the UAS has landed

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200
409

Content type

application/json

{"flightId": "string",
"operationId": "string"
}

Retrieve the flight status of the given UAS

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/json

{"flightStatus": "LANDED"
}

Operations

Create and manage operations

createOperation

Create a new operation

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Request Body schema: application/json
required

type required	string Value: "Feature"
required	object (operationCreateProperties)
required	object (GeoJSON Polygon)

Responses

Request samples

Payload

Content type

application/json

{"type": "Feature",
"properties": {"operationName": "Site-A July morning",
"rulesetCode": "opena1",
"description": "Roof inspection at the train station",
"lineOfSightType": "VLOS",
"pilotUuid": "45bf1aef-20f4-4a46-9011-a4a1bf9b7f82",
"observerUuids": ["b42d5c3e-bef2-44fb-9508-358fe8a2020a",
"b42d5c3e-bef2-44fb-9508-358fe8a2020b"
],
"volume": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"maxAltitude": 0
},
"markers": [{"longitude": 0,
"latitude": 0,
"type": "LANDING"
}
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}

Response samples

201

Content type

application/json

{"operationId": "string",
"portalUrl": "http://example.com"
}

Retrieve operations for the given UAS

path Parameters

serialNumber required	string The unique serial number for the UAS
activeAfter required	string <date-time> The start time to filter operations
activeBefore required	string <date-time> The end time to filter operations

query Parameters

activeAfter	string <date-time> Only return operations that are active after specified date-time
activeBefore	string <date-time> Only return operations that are active before specified date-time

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/vnd.geo+json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"properties": {"description": "Roof inspection at the train station",
"volume": {"start": "2022-05-23T15:04:04.812Z",
"end": "2022-05-23T15:04:04.812Z",
"maxAltitude": 0
},
"markers": [{"longitude": 0,
"latitude": 0,
"type": "LANDING"
}
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}
]
}

/uas/{serialNumber}/operations/{operationId}

path Parameters

serialNumber required	string The unique serial number for the UAS
operationId required	string

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/vnd.geo+json

{"type": "Feature",
"properties": {"description": "Roof inspection at the train station",
"volume": {"start": "2022-05-23T15:04:04.812Z",
"end": "2022-05-23T15:04:04.812Z",
"maxAltitude": 0
},
"markers": [{"longitude": 0,
"latitude": 0,
"type": "LANDING"
}
]
},
"geometry": {"type": "Polygon",
"coordinates": [[[0,
0
],
[0,
0
],
[0,
0
],
[0,
0
]
]
],
"bbox": [0,
0,
0,
0
]
}
}

Request acceptance for the specified operation.

path Parameters

operationId

required

string

The unique identifier of the operation.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

409

Content type

application/json

{"message": "Acceptance request is not allowed due to [specific reason]."
}

Request activation for the specified operation.

path Parameters

operationId

required

string

The unique identifier of the operation.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

409

Content type

application/json

{"message": "Activation request is not allowed due to [specific reason]."
}

Request withdrawal for the specified operation.

path Parameters

operationId

required

string

The unique identifier of the operation.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

409

Content type

application/json

{"message": "Withdrawal request is not allowed due to [specific reason]."
}

Request the end for the specified operation.

path Parameters

operationId

required

string

The unique identifier of the operation.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

409

Content type

application/json

{"message": "End request is not allowed due to [specific reason]."
}

PermissionRequests

Manage operation permission requests

Submits all permission requests of an operation.

path Parameters

operationId

required

string

The unique identifier of the operation.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200
409

Content type

application/json

{"permissionRequests": [{"permissionRequestId": "string",
"submitStatus": "OK",
"message": "string"
}
]
}

UAS

Create and manage Uas

Retrieve an UAS

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/json

{"generalFeatures": {"brand": "GCS MANU",
"model": "GCS model",
"type": "ROTARY_WING",
"numberOfRotors": 4,
"weight": 2,
"width": 2,
"height": 2,
"length": 2,
"wingspan": 2,
"bodyMaterial": "Aluminum",
"uasClass": "C0"
},
"flightFeatures": {"maxFlightTime": 2,
"payloadCapacity": 1.99,
"mtom": 2,
"maximumAltitude": 200,
"maximumSpeed": 2,
"minimumOperatingTemperature": 0,
"maximumOperatingTemperature": 32,
"maxNoise": 25.5
},
"controllerFeatures": {"operatingRange": 50,
"controllerFrequency": 2,
"controlSystem": "Remote Control + Phone/Tablet"
},
"nickname": "string",
"serialNumber": "string",
"registrationRef": "string"
}

Create a new UAS

Create a new UAS with the given details.

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Request Body schema: application/json
required

	object
	object
	object
nickname	string Nickname of the UAS
serialNumber required	string Serial number of the UAS
registrationRef	string Registration reference of the UAS

Responses

Request samples

Payload

Content type

application/json

{"generalFeatures": {"brand": "GCS MANU",
"model": "GCS model",
"type": "ROTARY_WING",
"numberOfRotors": 4,
"weight": 2,
"width": 2,
"height": 2,
"length": 2,
"wingspan": 2,
"bodyMaterial": "Aluminum",
"uasClass": "C0"
},
"flightFeatures": {"maxFlightTime": 2,
"payloadCapacity": 1.99,
"mtom": 2,
"maximumAltitude": 200,
"maximumSpeed": 2,
"minimumOperatingTemperature": 0,
"maximumOperatingTemperature": 32,
"maxNoise": 25.5
},
"controllerFeatures": {"operatingRange": 50,
"controllerFrequency": 2,
"controlSystem": "Remote Control + Phone/Tablet"
},
"nickname": "string",
"serialNumber": "string",
"registrationRef": "string"
}

Response samples

201

Content type

application/json

{"uasId": "string",
"portalUrl": "http://example.com"
}

Geofences

Retrieve applicable geofences

Retrieve geofences

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Request Body schema: application/json

bbox	Array of numbers (bbox) = 4 items [ items [ -180 .. 180 ] ] Bounding box coordinates for which to fetch geofences, in GeoJSON bbox format ([west, south, east, north]).
identifier	string Unique identifier of a specific geofence to fetch. Useful for when you receive an event about a new geofence and you want to fetch extra information.
timeWindow required	Array of strings <date-time> (timeWindow) = 2 items [ items <date-time > ] Start and end time of the time window for which to fetch geofences, in format [start, end].

Responses

Request samples

Payload

Content type

application/json

{"bbox": [4.338,
51.06,
4.629,
51.236
],
"identifier": "string",
"timeWindow": ["2022-11-03T09:00:00Z",
"2022-11-03T11:00:00Z"
]
}

Response samples

200

Content type

application/json

{"type": "FeatureCollection",
"features": [{"type": "Feature",
"id": "string",
"properties": {"restriction": "NO_RESTRICTION",
"description": "Emergency UAS Zone / fire fighting",
"type": "GEOZONE",
"lowerLimit": {"wgs84": 10,
"amsl": 10,
"sfc": 3
},
"upperLimit": {"wgs84": 10,
"amsl": 10,
"sfc": 3
}
},
"geometry": {"type": "Point",
"coordinates": [0,
0
],
"bbox": [0,
0,
0,
0
]
},
"bbox": [0,
0,
0,
0
]
}
],
"bbox": [0,
0,
0,
0
]
}

Company

Retrieve company info

Retrieve the company information associated with the provided API key

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/json

{"companyUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Pilots

Retrieve assignable pilots for an operation

List assignable pilots

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/json

[{"userUuid": "46b7dd76-0b4a-4629-a711-d0f6a4d4dacd",
"userMail": "fred.jansen@unifly.aero"
}
]

Observers

Retrieve assignable observers for an operation

List assignable observers

path Parameters

serialNumber

required

string

The unique serial number for the UAS

header Parameters

apikey

required

string

The API key for the user. The user can obtain this from their "profile" page.

Responses

Response samples

200

Content type

application/json

[{"userUuid": "46b7dd76-0b4a-4629-a711-d0f6a4d4dacd",
"userMail": "fred.jansen@unifly.aero"
}
]

Unifly GCS API (1.3.2)

Flight Status

Performs a takeoff

path Parameters

header Parameters

Responses

Response samples

Indicate that the UAS has landed

path Parameters

header Parameters

Responses

Response samples

Retrieve the flight status of the given UAS

path Parameters

header Parameters

Responses

Response samples

Operations

createOperation

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve operations for the given UAS

path Parameters

query Parameters

header Parameters

Responses

Response samples

/uas/{serialNumber}/operations/{operationId}

path Parameters

header Parameters

Responses

Response samples

Request acceptance for the specified operation.

path Parameters

header Parameters

Responses

Response samples

Request activation for the specified operation.

path Parameters

header Parameters

Responses

Response samples

Request withdrawal for the specified operation.

path Parameters

header Parameters

Responses

Response samples

Request the end for the specified operation.

path Parameters

header Parameters

Responses

Response samples

PermissionRequests

Submits all permission requests of an operation.

path Parameters

header Parameters

Responses

Response samples

UAS

Retrieve an UAS

path Parameters

header Parameters

Responses

Response samples

Create a new UAS

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Geofences

Retrieve geofences

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required