Получение списка Менеджеров всех нижестоящих Реселлеров
Метод Get a List of the Child Reseller's Managers используется для получения списка Менеджеров, существующих у всех Реселлеров, являющихся нижестоящими по отношению к текущему Реселлеру, или по отношению к его выбранному нижестоящему Реселлеру.
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_managersАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
| Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности |
| Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) |
| reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) |
| page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) |
| page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
Модель ответа
Название | Тип данных | Описание | |||
|---|---|---|---|---|---|
| data | array | Данные ответа | |||
id | integer | ID Менеджера | |||
| type | string | Тип данных | |||
| attributes | integer | Информация о Менеджере | |||
created_at | date | Дата и время создания Менеджера | |||
updated_at | date | Дата и время последнего изменения Менеджера | |||
| reseller_id | integer | ID Реселлера | |||
| name | string | Имя Менеджера | |||
| status | string | Статус Менеджера:
| |||
| string | Адрес email Менеджера, который используется для входа в Панель управления Оператора | ||||
| role | string | Уровень доступа Менеджера в Панель управления Оператора (список ролей см. в Роли сотрудников) | |||
| custom_attributes | array | Перечень дополнительных параметров Менеджера (см. Просмотр списка дополнительных параметров) | |||
| 'attribute.name' | string | Значение параметра | |||
| links | array | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | |||
| self | string | Ссылка на текущую страницу | |||
| first | string | Ссылка на первую страницу | |||
| prev | string | Ссылка на предыдущую страницу | |||
| next | string | Ссылка на следующую страницу | |||
| last | string | Ссылка на последнюю страницу | |||
Пример запроса
GET /api/v3/resellers/1/child_reseller_managers?page[size]=2&page[number]=58
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": [
{
"id": "231",
"type": "managers",
"attributes": {
"created_at": "2020-02-13T02:48:42.866+03:00",
"updated_at": "2020-02-13T03:27:24.889+03:00",
"reseller_id": 298,
"name": "Roman Bezmenko",
"status": "active",
"email": "roman@example.com",
"role": "admin",
"custom_attributes": {}
}
},
{
"id": "222",
"type": "managers",
"attributes": {
"created_at": "2019-04-11T08:48:33.325+03:00",
"updated_at": "2020-02-08T07:55:29.304+03:00",
"reseller_id": 283,
"name": "Ivan Blinnik",
"status": "active",
"email": "example@gmail.com",
"role": "sales",
"custom_attributes": {
"child attr": "test"
}
}
}
],
"links": {
"self": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_managers?page%5Bnumber%5D=58&page%5Bsize%5D=2",
"first": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_managers?page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_managers?page%5Bnumber%5D=57&page%5Bsize%5D=2",
"next": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_managers?page%5Bnumber%5D=59&page%5Bsize%5D=2",
"last": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_managers?page%5Bnumber%5D=60&page%5Bsize%5D=2"
}
}