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

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

GET /api/v1/billing/cameras/list

array group_id – ID группы, которой принадлежат домофоны.

array group_external_id – внешний ID группы, которой принадлежат домофоны.

array flat – номер квартиры, по которому будет отфильтрован список домофонов.

200 OK

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

JSON

{
    "data": [
        {
            "id": 1,
            "external_id": null,
            "department": 1
        },
        {
            "id": 2,
            "external_id": null,
            "department": 1
        }
    ],
    "links": {
        "first": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
        "last": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "http://127.0.0.1:8000/api/v1/billing/intercoms",
        "per_page": 25,
        "to": 2,
        "total": 2
    }
}

200 OK

Домофоны не были найдены

JSON

{
    "data": [],
    "links": {
        "first": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
        "last": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8000/api/v1/billing/intercoms?group_id=1&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "http://127.0.0.1:8000/api/v1/billing/intercoms",
        "per_page": 25,
        "to": null,
        "total": 0
    }
}

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 '{
    "group_id": [],
    "group_external_id": [],
    "flat": []
}'

PHP

$data = array (
  'group_id' => 
  array (
  ),
  'group_external_id' => 
  array (
  ),
  'flat' => 
  array (
  ),
);
$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);