Introduction
This page covers the ICD-001 Update Entity Command.
Contents
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
Entity Update Command Example
| Code Block | ||
|---|---|---|
| ||
<!--MsgId is the unique id of the message being sent --> <!--UserId is the numeric user id of the entity which requires to be updated --> <!--This command will enable the area with UserId 1 --> <?xml version="1.0" encoding="utf-8"?> <UpdateEntityCommand MsgTimeStamp="2020-05-011T01:01:01+00:00" MsgId="1" UserId="1" Type="Area" Enabled="true" xmlns="ICDNAV001-UpdateEntityCommand.xsd"> <Sender SenderId="SenderId1" NetworkAddress="127.0.0.1" NetworkPort="10000" /> </UpdateEntityCommand> |
...
Update Entity 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 | |
UserId | Id of the entity which needs to be updated | Integer | This is the User Id of the entity. If the Id is not found or if there are duplicates found, then the update will fail |
Type | The type of entity to update. Available options are:
| EntityType | Enabling or disabling an area will arm and disarm the area. Enabling or disabling a radar will enable or disable tracking from the selected radar |
Enabled | The state to set on the selected entity | Boolean | To enabled the entity, set this value to true, otherwise false |
Network Sender Element
Each incoming message can include an optional Sender element. This must include the IP address and port that the client is using to send instructions.
...
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...