library.category.delete

Scope: library

Кто может вызывать: Модератор категорий.

Удаляет категорию только если в ней нет книг (включая неактивные). Перед удалением проверяется booksCount по всем элементам раздела.

HTTP: POST

Побочные эффекты: Удаляет раздел iblock.

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

Параметр Тип Обяз. Описание
id int да ID категории

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

Поле Тип Описание
id int ID удалённой категории

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

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

Код Описание
PERMISSION_DENIED Нет прав модератора категорий
NOT_FOUND Категория не найдена (details.id)
CATEGORY_HAS_BOOKS В категории есть книги (details.id, details.booksCount)
VALIDATION_ERROR Сбой удаления на стороне iblock (details.id)

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

curl -X POST "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.category.delete.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "id": 81
        }'

Пример ответа (успех)

{
          "result": {
            "result": {
              "id": 89
            },
            "error": null
          }
        }

Пример ошибки (категория с книгами)

{
          "result": {
            "result": null,
            "error": {
              "code": "CATEGORY_HAS_BOOKS",
              "message": "Нельзя удалить категорию, в которой есть книги.",
              "details": {
                "id": 81,
                "booksCount": 12
              }
            }
          }
        }

Пример ошибки (категория не найдена)

{
          "result": {
            "result": null,
            "error": {
              "code": "NOT_FOUND",
              "message": "Категория не найдена.",
              "details": {
                "id": 999999999
              }
            }
          }
        }

См. также

Предыдущая
library.category.update
Следующая
Обзор раздела