Дерево страниц

Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Запрос: GET /enrollments

Информация

Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.

Оглавление
minLevel2

Права для выполнения запроса 

Владелец аккаунтаАдминистратор аккаунтаАдминистратор подразделения, Автор или роль с индивидуальными настройками.

Заголовки и параметры запроса

Заголовок

Описание

X-Auth-Account-Url (обязательный)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru.
X-Auth-Email (обязательный)Логин Владельца аккаунтаАдминистратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
X-Auth-Password (обязательный)Пароль Владельца аккаунтаАдминистратора аккаунта, Администратора подразделения, Автора или пользователя с ролью с индивидуальными настройками.
ПараметрОписание
learnerIds (необязательный)ID пользователей, список назначений которых вы хотите получить.
courseIds (необязательный)ID материалов, список назначений которых вы хотите получить.
pageSize (необязательный)Количество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)Токен для перехода на следующую страницу. 

Права для выполнения запроса 

...

Параметры ответа

ПараметрОписание

response

Массив с данными о назначении.
enrollmentIdID назначения.
courseIdID курса.
learnerIdID учащегося, на которого назначен курс.
accessDateДата начала обучения.
dueDateСрок выполнения курса.
expirationDate
shouldLockAfterDueDate

Запрет доступа после окончания срока выполнения.

Возможные значения:

true — доступ запрещен

false — доступ разрешен

Коды ответов

Код

Текст

Описание

200Successful operationЗапрос успешно обработан. Тело ответа будет содержать данные с информацией о назначениях в xml.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission DeniedУ пользователя недостаточно прав для получения списка назначений.

...