ipr.test.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 теста |
courseId |
ID курса |
title |
Название |
active |
Активность |
Возвращаемые данные
Массив объектов:
| Поле | Тип | Описание |
|---|---|---|
id |
int |
ID теста |
title |
string |
Название |
courseId |
int |
ID курса |
lessonId |
int|null |
Урок — источник вопросов (если questionsFrom — урок/курс) |
questionsFrom |
string |
Код источника вопросов обучения (L, C, A, H, S, R) |
active |
bool |
Активность |
sort |
int |
Сортировка |
approved |
bool |
Признак «утверждённый» тест |
completedScore |
int |
Проходной балл (%) |
Обработка ошибок
Справочник кодов: 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.test.list.json"
-H "Accept: application/json"
--data-urlencode "filter[courseId]=305"
Пример ответа
{
"result": {
"result": [
{
"id": 44,
"title": "Итоговый тест",
"courseId": 305,
"lessonId": 905,
"questionsFrom": "L",
"active": true,
"sort": 500,
"approved": true,
"completedScore": 70
}
],
"total": 1,
"next": null,
"error": null
}
}
См. также
Предыдущая
Следующая