SetTrainingSession

Updates the information of an existing training session. This API now
filters for unsafe HTML input fields. See Table 2-8, “HTML Tags Checked”
for the fields affected.

Note: Lower Case email address modification

When creating meetings, events, and training sessions as well as
creating or registering meeting attendees, email addresses will be
converted to lower case when saved in the report DB to match with the
URL APIs behavior that converts the email into lower case

Not backward compatible; this may impact the current APP that has
attendee email in mixes case.

Request

The following schema diagram shows the structure of the elements in the
setTrainingSession request message.

Figure 6-43 • Schema diagram for setTrainingSession

Note SetTrainingSession now allows users to determine whether or
not attendees can join the teleconference before the host does. This
functionality is located in the schedule element.

The <repeatSession> fields are used to edit and delete recurring
single-sessions.
CreateEvent supports Join Before Host Telephony for TSP sessions.
Set <role>=HOST to add the user as an alternate host.

Note In WebEx11, if setTrainingSession changes repeatType of a
started meeting, returns Exception (ID=060042, 'On WebEx11 site, a
started session cannot be deleted or changed recurrence type')

The sample XML document requests to update a training session
with the Session Key of 18975177.


<?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.training.SetTrainingSession">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>111111</sessionPassword>
            </accessControl>
            <metaData>
                <confName>test</confName>
                <description>des</description>
                <agenda>age</agenda>
                <greeting>greet</greeting>
            </metaData>
            <enableOptions>
                <chat>true</chat>
                <poll>true</poll>
                <presentation>true</presentation>
                <applicationShare>true</applicationShare>
            </enableOptions>
            <schedule>
                <startDate>04/03/2004 00:00:00</startDate>
                <timeZoneID>45</timeZoneID>
                <duration>60</duration>
            </schedule>
            <telephony>
                <numPhoneLines>1</numPhoneLines>
                <telephonySupport>NONE</telephonySupport>
                <extTelephonyURL>sdfg</extTelephonyURL>
                <extTelephonyDescription>sdfg</extTelephonyDescription>
                <enableTSP>false</enableTSP>
                <tspAccountIndex>1</tspAccountIndex>
            </telephony>
            <tracking>
                <trackingCode1>as</trackingCode1>
                <trackingCode2>asdf</trackingCode2>
                <trackingCode3>asdf</trackingCode3>
                <trackingCode4>asdf</trackingCode4>
                <trackingCode6>asdf</trackingCode6>
                <trackingCode7>asdf</trackingCode7>
                <trackingCode8>asdf</trackingCode8>
                <trackingCode9>asdf</trackingCode9>
                <trackingCode10>asdf</trackingCode10>
            </tracking>
            <repeat>
                <repeatType>RECURRING_SINGLE</repeatType>
                <endAfter>3</endAfter>
                <dayInWeek>
                    <day>MONDAY</day>
                </dayInWeek>
                <occurenceType>WEEKLY</occurenceType>
            </repeat>
            <attendeeOptions>
                <emailInvitations>false</emailInvitations>
                <request>true</request>
                <registration>true</registration>
                <auto>true</auto>
            </attendeeOptions>
            <sessionKey>18975177</sessionKey>
            <status>NOT_INPROGRESS</status>
        </bodyContent>
    </body>
</serv:message>

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 Training Session Service”.

Response

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

Figure 6-44 • Schema diagram for setTrainingSessionResponse

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:sess="http://www.webex.com/schemas/2002/06/service/session"
    xmlns:train="http://www.webex.com/schemas/2002/06/service/trainingsession"
    xmlns:qti="http://www.webex.com/schemas/2002/06/service/trainingsessionqti"
    xmlns:qtiasi=
    "http://www.webex.com/schemas/2002/06/service/trainingsessionqtiasi">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="train:SetTrainingSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that
an instantiation request was successful. They are described in "Global Response
Elements Showing Results and Errors”.