Метод: Активация/деактивация пользователя
Метод служит для активации/деактивации пользователя на платформе promotivation.
URL
PATCH {домен}/api/v2/user/activation
Описание
С помощью данного метода можно деактивировать пользователя, в таком случае он теряет доступ к платформе, при этом его данные сохраняются в системе. Существует возможность активировать деактивированного пользователя, в таком случае доступ к платформе восстановится.
Структура запроса
Пример запроса
Формат запроса:
PATCH {домен}/api/v2/user/add
"Authorization: Bearer 1jijdsaohdiadibbcsanco……"
"Content-Type: application/json"
{
"idExternal": "dkfsa124ksad",
"userStatu": "True"
}
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование |
|---|---|---|---|---|
Authorization |
string | Уникальный токен аутентификации | Да | Нет |
idExternal |
string | Внешний идентификатор пользователя. | Да | Да |
userStatus |
bool | Желаемый статус пользователя. True – активировать. False – деактивировать. | Да | Да |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"idExternal": "dkfsa124ksad"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус |
idExternal |
string | Внешний идентификатор пользователя |
Пример ответа с ошибкой
{
"status": "INVALID_FIELDS",
"message: " The fields are uncorrected quantity, offset ".
}
Параметры ответа с ошибками
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус ошибки |
message |
string | Информационное сообщение |
Возможные ошибки
| Статус | Описание |
|---|---|
INVALID_FIELDS |
Некорректное поле. Поле не соответствует требованиям. |
USER_NOT_FOUND |
Пользователь не найден |
TOKEN_ERROR |
Токен не найден |