CMM Endpoints

Get Results

Get Extended Results

PreviousCheck My Mission - CMM NextCMM Supporting Functions

Last updated 2 months ago

Was this helpful?

Post Cmm1

POST/check-my-mission/v1/cmm1

Authorization

Body

mission_id*Mission Id

Response

Successful Response

Body

simulation_id*Simulation Id

Request

const response = await fetch('/check-my-mission/v1/cmm1', {
    method: 'POST',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mission_id": "text"
    }),
});
const data = await response.json();

Response

{
  "simulation_id": "text"
}

Post Cmm2

POST/check-my-mission/v1/cmm2

Authorization

Body

performance_set_id*Performance Set Id

limit_set_ids*Limit Set Ids

route*Route

Response

Successful Response

Body

simulation_id*Simulation Id

Request

const response = await fetch('/check-my-mission/v1/cmm2', {
    method: 'POST',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "performance_set_id": "123e4567-e89b-12d3-a456-426614174000",
      "limit_set_ids": [
        null
      ],
      "route": [
        {
          "altitude": 100,
          "altitude_type": "AGL",
          "latitude": 52.52,
          "longitude": 13.404
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "simulation_id": "text"
}

Post Cmm3

POST/check-my-mission/v1/cmm3

Authorization

Body

performance_parameters*Performance Parameters

limit_parameters*Limit Parameters

route*Route

Response

Successful Response

Body

simulation_id*Simulation Id

Request

const response = await fetch('/check-my-mission/v1/cmm3', {
    method: 'POST',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "performance_parameters": [
        {
          "name": "text",
          "unit": "text",
          "value": 1
        }
      ],
      "limit_parameters": [
        {
          "name": "text",
          "type": "text",
          "limits": [
            {}
          ],
          "unit": "text",
          "altitude": 1,
          "altitude_type": "text",
          "altitude_unit": "text"
        }
      ],
      "route": [
        {
          "altitude": 100,
          "altitude_type": "AGL",
          "latitude": 52.52,
          "longitude": 13.404
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "simulation_id": "text"
}

Get Cmm

GET/check-my-mission/v1/cmm/{simulation_id}

Authorization

Path parameters

simulation_id*Simulation Id

Query parameters

Response

Successful Response

Body

Response Get Cmm Check My Mission V1 Cmm Simulation Id Get

Request

const response = await fetch('/check-my-mission/v1/cmm/{simulation_id}', {
    method: 'GET',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>"
    },
});
const data = await response.json();

Response

{
  "simulation_id": "text",
  "simulation_time": "2025-02-05T06:36:30.449Z",
  "route_distance": 1,
  "zero_wind_flight_time": 1,
  "elevation_at_take_off": 1,
  "elevation_at_landing": 1,
  "routes": [
    {
      "flight_status": {
        "evaluation": "nominal",
        "reasons_moderate": [],
        "reasons_severe": []
      },
      "take_off_time": "2025-02-05T06:36:30.449Z",
      "flight_time": 1,
      "landing_time": "2025-02-05T06:36:30.449Z",
      "soc_at_take_off_percent": 1,
      "soc_at_landing_percent": 1,
      "endurance_at_take_off": 1,
      "endurance_at_landing": 1,
      "min_max_weather_parameters": [
        {
          "parameter": "text",
          "min": 1,
          "max": 1
        }
      ]
    }
  ]
}

Get Cmm Extended

GET/check-my-mission/v1/cmm/{simulation_id}/{take_off_time}

Authorization

Path parameters

simulation_id*Simulation Id

take_off_time*Take Off Time

Response

Successful Response

Body

simulation_id*Simulation Id

simulation_time*Simulation Time

route_distance*Route Distance

zero_wind_flight_time*Zero Wind Flight Time

elevation_at_take_off*Elevation At Take Off

elevation_at_landing*Elevation At Landing

segments*Segments

Request

const response = await fetch('/check-my-mission/v1/cmm/{simulation_id}/{take_off_time}', {
    method: 'GET',
    headers: {
      "x-api-key": "APIKeyHeader <apiKey>"
    },
});
const data = await response.json();

Response

{
  "simulation_id": "text",
  "simulation_time": "2025-02-05T06:36:30.449Z",
  "route_distance": 1,
  "zero_wind_flight_time": 1,
  "elevation_at_take_off": 1,
  "elevation_at_landing": 1,
  "segments": [
    {
      "latitude": 1,
      "longitude": 1,
      "altitude": 1,
      "timeframe": "text",
      "status": "nominal",
      "speed_gs": {
        "value": 1,
        "unit": "text"
      },
      "speed_eas": {
        "value": 1,
        "unit": "text"
      },
      "weather_parameter": [
        {
          "name": "text",
          "type": "text",
          "value": 1,
          "unit": "text",
          "status": "nominal"
        }
      ]
    }
  ]
}