Introduction
This page covers the ICD-001 Request Status Command.
Contents
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
The request status command provides the ability to request a Status Report from Witness. The command includes a filter option which allows external systems to request all status data or only specific data.
Request Status 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 | |
Type | An integer which represents one or more status elements to request. Options are set by enabling bits in the integer as follows:
| Integer | You need to use a bitwise operation to send the relevant integer to request the different status data. For example:
A value of zero will be ignored and no data will be returned. |
The Area Status data is filtered by default. This filter is a setting in the ICD-001 plugin configuration. On sites where there may be many areas and areas of different types i.e. Camera, Detection etc, then it may be desirable to filter the area type so the status message only contains the area types you are interested in.
...
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...