> For the complete documentation index, see [llms.txt](https://docs.unisphere.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.unisphere.io/unisphere-apis/check-my-flight-cmf.md).

# Check My Flight - CMF

The Check my Flight functionality allows the user to receive evaluated flight data for a simulated flight trajectory for a specific takeoff time up to 7 days into the future.

{% hint style="info" %}
**Use Case:** Automated flight window identification, Resource Planning & Scheduling for points / routes / areas / volumes.
{% endhint %}

## Key functionalities

* CMF performs a check for a single and unique flight for a certain takeoff time.
* The check my flight functionality uses the latest information available to automatically decide for go or no go to an upcoming flight.
* In general, a check consists of:
* For route, a flight simulation is performed to retrieve the 4D-trajectory information
* The 4D trajectory is the main source of information to be checked / evaluated. Depending on the length of the flight the time until the check is completed is expected to take about 30s.
* Check my flight is only working with flights containing a route, not locations.
* Each check requested is saved and archived.

<figure><img src="/files/5yrAGRbQAUWe1nvg6Adm" alt="Overview of Check my Flight Endpoints showing three modes: check my flight for 1) this mission in NOVA, 2) this route, 3) all information provided in the request."><figcaption><p>Overview of Check my Flight Endpoints</p></figcaption></figure>

### CMF 1

* User provides the UUIID of an existing mission in NOVA, the TO (take-off) time and BatSoc (Battery state of charge)

### **CMF 2**

* User provides the UUIDs of the assets in NOVA, the route, the TO (take-off) time and BatSoc (Battery state of charge)

### **CMF 3**

* User provides all information required to perform a check including the route, the aircraft, the performance model, the operational limits the TO (take-off) time and BatSoc (Battery state of charge). In this mode the NOVA UI is not required a such.

## Workflow

Create Simulation using CMM1/2/3- Receive Simulation Id - Get results with simulation ID

## Request and Response Content

{% hint style="info" %}
Details for request and response schemes vary depending on the actual endpoint. Refer to the latest version ...
{% endhint %}

### 1 - Check Request

This request is required to trigger a trajectory simulation. It typically consists of:

1. ISO Time and date of the flight (TO time)
2. The mission ID
3. Battery State of Charge at TO in %
4. Metadata (dictionary)

### 2 - Response

Simulation ID

### 3 - Results Request

1. Provide simulation ID
2. Select response type (basic/extended)

### 4 - Response

**The basic response consists of:**

* UUID for this flight check
* Metadata
* Date / Time of Request 1
* System Status (OK, NOK)
* Check result, Flight Status:
  * Go (Green),
  * Conditional (yellow), Notification of why (List yellow parameters)
  * NoGo (Red), Reasons for NoGo (List red parameters and yellow parameters)
* High Level (Flight) Information
  * The distance of the route along the horizontal path is calculated w/o weather
  * The flight time w/o weather. It is calculated based on the rough calculation using the target ground speed provided or the EAS provided. No atmospheric effects (e.g. TAS) to be covered.
  * TO Time (UTC)
  * Trip Duration calculated by simulation in seconds
  * LDG Time (UTC)
  * State of Charge at TO in %
  * State of Charge at LDG in %
  * Energy consumption in %
  * Endurance at TO in s
  * Remaining Endurance at LDG in s
  * Elevation of earth surface above SL at TO location (COPERNICUS COP DEM GLO)
  * Elevation of earth surface above SL at LDG location (COPERNICUS COP DEM GLO)
  * Min/max values of all weather (defined in limit sets) parameters along the flight path

**The extended response consists of:**

* LAT/LON of all points in sequence
* Time at points Evaluation of segment after the given point (between current and next one)
* GS (ground speed)
* EAS (equivalent airspeed)
* Weather parameter information along flight path, as defined in the assets
