Availability

Breeze 4

Description

Returns a list of users who attended a Adobe Connect meeting. The data is returned in row elements, one for each person who attended. If the meeting hasn’t started or had no attendees, the response contains no rows.The response does not include meeting hosts or users who were invited but did not attend.

To call report-meeting-attendance, you must have publish, mini-host, or host permission on the meeting (see permission-id for details).

Request URL

 http://server_name/api/xml 
     ?action=report-meeting-attendance 
     &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 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-meeting-attendance> 
         <row transcript-id=integer sco-id=integer principal-id=integer 
                 answered-survey=boolean> 
             <login>string</login>  
             <session-name>string</session-name>  
             <sco-name>string</sco-name>  
             <date-created>datetime</date-created>  
             <date-end>datetime</date-end>  
             <participant-name>string</participant-name>  
         </row> 
         ... 
     </report-meeting-attendance> 
 </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-meeting-attendance

Container

The entire list of attendees for the meeting.

row

Container

Data about one meeting attendee.

transcript-id

BIGINT

The ID of the meeting transcript.

sco-id

BIGINT

The unique ID of the meeting.

principal-id

BIGINT

The ID of the principal who attended the meeting.

answered-survey

Boolean

Whether the meeting participant responded to a meeting poll. If 0 or false, the meeting did not have a poll or the participant did not respond (if 1 or true, the opposite). This value is updated when the poll is closed.

login

String

The meeting attendee’s login name.

session-name

String

The name of the user who entered the meeting room, creating a session.

sco-name

String

The name of the meeting.

date-created

Datetime

The date the meeting was created.

date-end

Datetime

The date the meeting ended.

participant-name

String

The name of the meeting attendee as registered with the server.

Sample request

 https://example.com/api/xml?action=report-meeting-attendance 
         &sco-id=2006778715

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-meeting-attendance> 
         <row transcript-id="2006778723" sco-id="2006778715"  
                     principal-id="2006258745" answered-survey="0"> 
             <login>joy@acme.com</login>  
             <session-name>Joy Smith</session-name>  
             <sco-name>Designing Online Courses</sco-name>  
             <date-created>2006-06-28T14:35:21.307-07:00</date-created>  
             <date-end>2006-06-28T15:09:05.447-07:00</date-end>  
             <participant-name>Joy Smith</participant-name>  
         </row> 
     </report-meeting-attendance> 
 </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