POST api/v1/device/{deviceId}/imvDevice/{deviceSerialNumber}/triggerVoD?clipType={clipType}

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

Request Information

URI Parameters

Name	Description	Type	Additional information
deviceId		integer	Required
deviceSerialNumber	deviceserialnumber (unique identifier) for the camera in question.	string	Required
clipType	"VOD", "Thumbnail", "Alarm", "Built-in-picture". If nothing is passed then default is VOD	string	None.

Body Parameters

UserPinInfo

Name	Description	Type	Additional information
UserPin		string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserPin": "sample string 1"
}

application/xml, text/xml

Sample:

<UserPinInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.IPVideo">
  <UserPin>sample string 1</UserPin>
</UserPinInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

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

Name	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>