Список кодов администратора

Список кодов

Список всех созданных кодов по конкретному домофону.

GET /api/admin/v1/intercom/{intercom}/codes

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

int intercom, Идентификатор домофона, коды которого нужно получить

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

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

200 OK

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

JSON

{
    "data": [
        {
            "id": 7,
            "title": "title",
            "code": "93552",
            "expired_at": "2023-12-22T00:00:00.000000Z",
            "is_expired": false,
            "will_deleted_at": "2023-12-23T00:00:00.000000Z",
            "created_at": "2023-12-21T14:31:14.000000Z",
            "intercom_flat": {
                "id": 2,
                "flat": 2,
                "key_count": null,
                "users_count": null,
                "intercom_id": 5,
                "properties": {
                    "is_analog_line_enable": false,
                    "is_can_manage_resistance": false,
                    "handset_ring_analog_volumes": null,
                    "handset_talk_analog_volumes": null,
                    "panel_talk_analog_volumes": null,
                    "panel_system_volumes": null
                }
            }
        },
        {
            "id": 6,
            "title": null,
            "code": "16233",
            "expired_at": "2023-12-22T00:00:00.000000Z",
            "is_expired": false,
            "will_deleted_at": "2023-12-23T00:00:00.000000Z",
            "created_at": "2023-12-21T14:30:42.000000Z",
            "intercom_flat": {
                "id": 2,
                "flat": 2,
                "key_count": null,
                "users_count": null,
                "intercom_id": 5,
                "properties": {
                    "is_analog_line_enable": false,
                    "is_can_manage_resistance": false,
                    "handset_ring_analog_volumes": null,
                    "handset_talk_analog_volumes": null,
                    "panel_talk_analog_volumes": null,
                    "panel_system_volumes": null
                }
            }
        },
        {
            "id": 2,
            "title": null,
            "code": "823949",
            "expired_at": "2023-12-22T00:00:00.000000Z",
            "is_expired": false,
            "will_deleted_at": "2023-12-23T00:00:00.000000Z",
            "created_at": "2023-12-21T14:23:49.000000Z",
            "intercom_flat": null
        }
    ],
    "links": {
        "first": "https://vms.local:8000/api/admin/v1/intercom/codes?page=1",
        "last": "https://vms.local:8000/api/admin/v1/intercom/codes?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://vms.local:8000/api/admin/v1/intercom/codes?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://vms.local:8000/api/admin/v1/intercom/codes",
        "per_page": 25,
        "to": 6,
        "total": 6
    }
}

401 Unauthorized

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

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. VMS Admin/Общая информация панели администратора/Валидация администратора

JSON

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

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercom/{intercom}/codes' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "intercom": 0,
    "per_page": 0,
    "page": 0
}'

PHP

$data = array (
  'intercom' => 0,
  'per_page' => 0,
  '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/admin/v1/intercom/{intercom}/codes', false, $context);