GCS RealTime API 1.3.1

Servers

  • ssl://portal.demo.unifly.tech:8883mqttproduction
    Security:
    • API key
      • In: user
    • API key
      • In: password

Operations

  • RECEIVE telemetry/{uasSerialNumber}/location

    Location of the UAS

    Operation IDsendTelemetryLocation

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    object

    Accepts the following message:

    Telemetry LocationtelemetryLocationMessage
    Message IDtelemetryLocationMessage

    Submit a change in location of a UAS.

    object

    Describes where the UAS is flying.

    Examples

  • RECEIVE telemetry/{uasSerialNumber}/heading

    Heading of the UAS

    Operation IDsendTelemetryHeading

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    object

    Accepts the following message:

    Telemetry HeadingtelemetryHeadingMessage
    Message IDtelemetryHeadingMessage

    Submit a change in the heading of a UAS.

    object

    The heading in which the UAS is moving

    Examples

  • RECEIVE telemetry/{uasSerialNumber}/velocity

    Velocity of the UAS

    Operation IDsendTelemetryVelocity

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    object

    Accepts the following message:

    Telemetry VelocitytelemetryVelocityMessage
    Message IDtelemetryVelocityMessage

    Submit a change in the velocity of a UAS.

    object

    The speed at which the UAS is moving

    Examples

  • RECEIVE telemetry/{uasSerialNumber}/emergencyStatus

    Emergency status of the UAS

    Operation IDsendTelemetryEmergencyStatus

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    object

    Accepts the following message:

    TelemetrytelemetryEmergencyStatusMessage
    Message IDtelemetryEmergencyStatusMessage

    Submit a change in the emergency status of a UAS.

    object

    Examples

  • SEND tracking/nearby/{uasSerialNumber}/{trackId}

    Tracking information relevant to the specified UAS, grouped by track id. Use the multi-level wildcard # (/tracking/nearby/#) to subscribe to all tracking information (restricted by security).

    Operation IDreceiveNearbyTracking

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    trackId
    required
    string
    object

    Accepts the following message:

    Nearby TrackingnearbyTrackingMessage
    Message IDnearbyTrackingMessage

    Anonymized information about tracks that are of importance to the user (due to proximity).

    object

    Examples

  • SEND alerts/nearby/{uasSerialNumber}/{alertId}

    Alert information relevant to the specified UAS, grouped by alert id. Use the multi-level wildcard # (/alerts/nearby/#) to subscribe to all alerts (restricted by security).

    Operation IDreceiveNearbyAlerts

    Available only on servers:

    object
    uasSerialNumber
    required
    string
    alertId
    required
    string
    object

    Accepts the following message:

    Nearby AlertnearbyAlertMessage
    Message IDnearbyAlertMessage

    Anonymized information about alerts that are of importance to the user (due to proximity or involvement)

    object

    Examples

  • SEND operations/{operationId}

    Operation information, grouped by operation id. Use the single-level wildcard + (/operations/+) to subscribe to all operations (restricted by security).

    Operation IDreceiveOperations

    Available only on servers:

    object
    operationId
    required
    string
    object

    Accepts the following message:

    OperationoperationMessage
    Message IDoperationMessage

    Indicates a change in properties of an operation. Access to operations is limited by security.

    object

    The properties of an operation

    Examples

  • SEND operations/{operationId}/instructions/{instructionId}

    Instruction information, grouped by instruction id and operation id. Use the single-level wildcard + (/operations/{operationId}/instructions/+) to subscribe to all instructions for an operation, or (/operations/+/instructions/+) to all instructions for all operations

    Operation IDreceiveOperationInstructions

    Available only on servers:

    object
    operationId
    required
    string
    instructionId
    required
    string
    object

    Accepts the following message:

    InstructioninstructionMessage
    Message IDinstructionMessage

    Indicates a change or arrival of an instruction to the operator.

    object

    Examples

  • RECEIVE operations/{operationId}/instructions/{instructionId}/transition/{transitionCode}

    Trigger a state transition on the instruction.

    Operation IDsendOperationInstructionStateTransition

    Available only on servers:

    object
    operationId
    required
    string
    instructionId
    required
    string
    transitionCode
    required
    string
    object

    Accepts the following message:

    Instruction state transitioninstructionTransitionMessage
    Message IDinstructionTransitionMessage

    Triggers a state transition on the instruction

    object

    Examples

  • SEND geofences/{geofenceId}

    Events related to changes, creation or removal of geofences

    Operation IDreceiveGeofenceEvent

    Available only on servers:

    object
    geofenceId
    required
    string
    object

    Accepts the following message:

    Geofence eventgeofenceEventMessage
    Message IDgeofenceEventMessage

    Describes an update, creation or removal of a geofence. The messages includes a bounding box; use this to determine whether the event is relevant (e.g. inside your viewport) and use the REST call to refresh the information if necessary.

    object

    Examples

Messages

  • #1Telemetry LocationtelemetryLocationMessage
    Message IDtelemetryLocationMessage

    Submit a change in location of a UAS.

    object

    Describes where the UAS is flying.

  • #2Telemetry HeadingtelemetryHeadingMessage
    Message IDtelemetryHeadingMessage

    Submit a change in the heading of a UAS.

    object

    The heading in which the UAS is moving

  • #3Telemetry VelocitytelemetryVelocityMessage
    Message IDtelemetryVelocityMessage

    Submit a change in the velocity of a UAS.

    object

    The speed at which the UAS is moving

  • #4TelemetrytelemetryEmergencyStatusMessage
    Message IDtelemetryEmergencyStatusMessage

    Submit a change in the emergency status of a UAS.

    object
  • #5Nearby TrackingnearbyTrackingMessage
    Message IDnearbyTrackingMessage

    Anonymized information about tracks that are of importance to the user (due to proximity).

    object
  • #6Nearby AlertnearbyAlertMessage
    Message IDnearbyAlertMessage

    Anonymized information about alerts that are of importance to the user (due to proximity or involvement)

    object
  • #7OperationoperationMessage
    Message IDoperationMessage

    Indicates a change in properties of an operation. Access to operations is limited by security.

    object

    The properties of an operation

  • #8InstructioninstructionMessage
    Message IDinstructionMessage

    Indicates a change or arrival of an instruction to the operator.

    object
  • #9Instruction state transitioninstructionTransitionMessage
    Message IDinstructionTransitionMessage

    Triggers a state transition on the instruction

    object
  • #10Geofence eventgeofenceEventMessage
    Message IDgeofenceEventMessage

    Describes an update, creation or removal of a geofence. The messages includes a bounding box; use this to determine whether the event is relevant (e.g. inside your viewport) and use the REST call to refresh the information if necessary.

    object

Schemas

  • timestamp
    string
    format: date-time
  • object

    The WGS84 coordinates of the UAS

  • object

    The properties of an operation

  • object
  • object [Altitude]

    Describes an altitude in one or more references

  • array<number>
    4 items

    Bounding box coordinates for which to fetch geofences, in GeoJSON bbox format ([west, south, east, north]).

  • object

    Describes where the UAS is flying.

  • groundSpeed
    number

    The speed at which the UAS is moving relative to the ground, in meters per second.

  • object

    The speed at which the UAS is moving

  • trueHeading
    number
    [ 0 .. 360 )

    The true heading of the UAS, relative to geographical north

  • magneticHeading
    number
    [ 0 .. 360 )

    The magnetic heading of the UAS, relative to magnetic north

  • object

    The heading in which the UAS is moving

  • object
  • emergencyStatus
    string

    Emergency state occurring with the drone

      Allowed values:
    • "LOSS_OF_LINK"
    • "LOSS_OF_SIGNAL"
    • "LOSS_OF_GPS"
    • "LOSS_OF_ENGINE"
    • "LOSS_OF_POWER"
    • "LOSS_OF_OWNERSHIP"
  • object
  • object
  • object
  • object
  • subjectType
    string
      Allowed values:
    • "UAS"
    • "GEOZONE"
    • "AIRCRAFT"
    • "UASOPERATION"
    • "AIRPORT"
    • "HELICOPTER"
    • "VESSEL"
  • object
  • object
  • object
  • object

    The data that is entered by the user in the form according to the form definition in the instruction. Key/value map, where the key is the id of the form field.

  • object

    Describes a form that can be shown to a user.

  • object
  • object
  • object