report-my-meetings

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Provides information about all Acrobat Connect meetings for which the user is a host, invited participant, or registered guest. The meeting can be scheduled in the past, present, or future.

Request URL

http://server_name/api/xml
    ?action=report-my-meetings
    &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 /> 
    <my-meetings> 
        <meeting sco-id=integer type="meeting" icon="meeting" 
                permission-id=allowedValue active-participants=integer> 
            <name>string</name> 
            <description>string</description> 
            <domain-name>domain</domain-name> 
            <url-path>url</url-path> 
            <date-begin>date</date-begin> 
            <date-end>date</date-end> 
            <expired>boolean</expired> 
            <duration>time</duration> 
        </meeting> 
        ...
    </my-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).
`my-meetings`		Container	Information about all meetings the user is, or has been, invited to.
`meeting`		Container	Details about one of the user's meetings.
	`sco-id`	Integer	The unique ID of the meeting.
	`type`	Allowed value	The type of the object returned (for this call, always `meeting`).
	`icon`	Allowed value	The icon that visually identifies the meeting in Enterprise Manager (for this call, always `meeting`).
	`permission-id`	Allowed value	The level of permission the user has to the meeting (see permission-id for values).
	`active-participants`	Integer	The number of participants the meeting currently has, including hosts and presenters.
`name`		String	The name of the meeting.
`domain-name`		String	The domain name portion of the URL to the meeting room.
`url-path`		String	The part of the meeting room URL that identifies the meeting and comes after the domain name.
`date-begin`		Datetime	The date and time the meeting begins (or has begun).
`date-end`		Datetime	The date and time the meeting ends (or has ended).
`expired`		Boolean	Whether the meeting has ended (`true` if it has, `false` if it has not).
`duration`		Time	The actual length of time of the meeting. This may be longer or shorter than the time the meeting was scheduled for.

Sample request

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

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <my-meetings>
        <meeting sco-id="2006334033" type="meeting" icon="meeting" 
                    permission-id="host" active-participants="0">
            <name>How to Write a Novel</name> 
            <domain-name>example.com</domain-name> 
            <url-path>/novel/</url-path> 
            <date-begin>2006-05-11T11:30:00.000-07:00</date-begin> 
            <date-end>2006-05-11T12:30:00.000-07:00</date-end> 
            <expired>true</expired> 
            <duration>01:00:00.000</duration> 
        </meeting>
        <meeting sco-id="2006743452" type="meeting" icon="meeting" 
                    permission-id="host" active-participants="0">
            <name>Intro to Film</name> 
            <domain-name>example.com</domain-name> 
            <url-path>/film/</url-path> 
            <date-begin>2006-06-09T14:00:00.000-07:00</date-begin> 
            <date-end>2006-06-09T20:00:00.000-07:00</date-end> 
            <expired>true</expired> 
            <duration>06:00:00.000</duration> 
        </meeting>
    </my-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_ac17.htm