Availability

Breeze 4

Description

Provides information about all the interactions users have had with a certain quiz. An interaction identifies all answers one user makes to one quiz question. If a user answers the same question more than once, all answers are part of the same interaction and have the same interaction-id.

This report provides information about every answer that any user has ever given to questions on a quiz. You can filter the response to make it more meaningful, using any allowed filters. For example, you can request all answers a certain user has given:

 https://example.com/api/xml?action=report-quiz-interactions 
         &sco-id=2006334909&filter-like-name=Joy%20Smith

Or, you can request only a certain user’s answers to a specific question:

 https://example.com/api/xml?action=report-quiz-interactions 
     &sco-id=2006334909&filter-name=Joy%20Smith 
     &filter-like-description=What is the capital of California

Request URL

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

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The unique ID of a presentation or course 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

 <results> 
     <status code=allowedValue />  
     <report-quiz-interactions> 
         <row display-seq=integer transcript-id=integer interaction-id=integer  
                     sco-id=integer score=integer> 
             <name>string</name>  
             <sco-name>string</sco-name>  
             <date-created>datetime</date-created>  
             <description>string</description>  
             <response>integer</response>  
         </row> 
         ... 
     </report-quiz-interactions> 
 </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-interactions

Container

Information about all interactions all users have had with the quiz.

row

Container

Information about one user, one quiz question, and one answer. Multiple row elements can be part of the same interaction.

display-seq

Integer

The sequence number of this question in the quiz.

transcript-id

BIGINT

The ID of one user’s attempt to take a quiz, with one user, one attempt at a quiz, and multiple questions and answers. Each time the user takes the quiz, the transcript-id changes.

interaction-id

BIGINT

The ID of all answers one user makes to one quiz question.

sco-id

BIGINT

The unique ID of a presentation or course that contains the quiz.

score

Integer

The user’s score for this question.

name

String

The name of the user.

sco-name

Integer

The name of the presentation or course that contains the quiz.

date-created

Datetime

The date or time the user started the course.

description

String

The quiz question the user answered.

response

String

The response the user gave.

Sample request

 https://example.com/api/xml?action=report-quiz-interactions 
     &sco-id=2006334909&filter-name=Joy Smith 
     &filter-like-description=governor

Sample request

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
 <status code="ok" />  
     <report-quiz-interactions> 
         <row display-seq="2" transcript-id="2006335803"  
                 interaction-id="2006334914" sco-id="2006334909" score="10"> 
             <name>Joy Smith</name>  
             <sco-name>California Quiz</sco-name>  
             <date-created>2006-05-11T15:50:23.643-07:00</date-created>  
             <description> 
                 The governor of California is a former actor. 
             </description>  
             <response>true</response>  
         </row> 
         <row display-seq="2" transcript-id="2006335827"  
                 interaction-id="2006334914" sco-id="2006334909" score="0"> 
             <name>Joy Smith</name>  
             <sco-name>California Quiz</sco-name>  
             <date-created>2006-05-11T17:32:53.970-07:00</date-created>  
             <description> 
             The governor of California is a former actor. 
             </description>  
             <response>false</response>  
         </row> 
         <row display-seq="2" transcript-id="2006335954"  
                 interaction-id="2006334914" sco-id="2006334909" score="10"> 
             <name>Joy Smith</name>  
             <sco-name>California Quiz/sco-name>  
             <date-created>2006-05-12T11:55:24.940-07:00</date-created>  
             <description> 
             The governor of California is a former actor. 
             </description>  
             <response>true</response>  
         </row> 
     </report-quiz-interactions> 
 </results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy