gamification.rating.delete
Scope:
gamificationКто может вызывать: Пользователь с правом на изменение настроек модуля (уровень доступа к модулю выше «чтения»; у администратора портала оно есть всегда). Подробнее: Права доступа
Удалить рейтинг — так же, как кнопка удаления на вкладке «Рейтинги» настроек модуля. «Общий» рейтинг (CODE = total) удалить нельзя.
HTTP: POST
Побочные эффекты: удаляется элемент инфоблока рейтингов, агенты пересчёта этого рейтинга снимаются.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id |
int |
да | ID рейтинга (псевдонимы: ID, ratingId) |
Возвращаемые данные
result.result — { "id": <ID>, "deleted": true }.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Нет права на изменение настроек модуля |
VALIDATION_ERROR |
Не передан id |
NOT_FOUND |
Элемент с таким id не является рейтингом |
DELETE_FORBIDDEN |
«Общий» рейтинг или удаление отклонено обработчиком |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.rating.delete.json" \
-H "Content-Type: application/json" \
-d '{"id": 915}'
Пример ответа:
{
"result": {
"result": { "id": 915, "deleted": true },
"total": null,
"next": null,
"error": null
}
}
См. также
Предыдущая
Следующая