report-quiz-question-response

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Provides a list of answers that users have given to questions on a quiz.

Without filtering, this action returns all answers from any user to any question on the quiz. However, you can filter the response for a specific user, interaction, or answer (see the filter syntax at filter-definition).

An interaction is a combination of one user and one question. If the user answers the same question more than once, all answers are part of the same interaction and have the same interaction-id.

Request URL

http://server_name/api/xml
    ?action=report-quiz-question-response
    &sco-id=integer
    &filter-definition=value
    &sort-definition=value
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The unique ID of a presentation that contains a quiz.
`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-question-response>
        <row principal-id=integer interaction-id=string>
            <user-name>string</user-name> 
            <response>string</response> 
            <date-created>datetime</date-created> 
        </row>
    </report-quiz-question-response>
</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-question-response`		Container	Information about all responses to all questions on the quiz.
`row`		Container	Information about one response.
	`principal-id`	Integer	The ID of the user who answered the quiz question.
	`interaction-id`	Integer	The ID of one response to one question.
`user-name`		String	The name of the user as registered on the server.
`response`		String	The user's response to the question, including a word or phrase, `true`, `false`, or a letter choice.
`date-created`		Datetime	The date and time the user responded.

Sample request

https://example.com/api/xml?action=report-quiz-question-response
    &sco-id=2006334909&filter-interaction-id=2006334913

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-quiz-question-response>
        <row principal-id="2006258745" interaction-id="2006334913">
            <user-name>Joy Smith</user-name> 
            <response>Sacramento</response> 
            <date-created>2006-05-11T15:50:23.643-07:00</date-created> 
        </row>
        <row principal-id="2006258745" interaction-id="2006334913">
            <user-name>Joy Smith</user-name> 
            <response>san francisco</response> 
            <date-created>2006-05-11T17:32:53.970-07:00</date-created> 
        </row>
        <row principal-id="2006258745" interaction-id="2006334913">
            <response>Sacramento</response> 
            <date-created>2006-05-12T11:55:24.940-07:00</date-created> 
        </row>
    </report-quiz-question-response>
</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_act2.htm