report-quiz-takers

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Provides information about all users who have taken a quiz in a training. Use a sco-id to identify the quiz.

To reduce the volume of the response, use any allowed filter or pass a type parameter to return information about just one type of SCO (courses, presentations, or meetings).

Request URL

http://server_name/api/xml
    ?action=report-quiz-takers
    &sco-id=integer
    &principal-id=integer
    &type=allowedValue
    &filter-definition=value
    &sort-definition=value
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The unique ID of a presentation or course that contains a quiz.
`principal-id`	Integer	N	The ID of a principal for whom you want quiz results.
`type`	Allowed value	N	The type of content for which you want results. Allowed values are `course`, `presentation`, and `meeting`.
`filter-definition`	Filter definition	N	A filter to reduce the volume of the response.
`sort-definition`	Sort definition	N	A sort to return results in a certain sequence.
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter or sort the response on any element or attribute it contains.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
    <report-quiz-takers> 
        <row transcript-id=integer sco-id=integer principal-id=integer 
                status=allowedValue score=integer asset-id=integer 
                permission-id=allowedValue attempts=integer time-taken=integer
                certificate=integer answered-survey=boolean version=integer> 
            <name>string</name> 
            <login>string</login> 
            <date-created>datetime</date-created> 
            <principal-name>string</principal-name> 
            <override>boolean</override> 
        </row> 
    </report-quiz-takers> 
</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-takers`		Container	Information about all users who have taken the quiz.
`row`		Container	Information about one user who has taken the quiz.
	`transcript-id`	Integer	The ID of the transcript on which the user's quiz score is recorded.
	`sco-id`	Integer	The unique ID of the presentation, course, or meeting that has the quiz.
	`principal-id`	Integer	The ID of the user who took the quiz.
	`status`	Allowed value	Whether the user passed or failed the most recent attempt at the quiz. Allowed values are `user-passed` and `user-failed`.
	`score`	Integer	The user's score on the most recent attempt at the quiz.
	`asset-id`	Integer	The ID of the version of the quiz the user attempted.
	`permission-id`	Allowed value	The level of permission the user has to access the quiz (see permission-id for values).
	`attempts`	Integer	The number of times the user has taken the quiz.
	`time-taken`	Integer	The amount of time the user spent taking the quiz, in milliseconds.
	`certificate`	Integer	The unique ID of a user's transcript.
	`answered-survey`	Boolean	Whether the learner completed a quiz. If 0 or false, the training does not have a quiz or the learner did not complete it. If 1 or true, the learner completed the quiz.
	`version`	Integer	The revision number of the quiz.
`name`		String	The name of the quiz.
`login`		String	The user's login name on the server.
`date-created`		Datetime	The date and time of the user's most recent quiz attempt.
`principal-name`		String	The full name of the user taking the quiz.
`override`		Boolean	A setting indicating whether a training manager can change the user's score on the quiz.

Sample request

https://example.com/api/xml?action=report-quiz-takers&sco-id=2006334909

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-quiz-takers>
        <row transcript-id="2006337854" sco-id="2006334909" 
                principal-id="2006258745" status="incomplete" score="0" 
                max-score="20" asset-id="2006334911" permission-id="" 
                attempts="4" time-taken="12593" certificate="" answered-survey="1"
                version="1">
            <name>California State Quiz</name> 
            <login>joy@acme.com</login> 
            <date-created>2006-05-16T11:14:47.000-07:00</date-created> 
            <principal-name>Joy Smith</principal-name> 
            <override>false</override> 
        </row>
    </report-quiz-takers>
</results>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04c_act4.htm