Availability

Breeze 5

Description

Returns information about principal-to-SCO transactions on your Adobe Connect server or in your Adobe Connect hosted account.

A transaction is an instance of one principal visiting one SCO. The SCO can be a Adobe Connect meeting, course, document, or any content on the server.

These are all examples of transactions:

  • If a principal attends a meeting twice, two transactions exist: one for each time the principal attended the meeting.

  • If five people attend a meeting, five transactions exist: one for each user who attended the meeting.

  • If a principal takes two courses three times each and passes each only on the third try, six transactions exist: one for each attempt on each course.

This call returns all transactions, so consider using a filter to reduce the volume of the response. For example, if you use filter-type=meeting, the call returns all meeting transactions:

 https://example.com/api/xml?action=report-bulk-consolidated-transactions 
     &filter-type=meeting

From the response, you can calculate Adobe Connect meeting usage by comparing times in date-created and date-closed (see “ Calculate meeting usage”). However, this call to report-bulk-consolidated-transactions, with filter-type=meeting, returns only users who logged in to the meeting as participants, not users who entered the meeting as guests.

Request URL

 http://server_name/api/xml 
     ?action=report-bulk-consolidated-transactions 
     &filter-definition=value 
     &sort-definition=value 
     &session=BreezeSessionCookieValue

Parameters

Name

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-consolidated-transactions>  
         <row transaction-id=integer sco-id=integer type=allowedValue  
                 principal-id=integer score=integer>  
             <name>string</name>  
             <url>relativeUrl</url>  
             <login>string</login>  
             <user-name>string</user-name>  
             <status>allowedValue</status>  
             <date-created>datetime</date-created>  
             <date-closed>datetime</date-closed> 
         </row> 
         ...  
     </report-bulk-consolidated-transactions> 
 </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-consolidated-transactions

Container

The entire list of transactions that matches the request.

row

Container

Details of one transaction that matches the request.

transaction-id

BIGINT

The ID of the transaction.

sco-id

BIGINT

The unique ID of the object (SCO) the user interacted with.

type

Allowed value

The type of the SCO (see type for allowed values).

principal-id

BIGINT

The ID of the principal involved in the transaction.

score

Integer

If the transaction (such as a quiz) assigned a score, the actual score. Otherwise, 0.

name

String

The name assigned to the SCO involved in the transaction.

url

String

The file name portion of the URL to the SCO involved in the transaction.

login

String

The principal’s login ID.

user-name

String

The full name of the user involved in the transaction (concatenated from first-name and last-name).

status

Allowed value

The status of the transaction. Allowed values are completed, in-progress, user-passed, and user-failed.

date-created

Datetime

The date and time the principal began interacting with the SCO and the transaction was created.

date-closed

Datetime

The date and time the principal finished interacting with the SCO and the transaction was complete.

Sample request

 https://example.com/api/xml?action=report-bulk-consolidated-transactions 
         &filter-type=meeting

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-bulk-consolidated-transactions> 
         <row transaction-id="2006905086" sco-id="2006905049" type="meeting" 
                 principal-id="2006258745" score="0"> 
             <name>Celebrate End of June Meeting</name>  
             <url>/endjune/</url>  
             <login>joy@acme.com</login>  
             <user-name>Joy Smith</user-name>  
             <status>completed</status>  
             <date-created>2006-06-30T11:10:37.003-07:00</date-created>  
             <date-closed>2006-06-30T11:45:21.397-07:00</date-closed>  
         </row> 
         <row transaction-id="2006905795" sco-id="2006905049" type="meeting" 
                 principal-id="2006258745" score="0"> 
             <name>Celebrate End of June Meeting</name>  
             <url>/endjune/</url>  
             <login>joy@acme.com</login>  
             <user-name>Joy Smith</user-name>  
             <status>completed</status>  
             <date-created>2006-06-30T17:58:29.060-07:00</date-created>  
             <date-closed>2006-06-30T17:59:09.970-07:00</date-closed>  
         </row> 
         ...  
     </report-bulk-consolidated-transactions> 
 </results>

See also

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