report-meeting-sessions

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Provides information about all the sessions of an Acrobat Connect meeting. A session is created when a participant enters an empty meeting. As more participants join the meeting, they join the session. The session ends when all attendees leave the meeting. When a new participant enters the now-empty meeting, a new session starts. For example, a recurring weekly meeting has a session each week when the meeting is held.

You can call report-meeting-sessions on past meetings, active meetings, or future meetings, but future meetings are not likely to have sessions.

Request URL

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

Parameters

Name	Type	Required	Description
`sco-id`	Integer	Y	The ID of a meeting for which you want session information.
`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-sessions>
        <row sco-id=integer asset-id=integer version=integer 
                num-participants=integer>
            <date-created>datetime</date-created> 
            <date-end>datetime</date-end> 
        </row>
        ...
    </report-meeting-sessions>
</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-sessions`		Container	The entire list of sessions for the meeting.
`row`		Container	Information about one session.
	`sco-id`	Integer	The unique ID of the meeting.
	`asset-id`	Integer	The unique ID of the session.
	`version`	Integer	A sequential ID for the session, starting at 1.
	`num-participants`	Integer	The number of participants in the meeting, other than the host.
`date-created`		Datetime	The date and time the session was created, when the participant entered the meeting room.
`date-end`		Datetime	The date and time the session ended, when the participant left the meeting room.

Sample request

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

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-meeting-sessions>
        <row sco-id="2006811328" asset-id="2006811333" version="1" 
                    num-participants="1">
            <date-created>2006-06-29T11:46:52.210-07:00</date-created> 
            <date-end>2006-06-29T13:34:43.410-07:00</date-end> 
        </row>
    </report-meeting-sessions>
</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/04b_ac13.htm