Getting a List of Courses (Page-by-Page)
AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: listContent
You will retrieve a list of course that were originally uploaded to the account. Content copied from other courses won't appear in the response.
Learn how to get a list of all course modules in the Getting a List of Course Modules article.
Permissions to Run Request
Account Owner, Account Administrators, Department Administrators, as well as Course Authors and users with a custom role with access to the project containing this course.
For users with a custom role, allow "View and enroll users into training programs."
Request Parameters
Parameter | Type | Description |
---|---|---|
token (required) | string | Access token. You can obtain a token by making a request. |
contentItemId (required) | string | The course ID |
pageSize (optional) | string | 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 |
---|---|---|
contentItems | array | An array with a list of courses, learning tracks, or standalone content items |
contentItem | array | An array of data about the course, learning track, or standalone content |
contentItemId | string | ID of the learning track, course, or standalone content |
title | string | Title of the learning track, course, or standalone content |
subtitle | string | Subtitle of the learning track, course, or standalone content |
description | string | Description of the learning track, course, or standalone content |
userId | string | ID of the user to whom the learning track, course, or content is assigned |
addedDate | dateTime | Date of addition of the learning track, course, or standalone content |
viewUrl | string | Link to view the learning track, course, or standalone content |
type | string | Type of content |
nextPageToken | string | The token needed to continue to the next page |
Possible Errors
Error | Description |
---|---|
Unknown content item | The course with the indicated ID was not found |
Permission denied | The user doesn't have permission to complete the request |
Sample Request
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListContentRequest>
<soap:credentials>
<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
</soap:credentials>
<soap:pageToken>string</soap:pageToken>
<soap:pageSize>1000</soap:pageSize>
</soap:ListContentRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<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:ListContentResult>
<ns1:contentItems>
<ns1:contentItem>
<ns1:contentItemId>string</ns1:contentItemId>
<ns1:title>string</ns1:title>
<ns1:subtitle>string</ns1:subtitle>
<ns1:description/>
<ns1:userId>string</ns1:userId>
<ns1:addedDate>2019-11-13T06:30:49+00:00</ns1:addedDate>
<ns1:viewUrl>string</ns1:viewUrl>
<ns1:type>string</ns1:type>
</ns1:contentItem>
<ns1:contentItem>
...
</ns1:contentItem>
</ns1:contentItems>
<ns1:nextPageToken>string</ns1:nextPageToken>
</ns1:ListContentResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>