Challenge Overview
FAA NOTAM: Notice to Airmen NOTAM Search API Design
Project Background
The Federal Aviation Administration (FAA) in collaboration with Topcoder is working to further improve timely access to Notice to Airmen (NOTAM) data by developing required Application Programming Interfaces (APIs) to meet the diverse needs of the aviation industry.
A Notice to Airmen (NOTAM) is the real-time notification component of the FAA's Aeronautical Information System and contains up-to-date information related to any change in the National Airspace System (NAS).
Who uses NOTAMs?
-
Commercial, General Aviation, and Drone pilots need access to NOTAM data before and during flight.
-
The FAA issues NOTAMs to support multiple Federal Agencies, Airports, protect critical infrastructure, disaster relief efforts, and space operations.
Challenge Overview
Welcome to the Notice to Airmen NOTAM Search API Design Challenge! Your task in this challenge is to design an API for searching NOTAM records.
Background Information
A NOTAM is a real time, safety critical, information essential to personnel concerned with flight operations but not known far enough in advance to be publicized by other means. It states the abnormal status of a component of the NAS – not the normal status.
The system that we’re building will need to ingest all the data sources and provide an API to query all the data based on various properties, such as location, notam type, location and notam number, effective start and end dates, affected feature types and last updated date.
API will also have the options to return the data in 3 different formats: AIXM, AIDAP or GeoJSON.
To access the API, users will first need to be registered on a developer portal where they would get an access key for the API.
All the application components will be hosted on Kubernetes and will need to be dockerized.
NOTE: For more details on project background and NOTAM data sources, see the architecture challenge
Technology Stack
-
Swagger - OpenAPI Spec
Assets
System architecture is posted in the challenge forums
Task Details
Your task in this challenge is to create an API specification for the NOTAM Search API. API requirements are noted in the architecture (make sure to read that document first). Short description is that Notam Search API only has one use case - searching the NOTAM records with various filtering options (all filters can be used in one API call) and 3 different output formats (AIXM 5.1, AIDAP, GeoJSON). Data should be filtered by:
-
Location and domesticLocation identifiers (full match)
-
NOTAM type (full match)
-
NOTAM number (has to be used along with location filter, using just number filter is not allowed)
-
Effective start and end dates (range)
-
Affected feature types
-
Location coordinates with radius search
-
Last updated date (range) - limited to past 72hrs (can’t search older records)
API will support pagination. Make sure to define responses for error cases (authentication, invalid parameter values, etc).
What To Submit
Submit the swagger specification for the API.