POST apioauth/matrixv2/services/{serviceId}/videodownloads

Request a video download from a service with a camera

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceId	The service id queried wtih the camera	unsigned integer	Required

Body Parameters

The download request

CreateVideoDownloadRequest

Name	Description	Type	Additional information
VideoCameraChannel	The camera channel to request, starting from 0	integer	None.
VideoStartTime	The start time required in UTC	date	None.
VideoEndTime	The end time required in UTC	date	None.
VideoComment	Any comment for the downlaod request	string	None.

Request Formats

application/json, text/json

Sample:

{
  "VideoCameraChannel": 1,
  "VideoStartTime": "2025-04-27T16:27:28.5381019+00:00",
  "VideoEndTime": "2025-04-27T16:27:28.5381019+00:00",
  "VideoComment": "sample string 4"
}

application/xml, text/xml

Sample:

<CreateVideoDownloadRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VideoCameraChannel>1</VideoCameraChannel>
  <VideoStartTime>2025-04-27T16:27:28.5381019+00:00</VideoStartTime>
  <VideoEndTime>2025-04-27T16:27:28.5381019+00:00</VideoEndTime>
  <VideoComment>sample string 4</VideoComment>
</CreateVideoDownloadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean>true</boolean>