Name
Last updated on
May 15, 2021
Availability
Breeze 4
Description
Provides a summary of data about a quiz, including the number of times the quiz has been taken; average, high, and low scores; and other information.
Request URL
http://server_name/api/xml ?action=report-quiz-summary &sco-id=integer &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Y |
The unique ID of a presentation that contains a quiz. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <report-quiz-summary> <row num-questions=integer average-score=integer low-score=integer high-score=integer numtaken=integer numdistincttaken=integer maxpossiblescore=integer asset-id=integer /> </report-quiz-summary> </results>
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
| results | Container |
All results the action returns. |
|
| status | Empty, with attributes |
The status of the response. |
|
| code | Allowed value |
A code indicating the response status (see status). |
|
| report-quiz-summary | Container |
Contains information about the quiz. |
|
| row | Empty, with attributes |
Summary information about the quiz. Can return more than one row element if the maxpossiblescore is different for different transcripts. |
|
| num-questions | Integer |
The number of questions on the quiz. |
|
| average-score | Integer |
The average score, across all users who have taken the quiz. |
|
| low-score | Integer |
The lowest score a user has received on the quiz. |
|
| high-score | Integer |
The highest score a user has received on the quiz. |
|
| numtaken | Integer |
The total number of times the quiz has been taken. |
|
| numdistincttaken | Integer |
The number of times the quiz has been taken by distinct principals. If a principal takes the quiz more than once, only one time is counted. |
|
| maxpossiblescore | Integer |
The highest possible score on the quiz. |
|
| asset-id | BIGINT |
The ID of the latest version of the SCO uploaded to the server. |
Sample request
https://server.com/api/xml?action=report-quiz-summary&sco-id=2006123456
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-quiz-summary> <row num-questions="2" average-score="0" low-score="0" high-score="0" numtaken="1" numdistincttaken="1" maxpossiblescore="0" asset-id="2006334911" /> <row num-questions="2" average-score="13" low-score="0" high-score="20" numtaken="3" numdistincttaken="3" maxpossiblescore="20" asset-id="2006334911" /> </report-quiz-summary> </results>