GET api/v3/locations/{locationId}/devices/{deviceId}/partitions/lastCommandState/{commandCode}
Polling API - Which should be called based on Arm/Disarm API output Result Codes
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId |
Location ID |
integer |
Required |
| deviceId |
Device ID |
integer |
Required |
| commandCode |
Last Command Code |
integer |
Required |
| PartitionIds | string |
None. |
Body Parameters
None.
Response Information
Resource Description
SecurityCommentStateResult
SecurityCommentStateResult| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusChange | CommentStateChange |
None. |
|
| ResultCode | integer |
None. |
|
| ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"StatusChange": {
"PartitionStateChange": [
{
"PartitionId": 1,
"Result": 2
},
{
"PartitionId": 1,
"Result": 2
}
],
"CommentState": 1
},
"ResultCode": 1,
"ResultData": "sample string 2"
}
application/xml, text/xml
Sample:
<SecurityCommentStateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V2.Security">
<ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
<ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
<StatusChange xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
<d2p1:CommentState>1</d2p1:CommentState>
<d2p1:PartitionStateChange>
<d2p1:PartitionCommentStateChange>
<d2p1:PartitionId>1</d2p1:PartitionId>
<d2p1:Result>2</d2p1:Result>
</d2p1:PartitionCommentStateChange>
<d2p1:PartitionCommentStateChange>
<d2p1:PartitionId>1</d2p1:PartitionId>
<d2p1:Result>2</d2p1:Result>
</d2p1:PartitionCommentStateChange>
</d2p1:PartitionStateChange>
</StatusChange>
</SecurityCommentStateResult>