Запрос: 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 (необязательный) | Токен для перехода на следующую страницу. |
Права для выполнения запроса
...
Параметры ответа
Параметр | Описание |
---|---|
response | Массив с данными о назначении. |
enrollmentId | ID назначения. |
courseId | ID курса. |
learnerId | ID учащегося, на которого назначен курс. |
accessDate | Дата начала обучения. |
dueDate | Срок выполнения курса. |
expirationDate | |
shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: true — доступ запрещен false — доступ разрешен |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | Successful operation | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о назначениях в xml. |
400 | Bad Request | Ошибка в запросе. |
401 | Unauthorized | Ошибка авторизации. |
403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений. |
...