ipr.event.delete

Scope: ipr

Кто может вызывать: Пользователь с правом удалять каталог (canDelete: администратор, HR или право section_delete на инфоблок). Подробнее: Модель доступа

Удаляет мероприятие каталога вместе со всеми его датами проведения в календаре.

HTTP: POST

Побочные эффекты: Каскадно удаляет календарные события дат проведения, затем сам элемент каталога (штатным удалением элемента инфоблока). Необратимо. Если мероприятие используется в действиях ИПР, без force удаление отклоняется.

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

Параметр Тип Обяз. Описание
id int да ID мероприятия
force bool нет true — удалить, даже если мероприятие используется в действиях ИПР. По умолчанию false

Вызов не идемпотентен: повтор после успеха вернёт NOT_FOUND; трактуйте его как «уже удалено».

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

Поле Тип Описание
id int ID удалённого мероприятия
deleted bool Всегда true
datesDeleted int Сколько календарных событий дат проведения удалено

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR event_in_use: мероприятие используется в действиях ИПР, details.iprActionCount — их число; повторите с force=true или деактивируйте мероприятие через ipr.event.update
NOT_FOUND Мероприятие не найдено (в том числе при повторном вызове)
PERMISSION_DENIED Нет права canDelete
INTERNAL_ERROR event_delete_failed и др.

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/ipr.event.delete.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "id": 501,
          "force": false
        }'

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

{
          "result": {
            "result": {
              "id": 501,
              "deleted": true,
              "datesDeleted": 3
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
ipr.event.update
Следующая
ipr.event.date.add