v1

latestOpenAPI 3.0.22026-07-132450182.6 KB
Surface Obstacles

Retrieve obstacles located within given area.

Retrieve obstacles located within given area. Request body parameters are:

post/us/v1/obstacles/polygon-query

Headers

x-api-keystring

Request body

polyobject required

Example request

{
  "poly": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -90.166,
          35.078
        ],
        [
          -90.104,
          35.066
        ],
        [
          -90.132,
          35.085
        ],
        [
          -90.166,
          35.078
        ]
      ]
    ]
  }
}

Response

A GeoJSON FeatureCollection, one Feature for each obstacle found.

foundobject required

Example response

{
  "found": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -90.1225,
            35.07
          ]
        },
        "properties": {
          "name": "MEMPHIS-TN-000197",
          "obstacle_type": "TOWER",
          "quantity": 2,
          "height_ft": 309,
          "lighting": "Medium Intensity White Strobe",
          "marking": "Marked"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -90.130556,
            35.072223
          ]
        },
        "properties": {
          "name": "MEMPHIS-TN-000414",
          "obstacle_type": "TOWER",
          "quantity": 1,
          "height_ft": 378,
          "lighting": "Red",
          "marking": "Marked"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -90.151389,
            35.077778
          ]
        },
        "properties": {
          "name": "MEMPHIS-TN-000755",
          "obstacle_type": "T-L TWR",
          "quantity": 1,
          "height_ft": 244,
          "lighting": "Red",
          "marking": "Orange or Orange and White Paint"
        }
      }
    ]
  }
}