ДОСТУПНО В BUSINESS ПОДПИСКЕ
Запрос: GET /enrollment
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.
Права для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Заголовки и параметры запроса
Заголовок | Описание |
---|---|
Authorization (обязательный) | Токен доступа. Вы можете получить токен с помощью запроса |
Параметр | Описание |
learnerIds (необязательный) | ID пользователей, список назначений которых вы хотите получить |
courseIds (необязательный) | ID материалов, список назначений которых вы хотите получить |
Параметры ответа
Параметр | Описание |
---|---|
response | Массив с данными о назначении |
enrollmentId | ID назначения |
courseId | ID курса |
learnerId | ID учащегося, на которого назначен курс |
accessDate | Дата начала обучения |
dueDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения |
expirationDate (необязательный) | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1 |
shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен, 1 — доступ запрещен |
issuedCertificateId | ID сертификата (токен) из полученного списка назначений |
certIssueDate | Дата выдачи сертификата |
certExpiryDate | Дата истечения сертификата |
enrollmentTypeGroup | Параметр показывает тип назначения. 0 — назначено администратором, 1 — добавлено из каталога |
Дату выдачи и истечения сертификата можно получить только по активным назначениям. С помощью этого метода нельзя получить данные по архивным и удаленным назначениям.
Коды ответов
Код | Текст | Описание |
---|---|---|
200 | OK | Запрос успешно обработан. Тело ответа будет содержать данные с информацией о назначениях в xml |
400 | Bad Request | Ошибка в запросе |
401 | Unauthorized | Ошибка авторизации |
403 | Permission Denied | У пользователя недостаточно прав для получения списка назначений |
Пример запроса
GET /enrollment?courseIds[]=146ac240-d54f-11e9-9b88-0a580af40973&learnerIds[]=00de7a40-deb5-11e9-8afe-0a580af40764 https/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Пример запроса 2
GET /enrollment?courseIds=146ac240-d54f-11e9-9b88-0a580af40973,a2239d7c-0a37-11ec-b63a-0242ac140033&learnerIds[]=a59c152e-1603-11ec-872d-0242ac160034 https/1.1 Host: api-learn.ispringlearn.ru Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE
Пример ответа
https/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <response> <enrollment> <enrollmentId>fc1fc35c-040d-11ed-a2ba-b6f58d6fa7b5</enrollmentId> <courseId>1cf62af4-02c3-11ed-8874-3ebfbdfaeb70</courseId> <learnerId>d9261766-040d-11ed-ae50-da994e0c8f89</learnerId> <accessDate>2022-07-14</accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> <certificate> <issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</issuedCertificateId> <issueDate>2022-07-15T07:19:00+00:00</issueDate> <expiryDate>2022-07-15T07:21:00+00:00</expiryDate> </certificate> </enrollment> </response>