Вы можете списать баллы у пользователя и указать причину списания с помощью POST запроса на URL: /gamification/points/withdraw
Права пользователя для выполнения запроса: Владелец аккаунта, Администратор аккаунта, Администратор подразделения.
Администратор подразделения может начислять и списывать баллы у пользователей только в своем подразделении и вложенных в него подразделениях.
Методы добавления и удаления баллов не работают, если у вас ограничен доступ к изменению пользователей (см. Настройки роли).
Параметры запроса
Параметр | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта или Администратора подразделения. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта или Администратора подразделения. |
| user_id (обязательный) | ID пользователя, у которого нужно списать баллы. |
| amount (обязательный) | Количество баллов для списания. |
| reason (обязательный) | Причина списания баллов. |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | Successful operation | Баллы успешно списаны. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission denied | Недостаточно прав у пользователя для выполнения запроса. |
Пример запроса
POST /gamification/points/withdraw HTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password Content-Type: application/xml Accept: application/xml <?xml version="1.0" encoding="UTF-8"?> <withdrawGamificationPoints> <userId>2c180ffc-8841-11e9-b68a-0242c0a85016</userId> <amount>10</amount> <reason>string</reason> </withdrawGamificationPoints>
Пример ответа
HTTP/1.1 200 Successful operation Connection: close