library.enum.author.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 Numeric id автора
name Имя
xmlId Символьный код enum

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

Массив { id, name, xmlId } + total, next. ID — numeric enum id для authorIds в book.add/update.

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

Справочник кодов: 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.enum.author.list.json" --data-urlencode "limit=2"
        

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

{
          "result": {
            "result": [
              {
                "id": 571,
                "name": "Harvard Business Review",
                "xmlId": "harvard_business_review"
              },
              {
                "id": 709,
                "name": "Labor Ateliergemeinschaft",
                "xmlId": "labor_ateliergemeinschaft"
              }
            ],
            "error": null
          },
          "next": 2,
          "total": 1181
        }
        

См. также

Предыдущая