library.book.get

Scope: library

Кто может вызывать: Сотрудник; черновик — только с правом просмотра.

Карточка книги по ID.

HTTP: GET

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

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

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

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

Объект книги в 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.

Код Описание
NOT_FOUND Книга не найдена или нет прав на просмотр

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

curl -G "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.book.get.json" --data-urlencode "id=1177"
        

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

{
          "result": {
            "result": {
              "id": 1177,
              "name": "REST test: полная книга 5",
              "code": "rest_test_polная_kniga",
              "sort": 500,
              "active": false,
              "categoryIds": [
                83,
                84
              ],
              "createdBy": 1,
              "dateCreate": "25.08.2026 12:33:23",
              "authors": [
                "Альфи Кон",
                "Стивен Кови"
              ],
              "paperVersion": true,
              "paperVersionCount": 3,
              "showInCategoryRecommendations": true,
              "electronicVersion": true,
              "electronicFileIds": [
                1342
              ],
              "audioVersion": true,
              "audioFileIds": [
                1343
              ],
              "publishYear": "2026",
              "annotation": "Описание книги",
              "link": "https://example.com/buy",
              "price": "990",
              "previewPictureId": 1341,
              "rating": 5,
              "voteCount": 1,
              "reviewsCount": 1,
              "availableCopies": 3,
              "isTakenByUser": false
            },
            "error": null
          }
        }
        

См. также

Предыдущая
Следующая