Заголовки запроса
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
GET /saas/v2/course/:courseId/progresses
Возвращает записи прогресса по урокам выбранного курса для всех участников. Каждая запись соответствует
паре «пользователь + урок».
Параметры пути
ID курса, прогресс по которому нужно получить.
Параметры запроса
Пагинация
Количество записей, которые нужно пропустить. По умолчанию 0.
Номер страницы (альтернатива skip). Начинается с 1.
Количество записей на странице. От 1 до 1000. По умолчанию 100.
Поля ответа
Постраничный список записей прогресса. Полная структура записи — courseProgress в справочнике
course.
Массив записей прогресса.
Статус прогресса по уроку. Возможные значения: NotInitialized, NotStarted, OnTheory,
OnPractice, OnReview, OnCorrection, Completed и др.
Статус расписания: OnTimeChoose, WaitingStart, InProgress, Completed, Canceled.
Дата старта по расписанию (ISO 8601).
Дата окончания по расписанию (ISO 8601).
Дедлайн практической части (ISO 8601).
Признак завершения урока.
Признак нахождения на проверке.
Дата завершения (ISO 8601).
Дата отправки на проверку (ISO 8601).
История изменения статуса: массив объектов { timestamp, status }.
Дата создания записи (ISO 8601).
Дата обновления записи (ISO 8601).
Общее количество записей.
Общее количество страниц.
Признак последней страницы.
Параметры следующей страницы (skip, take, page).
Параметры предыдущей страницы (skip, take, page).
curl --location 'https://api.exode.biz/saas/v2/course/10/progresses?take=50' \
--header 'Seller-Id: {{ sellerId }}' \
--header 'School-Id: {{ schoolId }}' \
--header 'Authorization: Bearer YOUR_TOKEN'
{
"success": true,
"code": 200,
"payload": {
"page": 1,
"count": 1,
"pages": 1,
"isFirst": true,
"isLast": true,
"items": [
{
"id": 9001,
"courseId": 10,
"userId": 123,
"lessonId": 55,
"status": "Completed",
"scheduleStatus": "InProgress",
"isCompleted": true,
"completedAt": "2025-01-15T10:30:00Z",
"createdAt": "2025-01-10T09:00:00Z",
"updatedAt": "2025-01-15T10:30:00Z"
}
],
"next": {
"skip": 20,
"take": 20,
"page": 2
},
"prev": {
"skip": 0,
"take": 20,
"page": 1
}
}
}
Требования к правам доступа
Требуется аутентификация по токену и одно из прав: куратор курса (CourseCurator) или управление
пользователями школы (SchoolManageUsers).