Skip to main content
Skip table of contents

Создание метки. VMS Client API

После создания метки придёт пуш с типом mark_created в канал user.ID

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

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

json

JSON
{
    "title": "Моя метка",
    "form": "2000-01-01T00:00:00Z"
}

cameraoptional

int

Идентификатор камеры, для которой нужно создать метку

titlerequired

string

Название метки

fromrequired

date

Дата начала метки

torequired

date

Дата окончания метки

Response

200

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

JSON
{
    "id": 1779416,
    "type": "mark",
    "type_pretty": "Метка",
    "title": "Моя метка",
    "can_delete": false,
    "from": "2020-00-00T00:00:00Z",
    "to": null,
    "camera_id": 894,
    "created_at": "2020-00-00T00:00:00Z",
    "updated_at": "2020-00-00 00:00:003"
}
401

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

422

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

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

Пример

JSON
curl -k --location --request POST 'https://vms.local/api/v1/cameras/{camera}/marks' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "title": "Моя метка",
    "form": "2000-01-01T00:00:00Z"
}'
JavaScript errors detected

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

If this problem persists, please contact our support.