Запрос: GET /enrollments
Заголовки
Заголовок | Описание |
|---|---|
| X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru. |
| X-Auth-Email (обязательный) | Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
| X-Auth-Password (обязательный) | Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками. |
Параметры
| learnerIds (необязательный) | ID пользователей, список назначений которых вы хотите получить. |
| courseIds (необязательный) | ID материалов, список назначений которых вы хотите получить. |
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
| pageToken (необязательный) | Токен для перехода на следующую страницу. |
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
| Подсказка |
|---|
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно. |
После того как запрос был успешно обработан, отправляется код ответа 200. Тело ответа будет содержать данные с информацией о назначениях в xml.
Коды ответов
Код | Текст | Описание |
|---|---|---|
| 200 | Successful operation | Запрос успешно обработан. |
| 400 | Bad Request | Ошибка в запросе. |
| 401 | Unauthorized | Ошибка авторизации. |
| 403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
GET/enrollments?courseIds[]=c74b4059-f593-11e9-a66a-0a580af40186&learnerIds[]=e9e1b906-0614-11ea-9f83-0a580af40788&pageSize=1000&pageToken=YzljNmM1MTEtZjU5My0xMWU5LWE2NmEtMGE1ODBhZjQwMddddTg28 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 |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<response>
<enrollments>
<enrollment>
<enrollmentId>c9c6bc26-f593-11e9-a66a-0a580af40186</enrollmentId>
<courseId>c74a4369-f593-11e9-a66a-0a580af40186</courseId>
<learnerId>b698163c-f593-11e9-a66a-0a580af40186</learnerId>
<accessDate>2018-03-07</accessDate>
<shouldLockAfterDueDate>0</shouldLockAfterDueDate>
</enrollment>
<enrollment>
...
</enrollment>
</enrollments>
<nextPageToken>string</nextPageToken>
</response> |