ipr.event.date.delete

Scope: ipr

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

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

HTTP: POST

Побочные эффекты: Удаляет календарное событие даты проведения и убирает его из мероприятия.

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

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

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

Поле Тип Описание
eventId int ID мероприятия
dateId int ID даты проведения
deleted bool Дата проведения принадлежала мероприятию и удалена
calendarDeleted bool Календарное событие удалено

Если dateId не принадлежит мероприятию, метод не возвращает ошибку: deleted: false, calendarDeleted: false, календарь не затрагивается. Поэтому повторный вызов безопасен.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR date_in_use: дата проведения выбрана в действиях ИПР (details.iprActionCount); повторите с force=true
NOT_FOUND Мероприятие не найдено (reason = event)
PERMISSION_DENIED Нет права canEdit
INTERNAL_ERROR link_event_save_failed, lock

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

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

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

{
          "result": {
            "result": {
              "eventId": 501,
              "dateId": 9001,
              "deleted": true,
              "calendarDeleted": true
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

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