Переименование камеры. VMS Client API
Переименование камеры.
Error rendering macro 'macro-html' : Page loading failed
Headers |
Authorization | Bearer token |
Accept | application/json |
X-Client | ios-cctv|android-cctv|thick-legal|web |
X-UUID | unique device id |
Body |
json |
JSON
{
"name": "new name"
}
|
cameraoptional | int | Идентификатор камеры |
namerequired | string | Новое название камеры |
Response |
200 | Объект камеры |
JSON
{
"id": 787,
"group_id": 100,
"status": "inactive",
"type": "media_server_v2",
"start_at": "2022-03-16 17:25:44",
"created_at": "2022-02-03 10:30:28",
"billing_id": null,
"pretty_name": "new name",
"pretty_text": "Камеры",
"short_address": "Камеры",
"full_address": "Камеры",
"lat": null,
"lng": null,
"azimuth": null,
"streams": [
{
"id": 847,
"type": "low",
"camera_id": 787,
"is_preview_from_server": true,
"is_archive_from_server": null,
"status": "inactive",
"has_sound": false,
"width": 320,
"height": 240
},
{
"id": 848,
"type": "high",
"camera_id": 787,
"is_preview_from_server": true,
"is_archive_from_server": null,
"status": "inactive",
"has_sound": false,
"width": 1920,
"height": 1080
}
],
"services": {
"ptz": false,
"motion_detect": false
},
"has_sound": false,
"is_archive_recording": true,
"is_bridge": false,
"is_favorite": false,
"user_status": "active",
"name": "new name"
}
|
401 | Токен авторизации не передан или не валидный, см. Получение токена |
422 | Возвращает JSON объект с ошибкой, см. Валидация |
JSON
{
"message": "Тут не будет информативного сообщения",
"errors": {
"any_key": [
"Тут будет описана причина ошибки"
]
}
}
|
404 | Если камера не принадлежит пользователю или не существует |
Пример |
JSON
curl -k --location --request POST 'https://vms.local/api/v1/cameras/{camera}/rename' \
--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 '{
"name": "new name"
}'
|