Briefing by Area - AirHub API

Scope: briefing:area:read

Request

Header Params

Authorization

string

optional

Authorization bearer accessToken generated in Authorization step

Example:

Body Params application/json

boundary

object

required

2D operational boundary of the flight represented in a GeoJSON geometry.

Example:

{"coordinates":[[[-83.07861764257095,42.335222895650645],[-83.07861764257095,42.318879440902606],[-83.05487387644406,42.318879440902606],[-83.05487387644406,42.335222895650645],[-83.07861764257095,42.335222895650645]]],"type":"Polygon"}

Example

{
  "boundary": {
    "coordinates": [
      [
        [
          -83.07861764257095,
          42.335222895650645
        ],
        [
          -83.07861764257095,
          42.318879440902606
        ],
        [
          -83.05487387644406,
          42.318879440902606
        ],
        [
          -83.05487387644406,
          42.335222895650645
        ],
        [
          -83.07861764257095,
          42.335222895650645
        ]
      ]
    ],
    "type": "Polygon"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200A successful response.

application/json

Body

status

enum<string>

optional

The status corresponds to the the B4UFLY Notice type, and is a generalized value.

NOTICE_STATUS_UNSPECIFIED: Notice status unspecified is used when the status is unset or unknown.

NOTICE_STATUS_WARNING: Warning is used when drone operations are prohibited due to flight restricted airspace.

NOTICE_STATUS_CAUTION: Caution is used when drone operations are possibly allowed but require awareness or even authorization.

NOTICE_STATUS_CLEAR_TO_FLY: Clear to Fly is used when drone operations are allowed and there is no airspace concerns.

NOTICE_STATUS_INFORMATIONAL: Informational is used to convey that the status is informational only and it is up to the pilot to determine if the operation is conforming.

Allowed values:

NOTICE_STATUS_UNSPECIFIEDNOTICE_STATUS_WARNINGNOTICE_STATUS_CAUTIONNOTICE_STATUS_CLEAR_TO_FLYNOTICE_STATUS_INFORMATIONAL

Default:

NOTICE_STATUS_UNSPECIFIED

authorizationType

enum<string>

optional

The authorization type is used to indicate if authorization is required or allowed and, if allowed, which mechanism should be used to obtain authorization.

AUTHORIZATION_TYPE_UNSPECIFIED: Unspecified is used when no authorization type could be determined.

AUTHORIZATION_TYPE_NOT_REQUIRED: Not Required is used when no authorization is needed to fly.

AUTHORIZATION_TYPE_DRONE_ZONE: Drone Zone is used when authorization is required but LANC is not available.

AUTHORIZATION_TYPE_LAANC: LAANC is used when authorization is required and LAANC authorization is available.

AUTHORIZATION_TYPE_RESTRICTED: Restricted is used when authorization is required but not allowed due to flight restricted airspace.

Allowed values:

AUTHORIZATION_TYPE_UNSPECIFIEDAUTHORIZATION_TYPE_NOT_REQUIREDAUTHORIZATION_TYPE_DRONE_ZONEAUTHORIZATION_TYPE_LAANCAUTHORIZATION_TYPE_RESTRICTED

Default:

AUTHORIZATION_TYPE_UNSPECIFIED

notices

array[object (v1Notice) {17}]

optional

Individual notices that show how the authorization determination was made.

dataSource

enum<string>

optional

Allowed values:

NOTICE_DATA_SOURCE_UNSPECIFIEDNOTICE_DATA_SOURCE_NSUFR_PART_TIMENOTICE_DATA_SOURCE_NSUFR_FULL_TIMENOTICE_DATA_SOURCE_SATRNOTICE_DATA_SOURCE_WASHINGTON_FRZNOTICE_DATA_SOURCE_TFR_ACTIVENOTICE_DATA_SOURCE_SUANOTICE_DATA_SOURCE_WASHINGTON_SFRANOTICE_DATA_SOURCE_TFR_SCHEDULEDNOTICE_DATA_SOURCE_LAANC_ENABLED_CONTROLLED_AIRSPACENOTICE_DATA_SOURCE_UASFM_CEILINGNOTICE_DATA_SOURCE_MTRNOTICE_DATA_SOURCE_STADIUMNOTICE_DATA_SOURCE_LAANC_NOT_ENABLED_CONTROLLED_AIRSPACENOTICE_DATA_SOURCE_NATIONAL_PARKNOTICE_DATA_SOURCE_RECREATIONAL_FLYER_FIXED_SITENOTICE_DATA_SOURCE_CLASS_GNOTICE_DATA_SOURCE_COMMUNITY_ADVISORYNOTICE_DATA_SOURCE_AIRPORTNOTICE_DATA_SOURCE_HELIPADNOTICE_DATA_SOURCE_NOTAMNOTICE_DATA_SOURCE_SEAPORT

Default:

NOTICE_DATA_SOURCE_UNSPECIFIED

dataSubtype

enum<string>

optional

Allowed values:

NOTICE_DATA_SUBTYPE_UNSPECIFIEDNOTICE_DATA_SUBTYPE_CLASS_BNOTICE_DATA_SUBTYPE_CLASS_CNOTICE_DATA_SUBTYPE_CLASS_DNOTICE_DATA_SUBTYPE_CLASS_ENOTICE_DATA_SUBTYPE_EMERGENCYNOTICE_DATA_SUBTYPE_ADMINNOTICE_DATA_SUBTYPE_RECREATIONALNOTICE_DATA_SUBTYPE_MOANOTICE_DATA_SUBTYPE_ALERT_AREANOTICE_DATA_SUBTYPE_DANGER_AREANOTICE_DATA_SUBTYPE_WARNING_AREANOTICE_DATA_SUBTYPE_PROHIBITED_AREANOTICE_DATA_SUBTYPE_RESTRICTED_AREANOTICE_DATA_SUBTYPE_ADVISORY_AREA

Default:

NOTICE_DATA_SUBTYPE_UNSPECIFIED

title

string

optional

Title of the notice.

Example:

R-3002D

description

string

optional

Text description of the notice.

Example:

Lorem ipsum ....

distance

number <double>

optional

Distance of the input to the notice in nautical miles.

Example:

1.1234

status

enum<string>

optional

The status corresponds to the the B4UFLY Notice type, and is a generalized value.

NOTICE_STATUS_UNSPECIFIED: Notice status unspecified is used when the status is unset or unknown.

NOTICE_STATUS_WARNING: Warning is used when drone operations are prohibited due to flight restricted airspace.

NOTICE_STATUS_CAUTION: Caution is used when drone operations are possibly allowed but require awareness or even authorization.

NOTICE_STATUS_CLEAR_TO_FLY: Clear to Fly is used when drone operations are allowed and there is no airspace concerns.

NOTICE_STATUS_INFORMATIONAL: Informational is used to convey that the status is informational only and it is up to the pilot to determine if the operation is conforming.

Allowed values:

NOTICE_STATUS_UNSPECIFIEDNOTICE_STATUS_WARNINGNOTICE_STATUS_CAUTIONNOTICE_STATUS_CLEAR_TO_FLYNOTICE_STATUS_INFORMATIONAL

Default:

NOTICE_STATUS_UNSPECIFIED

code

enum<string>

optional

Allowed values:

NOTICE_CODE_UNSPECIFIEDNOTICE_CODE_SPECIAL_FLIGHT_RULES_AREANOTICE_CODE_FLIGHT_RESTRICTED_AIRSPACENOTICE_CODE_CONTROLLED_AIRSPACENOTICE_CODE_SPECIAL_USE_AIRSPACENOTICE_CODE_STADIUMNOTICE_CODE_NATIONAL_PARKNOTICE_CODE_RECREATIONAL_FIXED_FLYER_SITENOTICE_CODE_CLEAR_TO_FLYNOTICE_CODE_INFORMATIONAL

Default:

NOTICE_CODE_UNSPECIFIED

ruleCode

enum<string>

optional

RULE_CODE_NOT_A_RULE: Not an explicit b4ufly rule.

Allowed values:

RULE_CODE_UNSPECIFIEDRULE_CODE_5_3ARULE_CODE_5_3BRULE_CODE_5_3CRULE_CODE_5_3DRULE_CODE_5_3ERULE_CODE_5_3FRULE_CODE_5_3GRULE_CODE_5_3HRULE_CODE_5_3IRULE_CODE_5_3JRULE_CODE_5_3KRULE_CODE_5_3ORULE_CODE_5_3PRULE_CODE_NOT_A_RULE

Default:

RULE_CODE_UNSPECIFIED

ruleDescription

string

optional

Textual description of the b4ufly rule.

Example:

No person may operate a small unmanned aircraft in restricted airspace unless that person has permission from the appropriate authority. Individuals violating any of these restrictions may be subject to FAA and/or law enforcement action.

authority

string

optional

Authoritative body behind the notice.

Example:

Federal Aviation Administration

sourceUrl

string

optional

Reference URL of the notice source.

Example:

https://sua.faa.gov

contact

object (v1ContactInformation)

optional

lowerAltitude

object (v1Altitude)

optional

upperAltitude

object (v1Altitude)

optional

geometry

object

optional

2D boundary of the notice represented by a GeoJSON geometry.

Example:

schedule

object (v1Schedule)

optional

events

array[object (v1Event) {4}]

optional

Scheduled events occuring during the lifetime of the notice.

Example

{
  "status": "NOTICE_STATUS_UNSPECIFIED",
  "authorizationType": "AUTHORIZATION_TYPE_UNSPECIFIED",
  "notices": [
    {
      "dataSource": "NOTICE_DATA_SOURCE_UNSPECIFIED",
      "dataSubtype": "NOTICE_DATA_SUBTYPE_UNSPECIFIED",
      "title": "R-3002D",
      "description": "Lorem ipsum ....",
      "distance": 1.1234,
      "status": "NOTICE_STATUS_UNSPECIFIED",
      "code": "NOTICE_CODE_UNSPECIFIED",
      "ruleCode": "RULE_CODE_UNSPECIFIED",
      "ruleDescription": "No person may operate a small unmanned aircraft in restricted airspace unless that person has permission from the appropriate authority. Individuals violating any of these restrictions may be subject to FAA and/or law enforcement action.",
      "authority": "Federal Aviation Administration",
      "sourceUrl": "https://sua.faa.gov",
      "contact": {
        "text": "Colonel Sanders: 1-800-chicken",
        "phoneNumber": "+1234567890",
        "email": "test@gmail.com",
        "url": "https://wwww.airspacelink.com"
      },
      "lowerAltitude": {
        "value": 200,
        "unit": "ALTITUDE_UNIT_UNSPECIFIED",
        "reference": "ALTITUDE_REFERENCE_UNSPECIFIED"
      },
      "upperAltitude": {
        "value": 200,
        "unit": "ALTITUDE_UNIT_UNSPECIFIED",
        "reference": "ALTITUDE_REFERENCE_UNSPECIFIED"
      },
      "geometry": {
        "coordinates": [
          [
            [
              -83.07861764257095,
              42.335222895650645
            ],
            [
              -83.07861764257095,
              42.318879440902606
            ],
            [
              -83.05487387644406,
              42.318879440902606
            ],
            [
              -83.05487387644406,
              42.335222895650645
            ],
            [
              -83.07861764257095,
              42.335222895650645
            ]
          ]
        ],
        "type": "Polygon"
      },
      "schedule": {
        "startTime": "2024-08-24T14:15:22Z",
        "endTime": "2024-12-30T23:00:00Z",
        "timezone": "America/New_York",
        "text": "INTERMITTENT, 0600 - 0200, DAILY; OTHER TIMES BY NOTAM 6 HOURS IN ADVANCE",
        "timesOfUse": [
          {
            "daysActive": [
              "SUN",
              "MON",
              "TUE",
              "WED",
              "THU",
              "FRI",
              "SAT"
            ],
            "dailyStart": "09:00",
            "dailyEnd": "22:00",
            "startTime": "2023-01-01T00:00:00Z",
            "endTime": "9999-12-30T23:59:59Z",
            "timezone": "America/New_York"
          }
        ]
      },
      "events": [
        {
          "name": "Detroit Lions vs. Los Angeles Rams",
          "type": "NFL",
          "startTime": "2025-01-12T12:00:00Z",
          "endTime": "2025-01-12T14:30:00Z"
        }
      ]
    }
  ]
}

🔴500An unexpected error response.