ZeroKey

System Settings

Global system settings relating to the core functions of the platform. These are usually configured at the time of initial system setup.

Get the current system state and settings

SecurityOAuth2 or ApiKey
Responses
200

Response success

Response Schema: application/json
object (Settings)
SiteID
number

The SiteID is tagged on most events as a means of identifying the source of the event across large multi-site networks.

Name
string

Friend-name for the site

Array of objects (Devices)
Array
DeviceID
string

A 6-byte MAC address associated to the device. This is usually the MAC address associated with the radio or Ethernet interface, depending on the particular device.

Position
Array of numbers >= 3 items

A vector representing the last known X, Y, and Z coordinates of the device, respectively. Coordinates are in metres, and may be negative.

Orientation
Array of numbers >= 4 items

A vector representing the W, X, Y, and Z values (respectively) of a normalized quaternion representing the device's orientation.

DeviceFlags
integer

A bitfield integer representing device-specific state information.

AlertState
string

The alert state of a device indicates whether it is currently alarming by flashing it's alarm LED, and exciting its buzzer and vibration motor.

Enum: "off" "active"
FirmwareHash
string

A unique hash identifier that indicates the exact firmware build on an device.

FirmwareVersion
string

The version of the firmware on a device.

DeviceType
string

Indicates whether the device is a gateway device, anchor node, or mobile node. This value is derived from the DeviceFlags bitfield.

Enum: "gateway" "anchor" "mobile"
LastUpdateTime
string <date-time>

The date and time of the last communication from the device.

BatteryLevel
number [ 0 .. 1 ]

The last indicated battery-level as a decimal value between 0..1. This field will be null if the device have not reported its battery level.

LastGatewaySource
string

A URI that specifies the last known network route to a device of the form ZK://{SiteID}::{GatewayID}::{ExternalSource}). ExternalSource may be a UDP end-point for Power-over-Ethernet devices of the form UDP::{Host}:{Port}, or may be a USB connected gateway of the form USB::{DeviceID}.

Array of objects (Modules)
Array
ModuleID
string

Globally unique identifier for the module, generated upon module installation.

Name
string

Friendly-name of the module, provided from the module assembly through the module interface.

Version
string

Indicates the current build version of the module.

Description
string

Long description of the module's functionality.

ModuleFilename
string

Path to the module's package file.

Active
boolean

Indicates whether the module is active. Inactive modules will not be loaded.

Running
boolean

Indicates whether the module has started-up and is in a running state.

Array of objects (Zones)
Array
SiteID
string

The configured SiteID within the system settings.

ZoneID
string

GUID representing a specific zone definition.

Name
string

Friendly-name for a specific zone definition. Any JSON string is valid.

GeometryType
string

Specifies the shape of the Zone, which also dictates how the GeometryData is interpreted. 2D shapes extend infinitely to all positive and negative Z-coordinate values.

Enum: "sphere" "circle" "cuboid" "square" "cylinder" "polygon"
GeometryData
Array of integers non-empty

The schema for GeometryData depends on the GeometryType according to the following table:

GeometryType GeometryData
sphere [[center_point],[radius,0,0]]
circle [[center_point],[radius,0,0]]
cuboid [[origin],[length,width,height],[axis_l],[axis_w],[axis_h]]
square [[bottom_left],[length,width,0],[axis_l_x, axis_l_y, 0],[axis_w_x, axis_w_y, 0]]
cylinder [[origin],[axis],[height,radius,0]]
polygon [[vertex 1],[vertex 2],...[vertex N],[height,0,0],[axis]]
MobileOriginSource
string

The MAC address of the device to attach this zone's centre to, allowing the zone to become a moving centroid with latest device position as its centre.

Array of objects (CollidingDevices)

List of devices that are currently colliding with the zone

AlertLevel
integer

Indicates the numeric alert level of the zone from the lowest priority (0) to the highest priority (+inf). This value determines what types of actions are taken on triggering, ranging from a site-wide alarm, device-level alarm, or a logged-only alarm.

Active
boolean
Default: true

Indicates whether the Zone is active or inactive. If a Zone is inactive, it will not cause any alarms even if devices enter the zone.

InclusionPolicy
string
Default: "all"

Specifies the default inclusion policy for devices which may trigger this zone. If set to all, any device that is not listed in the DeviceList is able to trigger the zone. If set to none, only devices listed in the DeviceList may trigger the zone.

Enum: "all" "none"
DeviceList
Array of strings

If InclusionPolicy is set to all, any device that is not listed in this list is able to trigger the zone. If InclusionPolicy to none, only devices listed in this list may trigger the zone.

Array of objects (ZoneAction)
IsGeometryLocked
boolean
Default: false

Indicates if the geometry modification of this zone is locked or not. When locked, changes to the geometry data are disabled.

IsTimed
boolean
Default: false

Indicates if the zone is a timed zone. If set, the StartTime and StopTime will be used to dictate when the zone is active.

StartTime
string <date-time>

The date and time indicating the start of the timed zone active timeframe. Only used when the IsTimed boolean is set to true.

StopTime
string <date-time>

The date and time indicating the end of the timed zone active timeframe. Only used when the IsTimed boolean is set to true.

401

Unauthorized access, invalid credentials were used.

get/system
Request samples 
Response samples 
application/json
{
  • "settings": {
    },
  • "devices": [
    ],
  • "modules": [
    ],
  • "zones": [
    ]
}
➔ Next to Quality of Service