POST/api/v1/obstacles/by-oas-numbersPrivate Pilot

Get By Oas Numbers

Gets multiple obstacles by their OAS numbers. This endpoint is designed to be used with the ObstacleOasNumbers returned by the navigation log endpoint (POST /api/v1/navlog/calculate) to retrieve full details for obstacles near a planned route.

Code Examples

curl \
  -X POST \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  "12-345678",
  "12-345679"
]' \
  "https://api.preflightapi.io/api/v1/obstacles/by-oas-numbers"

curl \
  -X POST \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  "12-345678",
  "12-345679"
]' \
  "https://api.preflightapi.io/api/v1/obstacles/by-oas-numbers"

Description

Send a JSON array of OAS number strings in the request body:

["12-345678", "12-345679", "12-345680"]

Response Schema

200Returns the matching obstacles

oasNumberstring

Obstacle Assessment Surface (OAS) number — the unique identifier for this obstacle. This is the key used to look up obstacles returned by the navigation log endpoint's ObstacleOasNumbers field.

stateIdstringnullable

Two-letter state identifier.

cityNamestringnullable

City nearest to the obstacle.

latitudenumbernullable

Latitude in decimal degrees (WGS 84).

longitudenumbernullable

Longitude in decimal degrees (WGS 84).

obstacleTypestringnullable

Type of obstacle (e.g., TOWER, BLDG, STACK).

quantityintegernullable

Number of obstacles at this location.

heightAglintegernullable

Height above ground level in feet.

heightAmslintegernullable

Height above mean sea level in feet.

lightingObstacleLightingnullable

Lighting type on the obstacle.

horizontalAccuracyHorizontalAccuracynullable

Horizontal accuracy of the position data.

verticalAccuracyVerticalAccuracynullable

Vertical accuracy of the height data.

markingObstacleMarkingnullable

Marking type on the obstacle.

verificationStatusVerificationStatusnullable

Verification status of the obstacle data.

400If the list is empty or exceeds 1000 itemsApiErrorResponse

codestring

Machine-readable error code (e.g., "AIRCRAFT_NOT_FOUND").

messagestring

Human-readable error message suitable for display.

detailsstringnullable

Additional error details (only included in development environment).

servicestringnullable

Name of the external service that failed (only included for 503 errors).

validationErrorsRecord<string, string[]>nullable

Field-level validation errors (only for validation failures).

timestampstring

UTC timestamp when the error occurred.

traceIdstringnullable

Correlation ID for tracing the request.

pathstringnullable

Request path that generated the error.

Get By Oas Numbers

Code Examples

Description

Response Schema

Search Documentation