Sign in

v1

latestOpenAPI 3.0.32026-07-24434977.4 KB
Tracked Subjects

Retrieving a Tracked Subject

Get a single subject's current location.

get/geo/subjects/{externalSubjectId}

Path parameters

externalSubjectIdstring required

ID of the subject type you are fetching

Response

Get a single subject's current location

subjectIdstring

ID of the subject in flocks system

subjectType'vehicle' | 'person' | 'drone' | 'other' required

base type of the subject. This is used to filter subjects on the map

subjectSubtypestring required

subtype of the subject. This is used to filter subjects on the map

externalIdstring required

ID of the subject in your system. Must be unique per organization.

createdAtstring date-time

RFC3339 UTC datetime string of when subject was created

updatedAtstring date-time

RFC3339 UTC datetime string of when subject was last updated. Use this if different time than createdAt or the current time.

disableAtstring date-time

RFC3339 UTC datetime string of when subject should be inactive

latitudenumber required
longitudenumber required
altitudenumber

altitude in meters, defaults to 0.0 and returned as 0.0 if not provided

deviceLinkstring

URL to the device, defaults to "" and returned as "" if not provided

deviceStatusstring

status of the device such as buffering, recording, etc

isRecordingboolean

if the subject is recording or not

nicknamestring

nickname of the subject

isLawEnforcementboolean

if the subject is a law enforcement subject or not