Включить страницу | ||||
---|---|---|---|---|
|
Метод: getEnrollments
Информация |
---|
...
Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно |
...
. |
Параметры запроса
Параметр | Тип | Описание | ||
---|---|---|---|---|
token (обязательный) | credentials | Смотрите описание объекта Credentials.string | Токен доступа. Вы можете получить токен с помощью запроса | |
courseIds (необязательный) | array | ID материалов, | списоксписок назначений которых вы хотите получить | .|
learnerIds (необязательный) | array | ID пользователей, список назначений которых вы хотите получить |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать списки назначений только пользователей подразделений, которыми управляют, и их дочерних подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
enrollment | array | Массив, содержащий значения — ID подразделения, его название, код и родительское подразделениеданные о назначении |
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 — добавлено из каталога |
Информация |
---|
Дату выдачи и истечения сертификата можно получить только по активным назначениям. С помощью этого метода нельзя получить данные по архивным и удаленным назначениям. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
<soapenv<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:soapenvSOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:GetEnrollmentsRequest> <soap:credentials> <soap:accountUrl>https://myaccount.ispringlearn.ru</soap:accountUrl> <soap:email>owner</soap:email>xmlns="https://ispringlearn.ru/go/services/api/soap"> <SOAP-ENV:Body> <soap:password>12345Q</soap:password><GetEnrollmentsRequest> </soap:credentials><credentials> <!--Optional:--><token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token> <soap:courseIds> </credentials> <!--Zero or more repetitions:--><courseIds> <soap:id>14e2acf6<id>146ac240-d54f-11e9-8339-0a580af40973</soap:id> <soap:id>1689f3e8-d54f-11e9-ac879b88-0a580af40973</soap:id> </soap:courseIds> <!--Optional:--><learnerIds> <soap:learnerIds> <!--Zero or more repetitions:--> <soap:id>d030ff3a-deb4-11e9-b26a-0a580af40764</soap:id> <soap:id>8363b098-<id>8363b098-e031-11e9-89cf-0a580af40b0f</soap:id> <soap:id>dcbe6062-deb4-11e9-88f1-0a580af40764</soap:id> <soap:id>48b9dc96-deb6-11e9-85ba-0a580af40764</soap:id> </soap:learnerIds> </soap:GetEnrollmentsRequest> </soapenvSOAP-ENV:Body> </soapenvSOAP-ENV:Envelope> |
Пример ответа
Блок кода | ||
---|---|---|
| ||
?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="httphttps://ispringlearn.comru/go/services/api/soap"> <SOAP-ENV:Body> <ns1:GetEnrollmentsResult><GetEnrollmentsResult> <ns1:enrollment><enrollment> <ns1:enrollmentId>c8bbdd64<enrollmentId>fc1fc35c-e031040d-11e911ed-8f79a2ba-0a580af40b0f<b6f58d6fa7b5</ns1:enrollmentId> <ns1:courseId>146ac240<courseId>1cf62af4-d54f02c3-11e911ed-9b888874-0a580af40973<3ebfbdfaeb70</ns1:courseId> <ns1:learnerId>8363b098<learnerId>d9261766-e031040d-11e911ed-89cfae50-0a580af40b0f<da994e0c8f89</ns1:learnerId> <ns1:accessDate>2019<accessDate>2022-0907-25<14</ns1:accessDate> accessDate> <enrollmentTypeGroup>0</enrollmentTypeGroup> <shouldLockAfterDueDate>0</shouldLockAfterDueDate> <certificate> <ns1:dueDate>2019-09-30</ns1:dueDate><issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</issuedCertificateId> <issueDate>2022-07-15T07:19:00+00:00</issueDate> <ns1:expirationDate>2019-09-30</ns1:expirationDate> <expiryDate>2022-07-15T07:21:00+00:00</expiryDate> <ns1:shouldLockAfterDueDate>true</ns1:shouldLockAfterDueDate></certificate> </ns1:enrollment> ... </ns1:GetEnrollmentsResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...