LsteventsessionHistory
Allows event hosts or site administrators to request detailed usage data
for previously hosted events.
A host can only access his or her own event history, but a site
administrator can access the history of all the events hosted on his or
her site. When a site administrator specifies a hostWebExID, the system
will return the data of the specified host’s events; if a hostWebExID is
not specified, all the events on his or her site will be returned. If
you are not a site administrator, the element hostWebExID will be
ignored.
Request
The sample XML document queries for the event session history on the site for the specified period of time.
<?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.history.LsteventsessionHistory">
<startTimeScope>
<sessionStartTimeStart>01/18/2004 00:58:16
</sessionStartTimeStart>
<sessionStartTimeEnd>01/19/2004 01:58:16</sessionStartTimeEnd>
</startTimeScope>
<endTimeScope>
<sessionEndTimeStart>01/18/2004 00:00:16</sessionEndTimeStart>
<sessionEndTimeEnd>01/31/2004 00:58:16</sessionEndTimeEnd>
</endTimeScope>
<listControl>
<startFrom>1</startFrom>
<maximumNum>12</maximumNum>
<listMethod>AND</listMethod>
</listControl>
<order>
<orderBy>CONFNAME</orderBy>
<orderAD>ASC</orderAD>
<orderBy>CONFID</orderBy>
<orderAD>ASC</orderAD>
<orderBy>STARTTIME</orderBy>
<orderAD>ASC</orderAD>
</order>
</bodyContent>
</body>
</serv:message>
The following schema diagram shows the structure of the elements in the lsteventsessionHistory request message.
Figure 9-3 • Schema diagram for lsteventsessionHistory
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 History Service”.
Response
The sample XML document shows an example of a possible response to the preceding request document.
<?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:history="http://www.webex.com/schemas/2002/06/service/history">
<serv:header>
<serv:response>
<serv:result>SUCCESS</serv:result>
<serv:gsbStatus>PRIMARY</serv:gsbStatus>
</serv:response>
</serv:header>
<serv:body>
<serv:bodyContent xsi:type="history:LsteventsessionHistoryResponse"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<history:eventSessionHistory>
<history:confID>4664836</history:confID>
<history:sessionKey>101451536</history:sessionKey>
<history:confName>akushc</history:confName>
<history:sessionStartTime>01/19/2004 00:58:16
</history:sessionStartTime>
<history:sessionEndTime>01/19/2004 02:24:48
</history:sessionEndTime>
<history:duration>87</history:duration>
<history:timezone>4</history:timezone>
<history:meetingType>ONS</history:meetingType>
<history:userID>479412751</history:userID>
<history:hostWebExID>test</history:hostWebExID>
<history:hostName>test</history:hostName>
<history:hostEmail>poloz@sz.webex.com</history:hostEmail>
<history:totalPeopleMinutes>145</history:totalPeopleMinutes>
<history:totalCallInMinutes>0</history:totalCallInMinutes>
<history:totalCallInTollfreeMinutes>0
</history:totalCallInTollfreeMinutes>
<history:totalCallOutDomestic>0</history:totalCallOutDomestic>
<history:totalCallOutInternational>0
</history:totalCallOutInternational>
<history:totalVoipMinutes>71</history:totalVoipMinutes>
<history:totalParticipants>3</history:totalParticipants>
<history:totalParticipantsVoip>5</history:totalParticipantsVoip>
<history:totalParticipantsCallIn>0
</history:totalParticipantsCallIn>
<history:totalParticipantsCallOut>0
</history:totalParticipantsCallOut>
<history:peakAttendee>8</history:peakAttendee>
</history:eventSessionHistory>
<history:matchingRecords>
<serv:total>1</serv:total>
<serv:returned>1</serv:returned>
<serv:startFrom>1</serv:startFrom>
</history:matchingRecords>
</serv:bodyContent>
</serv:body>
</serv:message>
The following schema diagram shows the structure of the elements in the lsteventsessionHistoryResponse message.
Figure 9-4 • Schema diagram for lsteventsessionHistoryResponse
The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.