Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Заголовки и параметры запроса

Заголовок

Описание

X-Auth-Account-Url (обязательный)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.
X-Auth-Email (обязательный)Логин Владельца аккаунтаАдминистратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)Пароль Владельца аккаунтаАдминистратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
ПараметрОписание
userIds (необязательный)ID пользователей, результаты которых вы хотите получить.
courseIds (необязательный)ID курсов, результаты по которым вы хотите получить. Результаты по материалам, которые включены в составной курс, в рамках данного метода получить нельзя. 
accessDate[startDate], accessDate[endDate] (необязательный)Выборка по дате начала обучения. Можно указать только accessDate[startDate] или accessDate[endDate]. 
dueDate[startDate], dueDate[endDate] (необязательный)

Выборка по по сроку выполнения курсов. Можно указать только dueDate[startDate] или dueDate[endDate].

completionDate[startDate], completionDate[endDate] (необязательный)

Выборка по дате завершения курсов пользователями. Можно указать только completionDate[startDate] или completionDate[endDate].

completionStatuses (необязательный)

Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения:

  • not_started
  • in_progress
  • pending
  • complete
  • passed
  • accepted
  • incomplete
  • failed
  • declined
departmentIds  (необязательный)ID подразделений, результаты которых вы хотите получить. 
userStatuses (необязательный)

Статус пользователей.

Возможные значения:
1 — активный

3 — заблокированный

По умолчанию, в ответе выводятся данные по активным пользователям.

pageSize (необязательный)Количество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)Токен для перехода на следующую страницу выборки. Не указывается для первой страницы. 

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

Параметр

Описание

learnerResultМассив с данными о результатах пользователя.
userIdID пользователя.
courseIdID курса.
sessionIdID сессии.
Параметр появляется, если в курсе есть тренинг.
moduleIdID материала.
moduleTitleНазвание материала.
enrollmentIdID назначения.
accessDateДата начала прохождения курса.
dueDateСрок выполнения курса. Параметр указывается в ответе, если указан срок выполнения курса.
expirationDateСрок выполнения курса. Параметр указывается в ответе, если доступ к курсу будет закрыт после срока выполнения.
completionDateДата завершения курса.
durationЕсли в качестве курса назначено видео или тренинг с выбранной сессией.
Параметр также появляется, если у курса указано рекомендованное время. 
timeSpentВремя, потраченное на завершение курса. 
completionStatus

Статус прохождения курсов.

Возможные значения:

  • not_started
  • in_progress
  • pending
  • complete
  • passed
  • accepted
  • incomplete
  • failed
  • declined
progressПрогресс прохождения курса. 
awardedScoreКоличество баллов, которое получил пользователь за прохождение курса.
isOverdue

Является ли курс просроченным.

Возможные значения:

  • 0 — курс не просрочен
  • 1 — курс просрочен
viewsCount Количество просмотров курса пользователем.

...