Method: enrollLearnersInCourses

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, Publishersor custom roles

Department Administrators, Publishers, and users with a custom role can enroll in courses only users from the departments they manage and their sub-departments.

Parameters

Parameter

Type

Description

credentials (required)credentialsRead the description of the Credentials object.
courseIds (required)string[]

The IDs of the courses you want to assign.

learnerIds (required)string[]The IDs of the learners you want to enroll in the courses.
accessDate (optional)dateTimeThe date and time when learners are supposed to start studying the course. If the start date and time aren't indicated, the current date and time will be auto-populated.
dueDateType (required)stringThis parameter indicates if the course has a due date or it isn't time-limited. Possible values of the parameter are unlimited, default, due_date, due_period.
dueDate (required)dateThis parameter is required if dueDateType is equal to due_date. 
duePeriod (required)int

This parameter is required if dueDateType is equal to due_period. It is measured in hours.

Return Value

After the request has been successfully processed, the system returns an object with the following properties:

ParameterTypeDescription
successboolTrue if the enrollment has been successfully created.

Possible Errors

Type

Description

Permission deniedThe user has no permissions to create enrollments.
Wrong parametersThe system failed to process the request because it did not contain all necessary parameters.

Sample Request

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
      <EnrollLearnersInCoursesRequest>
        <credentials>
          <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
          <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>
         <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>

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <ns1:SuccessResult>
      <ns1:success>true</ns1:success>
    </ns1:SuccessResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>