Webex XML API

LstsummarySession

LstsummarySession lists summary information for scheduled sessions. Users can specify search criteria such as host email and Webex ID, service type, session type and status (in progress or not in progress).

LstsummarySession can return information for all service types, including Meeting Center, Training Center, Event Center, Sales Center and Support Center. Information is returned based on which service types are specified in the request using the serviceTypes element. It can be used in place of LstsummaryMeeting, LstsummaryTrainingSession, and LstsummaryEvent.

If any serviceTypes specifications are defined in the request, then audio-only (AUO=16), access anywhere (RAS=10), and SMARTtech (SMT=14) sessions will be filtered out, unless they are specified in sessionTypes.

The startTime value is returned in the timezone specified in the timeZoneID within dateScope in the request. If this is not spcified, startTime is returned in GMT. This will be adjusted for daylight saving and standard time based on if the startDate falls in the timeZoneID’s DST span.

The returned session list includes sessions that the user is invited to if invited is set to TRUE. This search can be combined with a date range to narrow down the results.

The returned session list includes whether or not a session is a repeating or a single event.

The returned session list includes sessions where the specified hostWebID or hostEmail is an alternate host.

LstsummarySession can return a session list based on the ConfID.

LstsummarySession can return a session list based on a case-insensitive search for meeting topics that start with the string specified in the confName field.

Notes

  • If both hostWebExID and hostEmail are unspecified, a site administrator calling LstsummarySession will attempt to return scheduled sessions for all hosts on the site. A regular host will return only his or her own sessions. This API is not designed for site administrators requesting information about meetings for many, or all users, on a site and such requests can lead to unpredictable behavior, ranging from very slow system responses to an error message.
  • A regular host can, by default, specify another hostEmail or webExID for LstsummarySession to retrieve public, private and unlisted sessions for other hosts. However, if the Allow 1-Click user to join unlisted Meetings setting is unchecked in the Site Administration tool, a regular host cannot retrieve another host's private or unlisted sessions.
  • When you call LstsummarySession without user authentication—that is, the webExID and password are not specified in the security context header—you can retrieve all public sessions on the site. However, if Require login before site access is checked in the Site Administration tool, LstsummarySession cannot be called without user authentication. Please note that, as mentioned in the first note above, requests that return a large amount of data can lead to undesirable behavior.
  • Calculating recurring sessions is resource intensive and can severely affect system performance. Date ranges for querying recurring sessions may not exceed 42 days. Recurring sessions may not be queried using an endDate range, or with the OR listMethod.

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 lstsummarySession request message.

Figure 4-17 • Schema Diagram for lstsummarySession

The XML code below shows a sample request for summary information about scheduled sessions.

xml
Copy<?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>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.LstsummarySession">
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>50</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>
            <dateScope>
                <timeZoneID>45</timeZoneID>
            </dateScope>
            <sessionTypes>
                <sessionType>1</sessionType>
                <sessionType>6</sessionType>
                <sessionType>11</sessionType>
            </sessionTypes>
            <serviceTypes>
                <serviceType>MeetingCenter</serviceType>
                <serviceType>TrainingCenter</serviceType>
            </serviceTypes>
            <invited>true</invited>
        </bodyContent>
    </body>
</serv:message>

Response

The following schema diagram shows the structure of the elements in a lstsummarySessionResponse message.

Figure 4-18 • Schema Diagram for lstsummarySessionResponse

The sample XML document shows an example of a possible response to a lstsummarySession request such as the one above.

xml
Copy<?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:ep="http://www.webex.com/schemas/2002/06/service/ep"
    xmlns:meet="http://www.webex.com/schemas/2002/06/service/meeting">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ep:lstsummarySessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:matchingRecords>
                <serv:total>4</serv:total>
                <serv:returned>4</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </ep:matchingRecords>
            <ep:session>
                <ep:sessionKey>801413456</ep:sessionKey>
                <ep:confName>meeting1</ep:confName>
                <ep:sessionType>1</ep:sessionType>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:hostWebExID>siteadmin</ep:hostWebExID>
                <ep:hostFirstName>site</ep:hostFirstName>
                <ep:hostLastName>admin</ep:hostLastName>
                <ep:otherHostWebExID>siteadmin</ep:otherHostWebExID>
                <ep:timeZoneID>4</ep:timeZoneID>
                <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
                <ep:status>NOT_INPROGRESS</ep:status>
                <ep:startTime>05/07/2010 05:45:00</ep:startTime>
                <ep:openTime>5</ep:openTime>
                <ep:duration>60</ep:duration>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:hostEmail>test@webex.com</ep:hostEmail>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:hostJoined>false</ep:hostJoined>
                <ep:participantsJoined>false</ep:participantsJoined>
                <ep:confID>63596348</ep:confID>
                <ep:registration>false</ep:registration>
                <ep:isRecurring>false</ep:isRecurring>
                <ep:hostType>1001001</ep:hostType>
            </ep:session>
            <ep:session>
                <ep:sessionKey>805705806</ep:sessionKey>
                <ep:confName>meeting2</ep:confName>
                <ep:sessionType>6</ep:sessionType>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:hostWebExID>siteadmin</ep:hostWebExID>
                <ep:hostFirstName>site</ep:hostFirstName>
                <ep:hostLastName>admin</ep:hostLastName>
                <ep:otherHostWebExID>siteadmin</ep:otherHostWebExID>
                <ep:timeZoneID>4</ep:timeZoneID>
                <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
                <ep:status>NOT_INPROGRESS</ep:status>
                <ep:startTime>05/07/2010 05:30:00</ep:startTime>
                <ep:openTime>5</ep:openTime>
                <ep:duration>60</ep:duration>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:hostEmail>test@webex.com</ep:hostEmail>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:hostJoined>false</ep:hostJoined>
                <ep:participantsJoined>false</ep:participantsJoined>
                <ep:confID>63596352</ep:confID>
                <ep:registration>false</ep:registration>
                <ep:isRecurring>false</ep:isRecurring>
                <ep:hostType>1001001</ep:hostType>
            </ep:session>
            <ep:session>
                <ep:sessionKey>805705806</ep:sessionKey>
                <ep:confName>training1</ep:confName>
                <ep:sessionType>11</ep:sessionType>
                <ep:serviceType>TrainingCenter</ep:serviceType>
                <ep:hostWebExID>siteadmin</ep:hostWebExID>
                <ep:hostFirstName>site</ep:hostFirstName>
                <ep:hostLastName>admin</ep:hostLastName>
                <ep:otherHostWebExID>siteadmin</ep:otherHostWebExID>
                <ep:timeZoneID>4</ep:timeZoneID>
                <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
                <ep:status>NOT_INPROGRESS</ep:status>
                <ep:startTime>05/07/2010 05:45:00</ep:startTime>
                <ep:openTime>5</ep:openTime>
                <ep:duration>60</ep:duration>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:hostEmail>test@webex.com</ep:hostEmail>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:hostJoined>false</ep:hostJoined>
                <ep:participantsJoined>false</ep:participantsJoined>
                <ep:confID>63596352</ep:confID>
                <ep:registration>false</ep:registration>
                <ep:isRecurring>false</ep:isRecurring>
                <ep:hostType>0</ep:hostType>
            </ep:session>
            <ep:session>
                <ep:sessionKey>801355394</ep:sessionKey>
                <ep:confName>training5</ep:confName>
                <ep:sessionType>11</ep:sessionType>
                <ep:serviceType>TrainingCenter</ep:serviceType>
                <ep:hostWebExID>siteadmin</ep:hostWebExID>
                <ep:hostFirstName>site</ep:hostFirstName>
                <ep:hostLastName>admin</ep:hostLastName>
                <ep:otherHostWebExID>siteadmin</ep:otherHostWebExID>
                <ep:timeZoneID>4</ep:timeZoneID>
                <ep:timeZone>GMT-08:00, Pacific (San Francisco)</ep:timeZone>
                <ep:status>NOT_INPROGRESS</ep:status>
                <ep:startTime>05/08/2010 06:00:00</ep:startTime>
                <ep:openTime>5</ep:openTime>
                <ep:duration>60</ep:duration>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:hostEmail>test@webex.com</ep:hostEmail>
                <ep:passwordReq>true</ep:passwordReq>
                <ep:hostJoined>false</ep:hostJoined>
                <ep:participantsJoined>false</ep:participantsJoined>
                <ep:confID>1019614042</ep:confID>
                <ep:registration>false</ep:registration>
                <ep:isRecurring>false</ep:isRecurring>
                <ep:hostType>0</ep:hostType>
            </ep:session>
        </serv:bodyContent>
    </serv:body>
</serv:message>
Next