ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET /enrollment/{enrollment_id}
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
Параметр | Описание |
enrollmentId (обязательный) | ID назначения, о котором вы хотите получить информацию |
enrollmentIds (необязательный) | Массив ID назначений. Фильтр поиска нескольких ID назначений |
Параметры ответа
Параметр | Описание |
---|---|
response | Массив с данными о назначении |
enrollmentId | ID назначения |
courseId | ID курса |
learnerId | ID учащегося, на которого назначен курс |
accessDate | Дата начала обучения |
dueDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения |
expirationDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1 |
shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен, 1 — доступ запрещен |
enrollmentTypeGroup | Параметр показывает тип назначения. 0 — назначено администратором, 1 — добавлено из каталога |
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о назначении в xml |
400 | Bad Request | Ошибка в запросе |
401 | Unauthorized | Ошибка авторизации |
403 | Permission Denied | У пользователя недостаточно прав для получения информации о назначении |
Пример запроса
GET /api/v3/enrollment?enrollmentIds[]=6e051388-e76e-11ee-9af6-0242ac140070&enrollmentIds[]=1de7698c-df6c-11ee-b83c-0242ac160070&enrollmentIds[]=b7ec648e-e5e2-11ee-83ef-0242ac140071 HTTP/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Пример ответа
<?xml version="1.0" encoding="UTF-8"?> <response> <enrollment> <enrollmentId>1de7698c-df6c-11ee-b83c-0242ac160070</enrollmentId> <courseId>1a4799aa-df6c-11ee-b4d3-0242ac160070</courseId> <learnerId>0dcb28fe-df6c-11ee-a2ed-0242ac160070</learnerId> <accessDate>2024-03-11</accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> </enrollment> <enrollment> <enrollmentId>b7ec648e-e5e2-11ee-83ef-0242ac140071</enrollmentId> <courseId>a9d460cc-e5e2-11ee-9e4e-0242ac140071</courseId> <learnerId>5aaf4a2e-e075-11ee-ae20-0242c0a82070</learnerId> <accessDate>2024-03-19</accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> </enrollment> <enrollment> <enrollmentId>6e051388-e76e-11ee-9af6-0242ac140070</enrollmentId> <courseId>4d67b6bc-e76e-11ee-9e86-0242ac140070</courseId> <learnerId>50daac78-e5e3-11ee-a5d5-0242ac140071</learnerId> <accessDate>2024-03-21</accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> </enrollment> </response>