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

Метод: enrollLearnersInCourses

Важно:

Метод позволяет назначать пользователям только курсы. Записать пользователя на мероприятие, используя этот метод, нельзя.
С помощью метода вы можете создать назначение на курс с мероприятием, но без выбора сессии для посещения. Пользователь сможет самостоятельно выбрать сессию в своем портале.

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

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

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

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

Параметр	Тип	Описание
token (обязательный)	string	Токен доступа. Вы можете получить токен с помощью запроса
courseIds (обязательный)	string[]	ID курсов, которые вы хотите назначить
learnerIds (обязательный)	string[]	ID учащихся, которым вы хотите назначить курсы
accessDate (необязательный)	dateTime	Дата и время начала обучения. Если дата и время не указаны, будут автоматически подставлена текущие дата и время
dueDateType (обязательный)	string	Параметр показывает, есть ли у курса срок выполнения или же он неограничен по времени. Возможные значения параметра: unlimited, default, due_date, due_period
dueDate (обязательный)	date	Параметр обязателен, если dueDateType равен due_date
duePeriod (обязательный)	int	Параметр обязателен, если dueDateType равен due_period. Указывается в часах
lockAfterDueDate (необязательный)	bool	Параметр показывает, будет ли курс заблокирован после окончания срока выполнения. Возможные значения: false или true

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

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

Параметр	Тип	Описание
success	bool	True, если назначение было успешно создано

Возможные ошибки

Тип	Описание
Permission denied	У пользователя недостаточно прав для создания назначений
Wrong parameters	Ошибка в запросе

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

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="https://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
      <EnrollLearnersInCoursesRequest>
         <credentials>
           <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
         </credentials>
         <courseIds>
            <id>146ac240-d54f-11e9-9b88-0a580af40973</id>
         </courseIds>
         <learnerIds>
            <id>8363b098-e031-11e9-89cf-0a580af40b0f</id>
         </learnerIds>
         <accessDate>2019-09-24 10:30:00</accessDate>
         <dueDateType>unlimited</dueDateType>
         <dueDate>2019-09-25</dueDate>
         <duePeriod>10</soap:duePeriod>
      </EnrollLearnersInCoursesRequest>
 </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.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <ns1:SuccessResult>
      <ns1:success>true</ns1:success>
    </ns1:SuccessResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

Создание назначения