Метод: getEnrollments
Информация |
---|
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно. |
Параметры запроса
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
courseIds (необязательный) | array | ID материалов, список назначений которых вы хотите получить. |
learnerIds (необязательный) | array | ID пользователей, список назначений которых вы хотите получить. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать списки назначений только пользователей подразделений, которыми управляют, и их дочерних подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|
enrollment | array | Массив, содержащий значения — ID и название назначения. |
Пример запроса
Блок кода |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetEnrollmentsRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.ru</accountUrl>
<email>email@email.com</email>
<password>password</password>
</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="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetEnrollmentsResult>
<enrollment>
<enrollmentId>c8bbdd64-e031-11e9-8f79-0a580af40b0f</enrollmentId>
<courseId>146ac240-d54f-11e9-9b88-0a580af40973</courseId>
<learnerId>8363b098-e031-11e9-89cf-0a580af40b0f</learnerId>
<accessDate>2019-09-25</accessDate>
<dueDate>2019-09-30</dueDate>
<expirationDate>2019-09-30</expirationDate>
<shouldLockAfterDueDate>1</shouldLockAfterDueDate>
</enrollment>
...
</GetEnrollmentsResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |