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

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

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Метод: listLearnersModulesResults

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

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

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

Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.

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

Параметры запроса

Параметр

Тип

Описание

token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
userIds (необязательный)string[]ID пользователей, результаты которых вы хотите получить
courseIds (необязательный)string[]ID курсов, результаты по которым вы хотите получить
modulesIds (необязательный)string[]

ID модулей курса

courseItemIds (необязательный)string[]

ID материалов, которые включены в составной курс, результаты по которым вы хотите получить

enrollmentIds (необязательный)string[]

ID назначений, результаты по которым вы хотите получить

accessDate[startDate], accessDate[endDate] (необязательный)string (date-time RFC3339)Начальное и конечное ограничение по дате назначения курсов. Параметр может иметь только одну границу
dueDate[startDate], dueDate[endDate] (необязательный)string (date-time RFC3339)Начальное и конечное ограничение по сроку выполнения курсов. Параметр может иметь только одну границу
completionDate[startDate], completionDate[endDate] (необязательный)string (date-time RFC3339)Начальное и конечное ограничение по дате завершения курсов. Параметр может иметь только одну границу
completionStatuses (необязательный)string[]Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения — not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined
departmentIds  (необязательный)string[]ID подразделений, результаты которых вы хотите получить
userStatuses (необязательный) numberСтатус пользователей. Может принимать следующие значения: 1 — активный, 3 — заблокированный. По умолчанию, в ответе выводятся данные по активным пользователям
pageSize (необязательный)numberКоличество записей на 1 страницу. Если не указан, то 1000
pageToken (необязательный)stringТокен для перехода на следующую страницу выборки. Не указывается для первой страницы 

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

После того, как запрос успешно обработан, система возвращает объект со следующими свойствами:

Параметр

Тип

Описание

learnersResults []arrayМассив с данными об обученности пользователей.
userIdsstringID пользователей, результаты которых вы хотите получить
courseIdsstringID курсов, результаты по которым вы хотите получить
moduleIdsstringID модулей курса
courseItemIdsstringID материалов, которые включены в составной курс, результаты по которым вы хотите получить
enrollmentIdsstringID назначений, результаты по которым вы хотите получить
accessDatestringНачальное и конечное ограничение по дате назначения курсов. Параметр может иметь только одну границу
dueDatestringНачальное и конечное ограничение по сроку выполнения курсов. Параметр может иметь только одну границу
expirationDatestringСрок выполнения материала. Параметр указывается в ответе, если доступ к курсу будет закрыт после срока выполнения
completionDatestringДата завершения курса
timeSpentstringВремя, потраченное на прохождение курса
completionStatusstring

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

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

  • not_started,
  • in_progress,
  • pending,
  • complete,
  • passed,
  • accepted,
  • incomplete,
  • failed,
  • declined
isOverduestring

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

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

  • 0 — курс не просрочен,
  • 1 — курс просрочен
nextPageTokenstringТокен для перехода на следующую страницу. 

Возможные ошибки

Ошибка

Описание

Permission denied

У пользователя недостаточно прав для выполнения запроса.

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

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

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
      <ListLearnersModulesResultsRequest>
         <credentials>
            <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
         </credentials>
         <userIds>
            <id>25e44840-87a0-11e9-897c-0a580af40783</id>
         </userIds>
         <courseIds>
            <id>596e5f20-8c46-11e9-a814-0a580af4024a</id>
         </courseIds>
         <moduleIds>
            <id>607e6f31-9c57-12e8-a914-1a590af4025a</id>
         </moduleIds>
         <courseItemIds>
            <id>553964ac-3c5c-11ef-b1c4-02420a200163</id>
            <id>65a773eb-3c5c-11ef-b1c4-02420a200163</id>
            <id>81fdb5be-3c5c-11ef-9bec-02420a200177</id>
            <id>49032582-3c5c-11ef-b6fd-02420a200177</id>
         </courseItemIds>
         <enrollmentIds>
            <id>1777fdf0-232d-11ea-a24a-0a580af40c27</id>
            <id>a2cadee0-adee-11e9-b31d-0a580af40909</id>
            <id>3d4776b0-ae06-11e9-9707-0a580af4013b</id>
            <id>296bdbd8-aec2-11e9-aee5-0a580af402ea</id>
         </enrollmentIds>
         <accessDate>
            <startDate>2019-01-06T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </accessDate>
         <dueDate>
            <startDate>2019-01-12T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </dueDate>
         <completionDate>
            <startDate>2019-01-12T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </completionDate>
         <completionStatuses>
            <value>complete</value>
         </completionStatuses>
         <departmentIds>
            <id>81826672-9e49-11e9-b4fc-0a580af40235</id>
         </departmentIds>
         <userStatuses>
            <value>1</value>
            <value>3</value>
         </userStatuses>
         <pageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</pageToken>
         <pageSize>100</pageSize>
      </ListLearnersModulesResultsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
      <ListLearnersModulesResultsResult>
         <learnersResults>
             <learnerResult>
               <userId>6b0dfde6-9e69-11e9-8e2c-0a580af404f9</userId>
               <courseId>e1175540-ae0f-11e9-b49e-0a580af405b3</courseId>
               <courseTitle>КУРС 1</courseTitle>
               <moduleId>607e6f31-9c57-12e8-a914-1a590af4025a</moduleId>
               <moduleTitle>Материал 1</moduleTitle>
               <courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>
               <enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27</enrollmentId>
               <accessDate>2019-12-25T01:00:00+00:00</accessDate>
               <dueDate>2019-12-27T21:00:00+00:00</dueDate>
               <expirationDate>2019-12-27T21:00:00+00:00</expirationDate>
               <completionStatus>not_started</completionStatus>
               <isOverdue>true</isOverdue>
            </learnerResult>
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>9789a1ec-adee-11e9-b1b5-0a580af40906</courseId>
               <courseTitle>КУРС 2</courseTitle>
               <moduleId>607e6f32-9c58-12e8-a914-1a590af4025b</moduleId>
               <moduleTitle>Материал 2</moduleTitle>
               <courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
               <enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <timeSpent>127</timeSpent>
               <completionStatus>in_progress</completionStatus>
               <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>
               <moduleId>607e6f34-9c59-12e8-a915-1a590af4036b</moduleId>
               <moduleTitle>Материал 3</moduleTitle>
               <courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
               <enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <completionDate>2019-07-24T11:30:07+00:00</completionDate>
               <timeSpent>41006</timeSpent>
               <completionStatus>complete</completionStatus>
               <isOverdue>false</isOverdue>
               <viewsCount>3</viewsCount>
            </learnerResult>             
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
               <courseTitle>КУРС 4</courseTitle>
               <courseItemId>49032582-3c5c-11ef-b6fd-02420a200177</courseItemId>
               <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>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            </learnersResults>
         <nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken>
      </ListLearnersModulesResultsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • Нет меток