Skip to main content
Skip table of contents

Список событий. Распознавание лиц

Просмотр списка событий распознавания лиц.

GET/api/v1/analytic-case/{case}/face/history

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

caseoptional

int

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

per_pagerequired

int

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

camerasrequired

array

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

filesrequired

array

Массив id ресурсов, принадлежащих пользователю, по которым будут отображаться события

groupsrequired

array

Массив id групп ресурсов, принадлежащих пользователю, по которым будут отображаться события

daterequired

string

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

timezonerequired

string

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

fromrequired

string

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

torequired

string

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

eventsrequired

array

Массив id событий, по которым будет осуществляться фильтрация. Необязательный, список доступных id возвращатся в статике. Параметр external_events

similarity_fromrequired

int

Процент схожести, от которого будет осуществляться фильтрация

similarity_torequired

int

Процент схожести, до которого будет осуществляться фильтрация

Response

200

Возвращает список событий аналитики на i странице пагинации

JSON 
{
    "data": [
        {
            "crop": [
                ""
            ],
            "created_at": "2022-04-06 17:30:02",
            "rect": [
                [
                    744,
                    108,
                    40,
                    51
                ]
            ],
            "camera": {
                "id": 747,
                "group_id": 98,
                "status": "active",
                "type": "media_server_v2",
                "start_at": "2022-03-23 10:33:15",
                "created_at": "2022-01-27 19:13:18",
                "billing_id": null,
                "pretty_name": "Камера 1",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 737,
                        "type": "high",
                        "camera_id": 747,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1280,
                        "height": 960
                    },
                    {
                        "id": 738,
                        "type": "low",
                        "camera_id": 747,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1280,
                        "height": 960
                    }
                ],
                "has_sound": false,
                "is_archive_recording": true,
                "is_bridge": false,
                "is_favorite": false,
                "user_status": "active",
                "name": "Камера 1"
            },
            "analytic_group": {
                "id": 14,
                "name": "1",
                "type": "face_resource",
                "type_pretty": "Лица",
                "uuid": "2d951b2e-a92a-11ec-8995-a3b0e5228375",
                "created_at": "2022-03-21 18:18:36",
                "updated_at": "2022-03-21 18:18:36"
            },
            "analytic_file": {
                "id": 53,
                "name": "name.jpeg",
                "type": "face_resource",
                "type_pretty": "Лица",
                "uuid": null,
                "body": "",
                "url": "https://vms.local/storage/analytic-files/2022/3/21/WMUZQieuxkC1zm4XHVpTwRO3rd2ais1JLcMqzWJt.jpg",
                "created_at": "2022-03-21 18:18:33",
                "updated_at": "2022-03-21 18:18:33"
            },
            "similarity": 11,
            "event": {
                "id": 18,
                "name": "recognized-face",
                "description": "Лицо идентифицировано",
                "color": "#07D4F0",
                "analytic_type": "face"
            },
            "uuid": "e46844c5-24b1-433e-9031-e69b5f87a8b1",
            "is_can_open": true
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
        "last": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/analytic-case/945/face/history?per_page=24&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/analytic-case/945/face/history",
        "per_page": 24,
        "to": 1,
        "total": 1
    }
}

str crop, base64 изображение

str similarity, процент схожести crop с эталонным изображением

str uuid, уникальный идентификатор события кейса аналитики

bool is_can_open, отображает возможность открытия события, если true - было распознано n-e количество лиц в зоне/участке охвата камеры. Список событий по событию аналитики

401

Токен авторизации не передан или не валидный, см. Получение токена

422

Возвращает JSON объект с ошибкой, см. Валидация

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

Пример

JSON 
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/{case}/face/history?per_page=int&cameras=array&files=array&groups=array&date=string&timezone=string&from=string&to=string&events=array&similarity_from=int&similarity_to=int' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close