Получение списка менеджеров

Метод Get list of managers используется для получения списка менеджеров (сотрудников) текущего реселлера или любого из его нижестоящих реселлеров.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

GET {base_url}/api/v3/resellers/{reseller_id}/managers

Аргументы

Название

Тип параметра

Тип данных

Обязательный/ 
Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform
reseller_idpathintegerОбязательныйID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)
page[size]queryintegerОпциональныйПараметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию)
page[number]queryintegerОпциональныйПараметр постраничной навигации. Номер страницы ответа

Модель ответа

Название

Тип данных

Описание

dataarray of objectsДанные ответа


id

stringID сотрудника

typestringТип данных

attributesobjectИнформация о сотруднике


created_at

stringДата и время создания сотрудника


updated_at

stringДата последнего обновления информации о сотруднике


reseller_idintegerID реселлера, к которому относится сотрудник


namestringИмя сотрудника


statusstring

Статус сотрудника:

  • active — доступ в Панель управления Оператора разрешен.
  • inactive — доступ в Панель управления Оператора заблокирован.


emailstringАдрес email сотрудника, который используется для входа в Панель управления Оператора


manager_roleobjectРоль сотрудника в Панель управления Оператора (список ролей см. в Роли сотрудников и Получение списка ролей менеджеров)



idintegerID роли. Для администратора на корневом уровне возвращает null



namestringНазвание роли. Для администратора на корневом уровне возвращает null


phonestring

Номер телефона сотрудника в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


photostringСсылка на файл фотографии сотрудника


manager_keystring

Уникальный ключ сотрудника

Ключ позволяет автоматически привязывать к менеджеру клиентов (см. Просмотр и обновление информации о клиенте), воспользовавшихся специальной ссылкой при заказе новой услуги через Витрину (см. manager_key в Шаблон ссылки для заказа услуги через Витрину). Ключ может содержать латинские буквы, цифры, точки, дефисы и символы подчеркивания. Ключ менеджера чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице менеджера. Например, carter81 и Carter81 — это разные ключи, они не будут работать вместе для одного менеджера.



mfa_requiredbool

Статус многофакторной аутентификации (MFA) менеджера (см. Просмотр и обновление информации о сотруднике):

  • true — статус MFA менеджера Активный.
  • false — статус MFA менеджера Неактивный.


custom_attributesobject

дополнительные параметры сотрудника (см. Просмотр списка дополнительных параметров)




['custom_attribute_key']stringЗначение дополнительного параметра сотрудника с указанным ключом
linksobjectСсылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации

selfstringСсылка на текущую страницу

firststringСсылка на первую страницу

prevstringСсылка на предыдущую страницу

nextstringСсылка на следующую страницу

laststringСсылка на последнюю страницу

Пример запроса

GET /api/v3/resellers/1/managers?page[size]=2&page[number]=48
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
    "data": [
        {
            "id": "431",
            "type": "managers",
            "attributes": {
                "created_at": "2021-01-05T05:28:48.804+03:00",
                "updated_at": "2021-01-05T06:23:10.815+03:00",
                "reseller_id": 1,
                "name": "Brendon Leannon",
                "status": "active",
                "email": "carter81@example.net",
                "manager_role": {
                    "id": null,
                    "name": null
                },
                "phone": "+375280000000",
                "photo": "/images/manager/431/manager.png",
                "manager_key": "",
                "mfa_required": true, 
                "custom_attributes": {
                    "manager_1c_identifier": ""
                }
            }
        },
        {
            "id": "432",
            "type": "managers",
            "attributes": {
                "created_at": "2021-01-08T21:33:32.789+03:00",
                "updated_at": "2021-01-08T21:34:29.005+03:00",
                "reseller_id": 1,
                "name": "Trycia Corwin",
                "status": "active",
                "email": "tryciacorwin71@example.net",
                "manager_role": {
                    "id": 1,
                    "name": "Full control"
                },
                "phone": "+375270000000",
                "photo": "/images/manager/432/432.jpg",
                "manager_key": "",
                "mfa_required": true, 
                "custom_attributes": {
                    "manager_1c_identifier": "20"
                }
            }
        }
    ],
    "links": {
        "self": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=48&page%5Bsize%5D=2",
        "first": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=1&page%5Bsize%5D=2",
        "prev": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=47&page%5Bsize%5D=2",
        "next": null,
        "last": "https://test.activeplatform.com/api/v3/resellers/1/managers?page%5Bnumber%5D=48&page%5Bsize%5D=2"
    }
}