ipr.course.review.delete

Scope: ipr

Кто может вызывать: Автор отзыва (удаляет свой) либо администратор (любой отзыв, через userId). Подробнее: Модель доступа

Удаляет отзыв пользователя о курсе: сообщение форума и оценку. Метод идемпотентен: повторный вызов возвращает deleted: false.

HTTP: POST

Побочные эффекты: Удаляет сообщение форума (ищется по курсу, форуму, теме и автору — чужие форумы недостижимы) и строку оценки; рейтинг курса пересчитывается.

Параметры метода

Параметр Тип Обяз. Описание
courseId int да ID курса
userId int нет Автор отзыва. По умолчанию — текущий пользователь; другой — только администратор

Возвращаемые данные

Поле Тип Описание
courseId int ID курса
userId int Автор отзыва
deleted bool Что-то было удалено (сообщение или оценка)
messageDeleted bool Сообщение форума удалено
ratingDeleted bool Оценка удалена

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR courseId не передан или некорректен
PERMISSION_DENIED userId чужого пользователя передан не администратором
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.course.review.delete.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{"courseId": 305}'

Пример ответа

{
          "result": {
            "result": {
              "courseId": 305,
              "userId": 15,
              "deleted": true,
              "messageDeleted": true,
              "ratingDeleted": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.course.review.add
Следующая
Обзор раздела