О домофонах

Запрос и параметры

Запрос на отчет о домофонах платформы. После получения успешного ответа приходит пуш-уведомление c типом generate_report со ссылкой на скачивание отчета.

POST /api/admin/v1/reports?type=intercoms

Параметры:

int top_group_id – месторасположение в дереве домофонов, фильтрация только по id верхних групп.

date from – дата начала.

date to – дата окончания.

string timezone – Часовой пояс для отображения даты создания в отчете. Пример: Europe/Paris.

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/reports?type=intercoms' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "top_group_id": 0,
    "from": "date",
    "to": "date",
    "timezone": "string"
}'

PHP

$data = array (
  'top_group_id' => 0,
  'from' => 'date',
  'to' => 'date',
  'timezone' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/reports?type=intercoms', false, $context);

Ответы на запрос

Детальный перечень кодов возможных ответов смотрите в разделе «Общее описание API».

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

201 Created

JSON

{
    "id": 6438,
    "type": "intercoms",
    "from": "2023-05-24",
    "to": "2023-05-24",
    "url": "https://vms.local:8080/storage/",
    "created_at": "2023-03-09T13:15:35.000000Z"
}

Ответ с ошибкой:

401 Unauthorized

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