library.book.list

Scope: library

Кто может вызывать: Сотрудник библиотеки.

Список книг. Черновики (active=false) — только при праве просмотра неопубликованных.

HTTP: GET

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы; по умолчанию 50, максимум 500
offset int нет Смещение; по умолчанию 0
fetchAll bool нет Вернуть все строки (защитный лимит fetchAllMax из library.schema)
filter object нет Mongo-style фильтр ($eq, $in, …); допускается JSON-строка. Алиасы: listFilter, mongoFilter

Поля filter (Mongo)

Поле Алиасы Описание
id bookId, elementId ID книги
name — Название
author — ID/xmlId/имя автора из enum
categoryId sectionId, categoryIds ID категории
paperVersion — bool / $eq / $ne
electronicVersion — bool
audioVersion — bool

Операторы: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Поля могут передаваться на верхнем уровне query — нормализатор объединит их с filter.

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

Объект книги в result.result (для list — массив таких объектов; также total, next на уровне Bitrix result):

Поле Тип Описание
id int ID элемента каталога
name string Название
code string Символьный код
sort int Сортировка
active bool Опубликована
categoryIds int[] ID категорий
createdBy int ID создавшего пользователя
dateCreate string Дата создания (формат портала)
authors string[] Имена авторов (не enum id)
paperVersion bool Бумажная версия
paperVersionCount int Заданное число экземпляров
showInCategoryRecommendations bool В рекомендациях категории
electronicVersion bool Электронная версия
electronicFileIds int[] ID файлов e-book
audioVersion bool Аудиоверсия
audioFileIds int[] ID аудиофайлов
publishYear string Год издания
annotation string Описание
link string Внешняя ссылка
price string Цена
previewPictureId int ID обложки
rating float Средний рейтинг
voteCount int Число голосов
reviewsCount int Число отзывов
availableCopies int Доступно экземпляров сейчас
isTakenByUser bool Взята текущим пользователем

Ответ в конверте модуля: result.result, result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет доступа к разделу «Библиотека»
INVALID_LIMIT limit вне диапазона 1..500
INVALID_OFFSET offset < 0
INVALID_FILTER Некорректный filter или неизвестное поле (details.allowed)
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра
FETCH_ALL_LIMIT_EXCEEDED При fetchAll=true записей больше защитного лимита
INTERNAL_ERROR Внутренняя ошибка

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

curl -G "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.book.list.json" --data-urlencode "limit=2" --data-urlencode "filter[paperVersion][$eq]=true"

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

{
          "result": {
            "result": [
              {
                "id": 1587,
                "name": "REST docs full updated 20260827-104957",
                "code": "rest_docs_full_20260827_104957",
                "sort": 510,
                "active": false,
                "categoryIds": [
                  135
                ],
                "createdBy": 1,
                "dateCreate": "27.08.2026 10:49:57",
                "authors": [
                  "Harvard Business Review"
                ],
                "paperVersion": true,
                "paperVersionCount": 3,
                "showInCategoryRecommendations": true,
                "electronicVersion": true,
                "electronicFileIds": [],
                "audioVersion": true,
                "audioFileIds": [],
                "publishYear": "2025",
                "annotation": "Обновлённое описание",
                "link": "https://example.com/updated",
                "price": "1200",
                "previewPictureId": 0,
                "rating": 0,
                "voteCount": 0,
                "reviewsCount": 0,
                "availableCopies": 3,
                "isTakenByUser": false
              },
              {
                "id": 1583,
                "name": "REST docs full updated 20260827-104932",
                "code": "rest_docs_full_20260827_104932",
                "sort": 510,
                "active": false,
                "categoryIds": [
                  135
                ],
                "createdBy": 1,
                "dateCreate": "27.08.2026 10:49:32",
                "authors": [
                  "Harvard Business Review"
                ],
                "paperVersion": true,
                "paperVersionCount": 3,
                "showInCategoryRecommendations": true,
                "electronicVersion": true,
                "electronicFileIds": [],
                "audioVersion": true,
                "audioFileIds": [],
                "publishYear": "2025",
                "annotation": "Обновлённое описание",
                "link": "https://example.com/updated",
                "price": "1200",
                "previewPictureId": 0,
                "rating": 0,
                "voteCount": 0,
                "reviewsCount": 0,
                "availableCopies": 3,
                "isTakenByUser": false
              }
            ],
            "error": null
          },
          "next": 2,
          "total": 12
        }

См. также

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