library.ipr.addAction

Scope: library

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

HTTP: POST

Побочные эффекты: Добавляет книгу в программу ИПР.

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

Параметр Тип Обяз. Описание
bookId int да ID книги
programId int нет ID карточки ИПР (обязателен при нескольких). Алиасы: iprId
userId int нет Пользователь
dateTo string нет Плановая дата завершения

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

| bookId | int |
| userId | int |
| programId | int |

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

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

Код Описание
BOOK_NOT_FOUND Книга не найдена или не из каталога библиотеки (details.id)
IPR_NOT_AVAILABLE Модуль ИПР не установлен или не настроен (инфоблок действий, тип library, компетенция selfeducation)
VALIDATION_ERROR Невалидные параметры: пустой bookId (details.field), неверный programId (details.programId, userId), не удалось создать действие
PERMISSION_DENIED Чужой userId без прав модератора
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет доступа к библиотеке

Пример ошибки (BOOK_NOT_FOUND)

{
          "result": {
            "result": null,
            "error": {
              "code": "BOOK_NOT_FOUND",
              "message": "Книга не найдена.",
              "details": {
                "id": 999999
              }
            }
          }
        }

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

curl -X POST "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.ipr.addAction.json"
          -H "Content-Type: application/json"
          -H "Accept: application/json"
          --data '{
          "bookId": 1177,
          "programId": 1494,
          "userId": 1,
          "dateTo": "2026-12-31"
        }'

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

{
          "result": {
            "result": {
              "bookId": 1177,
              "userId": 1,
              "programId": 1494
            },
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела