Safe Sky Airside Sync API (1.35)

Download OpenAPI specification:

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

Overview

The Airside Sync 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://api.safe-sky.net/; in an on-premises deployment the URL will vary. The API uses versioned URLs, where the current API version is /v1.

OpenAPI Specifications

Airside Sync provides an OpenAPI specification documenting the current API in a machine readable manner, v2 and v3. This specification can be used to generate API code for many languages. The latest version is always available at https://api.safe-sky.net/v1/openapi.json (OpenAPI v2) and https://api.safe-sky.net/v1/openapi-v3.json (OpenAPI v3), with this rendered documentation available at https://api.safe-sky.net/v1/openapi.html.

Regions

Airside Sync is deployed in multiple geographic regions. A customer aerodrome is provisioned into a single region, the one closest to the customer. Region switching is automatic and transparent when using the Airside Sync client, but when using the API you must ensure to use the correct region yourself. If you are unsure about your region, please discuss with customer support.

The region is set by using the corresponding subdomain of api.safe-sky.net. Currently, the following regions exist:

  • eu.api.safe-sky.net for European and British customers. This region is also accessed when using api.safe-sky.net without a region specifier.
  • us.api.safe-sky.net for North American, South American and Caribbean customers.

Using the wrong region for an API call for a given aerodrome will result in an error.

Formatting

API responses are normally compact JSON. To instead receive formatted 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 must carry an Authorization header with the Bearer scheme and a valid API key. An API key can be created in the Airside Sync GUI, using the "Manage API keys" button at the bottom of the "About" screen. API keys are tied to the user who created them and will inherit their access permissions. API keys can be set to expire or have an unlimited lifetime.

Demo Key

There is a read only API key pst_bs6xevRYWdtan2KzhKpAPupiY2KLnAD7 that can be used for demonstration and experimentation on the fictional aerodrome DEMO. For example, to verify authentication from the command line:

% curl -H 'Authorization: Bearer pst_bs6xevRYWdtan2KzhKpAPupiY2KLnAD7' \
    https://api.safe-sky.net/v1/auth/user?pretty
{
    "username": "dc78f878-2d7c-40b9-a416-52a7ceea1fff",
    "email": "demo@safe-sky.net",
    "displayName": "Airside Sync Demo User",
    ...

List task users

Returns the usernames of users with task management permissions. The users are filtered based on the requesting user's permissions. A user cannot obtain a list of users of task types which the requesting user has no permissions to.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
Array of objects (ListTaskUsersResponseTaskUser)
Array
displayName
string
email
string
taskType
Array of integers <int32> [ items <int32 > ]

Response samples

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

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

Returns users with permission for the aerodrome in question only, requires aerodrome admin permission.

Responses

Response Schema: application/json
Array of objects (User)
Array
accountDisabled
boolean
city
string
country
string
created
string <date-time>
displayName
string
email
string
Array of objects (Permissions)
systemAdmin
boolean (The system_admin permissions grants system level operations above that of a single aerodrome: - create, list, update, and delete aerodromes - create, list, update, and delete users - grant and revoke user permissions)
userId
string
viaReadOnlyToken
boolean

Set if it's a read-only token user.

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 Airside Sync system. In this case the display name is used when creating the user.

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

The aerodrome_admin permission grants configuration updates on the specified aerodrome.

aerodromeId
string
archiveRead
boolean

The archive_read permission grants listing and exporting historical reports.

archiveReadMetadata
boolean

The archive_read_metadata permission grants listing and exporting historical reports including field metadata (who changed what when).

assessmentViewer
boolean

The assessment_viewer permission grants read-only access to the live report data.

customFormIds
Array of strings

The custom_form_ids list is the set of customised reports this user is allowed to see and publish.

liveWrite
boolean

The live_write permission grants changing the live report data.

reportSend
boolean

The report_send permission grants sending (and thus archiving) a new report.

revokeAccess
boolean

The revoke_access bit makes the permission invalid and it will be removed. Used in updates only.

standAssessment
boolean

The stand_assessment permission grants changing the Aircraft Stand live data.

standCoordinator
boolean

The stand_coordinator permission grants the ability to assign Aircraft Stands to groups. This permission results in a different view in the UI.

taskTypeIds
Array of integers <int32> [ items <int32 > ]

The task_type_ids list is the set of task types this user is allowed to see and handle.

Responses

Response Schema: application/json
error
string
sentMail
boolean
object (User)
accountDisabled
boolean
city
string
country
string
created
string <date-time>
displayName
string
email
string
Array of objects (Permissions)
systemAdmin
boolean (The system_admin permissions grants system level operations above that of a single aerodrome: - create, list, update, and delete aerodromes - create, list, update, and delete users - grant and revoke user permissions)
userId
string
viaReadOnlyToken
boolean

Set if it's a read-only token user.

Request samples

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

Response samples

Content type
application/json
{
  • "error": "string",
  • "sentMail": true,
  • "user": {
    }
}

Get login configuration

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

Responses

Response Schema: application/json
contactRequestUrl
string
kind
string (Login method type)
Default: "LOGINKIND_UNSUPPORTED"
Enum: "LOGINKIND_UNSUPPORTED" "LOGINKIND_OIDC"
manageAccountUrl
string
oidcAllowedTfps
Array of strings
oidcClientId
string
object
property name*
additional property
string
oidcIssuer
string
oidcJwksUrl
string
oidcLoginDiscoveryUrl
string
oidcPermissionsClaim
string
oidcRequiredScps
Array of strings
oidcResetDiscoveryUrl
string
oidcScopes
Array of strings
oidcSystemAdminClaim
string

Response samples

Content type
application/json
{
  • "contactRequestUrl": "string",
  • "kind": "LOGINKIND_UNSUPPORTED",
  • "manageAccountUrl": "string",
  • "oidcAllowedTfps": [
    ],
  • "oidcClientId": "string",
  • "oidcExtra": {
    },
  • "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 Schema: application/json
accountDisabled
boolean
city
string
country
string
created
string <date-time>
displayName
string
email
string
Array of objects (Permissions)
Array
aerodromeAdmin
boolean

The aerodrome_admin permission grants configuration updates on the specified aerodrome.

aerodromeId
string
archiveRead
boolean

The archive_read permission grants listing and exporting historical reports.

archiveReadMetadata
boolean

The archive_read_metadata permission grants listing and exporting historical reports including field metadata (who changed what when).

assessmentViewer
boolean

The assessment_viewer permission grants read-only access to the live report data.

customFormIds
Array of strings

The custom_form_ids list is the set of customised reports this user is allowed to see and publish.

liveWrite
boolean

The live_write permission grants changing the live report data.

regionId
string
Default: "EU"
Enum: "EU" "US" "AP" "CA" "UK" "IN" "CN" "KR" "BR"

The region ID where the aerodrome is located.

reportSend
boolean

The report_send permission grants sending (and thus archiving) a new report.

revokeAccess
boolean

The revoke_access bit makes the permission invalid and it will be removed. Used in updates only.

standAssessment
boolean

The stand_assessment permission grants changing the Aircraft Stand live data.

standCoordinator
boolean

The stand_coordinator permission grants the ability to assign Aircraft Stands to groups. This permission results in a different view in the UI.

taskTypeIds
Array of integers <int32> [ items <int32 > ]

The task_type_ids list is the set of task types this user is allowed to see and handle.

systemAdmin
boolean (The system_admin permissions grants system level operations above that of a single aerodrome: - create, list, update, and delete aerodromes - create, list, update, and delete users - grant and revoke user permissions)
userId
string
viaReadOnlyToken
boolean

Set if it's a read-only token user.

Response samples

Content type
application/json
{
  • "accountDisabled": true,
  • "city": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "displayName": "string",
  • "email": "string",
  • "permissions": [
    ],
  • "systemAdmin": true,
  • "userId": "string",
  • "viaReadOnlyToken": true
}

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 Schema: application/json
Array of objects (AuthKey)
Array
expiresAt
string <date-time>
lastUsed
string <date-time>
revocationId
string
tokenDisplay
string
userId
string

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
required
validityDays
integer <int32>

Responses

Response Schema: application/json
key
string

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 Schema: application/json
object (RevokeAPIKeyResponse)

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 Airside Sync app uses user data to store user preferences and other settings.

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

Response Schema: application/json
object (SetUserDataResponse)

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 Airside Sync app uses user data to store user preferences and other settings.

Authorizations:
bearerAuth
path Parameters
key
required
string

Responses

Response Schema: application/json
object (UserData)
key
string
value
string <byte>

In JSON, this value is base64 encoded.

Response samples

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

List read-only access keys

Returns a list of current read-only access keys for the currently authenticated user or all the keys related to the aerodrome for admins. For security reasons the full read-only access 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 read-only access key call.

Authorizations:
bearerAuth
query Parameters
aerodromeId
string

Responses

Response Schema: application/json
Array of objects (AuthKey)
Array
expiresAt
string <date-time>
lastUsed
string <date-time>
revocationId
string
tokenDisplay
string
userId
string

Response samples

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

Revoke read-only access key

Revokes a read-only access key, by looking it up via its revocation ID.

Authorizations:
bearerAuth
path Parameters
revocationId
required
string
query Parameters
aerodromeId
string

Responses

Response Schema: application/json
object (RevokeReadonlyAccessKeyResponse)

Response samples

Content type
application/json
{ }

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
required
displayName
string
newPermissionsStyle
boolean
object (Permissions)
aerodromeAdmin
boolean

The aerodrome_admin permission grants configuration updates on the specified aerodrome.

aerodromeId
string
archiveRead
boolean

The archive_read permission grants listing and exporting historical reports.

archiveReadMetadata
boolean

The archive_read_metadata permission grants listing and exporting historical reports including field metadata (who changed what when).

assessmentViewer
boolean

The assessment_viewer permission grants read-only access to the live report data.

customFormIds
Array of strings

The custom_form_ids list is the set of customised reports this user is allowed to see and publish.

liveWrite
boolean

The live_write permission grants changing the live report data.

reportSend
boolean

The report_send permission grants sending (and thus archiving) a new report.

revokeAccess
boolean

The revoke_access bit makes the permission invalid and it will be removed. Used in updates only.

standAssessment
boolean

The stand_assessment permission grants changing the Aircraft Stand live data.

standCoordinator
boolean

The stand_coordinator permission grants the ability to assign Aircraft Stands to groups. This permission results in a different view in the UI.

taskTypeIds
Array of integers <int32> [ items <int32 > ]

The task_type_ids list is the set of task types this user is allowed to see and handle.

Responses

Response Schema: application/json
error
string
object (User)
accountDisabled
boolean
city
string
country
string
created
string <date-time>
displayName
string
email
string
Array of objects (Permissions)
systemAdmin
boolean (The system_admin permissions grants system level operations above that of a single aerodrome: - create, list, update, and delete aerodromes - create, list, update, and delete users - grant and revoke user permissions)
userId
string
viaReadOnlyToken
boolean

Set if it's a read-only token user.

Request samples

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

Response samples

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

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 Schema: application/json
string <binary> (Free form byte stream)

Response samples

Content type
application/json
"string"

Config

List aerodromes

This method requires system admin permissions.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (AdminListAerodromesResponseAerodrome)
Array
aerodromeId
string
created
string <date-time>
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
expires
string <date-time>
iata
string
metarId
string
updated
string <date-time>

Response samples

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

Create aerodrome

This method requires system admin permissions.

Authorizations:
bearerAuth
Request Body schema: application/json
required
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AIXM Apron identifiers)
property name*
additional property
string
object (Apron name override, overrides the apron names in the reports only)
property name*
additional property
string
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
Array of objects (Customised report definitions)
Array
customFormId
string

The custom_form_id is the unique identifier for the form. It must be unique within an aerodrome. It can be either manually set or machine generated; e.g., "fod" and "021a303dc79b4d37b97d7af530464aa5" are both valid form IDs. IDs are enforced to be lowercase alphanumeric strings of at least 3 characters.

description
string

The description is an optional human readable description of the form.

Array of objects (CustomFormField)
iconData
string

The icon representation of this form. It should be configured as "0x..." where the value is the hex representation of the icon as defined in font_awesome_flutter.dart. Any style prefix ("fa-solid" or "fa-light") must be omitted.

languageCode
string

Optional language code for rendering the form. Defaults to English. Valid values are those understood by the internal/l10n package.

persistent
boolean

A form is "persistent" if it remains filled-out after submission. A non-persistent form is cleared or removed on each submission.

tileset
string
Default: "TILESET_UNSPECIFIED"
Enum: "TILESET_UNSPECIFIED" "TILESET_LIGHT" "TILESET_DARK" "TILESET_SATELLITE"

The tileset changes the map tiles in the rendered images (GPS locations).

title
string

The title is the human readable name of the form. It must be set.

deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
Array
dynamicFeatureConfigId
string

An aerodrome-unique id. This is aimed to keep the potential different dynamic feature implementations apart.

object

The possible groups an object can be part of.

Array of objects (FeatureObject)

The actual features.

object

Determines the scheme of the features, this determines what information can be supplied.

object

Maps the size of a feature to a cleaning duration.

object

If teams are relevant for this feature, supply the field_id.

titleCoordinator
string

Title for the coordinator overview, mandatory if a teams configuration is present. Otherwise the primary title is used.

titlePrimary
string

The title is the human readable name of the feature, this is mandatory.

titleShort
string

Short version fo the title, used in dialogs.

titleTeams
string

Title for an optional teams view screen, mandatory if a teams configuration is present.

object (Configuration for outgoing email (requires system admin permissions))
aadClientId
string
aadClientSecret
string
aadScopes
Array of strings
aadTokenUrl
string
smtpFrom
string
smtpFromName
string
smtpHost
string
smtpPassword
string
smtpReplyTo
string
smtpReplyToName
string
Array of objects (EmailConfigSMTPServer)
smtpUser
string
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)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (Map of aerodrome elements)
object (MapRect)
Array of objects (MapFeature)
Array of objects (MapMarker)
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 (Overwrite sensor depth thresholds)
wetDepthThreshold
number <double> (Depth in mm from which the runway should be considered wet)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
apiEndpoint
string
password
string
username
string
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
depthThreshold
integer <int32> (Max depth of a contamination when another zone is dry)
maxTemp
integer <int32> (Max temp (celcius))
maxTempDeviation
integer <int32> (Max deviation in temp (celcius))
rwyccThreshold
integer <int32> (Max deviation in RWYCC)
object (Aerodrome preferences, editable with aerodrome admin permissions)
allowedChangeReasons
Array of strings (Reasons for manual RWYCC up/downgrade, as defined in ICAO Doc 9981)
Items Enum: "CHANGE_REASON_TEMPERATURE" "CHANGE_REASON_DEW_POINT" "CHANGE_REASON_FRICTION" "CHANGE_REASON_PRECIPITATION" "CHANGE_REASON_PIREP" "CHANGE_REASON_OTHER" "CHANGE_REASON_FROZEN_SAND" "CHANGE_REASON_EXPERIENCE" "CHANGE_REASON_MULTICONTAMINANT" "CHANGE_REASON_WEATHER" "CHANGE_REASON_OBSERVATION"
allowedChemicals
Array of strings (DeicingChemical)
Items Enum: "UNSPECIFIED_OR_OTHER" "KAC_POTASSIUM_ACETATE" "KFOR_POTASSIUM_FORMATE" "GAC_GLYCERINE_ACETATE" "NAFO_SODIUM_FORMATE" "NAAC_SODIUM_ACETATE" "EG_ETHYLEN_GLYCOL" "PG_PROPYLENE_GLYCOL" "UREA"
atisAudioFormat
string (AudioFormat)
Default: "AUDIO_UNSPECIFIED"
Enum: "AUDIO_UNSPECIFIED" "AUDIO_NONE" "AUDIO_MP3" "AUDIO_WAV"
atisRecipients
Array of strings
autoImportConditions
boolean
object
disableClosedAprons
boolean
disableClosedTaxiways
boolean
disablePlausibilityAnalysis
boolean
disableRwyccAdjustReason
boolean
enforceRwyccUpDownGrades
boolean
excludeFrictionFromReport
boolean
mapTaxiwaysOnTop
boolean
observationTimeOnPublish
string (SetObservationTimeOnPublish)
Default: "NO"
Enum: "NO" "REMIND" "AUTO"
rcrPhotosCutoffHours
integer <int32>
rcrRecipients
Array of strings
snowtamRecipients
Array of strings
stockPhrases
Array of strings
object (TaskPreferences)
withFriction
boolean
withFrozenSand
boolean
withIgnoreRunway
boolean
withLandingDirection
boolean
withSpwr
boolean
withUnassessed
boolean
withViewerKeys
boolean
withoutSnow
boolean
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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
leftSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
length
integer <int32> (Runway length in meters)
localTaxiways
Array of strings (List of taxiways serving this runway)
rightSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
runwayAixmIdentifier
string (AIXM identifier)
runwayId
string (Runway identifier, with dash (e.g., "01L-19R"))
width
integer <int32> (Runway width in meters)
Array of objects (RWS200 config)
Array
address
string
password
string
runwayOverride
string
stationId
string
username
string
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
property name*
additional property
string
object (Taxiway name override, overrides the taxiway names in the reports only)
property name*
additional property
string
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Response Schema: application/json
object (Aerodrome configuration)
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
object (AIXM Apron identifiers)
object (Apron name override, overrides the apron names in the reports only)
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
created
string <date-time> (Created timestamp (read only))
Array of objects (Customised report definitions)
deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
object (Configuration for outgoing email (requires system admin permissions))
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 (Map of aerodrome elements)
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 (Overwrite sensor depth thresholds)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
object (Aerodrome preferences, editable with aerodrome admin permissions)
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
object (Taxiway name override, overrides the taxiway names in the reports only)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
updated
string <date-time> (Updated timestamp (read only))
userLimit
integer <int32> (User limit, where 0 means unlimited)

Request samples

Content type
application/json
{
  • "aerodromeAixmIdentifier": "string",
  • "aerodromeId": "string",
  • "aftnRcr": {
    },
  • "aftnSnowtam": {
    },
  • "apronAixmIdentifiers": {
    },
  • "apronOverrides": {
    },
  • "aprons": [
    ],
  • "atisEmailBodyTemplate": "string",
  • "atisEmailSubjectTemplate": "string",
  • "awoswxSiteId": "string",
  • "customForms": [
    ],
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "dynamicFeatures": [
    ],
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "rcrEmailBodyTemplate": "string",
  • "rcrEmailSubjectTemplate": "string",
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "snowtamAixmIdentifier": "string",
  • "snowtamEmailBodyTemplate": "string",
  • "snowtamEmailSubjectTemplate": "string",
  • "taskEmailBodyTemplate": "string",
  • "taskEmailSubjectTemplate": "string",
  • "taxiwayAixmIdentifiers": {
    },
  • "taxiwayOverrides": {
    },
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

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

Create aerodrome trial

Authorizations:
bearerAuth
Request Body schema: application/json
required
description
string (Description of the trial aerodrome)
featureAdditions
Array of strings (Optional: Additional features (e.g. PIREP, MOBILE_SENSORS, ...))
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
featureOverrides
Array of strings (Optional: Completely overrides features, using "premium" as default)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
noCustomisedReports
boolean

Do not include customised reports, the default templates include them.

preferredAerodromeId
string (Optional: the aerodrome id the trial environment gets. Generated if missing)
object (Initial admin)
displayName
string
email
string
realIcao
string (Optional: using a default if missing)
size
string (Defaults to SMALL_MMX)
Default: "TRIAL_UNKNOWN"
Enum: "TRIAL_UNKNOWN" "TRIAL_SMALL_MMX" "TRIAL_LARGE_DEMO" "TRIAL_CUSTOM"
templateFromAerodromeId
string (Optional: creates a template config based on the given aerodrome id)

Responses

Response Schema: application/json
addedUser
boolean (True if the initial admin was added succesfully)
object (The complete trial config)
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
object (AIXM Apron identifiers)
object (Apron name override, overrides the apron names in the reports only)
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
created
string <date-time> (Created timestamp (read only))
Array of objects (Customised report definitions)
deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
object (Configuration for outgoing email (requires system admin permissions))
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 (Map of aerodrome elements)
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 (Overwrite sensor depth thresholds)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
object (Aerodrome preferences, editable with aerodrome admin permissions)
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
object (Taxiway name override, overrides the taxiway names in the reports only)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
updated
string <date-time> (Updated timestamp (read only))
userLimit
integer <int32> (User limit, where 0 means unlimited)
sentWelcomeEmail
boolean (True if a welcome mail was sent to the added admin)

Request samples

Content type
application/json
{
  • "description": "string",
  • "featureAdditions": [
    ],
  • "featureOverrides": [
    ],
  • "noCustomisedReports": true,
  • "preferredAerodromeId": "string",
  • "primaryContact": {
    },
  • "realIcao": "string",
  • "size": "TRIAL_UNKNOWN",
  • "templateFromAerodromeId": "string"
}

Response samples

Content type
application/json
{
  • "addedUser": true,
  • "config": {
    },
  • "sentWelcomeEmail": true
}

Get aerodrome configuration

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

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
object (Aerodrome configuration)
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
object (AIXM Apron identifiers)
object (Apron name override, overrides the apron names in the reports only)
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
created
string <date-time> (Created timestamp (read only))
Array of objects (Customised report definitions)
deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
object (Configuration for outgoing email (requires system admin permissions))
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 (Map of aerodrome elements)
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 (Overwrite sensor depth thresholds)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
object (Aerodrome preferences, editable with aerodrome admin permissions)
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
object (Taxiway name override, overrides the taxiway names in the reports only)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
updated
string <date-time> (Updated timestamp (read only))
userLimit
integer <int32> (User limit, where 0 means unlimited)

Response samples

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

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
required
object (AerodromePreferences)
allowedChangeReasons
Array of strings (Reasons for manual RWYCC up/downgrade, as defined in ICAO Doc 9981)
Items Enum: "CHANGE_REASON_TEMPERATURE" "CHANGE_REASON_DEW_POINT" "CHANGE_REASON_FRICTION" "CHANGE_REASON_PRECIPITATION" "CHANGE_REASON_PIREP" "CHANGE_REASON_OTHER" "CHANGE_REASON_FROZEN_SAND" "CHANGE_REASON_EXPERIENCE" "CHANGE_REASON_MULTICONTAMINANT" "CHANGE_REASON_WEATHER" "CHANGE_REASON_OBSERVATION"
allowedChemicals
Array of strings (DeicingChemical)
Items Enum: "UNSPECIFIED_OR_OTHER" "KAC_POTASSIUM_ACETATE" "KFOR_POTASSIUM_FORMATE" "GAC_GLYCERINE_ACETATE" "NAFO_SODIUM_FORMATE" "NAAC_SODIUM_ACETATE" "EG_ETHYLEN_GLYCOL" "PG_PROPYLENE_GLYCOL" "UREA"
atisAudioFormat
string (AudioFormat)
Default: "AUDIO_UNSPECIFIED"
Enum: "AUDIO_UNSPECIFIED" "AUDIO_NONE" "AUDIO_MP3" "AUDIO_WAV"
atisRecipients
Array of strings
autoImportConditions
boolean
object
disableClosedAprons
boolean
disableClosedTaxiways
boolean
disablePlausibilityAnalysis
boolean
disableRwyccAdjustReason
boolean
enforceRwyccUpDownGrades
boolean
excludeFrictionFromReport
boolean
mapTaxiwaysOnTop
boolean
observationTimeOnPublish
string (SetObservationTimeOnPublish)
Default: "NO"
Enum: "NO" "REMIND" "AUTO"
rcrPhotosCutoffHours
integer <int32>
rcrRecipients
Array of strings
snowtamRecipients
Array of strings
stockPhrases
Array of strings
object (TaskPreferences)
withFriction
boolean
withFrozenSand
boolean
withIgnoreRunway
boolean
withLandingDirection
boolean
withSpwr
boolean
withUnassessed
boolean
withViewerKeys
boolean
withoutSnow
boolean

Responses

Response Schema: application/json
object (UpdateAerodromePreferencesResponse)

Request samples

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

Response samples

Content type
application/json
{ }

Update task recipients

Add or remove recipients for a specific task type

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
id
required
integer <int32>
Request Body schema: application/json
required
Array
string

Responses

Response Schema: application/json
object (UpdateTaskRecipientPreferenceResponse)

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{ }

Add or update task types

Create a new task type or updates an existing task type if an id is supplied. Requires aerodrome admin permissions.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
typeId
required
integer <int32>
query Parameters
typeDescription
string
Request Body schema: application/json
required
string

Responses

Response Schema: application/json
object (UpdateTaskTypePreferenceResponse)

Request samples

Content type
application/json
"string"

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

aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AIXM Apron identifiers)
property name*
additional property
string
object (Apron name override, overrides the apron names in the reports only)
property name*
additional property
string
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
Array of objects (Customised report definitions)
Array
customFormId
string

The custom_form_id is the unique identifier for the form. It must be unique within an aerodrome. It can be either manually set or machine generated; e.g., "fod" and "021a303dc79b4d37b97d7af530464aa5" are both valid form IDs. IDs are enforced to be lowercase alphanumeric strings of at least 3 characters.

description
string

The description is an optional human readable description of the form.

Array of objects (CustomFormField)
iconData
string

The icon representation of this form. It should be configured as "0x..." where the value is the hex representation of the icon as defined in font_awesome_flutter.dart. Any style prefix ("fa-solid" or "fa-light") must be omitted.

languageCode
string

Optional language code for rendering the form. Defaults to English. Valid values are those understood by the internal/l10n package.

persistent
boolean

A form is "persistent" if it remains filled-out after submission. A non-persistent form is cleared or removed on each submission.

tileset
string
Default: "TILESET_UNSPECIFIED"
Enum: "TILESET_UNSPECIFIED" "TILESET_LIGHT" "TILESET_DARK" "TILESET_SATELLITE"

The tileset changes the map tiles in the rendered images (GPS locations).

title
string

The title is the human readable name of the form. It must be set.

deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
Array
dynamicFeatureConfigId
string

An aerodrome-unique id. This is aimed to keep the potential different dynamic feature implementations apart.

object

The possible groups an object can be part of.

Array of objects (FeatureObject)

The actual features.

object

Determines the scheme of the features, this determines what information can be supplied.

object

Maps the size of a feature to a cleaning duration.

object

If teams are relevant for this feature, supply the field_id.

titleCoordinator
string

Title for the coordinator overview, mandatory if a teams configuration is present. Otherwise the primary title is used.

titlePrimary
string

The title is the human readable name of the feature, this is mandatory.

titleShort
string

Short version fo the title, used in dialogs.

titleTeams
string

Title for an optional teams view screen, mandatory if a teams configuration is present.

object (Configuration for outgoing email (requires system admin permissions))
aadClientId
string
aadClientSecret
string
aadScopes
Array of strings
aadTokenUrl
string
smtpFrom
string
smtpFromName
string
smtpHost
string
smtpPassword
string
smtpReplyTo
string
smtpReplyToName
string
Array of objects (EmailConfigSMTPServer)
smtpUser
string
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)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (Map of aerodrome elements)
object (MapRect)
Array of objects (MapFeature)
Array of objects (MapMarker)
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 (Overwrite sensor depth thresholds)
wetDepthThreshold
number <double> (Depth in mm from which the runway should be considered wet)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
apiEndpoint
string
password
string
username
string
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
depthThreshold
integer <int32> (Max depth of a contamination when another zone is dry)
maxTemp
integer <int32> (Max temp (celcius))
maxTempDeviation
integer <int32> (Max deviation in temp (celcius))
rwyccThreshold
integer <int32> (Max deviation in RWYCC)
object (Aerodrome preferences, editable with aerodrome admin permissions)
allowedChangeReasons
Array of strings (Reasons for manual RWYCC up/downgrade, as defined in ICAO Doc 9981)
Items Enum: "CHANGE_REASON_TEMPERATURE" "CHANGE_REASON_DEW_POINT" "CHANGE_REASON_FRICTION" "CHANGE_REASON_PRECIPITATION" "CHANGE_REASON_PIREP" "CHANGE_REASON_OTHER" "CHANGE_REASON_FROZEN_SAND" "CHANGE_REASON_EXPERIENCE" "CHANGE_REASON_MULTICONTAMINANT" "CHANGE_REASON_WEATHER" "CHANGE_REASON_OBSERVATION"
allowedChemicals
Array of strings (DeicingChemical)
Items Enum: "UNSPECIFIED_OR_OTHER" "KAC_POTASSIUM_ACETATE" "KFOR_POTASSIUM_FORMATE" "GAC_GLYCERINE_ACETATE" "NAFO_SODIUM_FORMATE" "NAAC_SODIUM_ACETATE" "EG_ETHYLEN_GLYCOL" "PG_PROPYLENE_GLYCOL" "UREA"
atisAudioFormat
string (AudioFormat)
Default: "AUDIO_UNSPECIFIED"
Enum: "AUDIO_UNSPECIFIED" "AUDIO_NONE" "AUDIO_MP3" "AUDIO_WAV"
atisRecipients
Array of strings
autoImportConditions
boolean
object
disableClosedAprons
boolean
disableClosedTaxiways
boolean
disablePlausibilityAnalysis
boolean
disableRwyccAdjustReason
boolean
enforceRwyccUpDownGrades
boolean
excludeFrictionFromReport
boolean
mapTaxiwaysOnTop
boolean
observationTimeOnPublish
string (SetObservationTimeOnPublish)
Default: "NO"
Enum: "NO" "REMIND" "AUTO"
rcrPhotosCutoffHours
integer <int32>
rcrRecipients
Array of strings
snowtamRecipients
Array of strings
stockPhrases
Array of strings
object (TaskPreferences)
withFriction
boolean
withFrozenSand
boolean
withIgnoreRunway
boolean
withLandingDirection
boolean
withSpwr
boolean
withUnassessed
boolean
withViewerKeys
boolean
withoutSnow
boolean
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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
leftSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
length
integer <int32> (Runway length in meters)
localTaxiways
Array of strings (List of taxiways serving this runway)
rightSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
runwayAixmIdentifier
string (AIXM identifier)
runwayId
string (Runway identifier, with dash (e.g., "01L-19R"))
width
integer <int32> (Runway width in meters)
Array of objects (RWS200 config)
Array
address
string
password
string
runwayOverride
string
stationId
string
username
string
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
property name*
additional property
string
object (Taxiway name override, overrides the taxiway names in the reports only)
property name*
additional property
string
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Response Schema: application/json
object (Aerodrome configuration)
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
object (AIXM Apron identifiers)
object (Apron name override, overrides the apron names in the reports only)
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
created
string <date-time> (Created timestamp (read only))
Array of objects (Customised report definitions)
deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
object (Configuration for outgoing email (requires system admin permissions))
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 (Map of aerodrome elements)
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 (Overwrite sensor depth thresholds)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
object (Aerodrome preferences, editable with aerodrome admin permissions)
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
object (Taxiway name override, overrides the taxiway names in the reports only)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
updated
string <date-time> (Updated timestamp (read only))
userLimit
integer <int32> (User limit, where 0 means unlimited)

Request samples

Content type
application/json
{
  • "aerodromeAixmIdentifier": "string",
  • "aftnRcr": {
    },
  • "aftnSnowtam": {
    },
  • "apronAixmIdentifiers": {
    },
  • "apronOverrides": {
    },
  • "aprons": [
    ],
  • "atisEmailBodyTemplate": "string",
  • "atisEmailSubjectTemplate": "string",
  • "awoswxSiteId": "string",
  • "customForms": [
    ],
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "dynamicFeatures": [
    ],
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "rcrEmailBodyTemplate": "string",
  • "rcrEmailSubjectTemplate": "string",
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "snowtamAixmIdentifier": "string",
  • "snowtamEmailBodyTemplate": "string",
  • "snowtamEmailSubjectTemplate": "string",
  • "taskEmailBodyTemplate": "string",
  • "taskEmailSubjectTemplate": "string",
  • "taxiwayAixmIdentifiers": {
    },
  • "taxiwayOverrides": {
    },
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

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

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

aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
connectionName
string
destinations
Array of strings
hosts
Array of strings
source
string
object (AIXM Apron identifiers)
property name*
additional property
string
object (Apron name override, overrides the apron names in the reports only)
property name*
additional property
string
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
Array of objects (Customised report definitions)
Array
customFormId
string

The custom_form_id is the unique identifier for the form. It must be unique within an aerodrome. It can be either manually set or machine generated; e.g., "fod" and "021a303dc79b4d37b97d7af530464aa5" are both valid form IDs. IDs are enforced to be lowercase alphanumeric strings of at least 3 characters.

description
string

The description is an optional human readable description of the form.

Array of objects (CustomFormField)
iconData
string

The icon representation of this form. It should be configured as "0x..." where the value is the hex representation of the icon as defined in font_awesome_flutter.dart. Any style prefix ("fa-solid" or "fa-light") must be omitted.

languageCode
string

Optional language code for rendering the form. Defaults to English. Valid values are those understood by the internal/l10n package.

persistent
boolean

A form is "persistent" if it remains filled-out after submission. A non-persistent form is cleared or removed on each submission.

tileset
string
Default: "TILESET_UNSPECIFIED"
Enum: "TILESET_UNSPECIFIED" "TILESET_LIGHT" "TILESET_DARK" "TILESET_SATELLITE"

The tileset changes the map tiles in the rendered images (GPS locations).

title
string

The title is the human readable name of the form. It must be set.

deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
Array
dynamicFeatureConfigId
string

An aerodrome-unique id. This is aimed to keep the potential different dynamic feature implementations apart.

object

The possible groups an object can be part of.

Array of objects (FeatureObject)

The actual features.

object

Determines the scheme of the features, this determines what information can be supplied.

object

Maps the size of a feature to a cleaning duration.

object

If teams are relevant for this feature, supply the field_id.

titleCoordinator
string

Title for the coordinator overview, mandatory if a teams configuration is present. Otherwise the primary title is used.

titlePrimary
string

The title is the human readable name of the feature, this is mandatory.

titleShort
string

Short version fo the title, used in dialogs.

titleTeams
string

Title for an optional teams view screen, mandatory if a teams configuration is present.

object (Configuration for outgoing email (requires system admin permissions))
aadClientId
string
aadClientSecret
string
aadScopes
Array of strings
aadTokenUrl
string
smtpFrom
string
smtpFromName
string
smtpHost
string
smtpPassword
string
smtpReplyTo
string
smtpReplyToName
string
Array of objects (EmailConfigSMTPServer)
smtpUser
string
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)
managedEmailDomains
Array of strings (Email domains where new users can be added)
object (Map of aerodrome elements)
object (MapRect)
Array of objects (MapFeature)
Array of objects (MapMarker)
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 (Overwrite sensor depth thresholds)
wetDepthThreshold
number <double> (Depth in mm from which the runway should be considered wet)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
apiEndpoint
string
password
string
username
string
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
depthThreshold
integer <int32> (Max depth of a contamination when another zone is dry)
maxTemp
integer <int32> (Max temp (celcius))
maxTempDeviation
integer <int32> (Max deviation in temp (celcius))
rwyccThreshold
integer <int32> (Max deviation in RWYCC)
object (Aerodrome preferences, editable with aerodrome admin permissions)
allowedChangeReasons
Array of strings (Reasons for manual RWYCC up/downgrade, as defined in ICAO Doc 9981)
Items Enum: "CHANGE_REASON_TEMPERATURE" "CHANGE_REASON_DEW_POINT" "CHANGE_REASON_FRICTION" "CHANGE_REASON_PRECIPITATION" "CHANGE_REASON_PIREP" "CHANGE_REASON_OTHER" "CHANGE_REASON_FROZEN_SAND" "CHANGE_REASON_EXPERIENCE" "CHANGE_REASON_MULTICONTAMINANT" "CHANGE_REASON_WEATHER" "CHANGE_REASON_OBSERVATION"
allowedChemicals
Array of strings (DeicingChemical)
Items Enum: "UNSPECIFIED_OR_OTHER" "KAC_POTASSIUM_ACETATE" "KFOR_POTASSIUM_FORMATE" "GAC_GLYCERINE_ACETATE" "NAFO_SODIUM_FORMATE" "NAAC_SODIUM_ACETATE" "EG_ETHYLEN_GLYCOL" "PG_PROPYLENE_GLYCOL" "UREA"
atisAudioFormat
string (AudioFormat)
Default: "AUDIO_UNSPECIFIED"
Enum: "AUDIO_UNSPECIFIED" "AUDIO_NONE" "AUDIO_MP3" "AUDIO_WAV"
atisRecipients
Array of strings
autoImportConditions
boolean
object
disableClosedAprons
boolean
disableClosedTaxiways
boolean
disablePlausibilityAnalysis
boolean
disableRwyccAdjustReason
boolean
enforceRwyccUpDownGrades
boolean
excludeFrictionFromReport
boolean
mapTaxiwaysOnTop
boolean
observationTimeOnPublish
string (SetObservationTimeOnPublish)
Default: "NO"
Enum: "NO" "REMIND" "AUTO"
rcrPhotosCutoffHours
integer <int32>
rcrRecipients
Array of strings
snowtamRecipients
Array of strings
stockPhrases
Array of strings
object (TaskPreferences)
withFriction
boolean
withFrozenSand
boolean
withIgnoreRunway
boolean
withLandingDirection
boolean
withSpwr
boolean
withUnassessed
boolean
withViewerKeys
boolean
withoutSnow
boolean
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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
leftSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
length
integer <int32> (Runway length in meters)
localTaxiways
Array of strings (List of taxiways serving this runway)
rightSide
string (Side of the runway as Compass Cardinal value)
Default: "CARDINAL_UNSPECIFIED"
Enum: "CARDINAL_UNSPECIFIED" "NORTH" "NORTHEAST" "EAST" "SOUTHEAST" "SOUTH" "SOUTHWEST" "WEST" "NORTHWEST"
runwayAixmIdentifier
string (AIXM identifier)
runwayId
string (Runway identifier, with dash (e.g., "01L-19R"))
width
integer <int32> (Runway width in meters)
Array of objects (RWS200 config)
Array
address
string
password
string
runwayOverride
string
stationId
string
username
string
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
property name*
additional property
string
object (Taxiway name override, overrides the taxiway names in the reports only)
property name*
additional property
string
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
userLimit
integer <int32> (User limit, where 0 means unlimited)

Responses

Response Schema: application/json
object (Aerodrome configuration)
aerodromeAixmIdentifier
string (AIXM identifier of the aerodrome in UUIDv4 format)
aerodromeId
string (Aerodrome identifier (ICAO))
object (AFTN configuration, for sending RCR via AFTN-over-TCP gateway)
object (AFTN configuration, for sending SNOWTAM via AFTN-over-TCP gateway)
object (AIXM Apron identifiers)
object (Apron name override, overrides the apron names in the reports only)
aprons
Array of strings (Aprons, in the order they are presented to the user)
atisEmailBodyTemplate
string (ATIS email body template override (Go template format))
atisEmailSubjectTemplate
string (ATIS email subject template override (Go template format))
awoswxSiteId
string (wx.awos.se site ID, for importing weather data)
created
string <date-time> (Created timestamp (read only))
Array of objects (Customised report definitions)
deployment
string (The aerodrome deployment type (production, trial, etc.))
Default: "UNKNOWN"
Enum: "UNKNOWN" "PRODUCTION" "TESTING" "TRIAL" "DEVELOPMENT" "EXPIRED"
description
string (Aerodrome description (name) for display purposes)
distanceUnit
string (Unit for runway lengths, widths)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
Array of objects (Aircraft stand configuration)
object (Configuration for outgoing email (requires system admin permissions))
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 (Map of aerodrome elements)
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 (Overwrite sensor depth thresholds)
object (NavCanada configuration, for sending SNOWTAM via NavCanada API)
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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"
object (Plausibility Analysis Thresholds)
object (Aerodrome preferences, editable with aerodrome admin permissions)
rcrEmailBodyTemplate
string (RCR email body template override (Go template format))
rcrEmailSubjectTemplate
string (RCR email subject template override (Go template format))
regulatoryFramework
string (The used framework (ICAO_GRF / CANADA_RSC))
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)
snowtamAixmIdentifier
string (SNOWTAM event identifier in UUIDv4 format)
snowtamEmailBodyTemplate
string (SNOWTAM email body template override (Go template format))
snowtamEmailSubjectTemplate
string (SNOWTAM email subject template override (Go template format))
taskEmailBodyTemplate
string (Task email notification body template override (Go template format))
taskEmailSubjectTemplate
string (Task email notification subject template override (Go template format))
object (AIXM Taxiway identifiers)
object (Taxiway name override, overrides the taxiway names in the reports only)
taxiways
Array of strings (Taxiways, in the order they are presented to the user)
updated
string <date-time> (Updated timestamp (read only))
userLimit
integer <int32> (User limit, where 0 means unlimited)

Request samples

Content type
application/json
{
  • "aerodromeAixmIdentifier": "string",
  • "aftnRcr": {
    },
  • "aftnSnowtam": {
    },
  • "apronAixmIdentifiers": {
    },
  • "apronOverrides": {
    },
  • "aprons": [
    ],
  • "atisEmailBodyTemplate": "string",
  • "atisEmailSubjectTemplate": "string",
  • "awoswxSiteId": "string",
  • "customForms": [
    ],
  • "deployment": "UNKNOWN",
  • "description": "string",
  • "distanceUnit": "DISTANCE_UNIT_UNSPECIFIED",
  • "dynamicFeatures": [
    ],
  • "email": {
    },
  • "emailImportAccount": "string",
  • "expires": "2019-08-24T14:15:22Z",
  • "managedEmailDomains": [
    ],
  • "map": {
    },
  • "mapPointPrecision": 0,
  • "metarId": "string",
  • "mobileSensorThresholds": {
    },
  • "navCanada": {
    },
  • "optionalFeatures": [
    ],
  • "plausibilityThresholds": {
    },
  • "preferences": {
    },
  • "rcrEmailBodyTemplate": "string",
  • "rcrEmailSubjectTemplate": "string",
  • "regulatoryFramework": "FRAMEWORK_UNSPECIFIED",
  • "runwaySenseId": "string",
  • "runways": [
    ],
  • "rws200": [
    ],
  • "silentAprons": [
    ],
  • "silentTaxiways": [
    ],
  • "snowtamAixmIdentifier": "string",
  • "snowtamEmailBodyTemplate": "string",
  • "snowtamEmailSubjectTemplate": "string",
  • "taskEmailBodyTemplate": "string",
  • "taskEmailSubjectTemplate": "string",
  • "taxiwayAixmIdentifiers": {
    },
  • "taxiwayOverrides": {
    },
  • "taxiways": [
    ],
  • "userLimit": 0
}

Response samples

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

Dynamics

Update dynamic features

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
dynamicFeatureConfigId
string
Array of objects (DynamicFeature)
Array
Array of objects (The fields which form this feature)
objectId
string (The object id (derived from DynamicFeatureConfig.objects))
object (A string)

The team assigned to this feature.

Responses

Response Schema: application/json
object (UpdateDynamicFeaturesResponse)

Request samples

Content type
application/json
{
  • "dynamicFeatureConfigId": "string",
  • "features": [
    ]
}

Response samples

Content type
application/json
{ }

Reset dynamic features

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

Responses

Response Schema: application/json
object (ResetDynamicFeaturesResponse)

Request samples

Content type
application/json
{
  • "dynamicFeatureConfigId": "string",
  • "featureIds": [
    ]
}

Response samples

Content type
application/json
{ }

Watch dynamic features assessments stream

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

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
object (rpcStatus)
code
integer <int32>
Array of objects (protobufAny)
message
string
object (DynamicFeaturesResponse)
object (Live state)

Response samples

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

Flights

Flights_ListArrivingFlights

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

look this many hours into the past (default 1)

untilHours
integer <int32>

look this many hours into the future (default 4)

Responses

Response Schema: application/json
Array of objects (Flight)
Array
object (Aircraft)
object (Airline)
object (FlightSrcDst)
object (FlightSrcDst)
object (FlightNumber)

Response samples

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

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 Schema: application/json
status
string (HealthStatus)
Default: "FAIL"
Enum: "FAIL" "OK"

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 aerodrome. No request body is required.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
object (Aerodrome assessments)
aerodromeId
string
Array of objects (Deprecated: see Dynamics service (1.31.1))
Array of objects (Apron assessments)
atisPreview
string (Deprecated: see AerodromeResponse (1.18.3))
csvPreview
string (Deprecated: see AerodromeResponse (1.18.3))
object (Last METAR (read only))
pdfPreview
string <byte> (Deprecated: see AerodromeResponse (1.18.3))
Array of objects (Deprecated: see AerodromeResponse (1.18.3))
rcrCurrent
Array of strings (Deprecated: see AerodromeResponse (1.18.3))
Array of objects (Deprecated: see AerodromeResponse (1.22.0))
object (Free form remarks)
runwaySenseTimestamp
string <date-time> (Timestamp of last RunwaySense update (read only))
Array of objects (Runway assessments)
Array of objects (Most recent RWIS data (read only))
sequence
string <int64> (Sequence number increments by one for each change)
significantChangeStatus
string (Deprecated: see AerodromeResponse (1.18.3))
Default: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED"
Enum: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED" "SIGNIFICANT_CHANGE_STATUS_OK" "SIGNIFICANT_CHANGE_STATUS_SHOULD_PUBLISH" "SIGNIFICANT_CHANGE_STATUS_EXPIRES_SOON" "SIGNIFICANT_CHANGE_STATUS_EXPIRED"

Indicating if a significant change has occurred in the aerodrome report, such as SNOWTAM validity or expiration.

object (Remarks, of the ones available as stock phrases)
Array of objects (Taxiway assessments)
textPreview
string (Deprecated: see AerodromeResponse (1.18.3))
updatedTimestamp
string <date-time> (Timestamp of last update (read only))
atisPreview
string
csvPreview
string
pdfPreview
string <byte>
object (PIREPSummary)
Array of objects (Raw list of recent PIREPs)
object (Map of runway ID to current PIREP summary state)
Array of objects (PlausibilityAnalysis)
Array
type
string (Description of the analysis)
Default: "PLAUSIBILITY_ANALYSIS_UNSPECIFIED"
Enum: "PLAUSIBILITY_ANALYSIS_UNSPECIFIED" "PLAUSIBILITY_ANALYSIS_RUNWAY_TEMPERATURE" "PLAUSIBILITY_ANALYSIS_SERVING_TAXIWAYS" "PLAUSIBILITY_ANALYSIS_RUNWAY_CONDITIONS" "PLAUSIBILITY_ANALYSIS_ZONE_RWYCC" "PLAUSIBILITY_ANALYSIS_RUNWAY_IGNORED"
Array of objects (PlausibilityWarning)
rcrCurrent
Array of strings
Array of objects (Runway Condition Report (RCR) entry)
Array
reportType
string (PublishReportFormat)
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "RCR" "SNOWTAM" "ATIS" "CUSTOM_FORM" "TASK"
runwayLines
Array of strings
time
string <date-time>
remainingValidityMinutes
integer <int32>
significantChangeStatus
string (SignificantChangeStatus)
Default: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED"
Enum: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED" "SIGNIFICANT_CHANGE_STATUS_OK" "SIGNIFICANT_CHANGE_STATUS_SHOULD_PUBLISH" "SIGNIFICANT_CHANGE_STATUS_EXPIRES_SOON" "SIGNIFICANT_CHANGE_STATUS_EXPIRED"

Indicating if a significant change has occurred in the aerodrome report, such as SNOWTAM validity or expiration.

textPreview
string

Response samples

Content type
application/json
{
  • "aerodrome": {
    },
  • "atisPreview": "string",
  • "csvPreview": "string",
  • "pdfPreview": "string",
  • "pirepSummary": {
    },
  • "plausibilityAnalysis": [
    ],
  • "rcrCurrent": [
    ],
  • "rcrHistory": [
    ],
  • "remainingValidityMinutes": 0,
  • "significantChangeStatus": "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED",
  • "textPreview": "string"
}

Update apron assessments

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
Array of objects (Apron assessments)
Array
apronId
string
object (Indicates if the apron is closed)
silent
boolean (A silent apron is not included in SNOWTAMs)
object (Indicates if the apron is slippery or in poor condition)

Responses

Response Schema: application/json
object (UpdateApronsResponse)

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 Schema: application/json
hash
string
key
string
mp3
string <byte>

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

Response Schema: application/json
object (UpdateRemarksResponse)

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 Schema: application/json
object (ResetAerodromeResponse)

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 Schema: application/json
object (RestoreReportResponse)

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 (Indicates adjacent snowbanks near the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Indicates that chemical treatment has been applied to the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Length of cleared runway surface)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

side
string (- LR: Both sides - L: Left - R: Right)
Default: "LR"
Enum: "LR" "L" "R"
unit
string (DistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
value
integer <int32>
object (Width of cleared runway surface)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

side
string (- LR: Both sides - L: Left - R: Right)
Default: "LR"
Enum: "LR" "L" "R"
unit
string (DistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
value
integer <int32>
object (Indicates if the runway is closed)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Type and amount of de-icing chemical applied)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
Array of strings (DeicingChemical)
Items Enum: "UNSPECIFIED_OR_OTHER" "KAC_POTASSIUM_ACETATE" "KFOR_POTASSIUM_FORMATE" "GAC_GLYCERINE_ACETATE" "NAFO_SODIUM_FORMATE" "NAAC_SODIUM_ACETATE" "EG_ETHYLEN_GLYCOL" "PG_PROPYLENE_GLYCOL" "UREA"
object (Indicates presence of drifting snow on the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Indicates presence of frozen sand on the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Indicates if the runway is ignored in report generation)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
landingDirection
string (Airplane landing direction)
Default: "LR"
Enum: "LR" "L" "R"
object (Indicates presence of loose sand on the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
boolean
object (Time of the observation)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
string <date-time>
object (Remarks about the runway)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
string
object (Snow drift data including distance and height on each side (Canada only))
distance
integer <int32>
heightMm
integer <int32>
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

side
string (- LR: Both sides - L: Left - R: Right)
Default: "LR"
Enum: "LR" "L" "R"
unit
string (DistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (Snowbank data including distance and height on each side)
distance
integer <int32>
heightMm
integer <int32>
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

side
string (- LR: Both sides - L: Left - R: Right)
Default: "LR"
Enum: "LR" "L" "R"
unit
string (DistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (Runway remarks applied from stock phrases)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

value
Array of strings
object (Air temperature)
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

unit
string (TemperatureUnit)
Default: "TEMPERATURE_UNIT_UNSPECIFIED"
Enum: "TEMPERATURE_UNIT_UNSPECIFIED" "CELSIUS" "FAHRENHEIT"
value
integer <int32>
object (Windrow data including distance and height on each side (Canada only))
distance
integer <int32>
heightMm
integer <int32>
object (Metadata)

Metadata describes the current state of a given field. A field starts life with op = UNCHANGED_CLEAR and no user or time. When a client sends an update with op = SET or op = CLEAR the server will update the corresponding field value, set the user and time according to current authenticated values, and set op back to the corresponding UNCHANGED_ variant. Fields without metadata, or with op set to something other than SET/CLEAR will be ignored by the server in updates.

side
string (- LR: Both sides - L: Left - R: Right)
Default: "LR"
Enum: "LR" "L" "R"
unit
string (DistanceUnit)
Default: "DISTANCE_UNIT_UNSPECIFIED"
Enum: "DISTANCE_UNIT_UNSPECIFIED" "METERS" "FEET"
object (Runway zone assessments)
object (Manually adjusted Runway Condition Code (RWYCC))
calculatedRwycc
string (Automatically calculated RWYCC value indicating runway breaking condition)
Default: "RWYCC_0"
Enum: "RWYCC_0" "RWYCC_1" "RWYCC_2" "RWYCC_3" "RWYCC_4" "RWYCC_5" "RWYCC_6"
object (Runway contamination percentage (rounded category: 0, 25, 50, 75, or 100) per ICAO Doc 9981)
object (Depth of the contamination in millimeters)
object (Coefficient of friction as μ * 100)
object (Reason(s) for manual RWYCC adjustment)
object (Canada-RSC only)
object (Canada-RSC only)
object (Canada-RSC only)
object (Primary surface description for the zone (DRY, WET, ICE, etc))
object (Runway zone assessments)
object (Manually adjusted Runway Condition Code (RWYCC))
calculatedRwycc
string (Automatically calculated RWYCC value indicating runway breaking condition)
Default: "RWYCC_0"
Enum: "RWYCC_0" "RWYCC_1" "RWYCC_2" "RWYCC_3" "RWYCC_4" "RWYCC_5" "RWYCC_6"
object (Runway contamination percentage (rounded category: 0, 25, 50, 75, or 100) per ICAO Doc 9981)
object (Depth of the contamination in millimeters)
object (Coefficient of friction as μ * 100)
object (Reason(s) for manual RWYCC adjustment)
object (Canada-RSC only)
object (Canada-RSC only)
object (Canada-RSC only)
object (Primary surface description for the zone (DRY, WET, ICE, etc))
object (Runway zone assessments)
object (Manually adjusted Runway Condition Code (RWYCC))
calculatedRwycc
string (Automatically calculated RWYCC value indicating runway breaking condition)
Default: "RWYCC_0"
Enum: "RWYCC_0" "RWYCC_1" "RWYCC_2" "RWYCC_3" "RWYCC_4" "RWYCC_5" "RWYCC_6"
object (Runway contamination percentage (rounded category: 0, 25, 50, 75, or 100) per ICAO Doc 9981)
object (Depth of the contamination in millimeters)
object (Coefficient of friction as μ * 100)
object (Reason(s) for manual RWYCC adjustment)
object (Canada-RSC only)
object (Canada-RSC only)
object (Canada-RSC only)
object (Primary surface description for the zone (DRY, WET, ICE, etc))

Responses

Response Schema: application/json
object (UpdateRunwayResponse)

Request samples

Content type
application/json
{
  • "adjacentSnowbanks": {
    },
  • "chemicalTreatment": {
    },
  • "clearedLength": {
    },
  • "clearedWidth": {
    },
  • "closed": {
    },
  • "deicingChemical": {
    },
  • "driftingSnow": {
    },
  • "frozenSand": {
    },
  • "ignored": {
    },
  • "landingDirection": "LR",
  • "looseSand": {
    },
  • "observationTime": {
    },
  • "remarks": {
    },
  • "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 Schema: application/json
object (rpcStatus)
code
integer <int32>
Array of objects (protobufAny)
message
string
object (AerodromeResponse)
object (Aerodrome assessments)
atisPreview
string
csvPreview
string
pdfPreview
string <byte>
object (PIREPSummary)
Array of objects (PlausibilityAnalysis)
rcrCurrent
Array of strings
Array of objects (Runway Condition Report (RCR) entry)
remainingValidityMinutes
integer <int32>
significantChangeStatus
string (SignificantChangeStatus)
Default: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED"
Enum: "SIGNIFICANT_CHANGE_STATUS_UNSPECIFIED" "SIGNIFICANT_CHANGE_STATUS_OK" "SIGNIFICANT_CHANGE_STATUS_SHOULD_PUBLISH" "SIGNIFICANT_CHANGE_STATUS_EXPIRES_SOON" "SIGNIFICANT_CHANGE_STATUS_EXPIRED"

Indicating if a significant change has occurred in the aerodrome report, such as SNOWTAM validity or expiration.

textPreview
string

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)
Array
object (Indicates if the taxiway is closed)
silent
boolean (A silent taxiways is not included in SNOWTAMs)
object (Indicates if the taxiway is slippery or in poor condition)
object (Snowbank data including distance and height on each side)
taxiwayId
string

Responses

Response Schema: application/json
object (UpdateTaxiwaysResponse)

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 Schema: application/json
object (ResetAerodromeRunwayResponse)

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 Schema: application/json
Array of objects (Imported runway report from external source, such as sensor data)
Array
description
string
object (Runway assessments)
source
string
timestamp
string <date-time>

Response samples

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

Inject a condition import

Airside Sync 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
required
description
string
object (Runway assessments)
object (Indicates adjacent snowbanks near the runway)
object (Indicates that chemical treatment has been applied to the runway)
object (Length of cleared runway surface)
object (Width of cleared runway surface)
object (Indicates if the runway is closed)
object (Type and amount of de-icing chemical applied)
object (Indicates presence of drifting snow on the runway)
object (Indicates presence of frozen sand on the runway)
object (Indicates if the runway is ignored in report generation)
landingDirection
string (Airplane landing direction)
Default: "LR"
Enum: "LR" "L" "R"
object (Indicates presence of loose sand on the runway)
object (Time of the observation)
object (Remarks about the runway)
runwayId
string
object (Snow drift data including distance and height on each side (Canada only))
object (Snowbank data including distance and height on each side)
object (Runway remarks applied from stock phrases)
object (Air temperature)
object (Windrow data including distance and height on each side (Canada only))
object (Runway zone assessments)
object (Runway zone assessments)
object (Runway zone assessments)
source
string
timestamp
string <date-time>

Responses

Response Schema: application/json
object (CreateConditionImportResponse)

Request samples

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

Response samples

Content type
application/json
{ }

Metar

List METAR reports

List the METAR reports for a given aerodrome for a given date.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
query Parameters
date
string <date-time>

Responses

Response Schema: application/json
Array of objects (METAR)
Array
altimInHg
number <double> (Altimeter setting in inches of mercury)
dewpointC
number <double>

Indicates the temperature in Celsius at which dew forms.

elevationM
number <double> (Elevation of the METAR measurement point in meters)
flightCategory
string (Flight rules category)
latitude
number <double> (Latitude of the METAR measurement point)
longitude
number <double> (Longitude of the METAR measurement point)
maxt24hrC
number <double>
maxtC
number <double>
metarType
string (Type of METAR-report (METAR, SPECI))
mint24hrC
number <double>
mintC
number <double>
observationTime
string <date-time>
precip24hrIn
number <double> (Precipitation in the last 24 hours in inches)
precip3hrIn
number <double> (Precipitation in the last 3 hours in inches)
precip6hrIn
number <double> (Precipitation in the last 6 hours in inches)
precipIn
number <double> (Precipitation in inches)
rawText
string (Unparsed METAR as raw string)
seaLevelPressureMb
number <double> (Sea level pressure in millibars)
Array of objects (Cloud conditions)
snowIn
number <double> (Snow accumulation in inches)
stationId
string
tempC
number <double>
threeHrPressureTendencyMb
number <double> (3-hour pressure tendency in millibars)
vertVisFt
integer <int32> (Vertical visibility in feet)
visibilityStatuteMi
number <double> (Visibility in statute miles)
Array of objects (METARWeatherCondition)
windDirDegrees
integer <int32> (Wind direction in degrees)
windDirVariable
boolean (True if wind direction fluctuates by 180° or more, with no prevailing direction)
windGustKt
integer <int32> (Wind gust in knots)
windSpeedKt
integer <int32> (Wind speed in knots)
wxString
string (METAR weather code)

Response samples

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

Notifications

Store registration token

Store or update a registration token. The user will receive push notifications.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
deviceId
string
registrationToken
string

Responses

Response Schema: application/json
object (StoreTokenResponse)

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "registrationToken": "string"
}

Response samples

Content type
application/json
{ }

Unlink user from registration token

The user will no longer receive push notifications. The token will not be removed. Calling "StoreToken" again will re-map the user to the token.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
deviceId
string

Responses

Response Schema: application/json
object (UnregisterUserResponse)

Request samples

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

Response samples

Content type
application/json
{ }

Pireps

Create pilot report

Create and and store a pilot report. The report to file is supplied as body.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
aircraftIdentification
string (Aircraft identification number)
brakingAction
string (Experienced braking action)
Default: "BRAKING_ACTION_UNSPECIFIED"
Enum: "BRAKING_ACTION_UNSPECIFIED" "BRAKING_ACTION_GOOD" "BRAKING_ACTION_GOOD_TO_MEDIUM" "BRAKING_ACTION_MEDIUM" "BRAKING_ACTION_MEDIUM_TO_POOR" "BRAKING_ACTION_POOR" "BRAKING_ACTION_LESS_THAN_POOR"
flightNumber
string (Landing flight number)
runwayId
string (Landing runway ID)
time
string <date-time> (Reported time of the PIREP)

Responses

Response Schema: application/json
object (CreatePIREPResponse)

Request samples

Content type
application/json
{
  • "aircraftIdentification": "A12B",
  • "brakingAction": "BRAKING_ACTION_UNSPECIFIED",
  • "flightNumber": "AB1234",
  • "runwayId": "01-19L",
  • "time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{ }

List pilot reports

List the pilot reports for a given aerodrome for a given number of days into the past.

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

Responses

Response Schema: application/json
Array of objects (PIREP)
Array
aircraftIdentification
string (Aircraft identification number)
brakingAction
string (Experienced braking action)
Default: "BRAKING_ACTION_UNSPECIFIED"
Enum: "BRAKING_ACTION_UNSPECIFIED" "BRAKING_ACTION_GOOD" "BRAKING_ACTION_GOOD_TO_MEDIUM" "BRAKING_ACTION_MEDIUM" "BRAKING_ACTION_MEDIUM_TO_POOR" "BRAKING_ACTION_POOR" "BRAKING_ACTION_LESS_THAN_POOR"
flightNumber
string (Landing flight number)
published
string <date-time> (Time the report was published into Airside Sync)
object (Publishing Airside Sync user)
reportId
string (Report ID (automatically generated))
runwayId
string (Landing runway ID)
time
string <date-time> (Reported time of the PIREP)

Response samples

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

List pilot reports for a year

List the pilot reports for a given aerodrome for a given year.

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

Responses

Response Schema: application/json
Array of objects (PIREP)
Array
aircraftIdentification
string (Aircraft identification number)
brakingAction
string (Experienced braking action)
Default: "BRAKING_ACTION_UNSPECIFIED"
Enum: "BRAKING_ACTION_UNSPECIFIED" "BRAKING_ACTION_GOOD" "BRAKING_ACTION_GOOD_TO_MEDIUM" "BRAKING_ACTION_MEDIUM" "BRAKING_ACTION_MEDIUM_TO_POOR" "BRAKING_ACTION_POOR" "BRAKING_ACTION_LESS_THAN_POOR"
flightNumber
string (Landing flight number)
published
string <date-time> (Time the report was published into Airside Sync)
object (Publishing Airside Sync user)
reportId
string (Report ID (automatically generated))
runwayId
string (Landing runway ID)
time
string <date-time> (Reported time of the PIREP)

Response samples

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

Reports

Publish report

Create and publish a new SNOWTAM, RCR, or ATIS (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
required
format
string (PublishReportFormat)
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "RCR" "SNOWTAM" "ATIS" "CUSTOM_FORM" "TASK"
methods
Array of strings (PublishReportMethod)
Items Enum: "METHOD_UNSPECIFIED" "AFTN" "FAX" "NAVCANADA" "EMAIL" "SMS"
updateTime
boolean

Responses

Response Schema: application/json
object (AerodromeReport)
object (Aerodrome assessment in structured form)
object (Customised report data in structured form)

A CustomForm is a form that can be filled out by the user. The form is self contained in that every form instance describes both the form schema and the filled out values. This allows forms to evolve over time, while leaving old data intact.

formattedAtis
string (Report in ATIS text format)
formattedCsv
string (Report in CSV format)
formattedPdf
string <byte> (Report in PDF format)
formattedPdfBlobKey
string (Blob key for the PDF report (alternative to formatted_pdf))
formattedText
string (Report in RCR/SNOWTAM text)
object (Report metadata, including timestamps and sequence number)
Array of objects (PublishReportResult)
Array
error
string
method
string (PublishReportMethod)
Default: "METHOD_UNSPECIFIED"
Enum: "METHOD_UNSPECIFIED" "AFTN" "FAX" "NAVCANADA" "EMAIL" "SMS"
success
boolean

Request samples

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

Response samples

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

Get report (SNOWTAM, RCR, ATIS or Customised Report)

Get a specific published report for the given aerodrome based on the report ID.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string
query Parameters
withPdf
boolean

Responses

Response Schema: application/json
object (AerodromeReport)
object (Aerodrome assessment in structured form)
object (Customised report data in structured form)

A CustomForm is a form that can be filled out by the user. The form is self contained in that every form instance describes both the form schema and the filled out values. This allows forms to evolve over time, while leaving old data intact.

formattedAtis
string (Report in ATIS text format)
formattedCsv
string (Report in CSV format)
formattedPdf
string <byte> (Report in PDF format)
formattedPdfBlobKey
string (Blob key for the PDF report (alternative to formatted_pdf))
formattedText
string (Report in RCR/SNOWTAM text)
object (Report metadata, including timestamps and sequence number)

Response samples

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

Get latest SNOWTAM

Get the latest published SNOWTAM for the given aerodrome.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
object (AerodromeReport)
object (Aerodrome assessment in structured form)
object (Customised report data in structured form)

A CustomForm is a form that can be filled out by the user. The form is self contained in that every form instance describes both the form schema and the filled out values. This allows forms to evolve over time, while leaving old data intact.

formattedAtis
string (Report in ATIS text format)
formattedCsv
string (Report in CSV format)
formattedPdf
string <byte> (Report in PDF format)
formattedPdfBlobKey
string (Blob key for the PDF report (alternative to formatted_pdf))
formattedText
string (Report in RCR/SNOWTAM text)
object (Report metadata, including timestamps and sequence number)

Response samples

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

Watch for latest report

Returns a stream of reports as they happen, beginning with the last one to be published. Optionally filtered to specific report formats using the formats parameter.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
formats
Array of strings (PublishReportFormat)
Items Enum: "UNSPECIFIED" "RCR" "SNOWTAM" "ATIS" "CUSTOM_FORM" "TASK"

Responses

Response Schema: application/json
object (rpcStatus)
code
integer <int32>
Array of objects (protobufAny)
message
string
object (WatchAerodromeReportResponse)
object (AerodromeReport)

Request samples

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

Response samples

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

List years

Lists the years in which reports were published for the given aerodrome.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
years
Array of integers <int32> [ items <int32 > ]

Response samples

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

List reports (SNOWTAM, RCR, ATIS or Customised Report)

Lists the published reports for the given aerodrome and year.

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

Responses

Response Schema: application/json
Array of objects (AerodromeReportMeta)
Array
aerodromeId
string
customFormId
string (Identifier for the custom form type, if the report is of a custom form (FOD, Wildlife, etc))
format
string (Report format type. SNOWTAM, ATIS, CUSTOM_FORM, etc)
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "RCR" "SNOWTAM" "ATIS" "CUSTOM_FORM" "TASK"
object (the first/primary map point for this report, if there is one)
published
string <date-time>
object (Information about the report’s publisher)
reportId
string
sequence
integer <int32> (SNOWTAM sequence number within the calendar year)
Array of objects (Delivery status of the report)
year
integer <int32> (Report published year)

Response samples

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

ReportsAIXM

Get report (SNOWTAM) in AIXM format

Get a specific published report for the given aerodrome based on the report ID, in AIXM format. Only SNOWTAM reports are valid for AIXM.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
reportId
required
string
query Parameters
withPdf
boolean

Responses

Response Schema: application/json
contentType
string

The HTTP Content-Type header value specifying the content type of the body.

data
string <byte>

The HTTP request/response body as raw binary.

Array of objects (protobufAny)

Application specific response metadata. Must be set in the first response for streaming APIs.

Array
@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property name*
additional property
any

Response samples

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

Get latest SNOWTAM in AIXM format

Get the latest published SNOWTAM for the given aerodrome in AIXM format.

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string

Responses

Response Schema: application/json
contentType
string

The HTTP Content-Type header value specifying the content type of the body.

data
string <byte>

The HTTP request/response body as raw binary.

Array of objects (protobufAny)

Application specific response metadata. Must be set in the first response for streaming APIs.

Array
@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property name*
additional property
any

Response samples

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

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 Schema: application/json
Array of objects (ListSensorSessionsResponseSensorSessionListItem)
Array
numMeasurements
integer <int32>
runwayId
string
sessionId
string
time
string <date-time>

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 Schema: application/json
object (SensorMeasurementLog)
Array of objects (SensorMeasurement)
object (SensorMetadata)
Array of objects (GPSPosition)
runwayId
string
sessionId
string

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 Schema: application/json
Array of objects (OnlineUsersOnlineUser)
Array
aerodromeId
string
build
string
deadline
string <date-time>
email
string
instance
string
platform
string
started
string <date-time>
userId
string

Response samples

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

Get system info

Get current system information (version, etc).

Authorizations:
bearerAuth

Responses

Response Schema: application/json
object (SystemFeatures)
userManagement
boolean
object (LicenseLimits)
aerodromeIdPatterns
Array of strings

Permitted aerodrome glob patterns. If empty, all aerodromes are permitted.

optionalFeatures
Array of strings (Optional features, i.e., 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" "RUNWAY_ASSESSMENT_FEATURE" "PIREP_FEATURE" "TASK_MANAGEMENT_FEATURE" "ANALYTICS_FEATURE" "SEND_NOTIFICATIONS_FEATURE"

Permitted optional features. If empty, all features are permitted. To permit no features, add an explicit NO_OPTIONAL_FEATURE to the list.

object (Licensee)
commonName
string
country
string
dnsNames
Array of strings
locality
string
organization
string
organizationalUnit
string
minRecommendedAppVer
string
recommendedAppVer
string
region
string (Region)
Default: "EU"
Enum: "EU" "US" "AP" "CA" "UK" "IN" "CN" "KR" "BR"

Region IDs must be valid DNS labels when used in "$region.app.safe-sky.net", e.g. "EU" will be encoded to "eu.app.safe-sky.net".

object (Version)
buildInfo
string ("9000-761b6ff4")
buildTime
string ("2006-01-02T15:04:05Z")
versionName
string ("1.25.0")

Response samples

Content type
application/json
{
  • "features": {
    },
  • "licenseLimits": {
    },
  • "licensee": {
    },
  • "minRecommendedAppVer": "string",
  • "recommendedAppVer": "string",
  • "region": "EU",
  • "version": {
    }
}

Task

Create a task

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
Request Body schema: application/json
required
assignee
string
description
string
owner
string
photoIds
Array of strings
object (GPS location)
altitude
number <double>
lat
number <double>
lon
number <double>
taskId
string
type
string

Responses

Response Schema: application/json
object (CreateTaskResponse)

Request samples

Content type
application/json
{
  • "assignee": "string",
  • "description": "string",
  • "owner": "string",
  • "photoIds": [
    ],
  • "position": {
    },
  • "taskId": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{ }

List all tasks for a given number of days

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

Responses

Response Schema: application/json
Array of objects (TaskData)
Array
assignee
string
created
string <date-time>
creator
string
description
string
Array of objects (TaskNoteValue)
owner
string
photoIds
Array of strings
object (GPS location)
sequence
integer <int32> (Id for customer consumption)
Array of objects (TaskStatusValue)
taskId
string
type
string
updated
string <date-time>

Response samples

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

Get a task

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string

Responses

Response Schema: application/json
object (TaskData)
assignee
string
created
string <date-time>
creator
string
description
string
Array of objects (TaskNoteValue)
owner
string
photoIds
Array of strings
object (GPS location)
sequence
integer <int32> (Id for customer consumption)
Array of objects (TaskStatusValue)
taskId
string
type
string
updated
string <date-time>

Response samples

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

Update the assigned user of a task

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
Request Body schema: application/json
required
string

Responses

Response Schema: application/json
object (UpdateTaskAssigneeResponse)

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Update the task description

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
Request Body schema: application/json
required
string

Responses

Response Schema: application/json
object (UpdateTaskDescriptionResponse)

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Update or add a note to a task

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
noteId
required
string
Request Body schema: application/json
required
string

Responses

Response Schema: application/json
object (UpdateTaskNoteResponse)

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Add a photo to a task or remove one

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
photoId
required
string
query Parameters
delete
boolean

Responses

Response Schema: application/json
object (UpdateTaskPhotoResponse)

Response samples

Content type
application/json
{ }

Update or add a position

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
Request Body schema: application/json
required
altitude
number <double>
lat
number <double>
lon
number <double>

Responses

Response Schema: application/json
object (UpdateTaskPositionResponse)

Request samples

Content type
application/json
{
  • "altitude": 0.1,
  • "lat": 0.1,
  • "lon": 0.1
}

Response samples

Content type
application/json
{ }

Update the task status

Authorizations:
bearerAuth
path Parameters
aerodromeId
required
string
taskId
required
string
Request Body schema: application/json
required
string (TaskStatus)
Default: "TASK_STATUS_UNSPECIFIED"
Enum: "TASK_STATUS_UNSPECIFIED" "TASK_STATUS_CREATED" "TASK_STATUS_ASSIGNED" "TASK_STATUS_IN_PROGRESS" "TASK_STATUS_ESCALATED" "TASK_STATUS_AWAIT_INFO" "TASK_STATUS_COMPLETED" "TASK_STATUS_CANCELLED"

Responses

Response Schema: application/json
object (UpdateTaskStatusResponse)

Request samples

Content type
application/json
"TASK_STATUS_UNSPECIFIED"

Response samples

Content type
application/json
{ }

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.+
query Parameters
tileSet
string
Default: "TILESET_UNSPECIFIED"
Enum: "TILESET_UNSPECIFIED" "TILESET_LIGHT" "TILESET_DARK" "TILESET_SATELLITE"

Responses

Response Schema: application/json
contentType
string

The HTTP Content-Type header value specifying the content type of the body.

data
string <byte>

The HTTP request/response body as raw binary.

Array of objects (protobufAny)

Application specific response metadata. Must be set in the first response for streaming APIs.

Array
@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property name*
additional property
any

Response samples

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

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
tileSet
required
string
Enum: "TILESET_UNSPECIFIED" "TILESET_LIGHT" "TILESET_DARK" "TILESET_SATELLITE"
name
required
string.+

Responses

Response Schema: application/json
contentType
string

The HTTP Content-Type header value specifying the content type of the body.

data
string <byte>

The HTTP request/response body as raw binary.

Array of objects (protobufAny)

Application specific response metadata. Must be set in the first response for streaming APIs.

Array
@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property name*
additional property
any

Response samples

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