Skip to main content
На этой странице — публичные структуры объектов, связанных с обучением: course, courseProgress, courseLesson, courseLessonPractice, courseLessonPracticeAttempt. Они возвращаются в методах работы с курсами и в вебхуках (CourseCompleted, CourseProgressChanged, CourseLessonPracticeCompleted).
Метод course/list/raw отдаёт компактную проекцию (courseId, name, type, groupIds). Ниже — полные публичные схемы сущностей.

course

id
integer
required
ID курса.
type
enum
required
Тип: Bundle, Webinar, TextCourse, Assessment, VideoCourse, PersonalLesson.
name
string
required
Название.
description
string
required
Описание.
alias
string | null
Символьный алиас.
tags
string[]
required
Теги.
seoTags
string[]
required
SEO-теги.
image
object | null
Изображения: { main, wrapper }.
promoVideo
string | null
Промо-видео.
settings
object
required
Настройки курса (произвольный объект).
order
integer
required
Порядок сортировки.
isBundle
boolean | null
Является ли бандлом.
createdAt
string
required
Дата создания (ISO 8601).
updatedAt
string
required
Дата обновления (ISO 8601).
archivedAt
string | null
Дата архивации или null.

courseProgress

Возвращается методом course/:courseId/progresses. Запись описывает прогресс пользователя по конкретному уроку.
id
integer
required
ID записи прогресса.
courseId
integer | null
ID курса.
userId
integer
required
ID пользователя.
lessonId
integer
required
ID урока.
status
enum | null
Статус урока: NotInitialized, NotStarted, OnTheory, OnPractice, OnReview, OnCorrection, Completed, NotParticipant, AvailableAsDemo, ExpiredByGroup, DisabledByGroup, AllowedByProgress, BlockedByProgress, StartScheduled, StartScheduledWaitPrev, BundleStartBlocked, BundleStartPendingConfirmation.
scheduleStatus
enum | null
Статус расписания: OnTimeChoose, WaitingStart, InProgress, Completed, Canceled.
scheduleStartAt
string | null
Старт по расписанию (ISO 8601).
scheduleFinishAt
string | null
Окончание по расписанию (ISO 8601).
practiceDeadlineAt
string | null
Дедлайн практики (ISO 8601).
isCompleted
boolean | null
Урок завершён.
isOnReview
boolean | null
На проверке.
completedAt
string | null
Дата завершения (ISO 8601).
onReviewAt
string | null
Дата отправки на проверку (ISO 8601).
statusHistoryLogs
object[] | null
История статусов: { timestamp, status }.
createdAt
string
required
Дата создания (ISO 8601).
updatedAt
string
required
Дата обновления (ISO 8601).

courseLesson

id
integer
required
ID урока.
courseId
integer
required
ID курса.
type
enum
required
Тип: Regular, Webinar.
accessType
enum
required
Тип доступа: Demo, Participant.
status
string | null
Статус урока.
name
string
required
Название.
description
string
required
Описание.
previewImage
string | null
Превью.
order
integer
required
Порядок.
withContent
boolean
required
Есть теоретический контент.
withPractice
boolean
required
Есть практическая часть.
publishedAt
string | null
Дата публикации (ISO 8601).
settings
object
required
Настройки урока.
isPublished
boolean | null
Опубликован.

courseLessonPractice

id
integer
required
ID практики.
name
string
required
Название.
description
string
required
Описание.
questionMode
enum
required
Режим вопросов.
resultMode
enum
required
Режим результатов.
variantMode
enum
required
Режим вариантов.
retryVariantMode
enum
required
Режим вариантов при пересдаче.
maxAttempts
integer | null
Макс. число попыток.
timeLimitInMinutes
integer | null
Лимит времени (мин).
deadlineInDays
integer | null
Дедлайн (дней).
passThreshold
integer | null
Порог прохождения.
starsPerTaskPoint
integer | null
Звёзд за балл задания.
requireAllAnswers
boolean
required
Требуются ответы на все задания.
tasksCount
integer
required
Количество заданий.

courseLessonPracticeAttempt

Возвращается при выгрузке попыток практик и в вебхуке CourseLessonPracticeCompleted.
id
integer
required
ID попытки.
uuid
string | null
UUID попытки.
variantId
integer
required
ID варианта.
userId
integer
required
ID пользователя.
status
enum | null
Статус: Created, OnReview, OnCorrection, AutoVerified, Verified, Failed, Stacked.
order
integer
required
Номер попытки.
finished
boolean
required
Попытка завершена.
sentToReviewAt
string | null
Отправлена на проверку (ISO 8601).
sentAfterDeadline
boolean
required
Отправлена после дедлайна.
deadlineAt
string | null
Дедлайн (ISO 8601).
passedAt
string | null
Дата прохождения (ISO 8601).
solvedCount
integer
required
Количество решённых заданий.
pointsAmount
integer
required
Набрано баллов.
maxPointsAmount
integer
required
Максимум баллов.
uncounted
boolean
required
Попытка не засчитана.
isPassed
boolean | null
Пройдена.
correctPercent
number | null
Процент правильных.
isExpired
boolean | null
Просрочена.
statusHistoryLogs
object[] | null
История статусов: { timestamp, status }.