Generate Route - AirHub API

Scope: route:create

Returns a GeoJSON LineString representing a route between two or more waypoints, optimized for the modeled risk of your operation. There are 3 methods to generating a route. Each route request must include one of the three methods described:

Pre-Generated Surface: Pre-create a classification surface and pass with the surface parameter. The surface must enclose all the waypoints or the route will be unsolvable.

Risk Model Definition with Area of Interest: Create a risk model definition and pass with the layers parameter. Include the operational area to be evaulated using the geometry parmeter. The geometry must enclose all waypoints or the route will be unsolvable.

Risk Model Definition: Create a risk model defintion and pass with the layers param. The API will infer the operational boundary using a buffer of the input waypoints.

Request

Header Params

Body Params application/json

Example

{
    "resolution": 9,
    "layers": [
        {
            "code": "nsufr_ft"
        },
        {
            "code": "nsufr_pt"
        },
        {
            "code": "tfr"
        },
        {
            "code": "sua"
        }
    ],
    "waypoints": {
        "type": "MultiPoint",
        "coordinates": [
            [
                -83.237915,
                42.316416
            ],
            [
                -83.205643,
                42.304991
            ]
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Body

Example

{
    "data": {
        "corridor": [
            "8a288c758037fff",
            "8a288c75811ffff",
            "8a288c2b24effff"
        ],
        "network": {
            "coordinates": [
                [
                    [
                        -118.802633639131,
                        45.6458480563089
                    ],
                    [
                        -118.807281209253,
                        45.6466533063531
                    ]
                ],
                [
                    [
                        -118.802633639131,
                        45.6458480563089
                    ],
                    [
                        -118.806148391677,
                        45.6458671344001
                    ]
                ],
                [
                    [
                        -118.802633639131,
                        45.6458480563089
                    ],
                    [
                        -118.805422182588,
                        45.6463312319668
                    ]
                ]
            ],
            "type": "MultiLineString"
        },
        "path": {
            "coordinates": [
                [
                    -118.685607263462,
                    45.6649712310512
                ],
                [
                    -118.687640419679,
                    45.6618603236282
                ],
                [
                    -118.688367745235,
                    45.6613969233936
                ],
                [
                    -118.704736454367,
                    45.657756124899
                ]
            ],
            "type": "LineString"
        }
    },
    "message": "success",
    "statusCode": 200
}

🔴500