Получение списка ролей менеджеров
Метод Get list of roles используется для получения списка ролей менеджеров текущего реселлера (см. Роли менеджеров).
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/manager_roles
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
base_url | path | string | Обязательный | URL ActivePlatform |
reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать только ID текущего реселлера (см. Просмотр информации о реселлере) |
page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) |
page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
Модель ответа
Название | Тип данных | Описание | |||
---|---|---|---|---|---|
data | array of objects | Данные ответа | |||
id | string | ID роли | |||
type | string | Тип данных | |||
attributes | object | Информация о роли | |||
created_at | string | Дата и время создания роли | |||
updated_at | string | Дата последнего обновления информации о роли | |||
name | string | Название роли | |||
reseller_id | integer | ID реселлера, к которому относится роль | |||
links | object | Ссылки на страницы для навигации по элементам ответа с учетом заданных параметров постраничной навигации | |||
self | string | Ссылка на текущую страницу | |||
first | string | Ссылка на первую страницу | |||
prev | string | Ссылка на предыдущую страницу | |||
next | string | Ссылка на следующую страницу | |||
last | string | Ссылка на последнюю страницу |
Пример запроса
GET /api/v3/resellers/1/manager_roles
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
Пример ответа
{
"data": [
{
"id": "1",
"type": "manager_roles",
"attributes": {
"created_at": "2023-09-18T13:25:15.066+03:00",
"updated_at": "2023-09-18T13:25:15.066+03:00",
"name": "Full control",
"reseller_id": 1
}
},
{
"id": "2",
"type": "manager_roles",
"attributes": {
"created_at": "2023-09-18T13:25:38.378+03:00",
"updated_at": "2023-09-18T13:25:38.378+03:00",
"name": "Sales",
"reseller_id": 1
}
}
],
"links": {
"self": "https://test.activeplatform.com/api/v3/resellers/1/manager_roles?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"first": "https://test.activeplatform.com/api/v3/resellers/1/manager_roles?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"prev": null,
"next": null,
"last": "https://test.activeplatform.com/api/v3/resellers/1/manager_roles?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}