Список ключей домофонa

Список ключей домофона

GET /api/admin/v1/intercoms/{intercom}/keys

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

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

int page, Номер страницы пагинации

string search,

string sort, Поле, по которому нужно отсортировать сервера

string dir, В каком направлении нужно отсортировать. desc - от большего к меньшему, asc - от меньшего к большему

date from, Начало интервала времени

date to, Конец интервала времени

integer user_id, Фильтрация по пользователю

array exclude_keys_id, Список ключей, которые нужно исключить

bool unbound_users, true - Получить только те ключи, которые не привязаны к пользователям

false - Получить ключи, привязанные к пользователю

bool unbound_flats, true - Получить только те ключи, которые не привязаны к квартире

false - Получить ключи, привязанные к квартире

integer intercom_flat_id, Получить все ключи квартиры

200 OK

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

JSON

{
    "data": [
        {
            "id": 1,
            "key": "0000003042CAAC",
            "user": null,
            "flat": {
                "id": 1,
                "flat": 1,
                "key_count": null,
                "users_count": null,
                "number": "91201692@vgw1.vms.local",
                "landline_number": "ххххххххххх",
                "is_smartphone_sip_line_available": true,
                "is_landline_sip_line_available": false,
                "is_analog_line_enable": false,
                "is_sip_line_enable": false
            },
            "created_at": "2022-11-11 14:46:16",
            "updated_at": "2022-11-11 14:46:16",
            "deleted_at": null
        },
        {
            "id": 2,
            "key": "000000A3B48D3C",
            "user": null,
            "flat": null,
            "created_at": "2022-11-11 14:46:16",
            "updated_at": "2022-11-11 14:46:16"
        },
        {
            "id": 3,
            "key": "000000418D363A",
            "user": null,
            "flat": null,
            "created_at": "2022-11-11 14:46:16",
            "updated_at": "2022-11-11 14:46:16"
        },
        {
            "id": 4,
            "key": "000000417EE9AA",
            "user": null,
            "flat": null,
            "created_at": "2022-11-11 14:46:16",
            "updated_at": "2022-11-11 14:46:16"
        },
        {
            "id": 5,
            "key": "0000003043CAAC",
            "user": null,
            "flat": null,
            "created_at": "2022-11-14 14:26:40",
            "updated_at": "2022-11-14 14:26:40"
        }
    ],
    "links": {
        "first": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=1",
        "last": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2",
        "prev": null,
        "next": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://vms.local:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2",
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8080/api/admin/v1/intercoms/1/keys",
        "per_page": 5,
        "to": 5,
        "total": 8
    }
}

401 Unauthorized

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/{intercom}/keys' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "page": 0,
    "search": "string",
    "sort": "string",
    "dir": "string",
    "from": "date",
    "to": "date",
    "user_id": "integer",
    "exclude_keys_id": [],
    "unbound_users": true,
    "unbound_flats": true,
    "intercom_flat_id": "integer"
}'

PHP

$data = array (
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'from' => 'date',
  'to' => 'date',
  'user_id' => 'integer',
  'exclude_keys_id' => 
  array (
  ),
  'unbound_users' => true,
  'unbound_flats' => true,
  'intercom_flat_id' => 'integer',
);
$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/admin/v1/intercoms/{intercom}/keys', false, $context);