Включить страницу | ||||
---|---|---|---|---|
|
Запрос: GET /learners/modules/results
Информация |
---|
Вы можете получить результаты по всему аккаунту, для определенных учащихся, для определенных курсов и материалов, а также указать статус пользователей, курсов, даты назначения и завершения, срок выполнения. |
Заголовки
Узнайте, как получить список материалов курсов аккаунта, в статье Получение списка материалов курса (устаревший). |
Оглавление | ||
---|---|---|
|
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать результаты пользователей подразделений, которыми управляют, и вложенных в них подразделениях.
Заголовки и параметры запроса
Заголовок | Описание | ||
---|---|---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса | ||
Заголовок | Описание | ||
X-Auth-Account-Url (required) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru. | ||
X-Auth-Email (required) | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. | ||
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 (необязательный) | Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения —значения:
| ||
departmentIds (необязательный) | ID подразделений, результаты результаты которых вы хотите получить. | ||
userStatuses (необязательный) | Статус пользователей. Может принимать следующиеВозможные значения: 1 —
3 — заблокированный. По умолчанию, в ответе выводятся данные по активным пользователям.По умолчанию, в ответе выводятся данные по активным пользователям | ||
pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. | ||
pageToken (необязательный) | Токен для перехода на следующую страницу выборки. Не указывается для первой страницы. |
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать результаты пользователей подразделений, которыми управляют, и вложенных в них подразделениях.
Параметры ответа
Параметр | Описание |
---|---|
result | Массив с данными о результатах пользователя по материалам |
userId | ID пользователя |
courseId | ID курса |
moduleId | ID материала |
moduleTitle | Название материала |
courseItemId | ID материала или мероприятия, входящих в состав курса. Этот параметр указывает на ID материала или мероприятия, присвоенный в аккаунте, вне курса, и не совпадает с параметром moduleId |
enrollmentId | ID назначения |
accessDate | Дата начала прохождения материала |
dueDate | Срок выполнения материала. Параметр указывается в ответе, если указан срок выполнения материала |
expirationDate | Срок выполнения материала. Параметр указывается в ответе, если доступ к курсу будет закрыт после срока выполнения |
completionDate | Дата завершения курса |
timeSpent | Время, потраченное на прохождение курса |
completionStatus | Статус прохождения курсов. Возможные значения:
|
progress | Прогресс прохождения курса |
awardedScore | Набранный балл за курс |
isOverdue | Является ли курс просроченным. Возможные значения:
|
viewsCount | Количество просмотров курса пользователем |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | Successful operationOK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о результатах пользователей в xml. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=4ebac138f0e7400a-3761ca31-11ea11e9-803ab6fc-0a580af407710a580af40a22&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&departmentIds&moduleIds[]=55e716fa-3c5c-11ef-96f2-02420a200177&moduleIds[]=ec04c50e6657451e-44153c5c-11ea11ef-9513ae43-0a580af4076302420a200177&accessDate[startDate]=20202019-0112-01T2124T21:00:00Z&accessDate[endDate]=2020-0112-30T03:00:00Z&dueDate[startDate]=20202019-0208-01T0330T03:00:00Z&dueDate[endDate]=20202019-0212-29T0330T03:00:00Z&completionDate[startDate]=20202019-0108-01T0330T03:00:00Z&completionDate[endDate]=20202019-0212-29T0330T03:00:00Z&completionStatusescompletionStatus=failed&departmentIds[]=declinedf0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=10033&pageToken=WyI3NGI0MTQ1Mi0zNzc1LTExZWEtYjdjYy0wYTU4MGFmNDA3YzYiLCI1YTk4Yjk3NC00MWUyLTExZWEtOGE2Ni0wYTU4MGFmNDBjNmYiXQMmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj 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 |
Пример ответа
Блок кода | ||
---|---|---|
| ||
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<results>
<result>
<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
<courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
<moduleTitle>Course 1</moduleTitle>
<moduleId>5a98720f-41e2-11ea-8a66-0a580af40c6f</moduleId>
<courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>
<enrollmentId>b9b41af0-f062-11eb-a99d-0242ac190033</enrollmentId>
<accessDate>2021-07-28T21: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>
<courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
<enrollmentId>bc2b7f9a-f066-11eb-bfc4-0242ac190033</enrollmentId>
<accessDate>2021-07-28T21:00:00+00:00</accessDate>
<dueDate>2021-07-29T21:00:00+00:00</dueDate>
<expirationDate>2021-07-29T21:00:00+00:00</expirationDate>
<timeSpent>0</timeSpent>
<completionStatus>in_progress</completionStatus>
<progress>50</progress>
<isOverdue>1</isOverdue>
</result>
<result>
<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
<courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
<moduleTitle>Course 3</moduleTitle>
<moduleId>6657451e-3c5c-11ef-ae43-02420a200177</moduleId>
<courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
<enrollmentId>b44e7392-f389-11eb-b462-0242ac130033</enrollmentId>
<accessDate>2021-08-01T21:00:00+00:00</accessDate>
<dueDate>2021-08-03T21:00:00+00:00</dueDate>
<timeSpent>0</timeSpent>
<completionStatus>not_started</completionStatus>
<isOverdue>1</isOverdue>
</result>
</results>
</response> | ||
Блок кода | ||
language | xml