Enums

About enums

Enums represent possible sets of values for a field.

For example, the SortDirection is an enum because it may be ASC or DESC to represent sorting a specific field either in ascending or descending order.

MessageState

Indicates the state of a message from a subscription.

Values for MessageState

Name	Description
START	The start of the messages for a given group of messages.
UPDATE	An update to an existing group of messages.
END	The ending of an existing group of messages.

ActivityType

Indicates the type of GeofenceEvent or ZoneEvent reported by a Geofence or a Zone.

Values for ActivityType

Name	Description
INGRESS	A detection entering a Geofence or a Zone.
DWELL	A detection remaining inside a Geofence or a Zone.
EGRESS	A detection exiting a Geofence or a Zone.

DataSourceType

Indicates the type of a DataSource

Values for DataSourceType

Name	Description
FOLDER	A data source that is simply meant to store videos or images
VIDEO_DEVICE	A data source that corresponds to a Device that is generating video.
IMAGE_DEVICE	A data source that corresponds to a Device that is generating images.
GEOPOSITION	A data source that directly produces Tracks and detections

EventValidationStatus

Used in EventValidationInput to indicate whether an event is VALID or INVALID.

Values for EventValidationStatus

Name	Description
VALID	The event is valid.
INVALID	The event is invalid.

SummaryBucketSize

Indicates the time bucket size for a summary query.

Values for SummaryBucketSize

Name	Description
MINUTES	Bucket by minutes.
HOURS	Bucket by hours.

DetectionsSortField

Indicates the field used for sorting a Detections query.

Values for DetectionsSortField

Name	Description
DETECTION_TIME	Sort the resulting list by detection time.
GLOBAL_TRACK_ID	Sort the resulting list by the corresponding Track’s unique identifier..

DataSourceSortField

Indicates the field used for sorting a Data Sources query.

Values for DataSourceSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
NAME	Sort the resulting list by the device name.

DevicesSortField

Indicates the field used for sorting a Devices query.

Values for DevicesSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
NAME	Sort the resulting list by the device name.

EventsSortField

Indicates the field used for sorting an events query.

Values for EventsSortField

Name	Description
ID	Sort the resulting list by the Event’s unique identifier.
START_TIME	Sort the resulting list by the Event’s start time.

EventProducersSortField

Indicates the field used for sorting an eventProducers query.

Values for EventProducersSortField

Name	Description
ID	Sort the resulting list by the EventProducer’s unique identifier.
EVENT_PRODUCER_NAME	Sort the resulting list by the EventProducer’s name.

GeofencesSortField

Indicates the field used for sorting a geofences query.

Values for GeofencesSortField

Name	Description
ID	Sort the resulting list by the Geofence’s unique identifier.
NAME	Sort the resulting list by the Geofence’s name.

GeofenceEventsSortField

Indicates the field used for sorting a geofenceEvents query.

Values for GeofenceEventsSortField

Name	Description
ID	Sort the resulting list by the GeofenceEvent’s unique identifier.
OCCURRED	Sort the resulting list by the GeofenceEvent’s timestamp.

GeofenceIntersectionsSortField

Indicates the field used for sorting a geofenceIntersections query.

Values for GeofenceIntersectionsSortField

Name	Description
ID	Sort the resulting list by the GeofenceIntersection’s unique identifier.
START_TIME	Sort the resulting list by the GeofenceIntersection’s start time.

MeasurementsSortField

Indicates the field used for sorting a measurements query.

Values for MeasurementsSortField

Name	Description
ID	Sort the resulting list by the Measurement’s unique identifier.
TIMESTAMP	Sort the resulting list by the Measurement’s timestamp.

PointOfInterestSortField

Indicates the field used for sorting a pointsOfInterest query.

Values for PointOfInterestSortField

Name	Description
ID	Sort the resulting list by the Point of Interest’s unique identifier.
NAME	Sort the resulting list by the Point of Interest’s name.

SensorType

Indicates the type of data that is outputted by a sensor.

Values for SensorType

Name	Description
NUMBER	Numeric data types, i.e integers, floats, and doubles.
BOOLEAN	Boolean data types, i.e true or false.
TEXT	Text-based data types.

SensorsSortField

Indicates the field used for sorting an sensors query.

Values for SensorsSortField

Name	Description
ID	Sort the resulting list by the sensor’s unique identifier.
NAME	Sort the resulting list by the sensor’s name.

SitesSortField

Indicates the field used for sorting an sites query.

Values for SitesSortField

Name	Description
ID	Sort the resulting list by the sites’s unique identifier.
NAME	Sort the resulting list by the sites’s name.

SortDirection

Indicates the direction of sorting based on a particular field’s value.

Values for SortDirection

Name	Description
ASC	Sort the resulting list in ascending order.
DESC	Sort the resulting list in descending order.

TagsSortField

Indicates the field used for sorting a Tags query.

Values for TagsSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
LABEL_NAME	Sort the resulting list by the tag name.

TracksSortField

Indicates the field used for sorting a Tracks query.

Values for TracksSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
TRACK_START_TIME	Sort the resulting list by the track start time.

VideosSortField

Indicates the field used for sorting a Videos query.

Values for VideosSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
DATA_SOURCE_ID	Sort the resulting list by the datasource identifier.
START_TIME	Sort the resulting list by start time.
END_TIME	Sort the resulting list by end time.

ZoneEventsSortField

Indicates the field used for sorting a zoneEvents query.

Values for ZoneEventsSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
START_TIME	Sort the resulting list by the track start time.

ZoneIntersectionsSortField

Indicates the field used for sorting a zoneIntersections query.

Values for ZoneIntersectionsSortField

Name	Description
ID	Sort the resulting list in by its unique identifier.
START_TIME	Sort the resulting list by the intersection start time.

ZonesSortField

Indicates the field used for sorting a zones query.

Values for ZonesSortField

Name	Description
ID	Sort the resulting list by the zone’s unique identifiers.
NAME	Sort the resulting list by the zone’s names