Method: ListLearnersModulesResults

You can retrieve results for the entire account, for certain learners, courses, and modules, specify the statuses of users and courses, start, completion, and due dates.

Learn how to get a list of all course modules in the Getting a List of Course Modules article.

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles.

Department Administrators and users with a custom role can get results of users belonging to the departments they manage and their sub-departments.

Request Parameters

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request
userIds (optional)	string[]	An array of IDs of the users whose results you want to retrieve
courseIds (optional)	string[]	An array of IDs of the courses which results you want to retrieve
modulesIds (optional)	string[]	Course modules IDs
courseItemIds (optional)	string[]	An array of IDs of the course modules which results you want to retrieve
enrollmentIds (optional)	string[]	An array of the enrollments IDs which results you want to retrieve
accessDate[startDate], accessDate[endDate] (optional)	string (date-time RFC3339)	The time range for course assignment date. This parameter can be limited only by one point
dueDate[startDate], dueDate[endDate] (optional)	string (date-time RFC3339)	The time range for course due date. This parameter can be limited only by one point
completionDate[startDate], completionDate[endDate] (optional)	string (date-time RFC3339)	The time range for course completion date. This parameter can be limited only by one point
completionStatuses (optional)	string[]	The statuses of courses which results you would like to retrieve. Possible values are: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined
departmentIds (optional)	string[]	An array of IDs of the departments whose results you want to retrieve
userStatuses (optional)	number	The user status. Possible values are: 1 — active, 3 — blocked. By default, the response shows data on active users
pageSize (optional)	number	The number of entries per page. If not indicated, equal to 1000
pageToken (optional)	string	The 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:

Parameter	Type	Description
learnersResults []	array	An array data on learners' level of training
userIds	string	The user ID
courseIds	string	The course ID
moduleIds	string	Content ID
enrollmentIds	string	The enrollment ID
accessDate	string	Start date of the course
dueDate	string	Course completion date. This parameter is specified in the response if the course completion date has been defined
expirationDate	string	Course completion date. This parameter is specified in the response if access to the course will be closed after the completion date
completionDate	string	Course completion date
timeSpent	string	Time taken to complete the course
completionStatus	string	Course completion status Possible values: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined
isOverdue	string	Whether or not the course has expired Possible values: 0 — the course has not expired 1 — the course has expired
nextPageToken	string	The token needed to continue to the next page

Possible Errors

Error	Description
Permission denied	The user doesn't have permission to complete the request. For example, Department Administrator can't get results of users belonging to a department they don't manage

Sample Request

<?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>
      <ListLearnersModulesResultsRequest>
         <credentials>
            <token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</token>
         </credentials>
         <userIds>
            <id>25e44840-87a0-11e9-897c-0a580af40783</id>
         </userIds>
         <courseIds>
            <id>596e5f20-8c46-11e9-a814-0a580af4024a</id>
         </courseIds>
         <moduleIds>
            <id>607e6f31-9c57-12e8-a914-1a590af4025a</id>
         </moduleIds>
         <courseItemIds>
            <id>553964ac-3c5c-11ef-b1c4-02420a200163</id>
            <id>65a773eb-3c5c-11ef-b1c4-02420a200163</id>
            <id>81fdb5be-3c5c-11ef-9bec-02420a200177</id>
            <id>49032582-3c5c-11ef-b6fd-02420a200177</id>
         </courseItemIds>
         <enrollmentIds>
            <id>1777fdf0-232d-11ea-a24a-0a580af40c27</id>
            <id>a2cadee0-adee-11e9-b31d-0a580af40909</id>
            <id>3d4776b0-ae06-11e9-9707-0a580af4013b</id>
            <id>296bdbd8-aec2-11e9-aee5-0a580af402ea</id>
         </enrollmentIds>
         <accessDate>
            <startDate>2019-01-06T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </accessDate>
         <dueDate>
            <startDate>2019-01-12T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </dueDate>
         <completionDate>
            <startDate>2019-01-12T00:00:00+00:00</startDate>
            <endDate>2019-31-12T00:00:00+00:00</endDate>
         </completionDate>
         <completionStatuses>
            <value>complete</value>
         </completionStatuses>
         <departmentIds>
            <id>81826672-9e49-11e9-b4fc-0a580af40235</id>
         </departmentIds>
         <userStatuses>
            <value>1</value>
            <value>3</value>
         </userStatuses>
         <pageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</pageToken>
         <pageSize>100</pageSize>
      </ListLearnersModulesResultsRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<?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>
      <ListLearnersModulesResultsResult>
         <learnersResults>
             <learnerResult>
               <userId>6b0dfde6-9e69-11e9-8e2c-0a580af404f9</userId>
               <courseId>e1175540-ae0f-11e9-b49e-0a580af405b3</courseId>
               <courseTitle>Course 1</courseTitle>
               <moduleId>607e6f31-9c57-12e8-a914-1a590af4025a</moduleId>
               <moduleTitle>Item 1</moduleTitle>
               <courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>
               <enrollmentId>1777fdf0-232d-11ea-a24a-0a580af40c27</enrollmentId>
               <accessDate>2019-12-25T01:00:00+00:00</accessDate>
               <dueDate>2019-12-27T21:00:00+00:00</dueDate>
               <expirationDate>2019-12-27T21:00:00+00:00</expirationDate>
               <completionStatus>not_started</completionStatus>
               <progress>0</progress>
               <isOverdue>true</isOverdue>
            </learnerResult>
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>9789a1ec-adee-11e9-b1b5-0a580af40906</courseId>
               <courseTitle>Course 2</courseTitle>
               <moduleId>607e6f32-9c58-12e8-a914-1a590af4025b</moduleId>
               <moduleTitle>Item 2</moduleTitle>
               <courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
               <enrollmentId>a2cadee0-adee-11e9-b31d-0a580af40909</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <timeSpent>127</timeSpent>
               <completionStatus>in_progress</completionStatus>
               <progress>80</progress>
               <awardedScore>13.64</awardedScore>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            <learnerResult>
               <userId>0569aad2-adee-11e9-b6c5-0a580af40906</userId>
               <courseId>1b70b088-ae06-11e9-b7d8-0a580af405b3</courseId>
               <courseTitle>Course 3</courseTitle>
               <moduleId>607e6f32-9c58-12e8-a914-1a590af4025b</moduleId>
               <moduleTitle>Item 3</moduleTitle>
               <courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
               <enrollmentId>3d4776b0-ae06-11e9-9707-0a580af4013b</enrollmentId>
               <accessDate>2019-07-24T00:00:00+00:00</accessDate>
               <completionDate>2019-07-24T11:30:07+00:00</completionDate>
               <timeSpent>41006</timeSpent>
               <completionStatus>complete</completionStatus>
               <progress>100</progress>
               <isOverdue>false</isOverdue>
               <viewsCount>3</viewsCount>
            </learnerResult>             
            <learnerResult>
               <userId>1529eee6-adee-11e9-a5d9-0a580af40906</userId>
               <courseId>1a6bc896-aec2-11e9-8955-0a580af406a3</courseId>
               <courseTitle>Course 4</courseTitle>
               <moduleId>607e6f32-9c58-12e8-a914-1a590af4025b</moduleId>
               <moduleTitle>Item 4</moduleTitle>
               <courseItemId>49032582-3c5c-11ef-b6fd-02420a200177</courseItemId>
               <enrollmentId>296bdbd8-aec2-11e9-aee5-0a580af402ea</enrollmentId>
               <accessDate>2019-07-25T00:00:00+00:00</accessDate>
               <completionDate>2019-07-25T09:55:37+00:00</completionDate>
               <timeSpent>37</timeSpent>
               <completionStatus>complete</completionStatus>
               <progress>100</progress>
               <isOverdue>false</isOverdue>
               <viewsCount>2</viewsCount>
            </learnerResult>
            </learnersResults>
         <nextPageToken>MGJiYjhlZGMtMjcwMS0xMWVhLTljYzgtMGE1ODBhZjQwYzRm</nextPageToken>
      </ListLearnersModulesResultsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>