Документация по iSpring Learn

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

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

Старая версия 18

changes.mady.by.user admin

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user Алина Задина

Сохранено

Ключ

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

Включить страницу
Лэйблы с указанием тарифа
Лэйблы с указанием тарифа

Запрос: GET /learners/modules/results

Информация

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

Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса (устаревший).

Оглавление
minLevel2

Права для выполнения запроса

...

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

. результаты . 
ЗаголовокОписание
X-Auth-Account-Url (required)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.
X-Auth-Email (required)Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запросаX-Auth-Password (required)Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
ПараметрОписание

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

ID пользователей, результаты которых вы хотите получить
courseIds (необязательный)ID курсов,  результаты результаты по которым вы хотите получить. 
moduleIds (необязательный)ID модулей курса
courseItemIds (необязательный)ID материалов, результаты по которым вы хотите получить
enrollmentIds (необязательный)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 —



1 — активный,

3 —

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

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

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

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

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

Параметр

Описание

result

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

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

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

  • not_started,
  • in_progress,
  • pending,
  • complete,
  • passed,
  • accepted,
  • incomplete,
  • failed,
  • declined
progressПрогресс прохождения курса
awardedScoreНабранный балл за курс
isOverdue

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

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

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

Коды ответов

Код

Текст

Описание

200Successful operationOKЗапрос успешно обработан.  Тело ответа будет содержать данные с информацией о результатах пользователей в xml.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission DeniedУ пользователя недостаточно прав для получения списка назначений.

Пример запроса

Блок кода
languagexml
GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&moduleIds[]=55e716fa-3c5c-11ef-96f2-02420a200177&moduleIds[]=6657451e-3c5c-11ef-ae43-02420a200177&accessDate[startDate]=2019-12-24T21:00:00Z&accessDate[endDate]=2020-12-30T03:00:00Z&dueDate[startDate]=2019-08-30T03:00:00Z&dueDate[endDate]=2019-12-30T03:00:00Z&completionDate[startDate]=2019-08-30T03:00:00Z&completionDate[endDate]=2019-12-30T03:00:00Z&completionStatus=failed&departmentIds[]=f0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=33&pageToken=MmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj

HTTPhttps/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://my.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

Блок кода
languagexml
HTTPhttps/1.1 200 Successful operation
Connection: close
OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <results>
        <result>
            <userId>80a1be92<userId>114dba08-442fa75e-11ea11eb-adefb4e5-0a580af4093e<0242ac13002a</userId>             
            <courseId>d766143a<courseId>f0e7400a-442fca31-11ea11e9-a7aeb6fc-0a580af4093e<0a580af40a22</courseId>
            <moduleTitle>Course 1</moduleTitle>
            <moduleId>e39583d0<moduleId>5a98720f-442f41e2-11ea-85b08a66-0a580af4093e<0a580af40c6f</moduleId>
            <moduleTitle>Name</moduleTitle><courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>                                                        
            <enrollmentId>0152c4f0<enrollmentId>b9b41af0-4430f062-11ea11eb-9b51a99d-0a580af4093e<0242ac190033</enrollmentId>
            <accessDate>2020<accessDate>2021-0107-31T0028T21:00:00+00:00</accessDate>
            <timeSpent>10</timeSpent>
            <completionStatus>in_progress</completionStatus>
            <progress>9.09</progress>
            <isOverdue>0</isOverdue>
        </result>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>             
            <courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
            <moduleTitle>Course 2</moduleTitle>
            <moduleId>55e716fa-3c5c-11ef-96f2-02420a200177</moduleId>
            <dueDate>2020-02-01T16<courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
            <enrollmentId>bc2b7f9a-f066-11eb-bfc4-0242ac190033</enrollmentId>
            <accessDate>2021-07-28T21:00:00+00:00</dueDate>accessDate>
            <completionDate>2020<dueDate>2021-0107-31T1329T21:4700:5900+00:00</completionDate>dueDate>
            <timeSpent>0</timeSpent><expirationDate>2021-07-29T21:00:00+00:00</expirationDate>
            <completionStatus>complete<<timeSpent>0</completionStatus>timeSpent>
            <progress>100<<completionStatus>in_progress</progress>completionStatus>
            <isOverdue>false<<progress>50</isOverdue>progress>
            <viewsCount>1<<isOverdue>1</viewsCount>isOverdue>
        </result>
        <result>
            <userId>9164a80a<userId>114dba08-38f6a75e-11ea11eb-90c8b4e5-0a580af40281<0242ac13002a</userId>
            <courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
             <courseId>d766143a-442f-11ea-a7ae-0a580af4093e</courseId><moduleTitle>Course 3</moduleTitle>
            <moduleId>e39583d0<moduleId>6657451e-442f3c5c-11ea11ef-85b0ae43-0a580af4093e<02420a200177</moduleId>
            <moduleTitle>Name</moduleTitle><courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
            <enrollmentId>222e7e28<enrollmentId>b44e7392-4433f389-11ea11eb-b741b462-0a580af4093e<0242ac130033</enrollmentId>
            <accessDate>2020<accessDate>2021-0108-31T0001T21:00:00+00:00</accessDate>
            <dueDate>2020<dueDate>2021-0108-31T1703T21:1000:00+00:00</dueDate>
            <expirationDate>2020-01-31T17:10:00+00:00</expirationDate><timeSpent>0</timeSpent>
            <completionStatus>not_started</completionStatus>
            <isOverdue>false<<isOverdue>1</isOverdue>
        </result>
         ...
    </results>
</response>