Breadcrumbs

Сoздание домофона

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

POST  /api/v1/billing/intercoms

JSON
{
    "group_external_id": "00000000-0000-0000-0000-000000000001",
    "flat_from": 1,
    "flat_to": 15,
    "serial_number": "serial_number",
    "mac": "AA:BB:CC:DD:EE:FF",
    "vendor": "interconnection",
    "model": "3516EV200",
    "name": "intercom name",
    "department": 1,
    "log_extra": {
        "some": "information"
    }
}

Параметры метода

integer group_id  required – ID группы (адреса), в которую нужно поместить домофон.


string group_external_id – внешний ID группы (адреса). Используется вместо group_id.


integer flat_from – номер первой квартиры в диапазоне квартир, подключённых к домофону.


integer flat_to – номер последней квартиры в диапазоне квартир, подключённых к домофону.


string serial_number  required – серийный номер панели.


string mac  required – MAC-адрес панели в формате `AA:BB:CC:DD:EE:FF`.


string vendor  required – производитель домофона.


string model  required – модель панели. Должна поддерживаться указанным производителем.


string name  required – название домофона/входа (отображается пользователям).


integer department  required – номер подъезда: от 1 до 10 000.


string|array log_extra – дополнительная информация, получаемая из внешней системы.

201  Created

Домофон успешно создан

JSON
{
    "id": 1,
    "external_id": null,
    "department": 1,
    "title": "intercom name",
    "mac": "A:BB:CC:DD:EE:FF",
    "model": "3516EV200",
    "serial_number": "serial_number",
    "status": "empty",
    "flat_from": 1,
    "flat_to": 15,
    "source": "auto"
}

401  Unauthorized

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

422  Unprocessable Entity

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

JSON
{
    "message": "Валидация не пройдена",
    "errors": {
        "mac": [
            "Такой MAC-адрес уже существует"
        ],
        "error": [
            "Модель панели не поддерживается указанным производителем"
        ]
    }
}
cURL
Bash
curl -k --request POST \
	--url 'https://your-domain/api/v1/billing/intercoms' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "group_id": "integer",
    "group_external_id": "string",
    "flat_from": "integer",
    "flat_to": "integer",
    "serial_number": "string",
    "mac": "string",
    "vendor": "string",
    "model": "string",
    "name": "string",
    "department": "integer",
    "log_extra": "string|array"
}'
PHP
PHP
$data = array (
  'group_id' => 'integer',
  'group_external_id' => 'string',
  'flat_from' => 'integer',
  'flat_to' => 'integer',
  'serial_number' => 'string',
  'mac' => 'string',
  'vendor' => 'string',
  'model' => 'string',
  'name' => 'string',
  'department' => 'integer',
  'log_extra' => 'string|array',
);
$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/v1/billing/intercoms', false, $context);