Список событий подсчета людей

Список событий подсчета людей в области.

GET /api/v1/analytic-case/{case}/person-counting/history

Параметры метода

int case, Уникальный идентификатор кейса аналитики

int per_page, Кол-во элементов в одной странице пагинации. По умолчанию 25 элементов

string date, Шаблон для фильтрации по дате. Это поле обязательно, когда нет фильтрации по полям from, to

array cameras, Массив id камер, по которым будут отображаться события

string timezone, Часовой пояс для шаблона фильтрации по дате. Пример - Europe/Paris.

string from, Дата, от которой будет осуществляться фильтрация. Это поле обязательно, когда нет фильтрации по полю date

string to, Дата, до которой будет осуществляться фильтрация. Это поле обязательно, когда нет фильтрации по полю date

200 OK

Успешный ответ

JSON

{
    "data": [
        {
            "camera": {
                "id": 746,
                "name": "Камера 1"
            },
            "created_at": "2022-04-07T15:18:38000000Z",
            "event": {
                "id": 28,
                "name": "person-counting",
                "description": "Подсчет людей в области",
                "color": "#1564A6",
                "analytic_type": "person-counting"
            },
            "person_count": 2,
            "crop": "base64content"
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/analytic-case/936/person-counting/history?per_page=24&page=1",
        "last": "https://vms.local/api/v1/analytic-case/936/person-counting/history?per_page=24&page=35",
        "prev": null,
        "next": "https://vms.local/api/v1/analytic-case/936/person-counting/history?per_page=24&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 35,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/analytic-case/936/person-counting/history?per_page=24&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://vms.local/api/v1/analytic-case/936/person-counting/history?per_page=24&page=2",
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/analytic-case/936/person-counting/history",
        "per_page": 24,
        "to": 24,
        "total": 827
    }
}

401 Unauthorized

Токен авторизации не передан или не валидный

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. VMS Client/Общая информация/Валидация клиента

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/v1/analytic-case/{case}/person-counting/history' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "case": 0,
    "per_page": 0,
    "date": "string",
    "cameras": [],
    "timezone": "string",
    "from": "string",
    "to": "string"
}'

PHP

$data = array (
  'case' => 0,
  'per_page' => 0,
  'date' => 'string',
  'cameras' => 
  array (
  ),
  'timezone' => 'string',
  'from' => 'string',
  'to' => 'string',
);
$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/analytic-case/{case}/person-counting/history', false, $context);