Обновление Менеджера Реселлера
Метод Update a Reseller's Manager позволяет обновлять информацию о Менеджере (Сотруднике) текущего Реселлера или любого из его нижестоящих Реселлеров.
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
Обновление информации доступно:
- Сотрудникам с ролью Системный администратор (см. Роли сотрудников) — о любом Менеджере (Сотруднике) без ограничений.
- Сотрудникам с другими ролями — только о Менеджере (Сотруднике), токен которого указан в заголовке запроса.
PATCH {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | |||||
---|---|---|---|---|---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) | |||||
Content-Type | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности | |||||
Accept | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) | |||||
reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) | |||||
manager_id | path | integer | Обязательный | ID Менеджера | |||||
data | form | object | Обязательный | Информация об атрибутах операции | |||||
attributes | form | object | Обязательный | Атрибуты операции | |||||
name | form | string | Опциональный | Имя Менеджера | |||||
status | form | string | Опциональный | Статус Менеджера:
| |||||
role | form | string | Опциональный | Уровень доступа Менеджера в Панель управления Оператора (список ролей см. в Роли сотрудников) Изменение параметра role доступно только при использовании токена Сотрудника с ролью Системный администратор. | |||||
password | form | string | Опциональный | Пароль Менеджера для входа в Панель управления Оператора | |||||
phone | form | string | Опциональный | Номер телефона Менеджера в международном формате:
| |||||
manager_key | form | string | Опциональный | Уникальный ключ Менеджера | |||||
custom_attributes | form | object | Опциональный | Дополнительные параметры Менеджера (см. Настройка дополнительных параметров) | |||||
data | form | array | Опциональный | Информация о Дополнительных параметрах Менеджера | |||||
key | form | string | Опциональный | Ключ Дополнительного параметра Менеджера | |||||
value | form | string | Опциональный | Значение Дополнительного параметра Менеджера. В зависимости от типа данных значение Дополнительного параметра Менеджера указывается в следующем формате:
|
Модель ответа
В случае отсутствия ошибок метод возвращает обновленную информацию об указанном Менеджере (см. модель ответа в Получение информации о Менеджере Реселлера по ID).
Ошибки валидации для переданных параметров Менеджера отображаются аналогично Панели управления Оператора (см. Создание сотрудника реселлера в ActivePlatform. Руководство по Панели управления Оператора (Реселлера)).
Пример запроса
PATCH /api/v3/resellers/1/managers/483
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json
{
"data": {
"attributes": {
"status": "inactive"
}
}
}
Пример ответа
{
"data": {
"id": "483",
"type": "managers",
"attributes": {
"created_at": "2020-11-16T12:27:49.922+03:00",
"updated_at": "2020-11-16T17:38:03.779+03:00",
"reseller_id": 1,
"name": "Rudy McLaughlin",
"status": "inactive",
"email": "terry@example.net",
"role": "admin",
"phone": "+375290000000",
"photo": null,
"custom_attributes": {
"test": "1"
}
}
}
}