Getting IDs of Quizzes, Online Tests, and Role-plays
AVAILABLE WITH BUSINESS SUBSCRIPTION
GET /quizzes
Note:
You can retrieve a list of quizzes, surveys and online tests only from projects you have access to.
Permissions to Run the Request
Any role with access to at least one project.
Request Headers and Parameters
Header | Description |
---|---|
Authorization (required) | Access token. You can obtain a token by making a request. |
Content-Type: application/json (required) | Property for processing a request in JSON. |
Accept: application/json (required) | Property for processing a request in JSON. |
Parameter | Description |
quizIds | The quiz ID |
contentItemIds | The ID of a content item: a standalone quiz, online test, survey, presentation, or scrollable course. |
parentCourseIds | The ID of the course where a quiz is located. A standalone quiz and a quiz inside a course can have the same quizId. |
pageSize | The number of entries per page. If not indicated, equal to 1000. |
pageToken | The token needed to continue to the next page. |
Return Values
Header | Description |
---|---|
quizId | The ID of a quiz / online test. quizId ≠ contentItemId |
quizTitle | The title of a quiz. |
contentItemId | The ID of a content item: a standalone quiz, online test, survey, presentation, or scrollable course. |
parentCourseId | The ID of the course where a quiz is located. A standalone quiz and a quiz inside a course can have the same quizId. |
nextPageToken | The key needed to continue to the next page. |
Response Codes
Code | Text | Description |
---|---|---|
200 | OK | The request has been successfully processed. |
400 | Bad Request | An authorization error |
404 | Unknown content item | Can't find the quiz with the specified ID. |
403 | Permission denied | No permission to run this request. |
Sample Request
GET /quizzes?contentItemId[]=d4c2f7cd-3dd3-11ef-9b83-02420a200158&contentItemIds[]=e69cca40-3dd3-11ef-a14c-02420a200163&parentCourseIds[]=c9ccd654-3dd3-11ef-9773-02420a200177&quizIds[]=df229156-3dd3-11ef-a94b-02420a200177&quizIds[]=03749b76-3dd4-11ef-a26b-02420a200177&pageSize=10&pageToken=NDNmZGM3Y2UtM2EwMi0xMWVmLTk0YWQtMDI0MjBhMjAwMTc3 HTTP/1.1
Host: api-learn.ispring.com
X-Auth-Account-Url: https://mytraining.ispring.com
X-Auth-Email: owner
X-Auth-Password: 12345
XML
Sample Response in XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<quizzes>
<result>
<quizId>43fdc7ce-3a02-11ef-94ad-02420a200177</quizId>
<quizTitle>Basic rules of merchandising</quizTitle>
<contentItemId>4316da94-3a02-11ef-a422-02420a200177</contentItemId>
<parentCourseIds/>
</result>
<result>
<quizId>3c35bfb2-3d2f-11ef-8337-02420a200176</quizId>
<quizTitle>Quiz</quizTitle>
<contentItemId>3bcdb70a-3d2f-11ef-b19e-02420a200176</contentItemId>
<parentCourseIds/>
</result>
<result>
<quizId>75b4d0a6-4028-11ef-a7d0-02420a200176</quizId>
<quizTitle>Standalone Longread with Online Test</quizTitle>
<contentItemId>0a157d44-3dd4-11ef-a14c-02420a200163</contentItemId>
<parentCourseIds/>
</result>
<result>
<quizId>ebf3fa10-4e76-11ef-8fe4-02420a20017c</quizId>
<quizTitle>Matching Quiz</quizTitle>
<contentItemId>bbbf8a0a-4e76-11ef-91cf-02420a20014e</contentItemId>
<parentCourseIds/>
</result>
</quizzes>
</response>
XML
Sample Response in JSON
{
"quizzes": [
{
"quizId": "43fdc7ce-3a02-11ef-94ad-02420a200177",
"quizTitle": "Quiz",
"contentItemId": "4316da94-3a02-11ef-a422-02420a200177"
},
{
"quizId": "75b4d0a6-4028-11ef-a7d0-02420a200176",
"quizTitle": "Standalone Longread with Online Test",
"contentItemId": "0a157d44-3dd4-11ef-a14c-02420a200163"
},
{
"quizId": "75b4d0a6-4028-11ef-a7d0-02420a200176",
"quizTitle": "Standalone Longread with Online Test",
"contentItemId": "0a157d44-3dd4-11ef-a14c-02420a200163",
"parentCourseId": "c9ccd654-3dd3-11ef-9773-02420a200177"
},
{
"quizId": "ebf3fa10-4e76-11ef-8fe4-02420a20017c",
"quizTitle": "Matching Quiz",
"contentItemId": "bbbf8a0a-4e76-11ef-91cf-02420a20014e",
"parentCourseId": "c9ccd654-3dd3-11ef-9773-02420a200177"
}
],
"nextPageToken": "NDNmZGM3Y2UtM2EwMi0xMWVmLTk0YWQtMDI0MjBhMjAwMTc3"
}
YML