ipr.course.list

Scope: ipr

Кто может вызывать: Авторизованный пользователь с доступом по ACL обучения. Подробнее: Модель доступа

Возвращает список курсов с поддержкой пагинации и фильтрации.

HTTP: GET

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

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение
fetchAll bool нет Вернуть все записи одним ответом (максимум 5000)
filter object нет Фильтр в mongo-style формате

Поля filter (Mongo)

Поле API Соответствие
id ID курса
title NAME
active ACTIVE
code Символьный код курса

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

Массив объектов:

Поле Тип Описание
id int ID курса
title string Название
code string Символьный код
active bool ACTIVE = Y
description string Краткое описание
sort int Сортировка
timestampX string Дата последнего изменения

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Модуль learning недоступен / внутренняя ошибка
INVALID_LIMIT / LIMIT_EXCEEDED / INVALID_OFFSET / INVALID_FILTER / INVALID_FILTER_OPERATOR Некорректные параметры пагинации/фильтра
FETCH_ALL_LIMIT_EXCEEDED Превышен лимит fetchAll

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.course.list.json"
          -H "Accept: application/json"
          --data-urlencode "limit=20"

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

{
          "result": {
            "result": [
              {
                "id": 305,
                "title": "Обратная связь 360",
                "code": "feedback-360",
                "active": true,
                "description": "Курс о принципах обратной связи 360",
                "sort": 100,
                "timestampX": "01.02.2026 10:00:00"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
ipr.course.get