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

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

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

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

changes.mady.by.user admin

Сохранено

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

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

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

Сохранено

Ключ

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

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

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

...

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

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

Заголовок

Описание

X-Auth-Account-Url X-Auth-Email (обязательный)Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.X-Auth-Password (обязательный)Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.ПараметрОписание
Authorization (обязательный)
Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.
Токен доступа. Вы можете получить токен с помощью запроса
ПараметрОписание
enrollmentIds (необязательный)ID назначений, информацию о которых хотите получить
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 —


1 — активный,

3 —

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

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

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

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

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

Параметр

Описание

learnerResultМассив с данными о результатах пользователя
userIdID пользователя
courseIdID курса
courseTitleНазвание курса
sessionIdID сессии.
Параметр появляется, если в курсе есть мероприятие
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 Количество просмотров курса пользователем

Коды ответов

Код

Текст

Описание

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

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

Блок кода
languagexml
GET/learners/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&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

HTTP/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>
     <ListLearnersResultsResult><results>
         <learnersResults><result>
             <learnerResult>
               <userId>6b0dfde6-9e69-11e9-8e2c-0a580af404f9<<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
               <courseId>e1175540-ae0f-11e9-b49e-0a580af405b3<<courseId>1852f94e-a75e-11eb-92c3-0242ac13002a</courseId>
               <courseTitle>КУРС<courseTitle>Course 1</courseTitle>
               <enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27<<enrollmentId>b9b41af0-f062-11eb-a99d-0242ac190033</enrollmentId>
               <accessDate>2019-12-25T01<accessDate>2021-07-28T21:00:00+00:00</accessDate>
               <dueDate>2019-12-27T21:00:00+00:00</dueDate><timeSpent>10</timeSpent>
               <expirationDate>2019-12-27T21:00:00+00:00</expirationDate>
               <completionStatus>not_started<<completionStatus>in_progress</completionStatus>
               <progress>0<<progress>9.09</progress>
               <isOverdue>true<<isOverdue>0</isOverdue>
            </learnerResult>result>
            <learnerResult><result>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906<<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
               <courseId>9789a1ec-adee-11e9-b1b5-0a580af40906<<courseId>401df18c-f37f-11eb-a842-0242ac130033</courseId>
            <courseTitle>Course   <courseTitle>КУРС 2</courseTitle>
               <enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909<<enrollmentId>b44e7392-f389-11eb-b462-0242ac130033</enrollmentId>
               <accessDate>2019-07-24T00<accessDate>2021-08-01T21:00:00+00:00</accessDate>
               <timeSpent>127</timeSpent>
               <completionStatus>in_progress</completionStatus>
               <progress>30</progress>
               <awardedScore>13.64</awardedScore>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            <learnerResult>
               <userId>0569aad2-adee-11e9-b6c5-0a580af40906</userId>
               <courseId>1b70b088-ae06-11e9-b7d8-0a580af405b3</courseId>
               <courseTitle>КУРС 3</courseTitle>
               <enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b</enrollmentId>
               <accessDate>2019-07-24T00<dueDate>2021-08-03T21:00:00+00:00</accessDate>dueDate>
               <completionDate>2019-07-24T11:30:07+00:00</completionDate>
               <timeSpent>41006<<duration>60</duration>
            <timeSpent>0</timeSpent>
               <completionStatus>complete<<completionStatus>not_started</completionStatus>
               <progress>100</progress>
               <isOverdue>false<<isOverdue>1</isOverdue>
               <viewsCount>3</viewsCount>
            </learnerResult>             </result>
            <learnerResult><result>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906<<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
               <courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
            <courseTitle>Course   <courseTitle>КУРС 4<3</courseTitle>
               <enrollmentId>296bdbd8-aec2-11e9-aee5-0a580af402ea</enrollmentId>
               <accessDate>2019-07-25T00:00:00+00:00</accessDate>
               <completionDate>2019-07-25T09:55:37+00:00</completionDate>
               <timeSpent>37</timeSpent>
               <completionStatus>complete</completionStatus>
               <progress>100</progress>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            </learnersResults>
         <nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken>result>
      </ListLearnersResultsResult>results>
</response>