User Story & Requirements
C1 – User Story
The flight operations manager of an organization has subscribed to NOVA.
He creates a route mission in NOVA web-application including all relevant assets.
After creation of a mission, he sees the ID of the mission.
He can copy the mission ID to further use it for programming. (To simplify this task of copying IDs from NOVA frontend the API provides an endpoint which lists all available assets, title and ID.)
The software engineer of the customer implements an internal software (The “external system” from Unisphere point of view) that allows its system to perform checks through the Unisphere API.
The external system sends a request and the API responds with a unique UUID which can be used to request the simulation result once it is ready.
Check my Flight validates the request and performs the flight check for the given mission ID, TO time and the battery SOC.
The API request performs basic validations of the input.
Once the simulation is finished, the result is available through the unique ID.
The output provides data only, no visualizations.
Requests and responses are archived and linked to organization (for tbd time)
Basic and extended are archived
We store the first access time of request 2 (basic and extended), only the first, not all.
Usage counter per organization is integrated, to count checks executed per day.
High Level Requirements
A check is defined as a flight path (vertical and lateral) with the help of simulation technology is evaluated (checked) against operational limits (e.g. flight time, maximum wind etc.).
A check is performed for a single flight with one specific TO time.
Check my Flight provides the functionality to do a check (one simulation) on the current (~local) day until 7 days into future based on a given date and time as input.
No historic data will be able to be accessed. The takeoff-time shall be within today + 7 days
Even if the technology has no specific limit for simulation time, the following limits protect the system from massive API calls or long response times by erroneous input.
The maximum flight duration time is 12 hours. Beyond a calculation of 12 hours the system aborts the simulation and reports maximum flight of X hours exceeded
i. Response with ID, Response if too long, error message e.g. status code
The maximum flight distance (great circle) allowed as an input is 2000km
If drift is observed in the simulation (aircraft speed against wind lower than wind speed) then simulation will abort and report a status code.
With the first request a UUID is created and responded.
Rate limits
Requests per minute: 50
Parallel requests: 1
Last updated
Was this helpful?