sUTM System API at UNLV

Small UAS Traffic Management System API

Default request content-types: application/json
Default response content-types: application/json
Schemes: http, https

By Monetta Shaw, Juyeon Jo, and Yoohwan Kim
Computer Science Department
University of Nevada Las Vegas (UNLV)
As part of MS Thesis of Monetta Shaw, May 2016:
     "A Web-Based Solution For Small Unmanned Aircraft System (sUAS) Traffic Management"
(Contact: Yoohwan.Kim@unlv.edu)

Summary

Tag: User

User management

Operation Description
POST /users

Create a new user

GET /users/{username}

Get a user by username

HEAD /users/{username}

Get the only the HTTP header for getting a user by username

PATCH /users/{username}

Update a user's information.

PUT /users/{username}

Update a user's information

GET /users/{username}/achievement-badges

List the achievement badges a user has earned

HEAD /users/{username}/achievement-badges

Get the only the HTTP header for getting a user by username

POST /users/auth-ticket

Get a ticket for user authentication

DELETE /users/auth-ticket

Revoke a user authentication ticket

POST /users/{username}/password

Change a user's password

GET /users/{username}/password/reset

Request to reset the password of a user

HEAD /users/{username}/password/reset

Get the only the HTTP header for requesting to reset the password of a user

POST /users/{username}/password/reset

Confirm a request to reset the password of a user.

GET /user-id/{userId}/username

Get the username of a user

Tag: UAS

Unmanned Aircraft System (UAS) management

Operation Description
GET /uas

List UAS

HEAD /uas

Get the only the HTTP header for listing UAS

POST /uas

Create a new UAS

GET /uas/{uasId}

Get a UAS by ID

HEAD /uas/{uasId}

Get the only the HTTP header for getting a UAS by ID

PATCH /uas/{uasId}

Update the information of a UAS

PUT /uas/{uasId}

Update the information of a UAS

DELETE /uas/{uasId}

Delete a UAS

POST /uas/{uasId}/position

Update the position of a UAS

POST /area/uas

List UAS that are within a given area

Tag: Flight Plan

Flight plan management

Operation Description
GET /flight-plans

List flight plans

HEAD /flight-plans

Get the only the HTTP header for listing flight plans

POST /flight-plans

Create a new flight plan

GET /flight-plans/{flightPlanId}

Get a flight plan by ID

HEAD /flight-plans/{flightPlanId}

Get the only the HTTP header for getting a user by ID

PATCH /flight-plans/{flightPlanId}

Update the information of a flight plan

PUT /flight-plans/{flightPlanId}

Update the information of a flight plan

DELETE /flight-plans/{flightPlanId}

Delete a flight plan

GET /flight-plans/{flightPlanId}/clearance/request

Request clearance for a flight plan

HEAD /flight-plans/{flightPlanId}/clearance/request

Get the only the HTTP header for requesting clearance for a flight plan

Tag: Flight Plan Clearance

Flight plan clearance management

Operation Description
GET /flight-plans/{flightPlanId}/clearance/request

Request clearance for a flight plan

HEAD /flight-plans/{flightPlanId}/clearance/request

Get the only the HTTP header for requesting clearance for a flight plan

Tag: System

Operations that should only be used within the system. Not available to a public user.

Operation Description

Tag: AUTHENTICATION REQUIRED

Operations that require authentication

Operation Description
PATCH /users/{username}

Update a user's information.

PUT /users/{username}

Update a user's information

DELETE /users/auth-ticket

Revoke a user authentication ticket

POST /uas

Create a new UAS

PATCH /uas/{uasId}

Update the information of a UAS

PUT /uas/{uasId}

Update the information of a UAS

DELETE /uas/{uasId}

Delete a UAS

POST /uas/{uasId}/position

Update the position of a UAS

POST /flight-plans

Create a new flight plan

PATCH /flight-plans/{flightPlanId}

Update the information of a flight plan

PUT /flight-plans/{flightPlanId}

Update the information of a flight plan

DELETE /flight-plans/{flightPlanId}

Delete a flight plan

GET /flight-plans/{flightPlanId}/clearance/request

Request clearance for a flight plan

HEAD /flight-plans/{flightPlanId}/clearance/request

Get the only the HTTP header for requesting clearance for a flight plan

GET /test/authentication

A test GET request with required authentication

HEAD /test/authentication

A test HEAD request with required authentication

POST /test/authentication

A test POST request with required authentication

PATCH /test/authentication

A test PATCH request with required authentication

PUT /test/authentication

A test PUT request with required authentication

DELETE /test/authentication

A test DELETE request with required authentication

Tag: SSL ONLY

The server will accept the request only if it is sent over SSL/TLS

Operation Description
POST /users

Create a new user

POST /users/auth-ticket

Get a ticket for user authentication

POST /users/{username}/password

Change a user's password

POST /users/{username}/password/reset

Confirm a request to reset the password of a user.

Tag: Test

For testing purposes only.

Operation Description
GET /test/authentication

A test GET request with required authentication

HEAD /test/authentication

A test HEAD request with required authentication

POST /test/authentication

A test POST request with required authentication

PATCH /test/authentication

A test PATCH request with required authentication

PUT /test/authentication

A test PUT request with required authentication

DELETE /test/authentication

A test DELETE request with required authentication

Tag: All

All API functions

Operation Description
POST /users

Create a new user

GET /users/{username}

Get a user by username

HEAD /users/{username}

Get the only the HTTP header for getting a user by username

PATCH /users/{username}

Update a user's information.

PUT /users/{username}

Update a user's information

GET /users/{username}/achievement-badges

List the achievement badges a user has earned

HEAD /users/{username}/achievement-badges

Get the only the HTTP header for getting a user by username

POST /users/auth-ticket

Get a ticket for user authentication

DELETE /users/auth-ticket

Revoke a user authentication ticket

POST /users/{username}/password

Change a user's password

GET /users/{username}/password/reset

Request to reset the password of a user

HEAD /users/{username}/password/reset

Get the only the HTTP header for requesting to reset the password of a user

POST /users/{username}/password/reset

Confirm a request to reset the password of a user.

GET /user-id/{userId}/username

Get the username of a user

GET /uas

List UAS

HEAD /uas

Get the only the HTTP header for listing UAS

POST /uas

Create a new UAS

GET /uas/{uasId}

Get a UAS by ID

HEAD /uas/{uasId}

Get the only the HTTP header for getting a UAS by ID

PATCH /uas/{uasId}

Update the information of a UAS

PUT /uas/{uasId}

Update the information of a UAS

DELETE /uas/{uasId}

Delete a UAS

POST /uas/{uasId}/position

Update the position of a UAS

GET /flight-plans

List flight plans

HEAD /flight-plans

Get the only the HTTP header for listing flight plans

POST /flight-plans

Create a new flight plan

GET /flight-plans/{flightPlanId}

Get a flight plan by ID

HEAD /flight-plans/{flightPlanId}

Get the only the HTTP header for getting a user by ID

PATCH /flight-plans/{flightPlanId}

Update the information of a flight plan

PUT /flight-plans/{flightPlanId}

Update the information of a flight plan

DELETE /flight-plans/{flightPlanId}

Delete a flight plan

GET /flight-plans/{flightPlanId}/clearance/request

Request clearance for a flight plan

HEAD /flight-plans/{flightPlanId}/clearance/request

Get the only the HTTP header for requesting clearance for a flight plan

GET /test/authentication

A test GET request with required authentication

HEAD /test/authentication

A test HEAD request with required authentication

POST /test/authentication

A test POST request with required authentication

PATCH /test/authentication

A test PATCH request with required authentication

PUT /test/authentication

A test PUT request with required authentication

DELETE /test/authentication

A test DELETE request with required authentication

POST /area/uas

List UAS that are within a given area

Security

Ticket Authentication

name: Authorization

in: header
description: Hawk authentication header as true described at https://github.com/hueniverse/hawk#protocol-example. The Hawk authentication header includes the ticket ID, a timestamp, nonce, an HMAC created using the ticket secret key, and optionally a payload hash and some extra data. The order of these items in the header does not matter.

Paths

List UAS that are within a given area

POST /area/uas

Tags: UAS, All

Get the data of every UAS that is currently within the given area. Does not include UAS on the border of the given area.

Uses default content-types: application/json

Data containing the coordinates of the area

area: object

A GeoJSON Polygon describing the area. NOTE: The longitude should be before the latitude in the coordinates arrays.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage

Uses default content-types: application/json

200 OK

Returns an object that contains the array containing the data of every UAS within the given area.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
List flight plans

GET /flight-plans

Tags: Flight Plan, All

Get the information of all flight plans (including old flight plans) with the properties specified in the query parameters.






uas_owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the flight plans of the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_owner_user_ids=aaa,bbb) #/parameters/uasOwnerUserIds
uas_operator_user_ids

The user ID(s) of the operator(s) of a UAS. When set, only the flight plans of the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_operator_user_ids=aaa,bbb) #/parameters/uasOperatorUserIds
uas_ids

The ID(s) of the UAS. When set, only the flight plans of the UAS with the specified ID(s) are retrieved.

query string[] , comma separated (uas_ids=aaa,bbb) #/parameters/uasIds
purpose

The purpose of the flight plans to be included. If the parameter is omitted or empty, flight plans with any type of purpose are included.

query string , x ∈ { recreational , commercial } #/parameters/flightPlanPurpose
fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage

Uses default content-types: application/json

200 OK

Returns an object that contains the array containing the information of every flight plan retrieved




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for listing flight plans

HEAD /flight-plans

Tags: Flight Plan, All

Get the metainformation contained in the header of a HTTP GET /flight-plans request. The response is the same as GET /flight-plans, but without the response body.






uas_owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the flight plans of the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_owner_user_ids=aaa,bbb) #/parameters/uasOwnerUserIds
uas_operator_user_ids

The user ID(s) of the operator(s) of a UAS. When set, only the flight plans of the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_operator_user_ids=aaa,bbb) #/parameters/uasOperatorUserIds
uas_ids

The ID(s) of the UAS. When set, only the flight plans of the UAS with the specified ID(s) are retrieved.

query string[] , comma separated (uas_ids=aaa,bbb) #/parameters/uasIds
purpose

The purpose of the flight plans to be included. If the parameter is omitted or empty, flight plans with any type of purpose are included.

query string , x ∈ { recreational , commercial } #/parameters/flightPlanPurpose
fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Create a new flight plan

POST /flight-plans

Tags: Flight Plan, AUTHENTICATION REQUIRED, All

Create a new flight plan with the information given.

Uses default content-types: application/json

Data containing the information of the new flight plan of the UAS

Uses default content-types: application/json

200 OK

Flight plan for the UAS has been created. Returns the information of the new flight plan.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Delete a flight plan

DELETE /flight-plans/{flightPlanId}

Tags: Flight Plan, AUTHENTICATION REQUIRED, All

Delete the flight plan with the given ID.






flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

204 No Content

Flight plan was successfully deleted.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID was not found

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get a flight plan by ID

GET /flight-plans/{flightPlanId}

Tags: Flight Plan, All

Get the data of the flight plan with the ID specified in the URI.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

200 OK

Returns the data of the flight plan with the ID




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for getting a user by ID

HEAD /flight-plans/{flightPlanId}

Tags: Flight Plan, All

Get the metainformation contained in the header of a HTTP GET /flight-plans/{flight-plan} request. The response is the same as GET /flight-plans/{flight-plan}, but without the response body.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update the information of a flight plan

PATCH /flight-plans/{flightPlanId}

Tags: Flight Plan, AUTHENTICATION REQUIRED, All

Update various properties of the flight plan with the ID specified in the URI. This operation can update the flight plan information when given a partial flight plan object.

Uses default content-types: application/json

Data containing the new information of the flight plan






flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

200 OK

Information of the flight plan was updated. Returns the flight plan with the new information.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update the information of a flight plan

PUT /flight-plans/{flightPlanId}

Tags: Flight Plan, AUTHENTICATION REQUIRED, All

Same as PATCH /flight-plans/{flight-plan}.

Uses default content-types: application/json

Data containing the new information of the flight plan






flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

200 OK

Information of the flight plan was updated. Returns the flight plan with the new information.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Request clearance for a flight plan

GET /flight-plans/{flightPlanId}/clearance/request

Tags: Flight Plan, Flight Plan Clearance, AUTHENTICATION REQUIRED, All

Create a request for clearance for the flight plan with the ID specified in the URI. In other words, request the system to evaluate the flight plan then grant or reject clearance for the flight plan with the ID specified in the URI.






flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

204 No Content

The system is processing the flight plan to determine if clearance should be granted. To get the system's decision, GET /flight-plans/{flightPlanId}




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for requesting clearance for a flight plan

HEAD /flight-plans/{flightPlanId}/clearance/request

Tags: Flight Plan, Flight Plan Clearance, AUTHENTICATION REQUIRED, All

Get the metainformation contained in the header of a HTTP GET /flight-plans/{flightPlanId}/clearance/request request. The response is the same as GET /flight-plans/{flightPlanId}/clearance/request, but without the response body and the flight plan clearance request is not processed






flightPlanId

ID of the flight plan

path string #/parameters/flightPlanId

Uses default content-types: application/json

204 No Content #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

Flight plan with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test DELETE request with required authentication

DELETE /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Only an object with a message is returned if authentication was successful. Nothing in the system is changed. This can be used for testing.

Uses default content-types: application/json

200 OK

Returns an object containing a message




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test GET request with required authentication

GET /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Only an object with a message is returned if authentication was successful. This can be used for testing.

Uses default content-types: application/json

200 OK

Returns an object containing a message




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test HEAD request with required authentication

HEAD /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Get the metainformation contained in the header of a HTTP GET /test/authentication request. The response is the same as GET /test/authenticaiton, but without the response body. This can be used for testing.

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test PATCH request with required authentication

PATCH /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Only the object that was sent in the request is returned if authentication was successful. Nothing in the system is changed. This can be used for testing.

Uses default content-types: application/json

Whatever data you want

whateverYouWant: string You can enter whatever data you like with not constraint on schema. This is an example of what you can enter.

Uses default content-types: application/json

200 OK

Returns the object that was sent in the request




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test POST request with required authentication

POST /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Only the object that was sent in the request is returned if authentication was successful. Nothing in the system is changed. This can be used for testing.

Uses default content-types: application/json

Whatever data you want

whateverYouWant: string You can enter whatever data you like with not constraint on schema. This is an example of what you can enter.

Uses default content-types: application/json

200 OK

Returns the object that was sent in the request




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
A test PUT request with required authentication

PUT /test/authentication

Tags: Test, AUTHENTICATION REQUIRED, All

Same as PATCH /test/authentication.

Uses default content-types: application/json

Whatever data you want

whateverYouWant: string You can enter whatever data you like with not constraint on schema. This is an example of what you can enter.

Uses default content-types: application/json

200 OK

Returns the object that was sent in the request




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
List UAS

GET /uas

Tags: UAS, All

Get the data of every UAS with the properties specified in the query parameters.






owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (owner_user_ids=aaa,bbb) #/parameters/ownerUserIds
operator_user_ids

The user ID(s) of the operator of a UAS. When set, only the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (operator_user_ids=aaa,bbb) #/parameters/operatorUserIds
fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage

Uses default content-types: application/json

200 OK

Returns an object that contains the array containing the data of every UAS




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for listing UAS

HEAD /uas

Tags: UAS, All

Get the metainformation contained in the header of a HTTP GET /uas request. The response is the same as GET /uas, but without the response body.






owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (owner_user_ids=aaa,bbb) #/parameters/ownerUserIds
operator_user_ids

The user ID(s) of the operator of a UAS. When set, only the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (operator_user_ids=aaa,bbb) #/parameters/operatorUserIds
fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Create a new UAS

POST /uas

Tags: UAS, AUTHENTICATION REQUIRED, All

Create a new UAS with the information given for the currently authenticated user.

Uses default content-types: application/json

Data containing the information of the new UAS

Uses default content-types: application/json

200 OK

UAS has been created. Returns the information of the new UAS.

Uas



Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Delete a UAS

DELETE /uas/{uasId}

Tags: UAS, AUTHENTICATION REQUIRED, All

Delete the UAS with the given ID.






uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

204 No Content

UAS was successfully deleted.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get a UAS by ID

GET /uas/{uasId}

Tags: UAS, All

Get the UAS with the ID specified in the URI.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

200 OK

Returns the UAS with the ID

Uas



Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for getting a UAS by ID

HEAD /uas/{uasId}

Tags: UAS, All

Get the metainformation contained in the header of a HTTP GET /uas/{uasId} request. The response is the same as GET /uas/{uasId}, but without the response body.






uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update the information of a UAS

PATCH /uas/{uasId}

Tags: UAS, AUTHENTICATION REQUIRED, All

Update various properties of the UAS with the ID specified in the URI. This operation can update the UAS information when given a partial UAS object.

Uses default content-types: application/json

Data containing the new information of the UAS






uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

200 OK

Information of the UAS was updated. Returns the UAS with the new information.

Uas



Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update the information of a UAS

PUT /uas/{uasId}

Tags: UAS, AUTHENTICATION REQUIRED, All

Same as PATCH /uas/{uasId}.

Uses default content-types: application/json

Data containing the new information of the UAS






uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

200 OK

Information of the UAS was updated. Returns the UAS with the new information.

Uas



Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update the position of a UAS

POST /uas/{uasId}/position

Tags: UAS, AUTHENTICATION REQUIRED, All

Update the properties of the position of the UAS with the ID specified in the URI.

Uses default content-types: application/json

Data containing the new information of the location of the UAS






uasId

ID of the UAS

path string #/parameters/uasId

Uses default content-types: application/json

200 OK

Position of the UAS was updated. Returns the new UAS position.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

UAS with ID was not found

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the username of a user

GET /user-id/{userId}/username

Tags: User, All

Get the username of the user with the user ID specified in the URI






userId

ID of the user

path string

Uses default content-types: application/json

200 OK

Returns the username of the user

username: string

User's current username




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Create a new user

POST /users

Tags: User, SSL ONLY, All

Create a new user with the given data.

Uses default content-types: application/json

Data of the new user.

Uses default content-types: application/json

200 OK

User has been created. Returns the data of the new user.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Revoke a user authentication ticket

DELETE /users/auth-ticket

Tags: User, AUTHENTICATION REQUIRED, All

Revoke the authentication ticket sent in the HTTP authentication header. After a ticket has been revoked, the ticket is no longer valid and cannot be used for authentication. This operation does not affect any UAS authentication tickets.

Uses default content-types: application/json

204 No Content

User authentication ticket was successfully revoked. The ticket is no longer valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get a ticket for user authentication

POST /users/auth-ticket

Tags: User, SSL ONLY, All

Get a ticket for authenticating the user with the username specified in the URI by sending the user's username and password. This can be used to create a 'Log in' function.

Uses default content-types: application/json

A JSON object that contains the password of the user with the username specified in the URI

password: string (password) (6 to 72 chars)

Uses default content-types: application/json

200 OK

The correct password was provided. Returns a user authentication ticket.

400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
403 Forbidden

The password given was incorrect.

404 Not Found

User with username does not exist

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get a user by username

GET /users/{username}

Tags: User, All

Get the data of the user with the username specified in the URI.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

Returns the data of the user with the username




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for getting a user by username

HEAD /users/{username}

Tags: User, All

Get the metainformation contained in the header of a HTTP GET /users/{username} request. The response is the same as GET /users/{username}, but without the response body.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update a user's information.

PATCH /users/{username}

Tags: User, AUTHENTICATION REQUIRED, All

Update various properties of the user with the username specified in the URI. This operation can update the user's information when given a partial user object.

Uses default content-types: application/json

Data containing the new user information that will overwrite the existing user information.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

User's information was updated. Returns the user with the new information.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Update a user's information

PUT /users/{username}

Tags: User, AUTHENTICATION REQUIRED, All

Same as PATCH /users/{username}.

Uses default content-types: application/json

Data containing the new user information that will overwrite the existing user information.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

User's information was updated. Returns the user with the new information.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
401 Unauthorized #/responses/Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
403 Forbidden #/responses/Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
List the achievement badges a user has earned

GET /users/{username}/achievement-badges

Tags: User, All

Get the data of the achievement badges earned by the user with the username specified in the URI.






fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[] #/parameters/fields
page

A number that is the nth page of results. Used for pagination.

query string #/parameters/page
per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15 #/parameters/perPage
username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

Returns an object that contains the array containing the data of achievement badges he user has earned




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for getting a user by username

HEAD /users/{username}/achievement-badges

Tags: User, All

Get the metainformation contained in the header of a HTTP GET /users/{username} request. The response is the same as GET /users/{username}, but without the response body.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Change a user's password

POST /users/{username}/password

Tags: User, All, SSL ONLY

Change the password of the user with the username specified in the URI.

Uses default content-types: application/json

Data containing the old and new passwords to be sent to the server using SSL only

oldPassword: string (password) (6 to 72 chars)

User's current password

newPassword: string (password) (6 to 72 chars)

The password that will become the user's new password






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

User's password was changed. The user can now use the new password to authenticate.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
403 Forbidden

The old (current) password given was incorrect.

404 Not Found

User with username does not exist

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Request to reset the password of a user

GET /users/{username}/password/reset

Tags: User, All

Request the system to reset the password of the user with the username specified in the URI. An email will be sent to the user with an password reset confirmation code.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

The process for resetting the user's password has been initiated. An email containing the password reset confirmation code has been sent. Returns the password reset token with some additional information.

token: string

A token that will be sent to the server to confirm the password reset.

email: string

A masked version of the email address to which the password reset confirmation code was sent

exp: integer (int64)

Token expiration date and time as the number of milliseconds since Unix Epoch (January 1 , 1970 12:00:00 am GMT)

400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Get the only the HTTP header for requesting to reset the password of a user

HEAD /users/{username}/password/reset

Tags: User, All

Get the metainformation contained in the header of a HTTP GET /users/{username}/password/reset request. The response is the same as GET /users/{username}/password/reset, but without the response body and no email is sent to the user with the username specified in the URI.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK #/responses/HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
404 Not Found

User with username does not exist

503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Confirm a request to reset the password of a user.

POST /users/{username}/password/reset

Tags: User, All, SSL ONLY

Confirm a request to reset the password of the user with the username specified in the URI. Must have previously received a password reset token from GET /users/{username}/password/reset.

Uses default content-types: application/json

Data containing the password reset token, password reset confirmation code, and the user's new password

token: string

The password reset token previously given by the server in a GET /users/{username}/password/reset request

confirmCode: string

The password reset confirmation code given to the user via email

newPassword: string (password) (6 to 72 chars)

The string that will become the user's new password. May be chosen by the user.






username

Username of the user (case-insensitive)

path string #/parameters/username

Uses default content-types: application/json

200 OK

User's password was reset. The user can now use the new password to authenticate.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
400 Bad Request #/responses/NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
403 Forbidden

The password reset is invalid for some reason. The reason is given in the error message.

404 Not Found

User with username does not exist

415 Unsupported Media Type #/responses/UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
422 Unprocessable Entity #/responses/ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
503 Service Unavailable #/responses/ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

default #/responses/UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string

Parameter definitions







flightPlanPurpose purpose

The purpose of the flight plans to be included. If the parameter is omitted or empty, flight plans with any type of purpose are included.

query string , x ∈ { recreational , commercial }
fields fields

Comma-separated list of fields to include in the object(s) that are returned. Fields not included in this list are excluded.

query string[]
page page

A number that is the nth page of results. Used for pagination.

query string
perPage per_page

A number that is the maximum number of items to return in a single page (response).

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 15
ownerUserIds owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (owner_user_ids=aaa,bbb)
operatorUserIds operator_user_ids

The user ID(s) of the operator of a UAS. When set, only the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (operator_user_ids=aaa,bbb)
uasOwnerUserIds uas_owner_user_ids

The user ID(s) of the owner of a UAS. When set, only the flight plans of the UAS that are owned by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_owner_user_ids=aaa,bbb)
uasOperatorUserIds uas_operator_user_ids

The user ID(s) of the operator(s) of a UAS. When set, only the flight plans of the UAS that are operated by the user(s) with the specified ID(s) are retrieved.

query string[] , comma separated (uas_operator_user_ids=aaa,bbb)
uasIds uas_ids

The ID(s) of the UAS. When set, only the flight plans of the UAS with the specified ID(s) are retrieved.

query string[] , comma separated (uas_ids=aaa,bbb)
username username

Username of the user (case-insensitive)

path string
uasId uasId

ID of the UAS

path string
flightPlanId flightPlanId

ID of the flight plan

path string

Response definitions

UnexpectedError

Unexpected error. Usually with a 500 status code.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
Unauthenticated

No or invalid authentication credentials were provided.




WWW-Authentication

If the Authentication HTTP header was not set, this lets the user know the authentication that is used by the server. The value should always be "Hawk"

string
Forbidden

User is authenticated, but not allowed to access the resource or perform the requested operation.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
ServiceUnavailable

Server is temporarily unavailable, usually because it is undergoing maintenance.

UnsupportedMediaType

Incorrect or no content type header was provided as part of the request.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
ValidationError

Data in the request is not valid.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
NoSSL

SSL is required, but the request is not sent over SSL




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string
HttpHeader

Metainformation contained in the HTTP header. No content in the response body.




Server-Authorization

Enables the client to authenticate the response and ensure it is talking to the correct server. Only in a response to a successfully authenticated request.

string

Schema definitions

Achievement: object

Information about the achievement

id: string (up to 50 chars)

A unique identifier for the achievement

name: string (up to 50 chars)

Name of the achievement

description: string (up to 255 chars)

Description of the achievement

AchievementBadge: object

An achievement badge a user has earned

id: string (10 to 10 chars)

Unique hexidecimal identifier assigned to a achievement badge by the server

userId: string

ID of the user who earned the achievement badge

achievement: Achievement

Information about the type of achievement the badge represents

dateEarned: string (date-time)

The date and time (UTC timezone) the user earned the achievement badge

AuthTicket: object

An object that contains information that can be used to authenticate without a user's username and password.

user: string (at least 8 chars)

The ID of the user the authentication ticket is used to authenticate as to the server

key: string (32 to 32 chars)

Ticket secret key that should be kept in a safe place

algorithm: string sha256

The HMAC (hash message authentication code) algorithm that should be used to create the HMAC for authentication and payload validation. The only algorithm currently supported is SHA256

exp: integer (int64)

Ticket expiration date and time as the number of seconds since Unix Epoch (January 1 , 1970 12:00:00 am GMT)

scope: string[]

A list of string used to describe the actions allowed when using this ticket. It is a way to limit what functionality is possible when using a certain ticket.

string
ext: object

Extra data used by the server during authentication

id: string

Ticket ID that is sent in a request that requires authentication

FlightPlan: object

Data about a flight plan sent from the server

id: string (8 to 8 chars)

Unique hexidecimal identifier assigned to a flight plan by the server

uasId: string

ID of the UAS the flight plan is for

name: string (up to 100 chars)

Name for human (not server) identification purposes

purpose: string , x ∈ { recreational (default) , commercial }

Type of reason for UAS flight

description: string (up to 255 chars)

Brief description

areaPath: object

Area or path of the planned UAS flight as a GeoJSON. NOTE: The longitude should be before the latitude in the coordinates arrays.

maxAltitude: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 99999.9999999 }

Maximumn number of feet above the mean sea level (MSL) the UAS will fly within the area/path

startDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight begins

endDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight ends

createdAt: string (date-time)

Date and time (UTC timezone) the flight plan was created

updatedAt: string (date-time)

Date and time (UTC timezone) the information was last changed

clearance: FlightPlanClearance

Data about the clearance of the flight, if clearance has either been granted or rejected

FlightPlanClearance: object

Data about a flight plan clearance sent from the server

id: string (8 to 8 chars)

Unique hexidecimal identifier assigned to a user by the server

decision: string (up to 20 chars)

Whether or not the flight plan clearance was granted, rejected, or waiting for ATC authorization(s)

reasonForDecision: string (up to 255 chars)

Explanation for why the flight plan clearance was granted or rejected

conditions: string[]

A list of conditions attached to the flight plan clearance, if clearance is granted.

string
warnings: string[]

A list of warning that apply to the flight plan that was granted clearance, if clearance is granted.

string
createdAt: string (date-time)

Date and time (UTC timezone) the flight plan clearance was granted or approved

updatedAt: string (date-time)

Date and time (UTC timezone) the information was last changed

FlightPlanCreationData: object

Data sent to the server for creating a flight plan

uasId: string

ID of the UAS the flight plan is for

name: string (up to 100 chars)

Name for human (not server) identification purposes

purpose: string , x ∈ { recreational (default) , commercial }

Type of reason for UAS flight

description: string (up to 255 chars)

Brief description

areaPath: object

Area or path of the planned UAS flight as a GeoJSON. NOTE: The longitude should be before the latitude in the coordinates arrays.

maxAltitude: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 99999.9999999 }

Maximumn number of feet above the mean sea level (MSL) the UAS will fly within the area/path

startDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight begins. The date/time format should be in the ISO 8601 format, but other formats are accepted.

endDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight ends. The date/time format should be in the ISO 8601 format, but other formats are accepted.

FlightPlanUpdateData: object

Data sent to the server for updating the information of an existing flight plan

uasId: string

ID of the UAS the flight plan is for

name: string (up to 100 chars)

Name for human (not server) identification purposes

purpose: string , x ∈ { recreational (default) , commercial }

Type of reason for UAS flight

description: string (up to 255 chars)

Brief description

areaPath: object

Area or path of the planned UAS flight as a GeoJSON. NOTE: The longitude should be before the latitude in the coordinates arrays.

maxAltitude: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 99999.9999999 }

Maximumn number of feet above the mean sea level (MSL) the UAS will fly within the area/path

startDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight begins

endDatetime: string (date-time)

Proposed date and time (UTC timezone) the UAS flight ends

HttpErrorMessage: object

Message sent from the server describing an error encountered by the server

message: string

Message describing the error

PaginatedAchievementBadges: object

total: integer , { x ∈ ℤ | x ≥ 0 }

Total number of achievement badges found for the query/request

perPage: integer , { x ∈ ℤ | x ≥ 1 } 15

Maximum number of achievement badges to return in a single page (response).

currentPage: integer , { x ∈ ℤ | x ≥ 1 }

Page number for which all of the achievement badges returned are a part of.

lastPage: integer , { x ∈ ℤ | x ≥ 0 }

Page number of the last page

nextPageUrl: string

URL for getting the next page. Is null when there is no next page.

prevPageUrl: string

URL for getting the previous page. Is null when there is no previous page.

from: integer , { x ∈ ℤ | x ≥ 1 }

Nth achievement badge from the the total set that is the first in the subset returned.

to: integer , { x ∈ ℤ | x ≥ 0 }

Nth achievement badge from the total set that is the last in the subset returned.

data: object[]

Array containing the subset of the the total set of achievement badges.

PaginatedFlightPlans: object

total: integer , { x ∈ ℤ | x ≥ 0 }

Total number of flight plans found for the query/request

perPage: integer , { x ∈ ℤ | x ≥ 1 } 15

Maximum number of flight plans to return in a single page (response).

currentPage: integer , { x ∈ ℤ | x ≥ 1 }

Page number for which all of the flight plans returned are a part of.

lastPage: integer , { x ∈ ℤ | x ≥ 0 }

Page number of the last page

nextPageUrl: string

URL for getting the next page. Is null when there is no next page.

prevPageUrl: string

URL for getting the previous page. Is null when there is no previous page.

from: integer , { x ∈ ℤ | x ≥ 1 }

Nth flight plan from the the total set that is the first in the subset returned.

to: integer , { x ∈ ℤ | x ≥ 0 }

Nth flight plan from the total set that is the last in the subset returned.

data: object[]

Array containing the subset of the the total set of flight plans.

PaginatedUas: object

total: integer , { x ∈ ℤ | x ≥ 0 }

Total number of UAS found for the query/request

perPage: integer , { x ∈ ℤ | x ≥ 1 } 15

Maximum number of UAS to return in a single page (response).

currentPage: integer , { x ∈ ℤ | x ≥ 1 }

Page number for which all of the UAS returned are a part of.

lastPage: integer , { x ∈ ℤ | x ≥ 0 }

Page number of the last page

nextPageUrl: string

URL for getting the next page. Is null when there is no next page.

prevPageUrl: string

URL for getting the previous page. Is null when there is no previous page.

from: integer , { x ∈ ℤ | x ≥ 1 }

Nth UAS from the the total set that is the first in the subset returned.

to: integer , { x ∈ ℤ | x ≥ 0 }

Nth UAS from the total set that is the last in the subset returned.

data: object[]

Array containing the subset of the the total set of UAS.

Uas

Point: object

A GeoJSON Point object for a geographical coordinate. For more information: http://geojson.org/geojson-spec.html#point

type: string Point

This must always have the value of "Point".

coordinates: number[]

An array containing the longitude and latitude (in that order). The longitude ranges from -180 to 180 and the latitude ranges from -90 to 90.

number (double) , { x ∈ ℝ | -180 ≤ x ≤ 180 }

SuccessfulRequestMessage: object

Message sent from the server describing that it successfully processed the request

message: string

Message describing the successful request

Uas: object

Data about a UAS sent from the sever

id: string (8 to 8 chars)

Unique hexidecimal identifier assigned to a UAS by the server

name: string (up to 100 chars)

Name for human (not server) identification purposes

ownerUserId: string

ID of the user that owns the UAS. The owner of a UAS is not always the operator.

operatorUserId: string

ID of the user that is operating the UAS. The operator of a UAS is not always the owner.

description: string (up to 255 chars)

Brief description

manufacturer: string (up to 100 chars)

Company that manufactured the UAS, if applicable

model: string (up to 100 chars)

Model name, if applicable

weight: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 999.9999 }

Weight in ounces (oz) with a maximum of 4 decimal places of precision

photo: string (up to 1572864 chars)

Photo of the UAS as a Base64 data URI string with the photo data as a base64 string. Allowed maximum size of photo is around 1 MiB (1048576 bytes) in binary form.

createdAt: string (date-time)

Date and time (UTC timezone) the UAS was added to the database

updatedAt: string (date-time)

Date and time (UTC timezone) the information was last changed

position: UasPosition

Geographical position (longitude and latitude) and altitude of the UAS

UasCreationData: object

Data sent to the server for creating a UAS

name: string (up to 100 chars)

Name for human (not server) identification purposes

description: string (up to 255 chars)

Brief description of the UAS

manufacturer: string (up to 100 chars)

Company that manufactured the UAS, if applicable

model: string (up to 100 chars)

Model name, if applicable

weight: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 999.9999 }

Weight in ounces (oz) with a maximum of 2 decimal places of precision

photo: string (up to 1572864 chars)

Photo of the UAS as a Base64 data URI string with the photo data as a base64 string. Allowed maximum size of photo is around 1 MiB (1048576 bytes) in binary form.

UasPosition: object

Data about the position of a UAS sent from the server

coordinates: Point

The coordinates as a GeoJSON Point object.

altitude: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 99999.9999999 }

Number of feet above the mean sea level (MSL)

updatedAt: string (date-time)

Date and time (UTC timezone) the information was last changed

UasPositionInputData: object

Data sent to the server for updating the postion of a UAS

coordinates: number[]

An array containing the longitude and the latitude (in that order). The longitude ranges from -180 to 180 and the latitude ranges from -90 to 90.

number (double) , { x ∈ ℝ | -180 ≤ x ≤ 180 }
altitude: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 99999.9999999 }

Number of feet above the mean sea level (MSL)

UasUpdateData: object

Data sent to the server for updating the information of an existing UAS

name: string (up to 100 chars)

Name for human (not server) identification purposes

description: string (up to 255 chars)

Brief description of the UAS

manufacturer: string (up to 100 chars)

Company that manufactured the UAS, if applicable

model: string (up to 100 chars)

Model name, if applicable

weight: number (double) , { x ∈ ℝ | 0 ≤ x ≤ 999.9999 }

Weight in ounces (oz) with a maximum of 2 decimal places of precision

photo: string (up to 1572864 chars)

Photo of the UAS as a Base64 data URI string with the photo data as a base64 string. Allowed maximum size of photo is around 1 MiB (1048576 bytes) in binary form.

User: object

Data about a user sent from the server

id: string (8 to 8 chars)

Unique hexidecimal identifier assigned to a user by the server

username: string (up to 50 chars)

Unique identifier created by the user (case-insensitive)

fullName: string (up to 100 chars)

First, middle, and last names OR full organization name

email: string (email) (up to 254 chars)

email address

mobilePhoneNumber: string (tel) (up to 10 chars)

Mobile phone number as a string of numbers

mobilePhoneCarrierId: integer , { x ∈ ℤ | x ≥ 1 }

The ID of the mobile phone carrier of the mobile phone number

stats: UserStats

Certain statistics about the user

createdAt: string (date-time)

Date and time (UTC timezone) in the user was created (registered)

updatedAt: string (date-time)

Date and time (UTC timezone) the information was last changed

UserCreationData: object

Data sent to the server for creating a new user

username: string (2 to 50 chars)

Unique identifier created by the user (case-insensitive)

password: string (password) (6 to 72 chars)

Password that contains a combination of letters, numbers, and symbols

fullName: string (up to 100 chars)

First, middle, and last names OR full organization name

email: string (email) (up to 254 chars)

email address

mobilePhoneNumber: string (tel) (up to 10 chars)

Mobile phone number as a string of numbers

mobilePhoneCarrierId: integer , { x ∈ ℤ | x ≥ 1 }

The ID of the mobile phone carrier of the mobile phone number

UserStats: object

Certain statistics about a user

pointsEarned: integer , { x ∈ ℤ | x ≥ 0 }

The number of points the user has earned

grantedFlightPlanClearanceCount: integer , { x ∈ ℤ | x ≥ 0 }

Number of times a flight plan for a UAS the user operated had clearance granted

rejectedFlightPlanClearanceCount: integer , { x ∈ ℤ | x ≥ 0 }

Number of times a flight plan for a UAS the user operated had clearance rejected

UserUpdateData: object

Data sent to the server for updating the information of an existing user

username: string (up to 50 chars)

Unique identifier created by the user (case-insensitive)

fullName: string (up to 100 chars)

First, middle, and last names OR full organization name

email: string (email) (up to 243 chars)

email address

mobilePhoneNumber: string (tel) (up to 10 chars)

Mobile phone number as a string of numbers

mobilePhoneCarrierId: integer , { x ∈ ℤ | x ≥ 1 }

The ID of the mobile phone carrier of the mobile phone number

ValidationErrorMessage: object

message: string

Message describing the error