Object reference

This is a reference of all the defined objects in our service.

Sensor objects

Reference of all sensor objects.

`sensorSerial`

Definition	Serial number of a sensor
Category	sensor
Data type	string
Writable	No
Description	A unique identifier assigned to each sensor during the manufacturing process. Alternatively the sensorSerial can be generated automatically during the provisioning process of a software sensor.

`sensorAlias`

Definition	An optional alias of a sensor
Category	sensor
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The sensorAlias is an optional identifier that can be used to refer to a specific sensor with a more user friendly way instead of the sensorSerial.

`sensorDescription`

Definition	An optional description of a sensor
Category	sensor
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The sensorDescription is an optional text that the user can use to better identify the sensor. Unlike the sensorAlias, the sensorDescription is not used in referencing the sensor.

`sensorLatitude`

Definition	The latitude of the sensor
Category	sensor
Data type	float
Writable	Yes (requires sensorAdmin + sensorAutoLocation = false)
Description	The sensorLatitude is used to identify the physical location of the sensor on the map. The latitude can be manually entered or optionally automatically obtained from the sensor's GNSS (if equipped).

`sensorLongitude`

Definition	The longitude of the sensor
Category	sensor
Data type	float
Writable	Yes (requires sensorAdmin + sensorAutoLocation = false)
Description	The sensorLongitude is used to identify the physical location of the sensor on the map. The longitude can be manually entered or optionally automatically obtained from the sensor's GNSS (if equipped).

`sensorFloor`

Definition	The floor of the sensor
Category	sensor
Data type	float
Writable	Yes (requires sensorAdmin)
Description	The sensorFloor is used to identify the physical location of the sensor. The floor is usually used indoor when the location has multiple floors.

`sensorAutoLocation`

Definition	Automatic location
Category	sensor
Data type	boolean
Writable	Yes (requires sensorAdmin)
Description	The sensorAutoLocation is used to indicate if the sensor has the GNSS feature enabled. Requires GNSS support on the sensor.

`sensorTags`

Definition	Optional tags for the sensor
Category	sensor
Data type	array of string
Writable	Yes (requires sensorAdmin)
Description	The tags can be used to add additional identifiers to a sensor. The tags can be used to identify common traits between multiple sensors. A sensor can have multiple tags.

`sensorPriority`

Definition	The alert level for a sensor
Category	sensor
Data type	string ["low", "normal", "high"]
Writable	Yes (requires sensorAdmin)
Description	The sensorPriority is used to determine the handling of alerts for a sensor in case of a failure.

`sensorMaxRange`

Definition	The maximum range of the sensor
Category	sensor
Data type	integer or float
Writable	Yes (requires sensorAdmin)
Description	The sensorMaxRange determines the maximum range how far the sensor is detecting visitors. Depending on the sensor model, the range is either a logarithmic range between 0-100 or a value in meters between 0-100.

`sensorIsActive`

Definition	Indicator of sensor being enabled or disabled
Category	sensor
Data type	boolean
Writable	Yes (requires sensorAdmin)
Description	The sensorIsActive determines if the sensor is enabled or disabled. Changing the sensor to not active, means that the data collection is stopped.

`sensorOnline`

Definition	Indicator of sensor being online
Category	sensor
Data type	boolean
Writable	No
Description	The sensorOnline indicates the status of the sensor being online at the given moment. The sensor will be automatically set to offline after not being online for 10 minutes.

`sensorLastSeen`

Definition	Datetime on when a sensor has last been online
Category	sensor
Data type	datetime
Writable	No
Description	The sensorLastSeen indicates the last occurance when the sensor was online. The last seen is a datetime sting.

`sensorState`

Definition	Indicator of sensor's state
Category	sensor
Data type	string ["disabled", "failed", "online"]
Writable	No
Description	The sensorState indicates the stte of the sensor. The sensorState differs from sensorIsActive and sensorOnline with the difference that it takes into consideration whether the sensor should be online or not.

`sensorAddress`

Definition	Address information of the sensor
Category	sensor
Data type	string
Writable	No
Description	The sensorAddress is an automatically generated field based on the physical location and coordinates of the sensor.

`sensorRssi`

Definition	Indicator of the sensor's network strength
Category	sensor
Data type	float
Writable	No
Description	The sensorRssi indicates the strength of the network connection for sending data to the cloud.

Data profile objects

Reference of all data profile objects. Also referred as calibration objects.

`calibrationProfileId`

Definition	A unique identifier of a data profile
Category	data profile
Data type	uuid
Writable	No
Description	The calibrationId is an automatically generated unique identifier for each data profile. Each sensor can be assigned with a data profile.

`calibrationProfileName`

Definition	Name of a data profile
Category	data profile
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The calibrationProfileName is used to name the data profiles with a more friendly identifier.

`calibrationProfileDescription`

Definition	Optional description of a data profile
Category	data profile
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The calibrationProfileDescription is an optional description field for providing additional information about a data profile.

`calibrationProfileFactor`

Definition	The factor a data profile uses to calibrate data
Category	data profile
Data type	float
Writable	Yes (requires sensorAdmin)
Description	The calibrationProfileFactor is a number multiplier that the data profile uses to calibrate and adjust the data from the sensors applied with the specific data profile.

Group objects

Reference of all group objects.

`groupId`

Definition	A unique identifier of a group
Category	group
Data type	uuid
Writable	No
Description	The groupId is an automatically generated unique identifier for each group. Each sensor can be assigned to multiple groups.

`groupName`

Definition	Name of a group
Category	group
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The groupName is used to name the group with a more friendly identifier.

`groupDescription`

Definition	Optional description of a group
Category	group
Data type	string
Writable	Yes (requires sensorAdmin)
Description	The groupDescription is an optional description field for providing additional information about a group.

`groupSensors`

Definition	List of member sensors assigned to a group
Category	group
Data type	array of sensor objects
Writable	Yes (requires sensorAdmin)
Description	The groupSensors lists all the sensors that are assigned to a specific group.

`groupUsers`

Definition	List of users restricted to a specific group
Category	group
Data type	array of user objects
Writable	Yes (requires sensorAdmin)
Description	The groupUsers lists all the users that are restrcited to a specific group.

Threshold objects

Reference of all threshold objects.

This section is under construction and will be added later.

User objects

Reference of all user objects.

This section is under construction and will be added later.

API credential objects

Reference of all API credential objects.

This section is under construction and will be added later.