AIRM API

Connect your software with the AIRM API to retrieve terms, definitions, URNs and much more. 

 

Introduction

The AIRM API is organised around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The API is organised in two categories: concepts API and search API.

Concepts API

The API for concepts lets the user retrieve items from any of the AIRM Components. Use the concepts API to retrieve AIRM concepts by name or urn.

Search API

The API for search provides access to the search capabilities available on the AIRM.aero website. Use the search API to find AIRM concepts using keywords and filters.

Terms

The REST API for Terms (Contextual Model)

GET /terms

Retrieves a term from the Contextual Model matching que parameters provided in the request.

Parameters:

name (string) optional

The term's name.

urn (string) optional

The term's urn.

version (string) optional

The AIRM version.

Request example: name=aircraft

Curl
curl -X GET "https://api.airm.aero/terms?name=aircraft" -H "accept: application/json"
Request URL
https://api.airm.aero/terms?name=aircraft

Response code=200

Response body
[
  {
    "id": 2539,
    "name": "Aircraft",
    "urn": "urn:aero:airm:1.0.0:ContextualModel:ATMBusinessTerms:Aircraft",
    "description": "Any machine that can derive support in the atmosphere from the reactions of the air other than the reactions of the air against the earth's surface.",
    "sources": [
      "ICAO"
    ],
    "status": "Approved",
    "version": "1.0.0",
    "abbreviation": null,
    "synonyms": []
  }
]
Response headers
content-encoding: gzip
content-type: application/json
date: Mon18 Jan 2021 12:40:04 GMT
transfer-encoding: chunked
vary: accept-encoding,origin,access-control-request-headers,access-control-request-method,accept-encoding

Abbreviations

The REST API for Abbreviations (Contextual Model)

GET /abbreviations

Retrieves an abbreviation from the Contextual Model matching que parameters provided in the request.

Parameters:

name (string) optional

The abbreviation's name.

urn (string) optional

The abbreviation's urn.

version (string) optional

The AIRM version.

Request example: name=CDM

Curl
curl -X GET "https://api.airm.aero/abbreviations?name=CDM" -H "accept: application/json"
Request URL
https://api.airm.aero/abbreviations?name=CDM

Response code=200

Response body
[
  {
    "id": 1735,
    "name": "CDM",
    "urn": "urn:aero:ses:eurocontrol:airm:1.0.0:ContextualModel:Abbreviations:CDM",
    "description": "Collaborative Decision Making",
    "sources": [
      "SESAR"
    ],
    "status": "Approved",
    "version": "1.0.0"
  }
]
Response headers
content-encoding: gzip
content-type: application/json
date: Mon18 Jan 2021 13:47:30 GMT
transfer-encoding: chunked
vary: accept-encoding,origin,access-control-request-headers,access-control-request-method,accept-encoding

Conceptual Model

The REST API for the Conceptual Model

GET /conceptual-models

Retrieves a concept from the Conceptual Model matching que parameters provided in the request.

Parameters:

name (string) optional

The concept's name.

urn (string) optional

The concept's urn.

version (string) optional

The AIRM version.

Request example: name=WakeTurbulenceCategory

Curl
curl -X GET "https://api.airm.aero/conceptual-models?name=WakeTurbulenceCategory" -H "accept: application/json"
Request URL
https://api.airm.aero/conceptual-models?name=WakeTurbulenceCategory

Response code=200

Response body
[
  {
    "id": 1559,
    "name": "WakeTurbulenceCategory",
    "urn": "urn:aero:airm:1.0.0:ConceptualModel:Subjects:Aircraft:WakeTurbulenceCategory",
    "description": "A grouping of aircraft according to the effect of the rotating air mass created behind the wing tips.",
    "sources": [
      "ICAO Doc 4444"
    ],
    "status": "Approved",
    "version": "1.0.0",
    "synonyms": [],
    "properties": [],
    "propertiesType": [],
    "associations": [
      {
        "id": 1683,
        "name": null,
        "cmType": 1838,
        "cmId": 1559,
        "cmTypeName": "FFICEInformation"
      }
    ],
    "associationsType": []
  }
]
Response headers
content-encoding: gzip
content-type: application/json
date: Tue02 Feb 2021 09:46:08 GMT
transfer-encoding: chunked
vary: accept-encoding,origin,access-control-request-headers,access-control-request-method,accept-encoding

Logical Model

The REST API for the Logical Model

GET /logical-models

Retrieves a concept from the Logical Model matching que parameters provided in the request.

Parameters:

name (string) optional

The concept's name.

urn (string) optional

The concept's urn.

version (string) optional

The AIRM version.

Request example: name=CodeRouteType

Curl
curl -X GET "https://api.airm.aero/logical-models?name=CodeRouteType" -H "accept: application/json"
Request URL
https://api.airm.aero/logical-models?name=CodeRouteType

Response code=200

Response body
[
  {
    "id": 1157,
    "name": "CodeRouteType",
    "urn": "urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeRouteType",
    "description": "A code indicating the route classification.",
    "sources": [
      "EUROCONTROL-FAA AIXM v.5.1"
    ],
    "status": "Approved",
    "version": "1.0.0",
    "toDisplay": false,
    "synonyms": [],
    "parentId": null,
    "parentIds": [],
    "properties": [
      {
        "id": 7821,
        "name": "ATS_ROUTE",
        "urn": "urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeRouteType@ATS_ROUTE",
        "description": "A specified route designed for channelling the flow of traffic as necessary for the provision of air traffic services.",
        "type": null,
        "typeName": null,
        "primitiveType": null,
        "sources": null,
        "termsInDefinition": [],
        "cardinality": {
          "lower": 0,
          "upper": 1
        }
      },
      {
        "id": 7822,
        "name": "NAT",
        "urn": "urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeRouteType@NAT",
        "description": "A route between Europe and North America whose exact location changes daily according to weather and traffic demands.",
        "type": null,
        "typeName": null,
        "primitiveType": null,
        "sources": null,
        "termsInDefinition": [],
        "cardinality": {
          "lower": 0,
          "upper": 1
        }
      },
      {
        "id": 7823,
        "name": "OCEANIC_TRACK",
        "urn": "urn:aero:airm:1.0.0:LogicalModel:Subjects:AirspaceInfrastructure:Codelists:CodeRouteType@OCEANIC_TRACK",
        "description": "A route that is part of an Organised Track System established for an oceanic area.",
        "type": null,
        "typeName": null,
        "primitiveType": null,
        "sources": null,
        "termsInDefinition": [],
        "cardinality": {
          "lower": 0,
          "upper": 1
        }
      }
    ]
  }
]
Response headers
content-encoding: gzip
content-type: application/json
date: Tue02 Feb 2021 09:51:38 GMT
transfer-encoding: chunked
vary: accept-encoding,origin,access-control-request-headers,access-control-request-method,accept-encoding