report-active-meetings

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Returns a list of Adobe® Acrobat® Connect™ Professional meetings that are currently in progress, including the number of minutes the meeting has been active.

For report-active-meetings to return results, at least one user must be present in at least one meeting room. If meetings are scheduled at present, but no users are attending those meetings, report-active-meetings returns an empty response.

Request URL

http://server_name/api/xml
    ?action=report-active-meetings
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

<results>
    <status code=allowedValue />
    <report-active-meetings>
        <sco sco-id=integer active-participants=integer 
                length-minutes=integer>
            <name>string</name>
            <url-path>string</url-path>
            <date-begi>datetime</date-begin>
        </sco>
    </report-active-meetings>
</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-active-meetings`		Container	The list of all meetings currently in progress.
`sco`		Container	Information about one meeting in progress.
	`sco-id`	Integer	The unique ID of a meeting in progress.
	`active-participants`	Integer	The number of users attending the meeting in progress, including hosts and presenters.
	`length-minutes`	Integer	The number of minutes the meeting has been active.
`name`		String	The name of the meeting, defined when the meeting was created.
`url-path`		String	The part of the meeting URL that comes after the domain and is unique to this meeting.
`date-begin`		Datetime	The date and time the meeting began.

Sample request

https://example.com/api/xml?action=report-active-meetings

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <report-active-meetings>
        <sco sco-id="2006778715" active-participants="" length-minutes="1">
            <name>Designing Online Courses</name> 
            <url-path>/online/</url-path> 
            <date-begin>2006-06-28T14:35:21.307-07:00</date-begin> 
        </sco>
    </report-active-meetings>
</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_act3.htm