...
Заголовок | Описание |
|---|---|
| Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса. |
| Параметр | Описание |
| 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 Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
...