| Включить страницу | ||||
|---|---|---|---|---|
|
...
Запрос: GET /learners/results
...
Заголовки и параметры запроса
Заголовок | Описание | ||
|---|---|---|---|
| Authorization (обязательный) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru. | ||
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. | ||
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. | ||
| Токен доступа. Вы можете получить токен с помощью запроса | |||
| Параметр | Описание | ||
| enrollmentIds (необязательный) | ID назначений, информацию о которых хотите получить | Параметр | Описание|
| userIds (необязательный) | ID пользователей, результаты которых вы хотите получить | .||
| courseIds (необязательный) | ID курсов, результаты результаты по которым вы хотите получить. Результаты по материалам, которые включены в составной курс, в рамках данного метода получить нельзя. | ||
| accessDate[startDate], accessDate[endDate] (необязательный) | Выборка по дате начала обучения. Можно указать только accessDateтолько accessDate[startDate] или accessDateили accessDate[endDate]. | ||
| dueDate[startDate], dueDate[endDate] (необязательный) | Выборка по по по по сроку выполнения курсов. Можно Можно указать только dueDateтолько dueDate[startDate] или dueDateили dueDate[endDate]. | ||
| completionDate[startDate], completionDate[endDate] (необязательный) | Выборка по дате завершения курсов пользователями. Можно указать только completionDateтолько completionDate[startDate] или completionDateили completionDate[endDate]. | ||
| completionStatuses (необязательный) | Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения:
| ||
| departmentIds (необязательный) | ID подразделений, результаты результаты которых вы хотите получить. | ||
| userStatuses (необязательный) | Статус пользователей. Возможные значения: 3 — 3 — заблокированный. По умолчанию, в ответе выводятся данные по активным пользователям.По умолчанию, в ответе выводятся данные по активным пользователям | ||
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. | ||
| pageToken (необязательный) | Токен для перехода на следующую страницу выборки. Не указывается для первой страницы. |
Параметры ответа
Параметр | Описание | |
|---|---|---|
| learnerResult | Массив с данными о результатах пользователя | .|
| userId | ID пользователя | .|
| courseId | ID курса | |
| courseTitle | Название курса. | |
| sessionId | ID сессии. Параметр появляется, если в курсе есть | тренинг.|
| moduleId | ID материала. | |
| moduleTitle | Название материала.мероприятие | |
| enrollmentId | ID назначения. | |
| accessDate | Дата начала прохождения курса. | |
| dueDate | Срок выполнения курса. Параметр указывается в ответе, если указан срок выполнения курса. | |
| expirationDate | Срок выполнения курса. Параметр указывается в ответе, если доступ к курсу будет закрыт после срока выполнения. | |
| completionDate | Дата завершения курса. | |
| duration | Если в качестве курса назначено видео или тренинг с выбранной сессией. Параметр также появляется, если у курса указано рекомендованное время | . |
| timeSpent | Время, потраченное на завершение курса. | |
| completionStatus | Статус прохождения курсов. Возможные значения:
| |
| progress | Прогресс прохождения курса. | |
| awardedScore | Количество баллов, которое получил пользователь за прохождение курса.Набранный балл за курс | |
| isOverdue | Является ли курс просроченным. Возможные значения:
| |
| viewsCount | Количество просмотров курса пользователем. |
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о результатах пользователей в 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 |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
https/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
<results>
<result>
<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
<courseId>1852f94e-a75e-11eb-92c3-0242ac13002a</courseId>
<courseTitle>Course 1</courseTitle>
<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>401df18c-f37f-11eb-a842-0242ac130033</courseId>
<courseTitle>Course 2</courseTitle>
<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>
<duration>60</duration>
<timeSpent>0</timeSpent>
<completionStatus>not_started</completionStatus>
<isOverdue>1</isOverdue>
</result>
<result>
<userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
<courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
<courseTitle>Course 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>
</result>
</results>
</response> |
...