AirHub API

Create Operation

Sandbox

POST

/v1/operations

ASL Operations

Last modified:2024-10-17 12:07:00

Scope: operation:create

This method will create a new ASL Operation.

Request

Body Params application/json

name

string

required

The name for this operation

pilotId

string

required

The user ID of the user requesting creation of this operation

Organization Only: If the requesting user belongs to an Organization account, this parameter may be populated with the user ID of any Organization member.

boundary

object

required

The geographic boundary for this operation represented in GeoJSON Polygon format

minAltitude

number <double>

required

The minimum altitude for this operation. Must be less than or equal to max altitude.

maxAltitude

number <double>

required

The max altitude for the flight volume. Must be greater than or equal to min altitude.

startTime

string <date-time>

required

The start time for this operation in RFC 3339 UTC format

endTime

string <date-time>

required

The end time for this operation in RFC 3339 UTC format. Must be greater than the start time.

aircraftId

string

optional

The ID of the aircraft to be used for this operation

timezone

string

required

The timezone in which this operation will take place in IANA Time Zone format. Used only as a display helper in client applications.

altitudeUnit

enum<string>

required

Allowed values:

ALTITUDE_UNIT_UNSPECIFIEDALTITUDE_UNIT_METERSALTITUDE_UNIT_FEET

Default:

ALTITUDE_UNIT_UNSPECIFIED

altitudeReference

enum<string>

required

Allowed values:

ALTITUDE_REFERENCE_UNSPECIFIEDALTITUDE_REFERENCE_WGS84ALTITUDE_REFERENCE_AGLALTITUDE_REFERENCE_AMSL

Default:

ALTITUDE_REFERENCE_UNSPECIFIED

flightType

enum<string>

required

Allowed values:

FLIGHT_TYPE_UNSPECIFIEDFLIGHT_TYPE_RECREATIONALFLIGHT_TYPE_COMMERCIAL

Default:

FLIGHT_TYPE_UNSPECIFIED

desc

string

optional

A description for this operation

callbackUrl

string

optional

URL that will recieve notifications when this operation has a status change

Example

{
  "name": "Operation 97",
  "pilotId": "11a3776c-338b-4c6f-8e9b-9c89ca6ecbc1",
  "boundary": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -78.55714924875102,
          38.15773996731016
        ],
        [
          -78.55714924875102,
          38.121934862230276
        ],
        [
          -78.51075174761395,
          38.121934862230276
        ],
        [
          -78.51075174761395,
          38.15773996731016
        ],
        [
          -78.55714924875102,
          38.15773996731016
        ]
      ]
    ]
  },
  "minAltitude": 0,
  "maxAltitude": 200,
  "startTime": "2024-08-23T20:25:00.000Z",
  "endTime": "2024-08-23T21:25:00.000Z",
  "aircraftId": "45dbf9a6-8113-4686-b31e-dc2d5af4adde",
  "timezone": "America/New_York",
  "altitudeUnit": "ALTITUDE_UNIT_FEET",
  "altitudeReference": "ALTITUDE_REFERENCE_AGL",
  "flightType": "FLIGHT_TYPE_COMMERCIAL",
  "desc": "Flight around Charlottesville"
}

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/operations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Operation 97",
    "pilotId": "11a3776c-338b-4c6f-8e9b-9c89ca6ecbc1",
    "boundary": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    -78.55714924875102,
                    38.15773996731016
                ],
                [
                    -78.55714924875102,
                    38.121934862230276
                ],
                [
                    -78.51075174761395,
                    38.121934862230276
                ],
                [
                    -78.51075174761395,
                    38.15773996731016
                ],
                [
                    -78.55714924875102,
                    38.15773996731016
                ]
            ]
        ]
    },
    "minAltitude": 0,
    "maxAltitude": 200,
    "startTime": "2024-08-23T20:25:00.000Z",
    "endTime": "2024-08-23T21:25:00.000Z",
    "aircraftId": "45dbf9a6-8113-4686-b31e-dc2d5af4adde",
    "timezone": "America/New_York",
    "altitudeUnit": "ALTITUDE_UNIT_FEET",
    "altitudeReference": "ALTITUDE_REFERENCE_AGL",
    "flightType": "FLIGHT_TYPE_COMMERCIAL",
    "desc": "Flight around Charlottesville"
}'

Responses

🟢200OK

application/json

A successful response.

Body

string

required

The ID of the newly created ASL Operation

Example

{
  "id": "97c375b5-5569-4da6-8846-8dc463d50943"
}

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Modified at 2024-10-17 12:07:00

List Operations

Get Operation