Запрос: GET /learners/modules/results
Вы можете получить результаты по всему аккаунту, для определенных учащихся, для определенных курсов и материалов, а также указать статус пользователей, курсов, даты назначения и завершения, срок выполнения.
Заголовки
| Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (required) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru. |
| X-Auth-Email (required) | Логин Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password (required) | Пароль Владельца аккаунта, Администратора, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| Параметр | Описание |
| userIds (необязательный) | ID пользователей, результаты которых вы хотите получить. |
| courseIds (необязательный) | ID курсов, результаты по которым вы хотите получить. |
| moduleIds (необязательный) | ID материалов, результаты по которым вы хотите получить. |
| accessDate[startDate], accessDate[endDate] (необязательный) | Начальное и конечное ограничение по дате назначения курсов. Параметр может иметь только одну границу. |
| dueDate[startDate], dueDate[endDate] (необязательный) | Начальное и конечное ограничение по сроку выполнения курсов. Параметр может иметь только одну границу. |
| completionDate[startDate], completionDate[endDate] (необязательный) | Начальное и конечное ограничение по дате завершения курсов. Параметр может иметь только одну границу. |
| completionStatuses (необязательный) | Статус прохождения курсов, результаты по которым вы хотите получить. Возможные значения — not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined. |
| departmentIds (необязательный) | ID подразделений, результаты которых вы хотите получить. |
| userStatuses (необязательный) | Статус пользователей. Может принимать следующие значения: 1 — активный, 3 — заблокированный. По умолчанию, в ответе выводятся данные по активным пользователям. |
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
| pageToken (необязательный) | Токен для перехода на следующую страницу выборки. Не указывается для первой страницы. |
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать результаты пользователей подразделений, которыми управляют, и вложенных в них подразделениях.
Коды ответов
| Код | Текст | Описание |
|---|---|---|
| 200 | Ok | Запрос успешно обработан. |
| 403 | Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
GET /learners/modules/results HTTP/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: http://myaccount.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password