...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
Example
...
Detection Command
| Code Block | ||
|---|---|---|
| ||
<!-- MsgId is the unique id of the message being sent -->
<!-- Unique Id must be unique across all tracks being sent to Witness -->
<?xml version="1.0" encoding="utf-8"?>
<DetectionCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="ICDNAV001-DetectionCommand" MsgId="1" MsgTimeStamp="2020-03-01T23:32:11.6298253+00:00">
<TrackDetection xsi:type="TrackDetection" UniqueId="03b48a2d-1709-4617-af18-12b5bce40c68" DetectionStatus="Update" ExpiryPeriod="4">
<DetectionData DetectedTime="2020-03-01T23:32:10.6298233+00:00" Latitude="51.678901" Longitude="-3.456642" Altitude="0" Speed="6.5" Course="231.2" Classification="Vehicle" Tag="Patrol Car 1" Friend="false"/>
</TrackDetection>
<!-- The sender element is optional -->
<Sender SenderId="XFSControlSuite:1" NetworkAddress="10.0.5.1" NetworkPort="5079" />
</DetectionCommand> |
...
Detection Command Attributes
Attributes | Description | Type | Notes |
MsgId | Unique message Id | Long | This must be globally unique across all message types |
MsgTimeStamp | Date and time that the message was sent | DateTime |
Track Detection Element
Each Track Detection represents an update for a track from the external system. One or more of these detections can be included in each Detection Command message.
...
Track Detection Attributes
Attributes | Description | Type | Notes |
UniqueId | Unique track Id. This can be any form Id represented as a string, such an integer, name or a GUID. | String | This must be globally unique across all tracks being sent to Witness |
DetectionStatus | Type of track detection. Options are:
| DetectionStatusList | |
ExpiryPeriod | Amount of time, in seconds, that a track will live in Witness without receiving any further updates before it is automatically deleted. This value should be greater zero and less than 30 seconds. | Integer |
Detection Data Element
This element contains data for the track, including key data for location, speed and course. Not all attributes are compulsory however the latitude and longitude are mandatory.
...
| Info |
|---|
Optional attributes are formatted in italics and highlighted with an asterisk. |
Attributes | Description | Type | Notes |
DetectedTime | The time that the track update was detected or created by its source | DateTime | |
Latitude | Latitude in decimal degrees. Uses the WGS84 datum | Double | |
Longitude | Longitude in decimal degrees. Uses the WGS84 datum | Double | |
*Altitude | The height of the target | Double | The datum for the height is not important. However we would expect the height to be above local ground level if you are expecting to follow the target with a camera on the local site. |
*Speed | Speed of the track in metres per second | Double | If no speed is specified it will be reported as zero |
*Course | The track’s course in degrees | Double | If no course is specified it will be reported as zero |
*Classification | Classification of the track. Options are:
| ClassificationTypeList | If no classification is specified the track will be reported as unclassified |
*Tag | The tracks visible Id or name that will appear on the UI | String | Each track will always be allocated a unique display number Id. If a tag is not provided then the number Id will be displayed otherwise the supplied tag will be used in the UI |
*Friend | If true, the track is treated as a friend and can never trigger an alarm. It will be displayed like any other track but it will be displayed as a friend | Boolean | If Friend is not set then it will be false meaning the track will have an unknown severity unless it is changed by a rule |
Managing a Track's Lifespan
...