...
Заголовок | Описание |
|---|---|
| Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса. |
| Параметр | Описание |
| learnerIds (необязательный) | ID пользователей, список назначений которых вы хотите получить. |
| courseIds (необязательный) | ID материалов, список список назначений которых вы хотите получить. |
| pageSize (необязательный) | Количество записей на 1 страницу. Если не указан, то 1000. |
| pageToken (необязательный) | Токен для перехода на следующую страницу. |
Параметры ответа
| Параметр | Описание |
|---|---|
response | Массив с данными о назначении. |
| enrollmentId | ID назначения. |
| courseId | ID курса. |
| learnerId | ID учащегося, на которого назначен курс. |
| accessDate | Дата начала обучения. |
| dueDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения. |
| expirationDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1. |
| shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен, 1 — доступ запрещен |
| certIssueDate | Дата выдачи сертификата. |
| certExpiryDate | Дата истечения сертификата. |
| enrollmentTypeGroup | Параметр показывает тип назначения. 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 Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
...