Skip to main content
Skip table of contents

Get the list of marks for the camera

Get the list of marks for the camera

Works exactly the same as VMS Client/Marks/List of Marks, but returns marks within one camera, but not more than 1000 pieces

GET /api/v1/cameras/{camera}/marks

Parameters

int camera, Camera ID


date from, Date from which labels will be displayed


date to, Date until which labels will be displayed


array types, Only types from the types array will be in the response.

200 OK

Successful response

JSON
[
    {
        "id": 1779416,
        "type": "motion_detect_smtp",
        "type_pretty": "SMTP Movement Detection",
        "title": "SMTP Movement Detection",
        "can_delete": false,
        "from": "2022-04-07 12:38:08",
        "to": null,
        "camera_id": 894,
        "created_at": "2022-04-07 12:38:03",
        "updated_at": "2022-04-07 12:38:03",
        "color": "#EDD500"
    }
]

401 Unauthorized

Authorization token not sent or not valid

403 Forbidden

If you requested a label type that is not available to the current user

422 Unprocessable Entity

Returns a JSON object with an error.

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}
cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/v1/cameras/{camera}/marks' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "camera": 0,
    "from": "date",
    "to": "date",
    "types": []
}'
PHP
PHP
$data = array (
  'camera' => 0,
  'from' => 'date',
  'to' => 'date',
  'types' => 
  array (
  ),
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/cameras/{camera}/marks', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.