Обновление менеджера реселлера
Метод Update manager позволяет обновлять информацию о менеджере (сотруднике) текущего реселлера или любого из его нижестоящих реселлеров.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
Обновление информации доступно:
- Сотрудникам с ролью Системный администратор (см. Роли сотрудников) — о любом менеджере (сотруднике) без ограничений.
- Сотрудникам с другими ролями — только о менеджере (сотруднике), токен которого указан в заголовке запроса.
PATCH {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}
Аргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание | |||||
---|---|---|---|---|---|---|---|---|---|
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 текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) | |||||
manager_id | path | integer | Обязательный | ID сотрудника | |||||
data | form | object | Обязательный | Информация об атрибутах операции | |||||
attributes | form | object | Обязательный | Атрибуты операции | |||||
name | form | string | Опциональный | Имя сотрудника | |||||
status | form | string | Опциональный | Статус сотрудника:
| |||||
role | form | string | Опциональный | Уровень доступа сотрудника в Панель управления Оператора (список ролей см. в Роли сотрудников) Изменение параметра | |||||
password | form | string | Опциональный | Пароль сотрудника для входа в Панель управления Оператора. Требования к паролю см. в Настройки пароля | |||||
phone | form | string | Опциональный | Номер телефона сотрудника в международном формате:
| |||||
manager_key | form | string | Опциональный | Уникальный ключ сотрудника Ключ позволяет автоматически привязывать к менеджеру клиентов (см. Просмотр и обновление информации о клиенте), воспользовавшихся специальной ссылкой при заказе новой услуги через Витрину (см. manager_key в Шаблон ссылки для заказа услуги через Витрину). Ключ может содержать латинские буквы, цифры, точки, дефисы и символы подчеркивания. Ключ менеджера чувствителен к регистру. Важно указывать в ссылке ключ так, как он указан на странице менеджера. Например, carter81 и Carter81 — это разные ключи, они не будут работать вместе для одного менеджера. | |||||
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"
}
}
}
}