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

Метод Get a List of the Reseller's Managers используется для получения списка Менеджеров (Сотрудников) текущего Реселлера или любого из его нижестоящих Реселлеров.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

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

Аргументы

Название

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

Тип данных

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

Описание

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

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

Название

Тип данных

Описание

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


id

stringID Менеджера

typestringТип данных

attributesobjectИнформация о Менеджере


created_at

dateДата и время создания Менеджера


updated_at

dateДата последнего обновления информации о Менеджере


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


namestringИмя Менеджера


statusstring

Статус Менеджера:

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


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


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


phonestring

Номер телефона Менеджера в международном формате:

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


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


manager_keystringУникальный ключ Менеджера


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",
                "role": "admin",
                "phone": "+375280000000",
                "photo": "/images/manager/431/manager.png",
				"manager_key": "",
                "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",
                "role": "sales",
                "phone": "+375270000000",
                "photo": "/images/manager/432/432.jpg",
				"manager_key": "",
                "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"
    }
}