Запрос: GET /enrollments
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
X-Auth-Account-Url (обязательный) | Базовый URL аккаунта, например, https://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=1. |
shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен 1 — доступ запрещен |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о назначениях в xml. |
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 https/1.1 Host: api-learn.ispringlearn.ru X-Auth-Account-Url: https://my.ispringlearn.ru X-Auth-Email: email@email.com X-Auth-Password: password
Пример ответа
https/1.1 200 OK <?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>