Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Запрос: POST /gamification/points/

...

withdraw

Заголовки

Заголовок

...

Права пользователя для выполнения запроса: Владелец аккаунтаАдминистратор аккаунтаАдминистратор подразделения.

Администратор подразделения может начислять и списывать баллы у пользователей только в своем подразделении и вложенных в него подразделениях.

Методы добавления и удаления баллов не работают, если у вас ограничен доступ к изменению пользователей (см. Настройки роли). 

Параметры запроса

Параметр

Описание

X-Auth-Account-Url (обязательный)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru
X-Auth-Email (обязательный)Логин Владельца Логин Владельца аккаунтаили Администратора, аккаунта Администратора подразделения или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)

Пароль Владельца Пароль Владельца аккаунтаАдминистратора аккаунтаАдминистратора, или Администратора подразделения. или пользователя с ролью с индивидуальными настройками

ПараметрОписание
user_id (обязательный)ID пользователя, у которого нужно списать баллы.
amount (обязательный)Количество баллов для списания.
reason (обязательный)Причина списания баллов. 

Права для выполнения запроса

Владелец аккаунтаАдминистратор аккаунтаАдминистратор подразделения или роль с индивидуальными настройками.

Администратор подразделения и пользователь с ролью с индивидуальными настройками могут списывать баллы у пользователей только в подразделениях, которыми управляют, и их дочерних подразделений.

Методы удаления баллов не работают, если у вас ограничен доступ к изменению пользователей (см. Настройки роли). 

Коды ответов

Код

Текст

Описание

200Successful operationБаллы успешно списаны.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса.

...

Блок кода
languagexml
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>

...