Запрос: 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 (необязательный) | Токен для перехода на следующую страницу выборки. Не указывается для первой страницы. |
...
Пример запроса
| Блок кода | ||||
|---|---|---|---|---|
| ||||
GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=4ebac138f0e7400a-3761ca31-11ea11e9-803ab6fc-0a580af407710a580af40a22&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&departmentIds[]=ec04c50e-4415-11ea-9513-0a580af40763&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 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 |
Пример ответа
| Блок кода | |
|---|---|
| language | xmlHTTP/1.1 200 Successful operation
Connection: close
<?xml version="1.0" encoding="UTF-8"?>
<response>
<results>
<result>
<userId>80a1be92-442f-11ea-adef-0a580af4093e</userId>
<courseId>d766143a-442f-11ea-a7ae-0a580af4093e</courseId>
<moduleId>e39583d0-442f-11ea-85b0-0a580af4093e</moduleId>
<moduleTitle>Name</moduleTitle>
<enrollmentId>0152c4f0-4430-11ea-9b51-0a580af4093e</enrollmentId>
<accessDate>2020-01-31T00:00:00+00:00</accessDate>
<dueDate>2020-02-01T16:00:00+00:00</dueDate>
<completionDate>2020-01-31T13:47:59+00:00</completionDate>
<timeSpent>0</timeSpent>
<completionStatus>complete</completionStatus>
<progress>100</progress>
<isOverdue>false</isOverdue>
<viewsCount>1</viewsCount>
</result>
<result>
<userId>9164a80a-38f6-11ea-90c8-0a580af40281</userId>
<courseId>d766143a-442f-11ea-a7ae-0a580af4093e</courseId>
<moduleId>e39583d0-442f-11ea-85b0-0a580af4093e</moduleId>
<moduleTitle>Name</moduleTitle>
<enrollmentId>222e7e28-4433-11ea-b741-0a580af4093e</enrollmentId>
<accessDate>2020-01-31T00:00:00+00:00</accessDate>
<dueDate>2020-01-31T17:10:00+00:00</dueDate>
<expirationDate>2020-01-31T17:10:00+00:00</expirationDate>
<completionStatus>not_started</completionStatus>
<isOverdue>false</isOverdue>
</result>
...
</results>
</response> |