Обновление Менеджера Реселлера

Метод Update a Reseller's Manager позволяет обновлять информацию о Менеджере (Сотруднике) текущего Реселлера или любого из его нижестоящих Реселлеров.

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

Обновление информации доступно:

  • Сотрудникам с ролью Системный администратор (см. Роли сотрудников) — о любом Менеджере (Сотруднике) без ограничений.
  • Сотрудникам с другими ролями — только о Менеджере (Сотруднике), токен которого указан в заголовке запроса.
PATCH {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id}

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
AcceptheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)
manager_idpathintegerОбязательныйID Менеджера
dataformobjectОбязательныйИнформация об атрибутах операции

attributesformobjectОбязательный
Атрибуты операции


nameformstringОпциональный
Имя Менеджера


statusformstring

Опциональный

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

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


roleformstringОпциональный

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

Изменение параметра role доступно только при использовании токена Сотрудника с ролью Системный администратор.



passwordformstringОпциональныйПароль Менеджера для входа в Панель управления Оператора


phoneformstringОпциональный

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

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


manager_keyformstringОпциональныйУникальный ключ Менеджера


custom_attributesformobjectОпциональныйДополнительные параметры Менеджера (см. Настройка дополнительных параметров)



dataformarrayОпциональныйИнформация о Дополнительных параметрах Менеджера




keyformstringОпциональный
Ключ Дополнительного параметра Менеджера




valueformstringОпциональный

Значение Дополнительного параметра Менеджера.

В зависимости от типа данных значение Дополнительного параметра Менеджера указывается в следующем формате:

  • Логический тип:
    • 1 соответствует true
    • 0 соответствует false
  • Дата: ДД.ММ.ГГГГ
  • Список: Ключ элемента

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

В случае отсутствия ошибок метод возвращает обновленную информацию об указанном Менеджере (см. модель ответа в Получение информации о Менеджере Реселлера по 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"
            }
        }
    }
}