POST api/v1/videoConfig/{MAC}/device/{deviceId}/trigger

The TriggerVideoCapture() Web PopulateResults is used to force the camera to trigger a video capture event, which will result in a video (or jpg) clip being saved to the AlarmNet video servers, if the camera is previously configured to do so.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
MAC

MAC Address (unique identifier) for the camera in question.

 string

Required
deviceId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

BaseResults object: ResultCode: Numerical indication of success/failure. 0=Success, Failure otherwise ResultData: Textual information, additional to the ResultCode as necessary.

BaseResults
NameDescriptionTypeAdditional 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>