POST api/v1/locations/{locationId}/devices/{deviceid}/AlarmResponse
After the alarm occurs in TC user have option to confirm the Alarm or Cancel it.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId | integer |
Required |
|
deviceid | integer |
Required |
Body Parameters
AlarmResponseName | Description | Type | Additional information |
---|---|---|---|
responseType |
Alarm response type ConfirmAlarm = 1 CancelAlarm = 2 |
integer |
None. |
PartitionId | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "responseType": 1, "PartitionId": [ 1, 2 ] }
application/xml, text/xml
Sample:
<AlarmResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1"> <PartitionId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </PartitionId> <responseType>1</responseType> </AlarmResponse>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResults
BaseResultsName | Description | Type | Additional information |
---|---|---|---|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResultCode": 1, "ResultData": "sample string 2" }
application/xml, text/xml
Sample:
<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi"> <ResultCode>1</ResultCode> <ResultData>sample string 2</ResultData> </BaseResults>