SKskydio
Markers

Upsert Marker (Beta)

Changed on

Create or update a marker. This will show up as an incident in the map view of Remote Flight Deck for DFR Command customers.

post/v0/marker

Request

  • Base URL
    https://api.skydio.com/api
  • Auth
    API key in header Authorization

Request body

areastring

The area that the marker is associated with. Ex. "5" (precinct number), "Downtown" (sector name), etc.

descriptionstring required

Detailed description of the marker that will appear in the marker details.

event_timestring date-time required

The time of the event that the marker is associated with.

latitudenumber required

Latitude in degrees.

longitudenumber required

Longitude in degrees.

source_namestring

Partner application name. Ex. Axon, Fusus, etc.

titlestring

A short title for the marker that will appear on the list view for the marker.

type'INCIDENT' | 'NG911' | 'GUNSHOT_DETECTION' | 'TAK' | 'UAS_DETECTION' | 'ALARM' required

The type of the marker. This will affect how the marker is displayed on the map view.

uuidstring uuid
versionnumber

An increasing number that represents the version of the marker. Once this field is set, future updates must use a higher version number for changes to take effect. Updates with the same or a lower version will be ignored. Must be within the signed 32-bit integer range (-2,147,483,648 to 2,147,483,647). Millisecond timestamps exceed this range, so use a counter or a timestamp in seconds instead.

Example request

{
  "event_time": "2022-05-03T03:10:52.503+00:00",
  "marker_details": {
    "caller_phone_number": "+12125551234"
  }
}

Response

Marker returned from GET and POST /marker endpoints

error_messagestring
skydio_error_codeinteger required
status_codeinteger required

Example response

{
  "data": {
    "marker": {
      "event_time": "2022-05-03T03:10:52.503+00:00",
      "marker_details": {
        "caller_phone_number": "+12125551234"
      }
    }
  }
}

Changes

  • 6589167ebe70Revision changes
    • breaking

      added subschema #5 subschema #6 to the request body allOf list

    • breaking

      added subschema #5: TAK Details subschema #6: Alarm Details subschema #7: Custom Marker Details subschema #8: Auto Detection Marker Details to the // response property oneOf list for the response status

    • warning

      the request property's max was set to 2147483647.00

    • warning

      the request property's min was set to -2147483648.00

    • warning

      added the new ALARM enum value to the // response property for the response status

    • warning

      added the new AUTO_DETECTION enum value to the // response property for the response status

    • warning

      added the new CUSTOM enum value to the // response property for the response status

    • warning

      added the new TAK enum value to the // response property for the response status

    • info

      added subschema #5: TAK Details subschema #6: Alarm Details to the request property anyOf list

    • info

      added the new ALARM enum value to the request property

    • info

      added the new TAK enum value to the request property

    • info

      added subschema #6 subschema #7 subschema #8 subschema #9 to the / response property allOf list for the response status