LstsummaryMeeting
LstsummaryMeeting
lists summary information for scheduled meetings. (This operation replaces LstMeeting
.)
The result
and exceptionID
global elements allow you to confirm that an instantiation request was successful. These elements are described in [Global Response Elements Showing Results and Errors]*If hostWebExID
is unspecified, a site administrator calling LstsummaryMeeting
will attempt to return scheduled meetings for all hosts on the site. A regular host will return only his or her own meetings. _02-07_GlobalResponseElementsShowingResultsandErrors.md#global-response-elements-showing-results-and-errors).
Notes
LstsummaryMeeting
is designed to enable regular Webex Meetings hosts get information for meetings they scheduled or were invited to. These meetings can be of any access type (i.e. public, private, or unlisted).If
hostWebExID
is unspecified, a site administrator callingLstsummaryMeeting
will attempt to return scheduled meetings for all hosts on the site. A regular host will return only his or her own meetings. This API is not designed for site administrators requesting information about meetings for many, or all users, on a site. Such requests can lead to unpredictable behavior, ranging from very slow system responses to an error message.
As mentioned above, for descriptions of the global elements in the security context of the header, please see Global Request Elements in Security Context.
For descriptions of the non-global elements, please refer to Elements in WebEx XML Schema Definitions for the Meeting Service.
Request
The following schema diagram shows the structure of the elements in a lstsummaryMeeting
request message.
Figure 5-16 • Schema Diagram for lstsummaryMeeting
The XML code below shows a sample request for summary information for meetings scheduled within a specific date range.
<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<header>
<securityContext>
<webExID>hostid</webExID>
<password>hostpassword</password>
<siteID>0000</siteID>
<partnerID>9999</partnerID>
<email>johnsmith@xyz.com</email>
</securityContext>
</header>
<body>
<bodyContent xsi:type="java:com.webex.service.binding.meeting.LstsummaryMeeting">
<listControl>
<startFrom>1</startFrom>
<maximumNum>10</maximumNum>
<listMethod>OR</listMethod>
</listControl>
<order>
<orderBy>HOSTWEBEXID</orderBy>
<orderAD>ASC</orderAD>
<orderBy>CONFNAME</orderBy>
<orderAD>ASC</orderAD>
<orderBy>STARTTIME</orderBy>
<orderAD>ASC</orderAD>
</order>
</bodyContent>
</body>
</serv:message>
Response
The following schema diagram shows the structure of the elements in a lstsummaryMeetingResponse
message.
Figure 5-17 • Schema Diagram for lstsummaryMeetingResponse
The XML code below shows a sample lstsummaryMeetingResponse
message.
<?xml version="1.0" encoding="UTF-8"?>
<serv:message
xmlns:serv="http://www.webex.com/schemas/2002/06/service"
xmlns:com="http://www.webex.com/schemas/2002/06/common"
xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting"
xmlns:att="http://www.webex.com/schemas/2002/06/service/attendee">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent
xsi:type="meet:lstsummaryMeetingResponse"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<meet:meeting>
<meet:meetingKey>805758262</meet:meetingKey>
<meet:confName>MC session</meet:confName>
<meet:meetingType>3</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/06/2010 12:10:54</meet:startDate>
<meet:duration>60</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>807369510</meet:meetingKey>
<meet:confName>MC session</meet:confName>
<meet:meetingType>3</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/06/2010 12:10:54</meet:startDate>
<meet:duration>60</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>804897338</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>809728112</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>806106065</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>806344494</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>803809748</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>802564582</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>803754412</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:meeting>
<meet:meetingKey>801848443</meet:meetingKey>
<meet:confName>Sample Meeting</meet:confName>
<meet:meetingType>1</meet:meetingType>
<meet:hostWebExID>bill</meet:hostWebExID>
<meet:otherHostWebExID>bill</meet:otherHostWebExID>
<meet:timeZoneID>4</meet:timeZoneID>
<meet:timeZone>GMT-08:00, Pacific (San Francisco)</meet:timeZone>
<meet:status>NOT_INPROGRESS</meet:status>
<meet:startDate>05/31/2004 10:10:10</meet:startDate>
<meet:duration>20</meet:duration>
<meet:listStatus>PUBLIC</meet:listStatus>
<meet:hostJoined>false</meet:hostJoined>
<meet:participantsJoined>false</meet:participantsJoined>
</meet:meeting>
<meet:matchingRecords>
<serv:total>25</serv:total>
<serv:returned>10</serv:returned>
<serv:startFrom>1</serv:startFrom>
</meet:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>