Запрос: 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 | Successful operation | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о результатах пользователей в xml. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений. |
Пример запроса
GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=4ebac138-3761-11ea-803a-0a580af40771&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&departmentIds[]=ec04c50e-4415-11ea-9513-0a580af40763&accessDate[startDate]=2020-01-01T21:00:00Z&accessDate[endDate]=2020-01-30T03:00:00Z&dueDate[startDate]=2020-02-01T03:00:00Z&dueDate[endDate]=2020-02-29T03:00:00Z&completionDate[startDate]=2020-01-01T03:00:00Z&completionDate[endDate]=2020-02-29T03:00:00Z&completionStatuses[]=declined&userStatuses[]=1&pageSize=100&pageToken=WyI3NGI0MTQ1Mi0zNzc1LTExZWEtYjdjYy0wYTU4MGFmNDA3YzYiLCI1YTk4Yjk3NC00MWUyLTExZWEtOGE2Ni0wYTU4MGFmNDBjNmYiXQ 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