library.review.list

Scope: library

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

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`	ID отзыва
`bookId`	ID книги
`userId`	ID автора
`rating`	Оценка

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

Объект отзыва в result.result (list — массив + total, next):

Поле	Тип	Описание
`id`	`int`	ID записи HL
`bookId`	`int`	ID книги
`userId`	`int`	ID автора отзыва
`rating`	`float`	Оценка
`text`	`string`	Текст (HTML, whitelist)

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

Справочник кодов: 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.review.list.json" --data-urlencode "limit=2" --data-urlencode "filter[bookId][$eq]=1177"

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

{
          "result": {
            "result": [
              {
                "id": 12,
                "bookId": 1177,
                "userId": 1,
                "rating": 5,
                "text": "<p>Отзыв REST docs</p>"
              }
            ],
            "error": null
          },
          "total": 1
        }