Page tree
Skip to end of metadata
Go to start of metadata

You can create a new enrollment with the enrollLearnersInCourses method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators, Publishers, or users with a role with custom settings allowing to create enrollments.

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:

Parameter

Type

Description

enrollmentId

string

The ID of a created enrollment.

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>

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

<?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>
    <EnrollLearnersInCoursesResult>
      <enrollmentId>string</enrollmentId>
    </EnrollLearnersInCoursesResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels