Classification Surface

Sandbox

POST

/v2/classify

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

Scope: surface:create

The HexGen™ Surface API is a powerful geospatial aggregation and modeling engine that efficiently processes and combines multiple datasets to generate custom-tailored insights. This API enables users to integrate authoritative data provided by Airspace Link with their own GIS data, creating comprehensive and data-driven solutions. The API simplifies the process of combining and processing large amounts of data, transforming complexity into actionable insights.

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

geometry

object

required

coordinates

array [array]

required

type

string

required

layers

array [object {2}]

required

code

string

optional

risk

integer

optional

resolution

integer

required

Example

{
  "geometry": {
    "coordinates": [
      [
        [
          -83.281174,
          42.258
        ],
        [
          -83.281174,
          42.3121
        ],
        [
          -83.218689,
          42.3121
        ],
        [
          -83.218689,
          42.258
        ],
        [
          -83.281174,
          42.258
        ]
      ]
    ],
    "type": "Polygon"
  },
  "layers": [
    {
      "code": "uasfm_ceiling",
      "risk": 1
    }
  ],
  "resolution": 9
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://airhub-api-sandbox.airspacelink.com/v2/classify' \
--header 'Authorization: ' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "geometry": {
        "coordinates": [
            [
                [
                    -83.281174,
                    42.258
                ],
                [
                    -83.281174,
                    42.3121
                ],
                [
                    -83.218689,
                    42.3121
                ],
                [
                    -83.218689,
                    42.258
                ],
                [
                    -83.281174,
                    42.258
                ]
            ]
        ],
        "type": "Polygon"
    },
    "layers": [
        {
            "code": "uasfm_ceiling",
            "risk": 1
        }
    ],
    "resolution": 9
}'

Responses

🟢200Happy path desc

application/json

Body

data

object

required

bitmaskMap

object

required

hexes

array [object {3}]

required

message

string

required

statusCode

integer

required

Example

{
  "data": {
    "bitmaskMap": {
      "uasfm_ceiling": {
        "bitmask": 1,
        "risk": 1
      }
    },
    "hexes": [
      {
        "bitmask": 1,
        "index": "892ab2cd8d7ffff",
        "risk": 1
      }
    ]
  },
  "message": "success",
  "statusCode": 200
}

🔴500Internal error

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

Suitability

Surface v2 GeoJSON