Open ATMS (1.0.8)

Download OpenAPI specification:Download

Airlab Technical Support: support@airlab.aero URL: http://airlab.aero/contact

Introduction

This is a set of API for accessing services provided by the Open ATMS system.

Authentication

api-key

Security Scheme Type API Key
Header parameter name: api-key

Airports

Endpoints for retrieving airport records

Get list of all Airports

Responses

200

OK

401

Unauthorized

403

Forbidden

get/airac/airports
https://open-atms.airlab.aero/api/v1/airac/airports

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Details of an airport queried by ICAO or IATA

path Parameters
id
required
string

id

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/airac/airports/{id}
https://open-atms.airlab.aero/api/v1/airac/airports/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "uid": "string",
  • "name": "string",
  • "iata": "string",
  • "icao": "string",
  • "lat": 0,
  • "lng": 0,
  • "alt": 0
}

Airways

Endpoints for retrieving airway records

Get all Airways

Responses

200

OK

401

Unauthorized

403

Forbidden

get/airac/airways
https://open-atms.airlab.aero/api/v1/airac/airways

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get an Airway by the name.

path Parameters
name
required
string

name

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/airac/airways/{name}
https://open-atms.airlab.aero/api/v1/airac/airways/{name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "points":
    [
    ]
}

SID

Endpoints for retrieving SID (Standard Instrumentation Departure) records

Get all SID by airport ICAO.

path Parameters
icao
required
string

icao

Responses

200

OK

401

Unauthorized

403

Forbidden

get/airac/sids/airport/{icao}
https://open-atms.airlab.aero/api/v1/airac/sids/airport/{icao}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get a SID by its name and the airport ICAO.

path Parameters
icao
required
string

icao

name
required
string

name

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/airac/sids/airport/{icao}/{name}
https://open-atms.airlab.aero/api/v1/airac/sids/airport/{icao}/{name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "airport":
    {
    },
  • "waypoints":
    [
    ]
}

STAR

Endpoints for retrieving STAR (Standard Terminal Arrival Routes) records

Get all STAR by airport ICAO code.

path Parameters
icao
required
string

icao

Responses

200

OK

401

Unauthorized

403

Forbidden

get/airac/stars/airport/{icao}
https://open-atms.airlab.aero/api/v1/airac/stars/airport/{icao}

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get a STAR by its name and the airport icao code.

path Parameters
icao
required
string

icao

name
required
string

name

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/airac/stars/airport/{icao}/{name}
https://open-atms.airlab.aero/api/v1/airac/stars/airport/{icao}/{name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "airport":
    {
    },
  • "waypoints":
    [
    ]
}

Waypoints

Endpoints for retrieving waypoint records

Get all Waypoints

Responses

200

OK

401

Unauthorized

403

Forbidden

get/airac/waypoints
https://open-atms.airlab.aero/api/v1/airac/waypoints

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get a Waypoint by name

path Parameters
name
required
string

name

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/airac/waypoints/{name}
https://open-atms.airlab.aero/api/v1/airac/waypoints/{name}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "uid": "string",
  • "name": "string",
  • "lat": 0,
  • "lng": 0
}

Flight Plan Clearance Request

Endpoints for flight plan clearance requests

Put a request for Flight Plan Clearance.

Request Body schema: application/json

JSON containing request information for flight plan clearance.

gufi
required
object

Global Unique Flight Identifier.

The value contains 32 digits with the final digits indicating the CDC record number.

Note : To be replaced by a value generated by a GUFI service in the future.

fplModifTime
required
string <date-time>

The current modified time of a Flight Plan. Can be obtained from the latest Flight Plan record in FIXM. Date Time format should follow iso-8601. (https://www.iso.org/iso-8601-date-and-time-format.html)

clientId
required
string

Client ID to identify the requestor that submits the flight clearance request

data
required
string

Flight Clearance Request String in an ICAO-like syntax. Additional sub-fields are added to cover needs not fulfilled with the ICAO syntax.

** Note : The example given is 1 of many valid switches.

Structure : 'CFL-${aircraftIdent}/${ssrMode}${ssrCode}-${departureAerodrome}${departureTime}-${arrivalAerodrome}-CFL/${flightOrAltitudeLevel} OPT/${impactOnComputation} DOF/${dofSwitch}'

aircraftIdent - Aircraft identification shown in Flight Plan (<= 10 characters).

ssrMode - A

ssrCode - 4 NUMERICS giving the SSR code assigned to the aircraft.

departureAerodrome - 4 LETTERS, being the ICAO four-letter location indicator allocated to the departure aerodrome or ZZZZ if no ICAO location indicator has been allocated.

departureTime - 4 Numerics

arrivalAerodrome - 4 LETTERS, being the ICAO four-letter location indicator allocated to the arrival aerodrome or ZZZZ if no ICAO location indicator has been allocated.

flightOrAltitudeLevel - F (for Flight) or A (for Altitude) followed by digits. (F300)

dofSwitch - A compulsory switch that contains the date of operation of the flight plan (in YYMMDD format).

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/fpl/clearance/
https://open-atms.airlab.aero/api/v1/fpl/clearance/

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "gufi":
    {
    },
  • "fplModifTime": "2016-08-04T18:53:38.297Z",
  • "clientId": "1",
  • "data": "CFL-RAMTRK/A5002-0115WSSS-FAJS-CFL/F300 OPT/WITH IMPACT DOF/200603"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "title": "OK",
  • "status": 200
}

Conflict Alerts Management

Endpoints for conflict alerts management service

Submit new or updated mtcd alert

path Parameters
id
required
integer

Alert Identifier

  • The item is the Alert Identification of the conflict in the system
  • This number shall be assigned, by the Conflict Probe Server, incrementally to every new alert and restart on zero after reaching the maximum value (65535) [Asterix I004/040]
Request Body schema: application/json

JSON containing request information for new MTCD alert or update MTCD alert

id
required
number <integer>

Alert Identifier

  • The item is the Alert Identification of the conflict in the system
  • This number shall be assigned, by the Conflict Probe Server, incrementally to every new alert and restart on zero after reaching the maximum value (65535) [Asterix I004/040]
timestamp
required
string <date-time>

Time of Message

  • Absolute time stamping of the message in the form of elapsed time since last midnight [Asterix I004/020]
status
string
Default: "ACTIVE"
Enum: "ACTIVE" "DELETED"

Alert Status

  • Information concerning status of the alert
  • The content of this item is implementation dependent [Asterix I004/045]
conflict
object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/alerts/mtcd/{id}
https://open-atms.airlab.aero/api/v1/alerts/mtcd/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 1,
  • "timestamp": "2020-05-25T15:18:19.833Z",
  • "status": "ACTIVE",
  • "conflict":
    {