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

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

Сравнение версий

Старая версия 9

changes.mady.by.user Irina Chumanova

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user elena.antipova

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Включить страницу
Лэйблы с указанием тарифа
Лэйблы с указанием тарифа

Метод: getEnrollments

Информация

...

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

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

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

credentials Смотрите описание объекта Credentials. список .
ПараметрТипОписание
token (обязательный)credentialsstringТокен доступа. Вы можете получить токен с помощью запроса
courseIds  (необязательный)arrayID материалов, список назначений которых вы хотите получить
learnerIds  (необязательный)arrayID пользователей, список назначений которых вы хотите получить

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

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

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

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

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

ПараметрТипОписание
enrollmentarrayМассив, содержащий значения  — ID подразделения, его название, код и родительское подразделениеданные о назначении
enrollmentIdstringID назначения
courseIdstringID курса
learnerIdstringID учащегося, на которого назначен курс
accessDatedateДата начала обучения
dueDatedateСрок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения
expirationDatedateСрок выполнения курса. Параметр появляется в ответе, если для назначения указан срок выполнения и shouldLockAfterDueDate=1
shouldLockAfterDueDateboolean

Запрет доступа после окончания срока выполнения.

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

0 — доступ разрешен,

1 — доступ запрещен

issuedCertificateIddateID сертификата (токен) из полученного списка назначений
certIssueDatedateДата выдачи сертификата
certExpiryDatedateДата истечения сертификата
enrollmentTypeGroupint32

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

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

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

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


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

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

Блок кода
languagexml
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="httphttps://ispringlearn.comru/go/services/api/soap">
  <SOAP-ENV:Body>
      <GetEnrollmentsRequest>
         <credentials>
              <accountUrl>http://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>

...

Блок кода
languagexml
?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="httphttps://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="httphttps://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>
            <certificate>
                <issuedCertificateId>66b4ed00-040e-11ed-a8a2-b6f58d6fa7b5</issuedCertificateId>
             <dueDate>2019-09-30</dueDate>
   <issueDate>2022-07-15T07:19:00+00:00</issueDate>
                <expirationDate>2019<expiryDate>2022-09-30</expirationDate>07-15T07:21:00+00:00</expiryDate>
            <shouldLockAfterDueDate>true<</shouldLockAfterDueDate>certificate>
         </enrollment>
          ...
      </GetEnrollmentsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

...