AirHub API

Suitability

Deprecated

Sandbox

POST

/v1/suitability

Last modified:2024-05-17 17:25:38

Scope: surface:create

DEPRECATED - use Classification Surface instead.

Generates a risk suitability surface with any data sources you request. Suitability surfaces are similar to computing risk, but allow you to model risk classification that are consistent with your concept of operations.

Request

Header Params

Content-Type

enum<string>

required

Allowed value:

application/json;charset=UTF-8

Example:

application/json;charset=UTF-8

Authorization

string

required

Authorization bearer accessToken generated in Authorization step

Example:

Body Params application/json

uavWeight

string

required

uavType

string

required

pilotControl

string

required

losType

string

required

maxAltitude

integer

required

resolution

integer

required

noFill

boolean

required

features

object

required

police_stations

object

required

geometry

object

required

type

string

required

coordinates

array [array]

required

Example

{
  "uavWeight": "MICRO",
  "uavType": "FIXED_WING",
  "pilotControl": "SINGLE_PILOT",
  "losType": "VLOS",
  "maxAltitude": 100,
  "resolution": 10,
  "noFill": true,
  "features": {
    "police_stations": {
      "weight": 100
    }
  },
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -83.2428932189941,
          42.2835320469015
        ],
        [
          -83.2011795043945,
          42.2835320469015
        ],
        [
          -83.2011795043945,
          42.3354533445451
        ],
        [
          -83.2428932189941,
          42.3354533445451
        ],
        [
          -83.2428932189941,
          42.2835320469015
        ]
      ]
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://airhub-api-sandbox.airspacelink.com/v1/suitability' \
--header 'Authorization: ' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "uavWeight": "MICRO",
    "uavType": "FIXED_WING",
    "pilotControl": "SINGLE_PILOT",
    "losType": "VLOS",
    "maxAltitude": 100,
    "resolution": 10,
    "noFill": true,
    "features": {
        "police_stations": {
            "weight": 100
        }
    },
    "geometry": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    -83.2428932189941,
                    42.2835320469015
                ],
                [
                    -83.2011795043945,
                    42.2835320469015
                ],
                [
                    -83.2011795043945,
                    42.3354533445451
                ],
                [
                    -83.2428932189941,
                    42.3354533445451
                ],
                [
                    -83.2428932189941,
                    42.2835320469015
                ]
            ]
        ]
    }
}'

Responses

🟢200Success

application/json

Body

statusCode

integer

required

message

string

required

data

object

required

features

array [object {3}]

required

type

string

required

Example

{
  "statusCode": 200,
  "message": "success",
  "data": {
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -83.2290423803194,
                42.3237818364034
              ],
              [
                -83.2299442668952,
                42.3235550600582
              ],
              [
                -83.2301025552757,
                42.3228889819488
              ],
              [
                -83.2293589804454,
                42.3224496833283
              ],
              [
                -83.2284571118341,
                42.3226764515939
              ],
              [
                -83.2282988000888,
                42.3233425265594
              ],
              [
                -83.2290423803194,
                42.3237818364034
              ]
            ]
          ]
        },
        "properties": {
          "density": "Suburban",
          "infrastructureTypes": [],
          "popPerSqMi": 1032.72537252511,
          "score": 2,
          "suitableFeatures": []
        }
      }
    ],
    "type": "FeatureCollection"
  }
}

🔴500500

Modified at 2024-05-17 17:25:38

Aviation

Classification Surface