From bd04680e053304d6815221823a705c1e09da709d Mon Sep 17 00:00:00 2001 From: Safe Sky Release Automation Date: Sun, 1 Oct 2023 01:32:18 +0000 Subject: [PATCH] Import updated API specs --- docs/index.html | 1223 +++++++++++++++++++++++++++-------------------- openapi.json | 88 +++- 2 files changed, 790 insertions(+), 521 deletions(-) diff --git a/docs/index.html b/docs/index.html index ac0f861..0d4f2cb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12,386 +12,373 @@ margin: 0; } - -
API docs by Redocly
API docs by Redocly

Safe Sky Atlas API (1.18)

Download OpenAPI specification:Download

Safe Sky Industries, Inc.: support@safe-sky.net URL: https://docs.safe-sky.net/

Overview

The Atlas system provides an open REST API for accessing report data.

+ " fill="currentColor">

Safe Sky Atlas API (1.18)

Download OpenAPI specification:Download

Safe Sky Industries, Inc.: support@safe-sky.net URL: https://docs.safe-sky.net/

Overview

The Atlas system provides an open REST API for accessing report data.

The REST API uses JSON over HTTPS exclusively. In a cloud deployment the API is exposed on https://atlas.safe-sky.net/; in an on-premises deployment the URL will vary. The API uses versioned URLs, where the current API version is /v1.

@@ -424,7 +426,28 @@

Formatting

human-readable JSON you can add the query parameter ?pretty to any API call or, equivalently, set the Accept: application/json+pretty query header.

-

Auth

All API methods require authentication, unless otherwise noted. Each request +

Auth

All API methods require authentication, unless otherwise noted. Each request must carry an Authorization header with the Bearer scheme and a valid access token. An access token can be acquired in different ways depending on the specific deployment. For customers using federated authentication @@ -445,199 +468,377 @@

Demo Key

"displayName": "Atlas Demo User", ... -

List aerodrome users

Returns a list of users that are members of the aerodrome. This +

List aerodrome users

Returns a list of users that are members of the aerodrome. This method requires aerodrome admin permissions.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Aerodrome is optional, when set it returns users with permission for +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Aerodrome is optional, when set it returns users with permission for the aerodrome in question only, requires aerodrome admin permission. Blank aerodrome returns all users and requires system admin permission.

-

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Add a user to an aerodrome, granting the given permissions.

The email address is used to look up an existing user or, if one does +

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Add a user to an aerodrome, granting the given permissions.

The email address is used to look up an existing user or, if one does not exist, invite the user to the Atlas system. In this case the display name is used when creating the user.

-
Authorizations:
bearerAuth
Request Body schema: application/json
displayName
string
email
string
object (Permissions)

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "email": "string",
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

Get login configuration

The system login configuration determines whether internal or +

Authorizations:
bearerAuth
Request Body schema: application/json
required
displayName
string
email
string
object (Permissions)

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "email": "string",
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

Get login configuration

The system login configuration determines whether internal or external authentication is used, and which ID provider to use.

-

Responses

Response samples

Content type
application/json
{
  • "kind": "LOGINKIND_UNSUPPORTED",
  • "oidcAllowedTfps": [
    ],
  • "oidcClientId": "string",
  • "oidcIssuer": "string",
  • "oidcJwksUrl": "string",
  • "oidcLoginDiscoveryUrl": "string",
  • "oidcPermissionsClaim": "string",
  • "oidcRequiredScps": [
    ],
  • "oidcResetDiscoveryUrl": "string",
  • "oidcScopes": [
    ],
  • "oidcSystemAdminClaim": "string"
}

Get current user

Returns the currently authenticated user.

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

List API keys

Returns a list of current API keys for the currently authenticated +

Responses

Response samples

Content type
application/json
{
  • "kind": "LOGINKIND_UNSUPPORTED",
  • "oidcAllowedTfps": [
    ],
  • "oidcClientId": "string",
  • "oidcIssuer": "string",
  • "oidcJwksUrl": "string",
  • "oidcLoginDiscoveryUrl": "string",
  • "oidcPermissionsClaim": "string",
  • "oidcRequiredScps": [
    ],
  • "oidcResetDiscoveryUrl": "string",
  • "oidcScopes": [
    ],
  • "oidcSystemAdminClaim": "string"
}

Get current user

Returns the currently authenticated user.

+
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

List API keys

Returns a list of current API keys for the currently authenticated user. For security reasons the full API keys are not returned, instead a truncated display string is returned that can be shown to the user. The revocation ID is used to refer to a key in the revoke API key call.

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Create API key

Creates an API key that can be used to authenticate as the currently +

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Create API key

Creates an API key that can be used to authenticate as the currently authenticated user. The validity period is specified in days.

-
Authorizations:
bearerAuth
Request Body schema: application/json
validityDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "validityDays": 0
}

Response samples

Content type
application/json
{
  • "key": "string"
}

Revoke API key

Revokes an API key, by looking it up via its revocation ID.

-
Authorizations:
bearerAuth
path Parameters
revocationId
required
string

Responses

Response samples

Content type
application/json
{ }

Set user data

Set user data for the currently authenticated user. User data is a +

Authorizations:
bearerAuth
Request Body schema: application/json
required
validityDays
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "validityDays": 0
}

Response samples

Content type
application/json
{
  • "key": "string"
}

Revoke API key

Revokes an API key, by looking it up via its revocation ID.

+
Authorizations:
bearerAuth
path Parameters
revocationId
required
string

Responses

Response samples

Content type
application/json
{ }

Set user data

Set user data for the currently authenticated user. User data is a collection of key-value pairs, where the key is a string and the value is a slice of bytes (base64 encoded, in JSON). The server does not interpret the value and is only used to store it. The Atlas app uses user data to store user preferences and other settings.

-
Authorizations:
bearerAuth
path Parameters
data.key
required
string
Request Body schema: application/json
value
string <byte>

In JSON, this value is base64 encoded.

-

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{ }

Get user data

Get user data for the currently authenticated user. User data is a +

Authorizations:
bearerAuth
path Parameters
data.key
required
string
Request Body schema: application/json
required
value
string <byte>

In JSON, this value is base64 encoded.

+

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{ }

Get user data

Get user data for the currently authenticated user. User data is a collection of key-value pairs, where the key is a string and the value is a slice of bytes (base64 encoded, in JSON). The server does not interpret the value and is only used to store it. The Atlas app uses user data to store user preferences and other settings.

-
Authorizations:
bearerAuth
path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update aerodrome user

Update the user permissions for one or more aerodromes and sets the +

Authorizations:
bearerAuth
path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update aerodrome user

Update the user permissions for one or more aerodromes and sets the display name. The special permission "RevokeAccess" can be used to remove permissions for an aerodrome entirely.

-
Authorizations:
bearerAuth
path Parameters
userId
required
string
Request Body schema: application/json
displayName
string
object (Permissions)

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

Blob

Get a blob from backend storage

The blob data is returned directly in the HTTP response body. The key +

Authorizations:
bearerAuth
path Parameters
userId
required
string
Request Body schema: application/json
required
displayName
string
object (Permissions)

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string"
}

Blob

Get a blob from backend storage

The blob data is returned directly in the HTTP response body. The key to use is returned by other methods, such as GetSpokenATIS.

-
Authorizations:
bearerAuth
path Parameters
key
required
string.+

Responses

Response samples

Content type
application/json
{
  • "contentType": "string",
  • "data": "string",
  • "extensions": [
    ]
}

Config

List aerodromes

This method requires system admin permissions.

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "aerodromes": [
    ]
}

Create aerodrome

This method requires system admin permissions.

-
Authorizations:
bearerAuth
Request Body schema: application/json
aerodromeId
string (Aerodrome identifier (ICAO))
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes +
Authorizations:
bearerAuth
path Parameters
key
required
string.+

Responses

Response samples

Content type
application/json
{
  • "contentType": "string",
  • "data": "string",
  • "extensions": [
    ]
}

Config

List aerodromes

This method requires system admin permissions.

+
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "aerodromes": [
    ]
}

Create aerodrome

This method requires system admin permissions.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
aerodromeId
string (Aerodrome identifier (ICAO))
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes - TESTING: Used by customer for testing / training purposes - TRIAL: Used by prospective customer for trial purposes - DEVELOPMENT: Used internally for development purposes - - EXPIRED: Has expired)
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Get aerodrome configuration

Returns the configuration for the specified aerodrome, including map + - EXPIRED: Has expired)

Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasMobileSensorThresholds)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC" "ICAO_GRF_NOMULTIDEPTH"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Get aerodrome configuration

Returns the configuration for the specified aerodrome, including map data.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Update aerodrome preferences

Set optional preferences for the specified aerodrome. Requires +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Update aerodrome preferences

Set optional preferences for the specified aerodrome. Requires aerodrome admin permissions.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
object (atlasAerodromePreferences)

Responses

Request samples

Content type
application/json
{
  • "preferences": {
    }
}

Response samples

Content type
application/json
{ }

Update aerodrome configuration

This method requires system admin permissions.

-
Authorizations:
bearerAuth
path Parameters
config.aerodromeId
required
string

Aerodrome identifier (ICAO)

-
Request Body schema: application/json

Aerodrome configuration

-
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes +
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
object (atlasAerodromePreferences)

Responses

Request samples

Content type
application/json
{
  • "preferences": {
    }
}

Response samples

Content type
application/json
{ }

Update aerodrome configuration

This method requires system admin permissions.

+
Authorizations:
bearerAuth
path Parameters
config.aerodromeId
required
string

Aerodrome identifier (ICAO)

+
Request Body schema: application/json
required

Aerodrome configuration

+
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes - TESTING: Used by customer for testing / training purposes - TRIAL: Used by prospective customer for trial purposes - DEVELOPMENT: Used internally for development purposes - - EXPIRED: Has expired)
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Update aerodrome configuration

This method requires system admin permissions.

-
Authorizations:
bearerAuth
path Parameters
config.aerodromeId
required
string

Aerodrome identifier (ICAO)

-
query Parameters
updateMask
string
Request Body schema: application/json

Aerodrome configuration

-
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes + - EXPIRED: Has expired)
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasMobileSensorThresholds)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC" "ICAO_GRF_NOMULTIDEPTH"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Update aerodrome configuration

This method requires system admin permissions.

+
Authorizations:
bearerAuth
path Parameters
config.aerodromeId
required
string

Aerodrome identifier (ICAO)

+
query Parameters
updateMask
string
Request Body schema: application/json
required

Aerodrome configuration

+
object (atlasAFTNConfig)
aprons
Array of strings (Aprons, in the order they are presented to the user)
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
deployment
string (- PRODUCTION: Used by customer for production purposes - TESTING: Used by customer for testing / training purposes - TRIAL: Used by prospective customer for trial purposes - DEVELOPMENT: Used internally for development purposes - - EXPIRED: Has expired)
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Health

Perform a health check

The system performs an end-to-end health check, including a full + - EXPIRED: Has expired)

Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (atlasDistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (atlasEmailConfig)
emailImportAccount
string (Email account ID for importing sensor data sent via email)
expires
string <date-time> (The license expiry for the aerodrome, or blank if the license does not expire)
iata
string (Airport code (IATA), for information purposes only)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (atlasAerodromeMap)
mapPointPrecision
integer <int32> (Map point precision in meters, for reducing map resolution to increase performance)
metarId
string (METAR ID (ICAO), for importing weather data)
object (atlasMobileSensorThresholds)
object (atlasNavCanadaConfig)
optionalFeatures
Array of strings (Enabled optional features (licensed modules))
Items Enum: "NO_OPTIONAL_FEATURE" "MOBILE_SENSORS_FEATURE" "ATIS_REPORTING_FEATURE" "DESKTOP_UI_FEATURE" "MEDIA_CAPTURE_FEATURE" "NAVBLUE_RUNWAYSENSE_FEATURE" "SEND_RCR_FEATURE" "FRICTION_REPORTING_FEATURE" "VIEWER_KEY_FEATURE" "ARCHIVE_VIEW_FEATURE" "STOCK_REMARKS_FEATURE" "API_FEATURE" "SEND_SMS_FEATURE" "SEND_FAX_FEATURE" "MAP_FEATURE"
object (atlasPlausibilityThresholds)
object (atlasAerodromePreferences)
regulatoryFramework
string (atlasRegulatoryFramework)
Default: "FRAMEWORK_UNSPECIFIED"
Enum: "FRAMEWORK_UNSPECIFIED" "ICAO_GRF" "CANADA_RSC" "ICAO_GRF_NOMULTIDEPTH"
runwaySenseId
string (NavBlue RunwaySense ID, for importing aircraft braking data)
Array of objects (Runways, in the order they are presented to the user)
Array of objects (RWS200 config)
silentAprons
Array of strings (Silent aprons, i.e., those that can be reported but are not included in SNOWTAM)
silentTaxiways
Array of strings (Silent taxiways, i.e., those that can be reported but are not included in SNOWTAM)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Request samples

Content type
application/json
{
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aftn": {
    },
  • "aprons": [
    ],
  • "awoswxSiteId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "iata": "string",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "taxiways": [
    ],
  • "updated": "2019-08-24T14:15:22Z",
  • "userLimit": 0
}

Health

Perform a health check

The system performs an end-to-end health check, including a full database transaction, and returns a summarized status. This method can be used for service monitoring and load balancing.

This method does not require authentication.

-

Responses

Response samples

Content type
application/json
{
  • "status": "FAIL"
}

Live

The aerodrome assessment is represented a single JSON object. At the top +

Responses

Response samples

Content type
application/json
{
  • "status": "FAIL"
}

Live

The aerodrome assessment is represented a single JSON object. At the top level are certain metadata fields, and the runways, taxiways and aprons arrays. Each contain lists of objects describing an individual aerodrome element. Each such element has several fields, each generally consisting of both a value and meta field. The value is the current assessment and the meta contains information about who and when made the assessment. The personal information (user ID) is in some cases redacted.

-

Get current assessments

The aerodrome live method returns the currently assessed state of the +

Get current assessments

The aerodrome live method returns the currently assessed state of the aerodrome. No request body is required.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aprons": [
    ],
  • "atisPreview": "string",
  • "csvPreview": "string",
  • "metar": {
    },
  • "pdfPreview": "string",
  • "plausibilityAnalysis": [
    ],
  • "rcrCurrent": [
    ],
  • "rcrHistory": [
    ],
  • "remainingValidityMinutes": 0,
  • "remarks": {
    },
  • "runwaySenseTimestamp": "2019-08-24T14:15:22Z",
  • "runways": [
    ],
  • "rwis": [
    ],
  • "sequence": "string",
  • "significantChange": true,
  • "stockPhrases": {
    },
  • "taxiways": [
    ],
  • "textPreview": "string",
  • "updatedTimestamp": "2019-08-24T14:15:22Z"
}

Update apron assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
Array of objects (Apron assessments)

Responses

Request samples

Content type
application/json
{
  • "aprons": [
    ]
}

Response samples

Content type
application/json
{ }

Get spoken ATIS report

Returns the ATIS report as voice synthesized speech. If keyOnly is +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodromeId": "string",
  • "aprons": [
    ],
  • "atisPreview": "string",
  • "csvPreview": "string",
  • "metar": {
    },
  • "pdfPreview": "string",
  • "plausibilityAnalysis": [
    ],
  • "rcrCurrent": [
    ],
  • "rcrHistory": [
    ],
  • "remainingValidityMinutes": 0,
  • "remarks": {
    },
  • "runwaySenseTimestamp": "2019-08-24T14:15:22Z",
  • "runways": [
    ],
  • "rwis": [
    ],
  • "sequence": "string",
  • "significantChange": true,
  • "significantChangeStatus": "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED",
  • "stockPhrases": {
    },
  • "taxiways": [
    ],
  • "textPreview": "string",
  • "updatedTimestamp": "2019-08-24T14:15:22Z"
}

Update apron assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
Array of objects (Apron assessments)

Responses

Request samples

Content type
application/json
{
  • "aprons": [
    ]
}

Response samples

Content type
application/json
{ }

Get spoken ATIS report

Returns the ATIS report as voice synthesized speech. If keyOnly is set, then only the blob key for the generated file is returned, and GetBlob can be used to download it.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
query Parameters
keyOnly
boolean

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "key": "string",
  • "mp3": "string"
}

Update general free text remarks for the aerodrome

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
remarks
string
stockPhrases
Array of strings

Responses

Request samples

Content type
application/json
{
  • "remarks": "string",
  • "stockPhrases": [
    ]
}

Response samples

Content type
application/json
{ }

Reset aerodrome

Resets all assessments for the entire aerodrome.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{ }

Restore aerodrome from specific report

Restores all aerodrome assessments to those of the specified report +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
query Parameters
keyOnly
boolean

Responses

Response samples

Content type
application/json
{
  • "hash": "string",
  • "key": "string",
  • "mp3": "string"
}

Update general free text remarks for the aerodrome

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
remarks
string
stockPhrases
Array of strings

Responses

Request samples

Content type
application/json
{
  • "remarks": "string",
  • "stockPhrases": [
    ]
}

Response samples

Content type
application/json
{ }

Reset aerodrome

Resets all assessments for the entire aerodrome.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{ }

Restore aerodrome from specific report

Restores all aerodrome assessments to those of the specified report (either RCR or SNOWTAM).

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string

Responses

Response samples

Content type
application/json
{ }

Update runway assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runway.runwayId
required
string
Request Body schema: application/json

Runway assessments

-
object (A boolean)
object (A boolean)
object (A distance)
object (A distance)
object (A boolean)
object (A deicing chemical)
object (A boolean)
object (A boolean)
landingDirection
string (atlasSide)
Default: "LR"
Enum: "LR" "L" "R"
object (A boolean)
object (A time)
object (A string)
singleZone
boolean
object (A distance and side)
object (A distance and side)
object (One or more strings)
object (A temperature)
object (A distance and side)
object (Runway zone assessments)
object (Runway zone assessments)
object (Runway zone assessments)

Responses

Request samples

Content type
application/json
{
  • "adjacentSnowbanks": {
    },
  • "chemicalTreatment": {
    },
  • "clearedLength": {
    },
  • "clearedWidth": {
    },
  • "closed": {
    },
  • "deicingChemical": {
    },
  • "driftingSnow": {
    },
  • "frozenSand": {
    },
  • "landingDirection": "LR",
  • "looseSand": {
    },
  • "observationTime": {
    },
  • "remarks": {
    },
  • "singleZone": true,
  • "snowDrifts": {
    },
  • "snowbanks": {
    },
  • "stockPhrases": {
    },
  • "temperature": {
    },
  • "windrows": {
    },
  • "zoneA": {
    },
  • "zoneB": {
    },
  • "zoneC": {
    }
}

Response samples

Content type
application/json
{ }

Watch aerodrome assessments stream

This returns a stream of JSON objects, in real time as assessments change.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    },
  • "result": {
    }
}

Update taxiway assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
Array of objects (Taxiway assessments)

Responses

Request samples

Content type
application/json
{
  • "taxiways": [
    ]
}

Response samples

Content type
application/json
{ }

Reset runway

Resets all assessments for a specific runway.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string

Responses

Response samples

Content type
application/json
{ }

List available recent condition imports

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
query Parameters
sinceHours
integer <int32>

Number of hours to look back, defaults to 24

-

Responses

Response samples

Content type
application/json
{
  • "imports": [
    ]
}

Inject a condition import

Atlas can accept condition data from third party providers, which can +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string

Responses

Response samples

Content type
application/json
{ }

Update runway assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runway.runwayId
required
string
Request Body schema: application/json
required

Runway assessments

+
object (A boolean)
object (A boolean)
object (A distance)
object (A distance)
object (A boolean)
object (A deicing chemical)
object (A boolean)
object (A boolean)
landingDirection
string (atlasSide)
Default: "LR"
Enum: "LR" "L" "R"
object (A boolean)
object (A time)
object (A string)
singleZone
boolean
object (A distance and side)
object (A distance and side)
object (One or more strings)
object (A temperature)
object (A distance and side)
object (Runway zone assessments)
object (Runway zone assessments)
object (Runway zone assessments)

Responses

Request samples

Content type
application/json
{
  • "adjacentSnowbanks": {
    },
  • "chemicalTreatment": {
    },
  • "clearedLength": {
    },
  • "clearedWidth": {
    },
  • "closed": {
    },
  • "deicingChemical": {
    },
  • "driftingSnow": {
    },
  • "frozenSand": {
    },
  • "landingDirection": "LR",
  • "looseSand": {
    },
  • "observationTime": {
    },
  • "remarks": {
    },
  • "singleZone": true,
  • "snowDrifts": {
    },
  • "snowbanks": {
    },
  • "stockPhrases": {
    },
  • "temperature": {
    },
  • "windrows": {
    },
  • "zoneA": {
    },
  • "zoneB": {
    },
  • "zoneC": {
    }
}

Response samples

Content type
application/json
{ }

Watch aerodrome assessments stream

This returns a stream of JSON objects, in real time as assessments change.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    },
  • "result": {
    }
}

Update taxiway assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
Array of objects (Taxiway assessments)

Responses

Request samples

Content type
application/json
{
  • "taxiways": [
    ]
}

Response samples

Content type
application/json
{ }

Reset runway

Resets all assessments for a specific runway.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string

Responses

Response samples

Content type
application/json
{ }

List available recent condition imports

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
query Parameters
sinceHours
integer <int32>

Number of hours to look back, defaults to 24

+

Responses

Response samples

Content type
application/json
{
  • "imports": [
    ]
}

Inject a condition import

Atlas can accept condition data from third party providers, which can then be selected for import in the app. Only fields with the metadata op UPDATE_SET or UPDATE_CLEAR are applied on import.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
Request Body schema: application/json
description
string
object (Runway assessments)
source
string
timestamp
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "runway": {
    },
  • "source": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Reports

Publish ATIS

This publishes the current status as an ATIS message via email, including +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
Request Body schema: application/json
required
description
string
object (Runway assessments)
source
string
timestamp
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "runway": {
    },
  • "source": "string",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

Reports

Publish ATIS

This publishes the current status as an ATIS message via email, including both text and voice synthesized sound file (as configured).

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{ }

Publish report

Create and publish a new SNOWTAM or RCR (according to the given +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{ }

Publish report

Create and publish a new SNOWTAM or RCR (according to the given format) and send it out using specified methods. The created report is returned.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
format
string (atlasPublishReportFormat)
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "RCR" "SNOWTAM"
methods
Array of strings (atlasPublishReportMethod)
Items Enum: "METHOD_UNSPECIFIED" "AFTN" "FAX" "NAVCANADA" "EMAIL" "SMS"
updateTime
boolean

Responses

Request samples

Content type
application/json
{
  • "format": "UNSPECIFIED",
  • "methods": [
    ],
  • "updateTime": true
}

Response samples

Content type
application/json
{
  • "report": {
    },
  • "results": [
    ]
}

Get RCR

Get a specific published RCR for the given aerodrome, identified by +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
format
string (atlasPublishReportFormat)
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "RCR" "SNOWTAM"
methods
Array of strings (atlasPublishReportMethod)
Items Enum: "METHOD_UNSPECIFIED" "AFTN" "FAX" "NAVCANADA" "EMAIL" "SMS"
updateTime
boolean

Responses

Request samples

Content type
application/json
{
  • "format": "UNSPECIFIED",
  • "methods": [
    ],
  • "updateTime": true
}

Response samples

Content type
application/json
{
  • "report": {
    },
  • "results": [
    ]
}

Get RCR

Get a specific published RCR for the given aerodrome, identified by id.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

Get latest SNOWTAM

Get the latest published SNOWTAM report for the given aeroddome.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

List years

Lists the available years for the given aerodrome.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "years": [
    ]
}

List SNOWTAMs

Lists the published SNOWTAMs for the given aerodrome and year.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
year
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Get SNOWTAM

Get a specific published SNOWTAM for the given aerodrome, identified +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

Get latest SNOWTAM

Get the latest published SNOWTAM report for the given aeroddome.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

List years

Lists the available years for the given aerodrome.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "years": [
    ]
}

List SNOWTAMs

Lists the published SNOWTAMs for the given aerodrome and year.

+
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
year
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Get SNOWTAM

Get a specific published SNOWTAM for the given aerodrome, identified by year and sequence number.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
year
required
integer <int32>
sequence
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

Sensor

List sensor sessions for a given runway

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
query Parameters
sinceHours
integer <int32>

Number of hours to look back, defaults to 24

-

Responses

Response samples

Content type
application/json
{
  • "sensorSessions": [
    ]
}

Get a sensor session by ID

This returns the entire sensor session, with all data points from the +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
year
required
integer <int32>
sequence
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "formattedCsv": "string",
  • "formattedPdf": "string",
  • "formattedText": "string",
  • "meta": {
    }
}

Sensor

List sensor sessions for a given runway

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
query Parameters
sinceHours
integer <int32>

Number of hours to look back, defaults to 24

+

Responses

Response samples

Content type
application/json
{
  • "sensorSessions": [
    ]
}

Get a sensor session by ID

This returns the entire sensor session, with all data points from the sensor plus correlating position data from the device GPS.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
sessionId
required
string

Responses

Response samples

Content type
application/json
{
  • "measurements": [
    ],
  • "metadata": {
    },
  • "positions": [
    ],
  • "runwayId": "string",
  • "sessionId": "string"
}

System

List online users

List the users who are currently online for the given aerodrome. +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
runwayId
required
string
sessionId
required
string

Responses

Response samples

Content type
application/json
{
  • "measurementLog": {
    }
}

System

List online users

List the users who are currently online for the given aerodrome. Requires aerodrome admin permissions.

-
Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Get system info

Get current system information (version, etc).

-
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "features": {
    },
  • "licenseLimits": {
    },
  • "licensee": {
    },
  • "version": {
    }
}

Tile

Get map tile

The tile name is in OpenStreetMap format: x/y/zoom. The tile data is +

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Get system info

Get current system information (version, etc).

+
Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "features": {
    },
  • "licenseLimits": {
    },
  • "licensee": {
    },
  • "version": {
    }
}

Tile

Get map tile

The tile name is in OpenStreetMap format: x/y/zoom. The tile data is returned in the HTTP body in png format.

-
Authorizations:
bearerAuth
path Parameters
name
required
string.+

Responses

Response samples

Content type
application/json
{
  • "contentType": "string",
  • "data": "string",
  • "extensions": [
    ]
}
+
Authorizations:
bearerAuth
path Parameters
name
required
string.+

Responses

Response samples

Content type
application/json
{
  • "contentType": "string",
  • "data": "string",
  • "extensions": [
    ]
}