Включить страницу | ||||
---|---|---|---|---|
|
Метод: getEnrollments
Информация |
---|
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно. |
Параметры запроса
Параметр | Тип | Описание | ||
---|---|---|---|---|
token (обязательный) | credentials | Смотрите описание объекта Credentials.string | Токен доступа. Вы можете получить токен с помощью запроса | |
courseIds (необязательный) | array | ID материалов, | списоксписок назначений которых вы хотите получить | .|
learnerIds (необязательный) | array | ID пользователей, список назначений которых вы хотите получить | .
Права пользователя для выполнения запроса
...
Параметр | Тип | Описание |
---|---|---|
enrollment | array | Массив, содержащий данные о назначении. |
enrollmentId | string | ID назначения. |
courseId | string | ID курса. |
learnerId | string | ID учащегося, на которого назначен курс. |
accessDate | date | Дата начала обучения. |
dueDate | date | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения. |
expirationDate | date | Срок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1. |
shouldLockAfterDueDate | boolean | Запрет доступа после окончания срока выполнения. Возможные значения: 0 — доступ разрешен, 1 — доступ запрещен |
issuedCertificateId | date | 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.comru/go/services/api/soap"> <SOAP-ENV:Body> <GetEnrollmentsRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.ru</accountUrl> <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> <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="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.comru/go/services/api/soap"> <SOAP-ENV:Body> <GetEnrollmentsResult> <enrollment> <enrollmentId>c8bbdd64<enrollmentId>fc1fc35c-e031040d-11e911ed-8f79a2ba-0a580af40b0f<b6f58d6fa7b5</enrollmentId> <courseId>146ac240<courseId>1cf62af4-d54f02c3-11e911ed-9b888874-0a580af40973<3ebfbdfaeb70</courseId> <learnerId>8363b098<learnerId>d9261766-e031040d-11e911ed-89cfae50-0a580af40b0f<da994e0c8f89</learnerId> <accessDate>2019<accessDate>2022-0907-25</accessDate> 14</accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> <dueDate>2019-09-30</dueDate> <certificate> <issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</issuedCertificateId> <issueDate>2022-07-15T07:19:00+00:00</issueDate> <expirationDate>2019-09-30</expirationDate> <expiryDate>2022-07-15T07:21:00+00:00</expiryDate> <shouldLockAfterDueDate>1<</shouldLockAfterDueDate>certificate> </enrollment> ... </GetEnrollmentsResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...