library.book.return

Scope: library

Кто может вызывать: Сотрудник (своя выдача) или модератор.

HTTP: POST

Побочные эффекты: Возвращает книгу в библиотеку (фиксирует возврат в истории выдачи).

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

Параметр Тип Обяз. Описание
bookId int да ID книги. Алиасы: id
userId int нет Заёмщик (по умолчанию — вызывающий)

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

Поле Тип
bookId int
userId int
success bool

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

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

Код Описание
BOOK_NOT_FOUND Книга не найдена или не из каталога библиотеки (details.id)
VALIDATION_ERROR Пользователь не брал книгу (details.code: didNotTaken); прочие ошибки (details.code, напр. userId)
PERMISSION_DENIED Чужой userId без прав модератора

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

curl -X POST "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.book.return.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "bookId": 1177,
          "userId": 1
        }'
        

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

{
          "result": {
            "result": {
              "bookId": 1177,
              "userId": 1,
              "success": true
            },
            "error": null
          }
        }
        

См. также

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