AVAILABLE WITH BUSINESS SUBSCRIPTION

MethodlistEnrollments

You can get all the account enrollments, enrollments related to certain learners or to certain courses, or both.


Permissions to Run the Request

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

Department Administrators, Publishers, and users with a custom role can get information about enrollments assigned to users from the departments they manage and their sub-departments.

Request Parameters

ParameterTypeDescription
token (required)stringAccess token. You can obtain a token by making a request.
courseIds (optional)array

The IDs of courses whose enrollments you would like to retrieve.

learnerIds (optional)arrayThe IDs of users whose enrollments you would like to retrieve.
pageSize (optional)stringThe number of entries per page. If not indicated, equal to 1000.
pageToken  (optional)stringThe token needed to continue to the next page.

Return Values

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

ParameterTypeDescription
enrollmentarray

An array containing enrollments IDs.

nextPageTokenstringThe token needed to continue to the next page.
issuedCertificateId
The certificate ID (token) from the list of enrollments.
certIssueDatedateThe date the certificate was issued.
certExpiryDatedateThe certificate’s expiration date.
enrollmentTypeGroupint32Possible values:

0 — assigned by an administrator

1 — added from the catalog
The date of issue and expiration of the certificate can only be received for active enrollments. When using this method, you cannot get the data for archived or deleted enrollments.

Sample Request

<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/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

Sample Response

?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://ispringlearn.com/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>
XML