Name
Last updated on
May 15, 2021
Availability
Breeze 5
Description
Returns information about every quiz question in the account you are logged in to.
The response includes a combination of the quiz question, the answer, the ID of the user who answered, and the ID of the transaction.
This action returns all question-and-answer combinations in the account, unless you use a filter to limit the size of the response.
Request URL
http://server_name/api/xml ?action=report-bulk-questions &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
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-bulk-questions> <row transaction-id=integer score=integer principal-id=integer> <question>string</question> <response>string</response> <date-created>datetime</date-created> </row> ... </report-bulk-questions> </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-bulk-questions | Container |
The entire list of question-and-answer combinations that match the request. |
|
| row | Container |
Details about one question-and-answer combination. |
|
| transaction-id | BIGINT |
The ID of the interaction between a user and a quiz. |
|
| score | Integer |
The score assigned to the question. |
|
| principal-id | BIGINT |
The ID of the user who answered or viewed the question. |
|
| question | String |
The text of the question, which might be phrased as a statement. |
|
| response | String |
The response the user chose or entered. |
|
| date-created | Datetime |
The date and time the user answered the question. |
Sample request
https://example.com/api/xml?action=report-bulk-questions
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-bulk-questions> <row transaction-id="2006335803" score="10" principal-id="2006258745"> <question>The capital of California is<1></question> <response>Sacramento</response> <date-created>2006-05-11T15:50:23.643-07:00</date-created> </row> <row transaction-id="2006335827" score="0" principal-id="2006258745"> <question>The capital of California is<1></question> <response>san francisco</response> <date-created>2006-05-11T17:32:53.970-07:00</date-created> </row> </report-bulk-questions> </results>
See also
