Документация по iSpring Learn

Дерево страниц

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Метод: listEnrollments

Вы можете получить список назначений для всего аккаунта, для определенных учащихся и для определенных курсов, а также для двух параметров одновременно.

Права пользователя для выполнения запроса

Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.

Администратор подразделения, Автор или пользователь с ролью с индивидуальными настройками могут получать постраничный список назначений для пользователей подразделений, которыми управляют, и их дочерних подразделений.

Параметры запроса

ПараметрТипОписание
token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
courseIds  (необязательный)arrayID материалов, список назначений которых вы хотите получить
learnerIds  (необязательный)arrayID пользователей, список назначений которых вы хотите получить
pageSize (необязательный)stringКоличество записей на 1 страницу. Если не указан, то 1000
pageToken (необязательный)stringТокен для перехода на следующую страницу

Возвращаемые значения

После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:

ПараметрТипОписание
enrollmentarrayМассив, содержащий ID назначений
nextPageTokenstringТокен для перехода на следующую страницу 
certIssueDatedateДата выдачи сертификата
certExpiryDatedateДата истечения сертификата
enrollmentTypeGroupint32

Параметр показывает тип назначения.

Возможные значения:

0 — назначено администратором,

1 — добавлено из каталога

Дату выдачи и истечения сертификата можно получить только по активным назначениям. С помощью этого метода нельзя получить данные по архивным и удаленным назначениям.

Пример запроса

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.ru/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ListEnrollmentsRequest>
         <soap:credentials>
            <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
         </soap:credentials>
         <soap:courseIds>
            <soap:id>string</soap:id>
         </soap:courseIds>
         <soap:learnerIds>
            <soap:id>string</soap:id>
         </soap:learnerIds>
         <soap:pageToken>string</soap:pageToken>
         <soap:pageSize>1000</soap:pageSize>
      </soap:ListEnrollmentsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Пример ответа

?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.ru/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:ListEnrollmentsResult>
         <ns1:enrollments>
            <ns1:enrollment>
               <ns1:enrollmentId>2b7d48aa-fa51-11e9-998f-0a580af40a83</ns1:enrollmentId>
               <ns1:courseId>2b2b8b28-fa51-11e9-88ef-0a580af40a83</ns1:courseId>
               <ns1:learnerId>2abfba42-fa51-11e9-95f0-0a580af40a83</ns1:learnerId>
               <ns1:accessDate>2019-10-29</ns1:accessDate>
               <ns1:shouldLockAfterDueDate>0</ns1:shouldLockAfterDueDate>
               <ns1:certificate>
                     <ns1:issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</ns1:issuedCertificateId>
                     <ns1:issueDate>2022-07-15T07:19:00+00:00</ns1:issueDate>
                     <ns1:expiryDate>2022-07-15T07:21:00+00:00</ns1:expiryDate>
               </ns1:certificate>
            </ns1:enrollment>
            <ns1:enrollment>
               ...
            </ns1:enrollment>
         </ns1:enrollments>
         <ns1:nextPageToken>string</ns1:nextPageToken>
      </ns1:ListEnrollmentsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>