Получение спискa камер внешней системой

Метод и параметры

GET /api/v1/billing/cameras/list

array cameras_ids required – массив идентификаторов камер (id). Максимум 30 элементов. Обязателен если не присланы cameras_uuid или login.

array cameras_uuid required – массив идентификаторов камер (external_id). Максимум 30 элементов Обязателен если не присланы cameras_ids или login.

string login required – логин пользователя, список камер которого нужно получить. Обязателен если не присланы cameras_ids или cameras_uuid.

bool paginate – управляет включением пагинации в ответе. В случае если значение положительно, ответ будет содержать блоки пагинации (разделение результатов на страницы).

int page – номер страницы пагинации. Применяется, если paginate - имеет положительное значение.

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

200 OK

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

JSON

[
    {
        "id": 3,
        "external_id": "3",
        "start_at": null,
        "status": "active",
        "name": "Camera 1",
        "group_type": "public",
        "streams": [
            {
                "type": "high",
                "status": "active",
                "camera_id": 3
            },
            {
                "type": "low",
                "status": "active",
                "camera_id": 3
            }
        ]
    },
    {
        "id": 4,
        "external_id": "4",
        "start_at": null,
        "status": "active",
        "name": "Camera 2",
        "group_type": "private",
        "streams": [
            {
                "type": "high",
                "status": "active",
                "camera_id": 4
            },
            {
                "type": "low",
                "status": "active",
                "camera_id": 4
            }
        ]
    }
]

200 OK

Камеры не были найдены

JSON

null

422 Unprocessable Entity

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

JSON

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

cURL

Bash

curl -k --request GET \
	--url 'https://your-domain/api/v1/billing/cameras/list' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "cameras_ids": [],
    "cameras_uuid": [],
    "login": "string",
    "paginate": true,
    "page": 0,
    "per_page": 0
}'

PHP

$data = array (
  'cameras_ids' => 
  array (
  ),
  'cameras_uuid' => 
  array (
  ),
  'login' => 'string',
  'paginate' => true,
  'page' => 0,
  'per_page' => 0,
);
$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/billing/cameras/list', false, $context);