| Включить страницу | ||||
|---|---|---|---|---|
|
Запрос: GET /learners/results
Заголовки
| Информация |
|---|
Вы можете получить результаты по всему аккаунту, для определенных учащихся, для определенных курсов, а также указать статус пользователей, курсов, даты назначения и завершения, срок выполнения. |
Оглавление minLevel 2
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать результаты пользователей подразделений, которыми управляют, и вложенных в них подразделениях.
Заголовки и параметры запроса
Заголовок | Описание |
|---|---|
| Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
| Параметр | Описание |
| 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 (необязательный) | Статус прохождения курсов, результаты по которым вы хотите получить. Возможные |
значения:
|
| departmentIds (необязательный) | ID подразделений, |
| результаты которых вы хотите получить |
| userStatuses (необязательный) | Статус пользователей. |
Возможные значения: |
|
3 — заблокированный. |
По умолчанию, в ответе выводятся данные по активным пользователям | |
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000 |
| pageToken (необязательный) | Токен для перехода на следующую страницу выборки. Не указывается для первой страницы |
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Вы можете получить результаты по всему аккаунту, для определенных учащихся, для определенных курсов, а также указать статус пользователей, курсов, даты назначения и завершения, срок выполнения.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать результаты пользователей подразделений, которыми управляют, и вложенных в них подразделениях.
Параметры ответа
Параметр | Описание |
|---|---|
| learnerResult | Массив с данными о результатах пользователя |
| userId | ID пользователя |
| courseId | ID курса |
| courseTitle | Название курса |
| sessionId | ID сессии. Параметр появляется, если в курсе есть мероприятие |
| enrollmentId | ID назначения |
| accessDate | Дата начала прохождения курса |
| dueDate | Срок выполнения курса. Параметр указывается в ответе, если указан срок выполнения курса |
| expirationDate | Срок выполнения курса. Параметр указывается в ответе, если доступ к курсу будет закрыт после срока выполнения |
| completionDate | Дата завершения курса |
| duration | Если в качестве курса назначено видео или тренинг с выбранной сессией. Параметр также появляется, если у курса указано рекомендованное время |
| timeSpent | Время, потраченное на завершение курса |
| completionStatus | Статус прохождения курсов. Возможные значения:
|
| progress | Прогресс прохождения курса |
| awardedScore | Набранный балл за курс |
| isOverdue | Является ли курс просроченным. Возможные значения:
|
| viewsCount | Количество просмотров курса пользователем |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | Successful operationOK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о результатах пользователей в xml. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
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 |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
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>Course <courseTitle>КУРС 1</courseTitle> <enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27<<enrollmentId>b9b41af0-f062-11eb-a99d-0242ac190033</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> <enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909</enrollmentId> <accessDate>2019-07-24T00<accessDate>2021-07-28T21:00:00+00:00</accessDate> <timeSpent>127<<timeSpent>10</timeSpent> <completionStatus>in_progress</completionStatus> <awardedScore>13.64</awardedScore><progress>9.09</progress> <isOverdue>false<<isOverdue>0</isOverdue> <viewsCount>2</viewsCount> </learnerResult>result> <learnerResult><result> <userId>0569aad2-adee-11e9-b6c5-0a580af40906<<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId> <courseId>1b70b088-ae06-11e9-b7d8-0a580af405b3<<courseId>401df18c-f37f-11eb-a842-0242ac130033</courseId> <courseTitle>Course <courseTitle>КУРС 3<2</courseTitle> <enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b<<enrollmentId>b44e7392-f389-11eb-b462-0242ac130033</enrollmentId> <accessDate>2019-07-24T00<accessDate>2021-08-01T21:00:00+00:00</accessDate> <completionDate>2019-07-24T11:30:07<dueDate>2021-08-03T21:00:00+00:00</completionDate>dueDate> <timeSpent>41006</timeSpent><duration>60</duration> <completionStatus>complete</completionStatus> <timeSpent>0</timeSpent> <isOverdue>false</isOverdue><completionStatus>not_started</completionStatus> <viewsCount>3</viewsCount> <isOverdue>1</isOverdue> </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> <isOverdue>false</isOverdue><progress>100</progress> <viewsCount>2</viewsCount> <isOverdue>false</isOverdue> </learnerResult>result> </learnersResults> <nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken> </ListLearnersResultsResult></results> </response> |