ДОСТУПНО В BUSINESS ПОДПИСКЕ
Метод: getEnrollments
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса. |
courseIds (необязательный) | array | ID материалов, список назначений которых вы хотите получить. |
learnerIds (необязательный) | array | ID пользователей, список назначений которых вы хотите получить. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать списки назначений только пользователей подразделений, которыми управляют, и их дочерних подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
enrollment | array | Массив, содержащий данные о назначении. |
enrollmentId | ID назначения | |
courseId | ID курса | |
learnerId | ID учащегося, на которого назначен курс | |
accessDate | Дата начала обучения | |
dueDate | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения | |
expirationDate | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1 | |
shouldLockAfterDueDate | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен, 1 — доступ запрещен | |
issuedCertificateId | ID сертификата (токен) из полученного списка назначений | |
certIssueDate | date | Дата выдачи сертификата |
certExpiryDate | date | Дата истечения сертификата |
enrollmentTypeGroup | int32 | Параметр показывает тип назначения. 0 — назначено администратором, 1 — добавлено из каталога |
Пример запроса
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.ru/go/services/api/soap"> <SOAP-ENV:Body> <GetEnrollmentsRequest> <credentials> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> </credentials> <courseIds> <id>146ac240-d54f-11e9-9b88-0a580af40973</id> </courseIds> <learnerIds> <id>8363b098-e031-11e9-89cf-0a580af40b0f</id> </learnerIds> </GetEnrollmentsRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Пример ответа
?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.ru/go/services/api/soap"> <SOAP-ENV:Body> <GetEnrollmentsResult> <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> ... </GetEnrollmentsResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>