XML API Reference Guide

Cisco Webex provides an online virtual meeting experience. The XML API provides a method to integrate Webex services with your custom web portal or application. This reference guide contains descriptions and examples for each avaialble XML request, response, and definition for all available options. For more details about the Cisco Webex service, visit http://www.webex.com.

Audience

This guide provides information for developers who are integrating a website or application with Cisco Webex meeting, training, event, or support services. It assumes that you are familiar with the following:

XML (eXtensible Markup Language)
Basic programming skills
Webex services

For more information refer to the:

Webex website: http://www.webex.com,
Webex University: http://university.webex.com

XML Request and Response Documents

This chapter explains how to use XML documents that provide request and response communications between your application and the Webex XML servers.

The Webex XML servers maintain the operations that capture information about users, meetings, and so on. Various XML request and response messages enable you to retrieve and change the information within those services.

Messages such as DelMeeting and GetMeeting are among the most succinct document types. For these types of messages, you supply only the element values that are required to identify the item to be deleted or retrieved.

To optimize flexibility when requesting, the Webex XML server can handle more complex and lengthy stretches of markup that includes request control elements in addition to the elements of a particular operation. For example, elements such as maximumNum, startFrom, and listMethod allow control over requests that can return multiple operations in a single transaction.

Global Request Elements in Security Context

Every Webex XML API request message requires a header section that specifies securityContext information to authenticate the Webex user with the site. The securityContext header is defined by the complex type contextSecurityType in the schema; it contains the following elements:

Element	Description
`webExID`	A Webex-maintained reference to the Webex user ID for the meeting host.
`password`	The password associated with the `webExID`.
`siteID`	The Webex-assigned identification number that uniquely identifies your website.
`siteName`	The first string in your Webex site URL, provided by Webex. For example: `siteName` is “acme” for the site `http://acme.webex.com`.
`partnerID`	Optional. A reference to the Webex partner, provided by Webex.
`email`	Optional. User must supply the email address that is stored in their user profile if they use this option.
`sessionTicket`	Valid for the duration of a session. Can be used in place of `<password>`.

XSD Schema Diagram of securityContext

All XML APIs that use <securityContext> have the option to use com:sessionTicket in place of com:password. See “AuthenticateUser” for more information.

Because the securityContext header contains the Webex user’s password, we strongly recommend submitting all XML API request messages through a secured protocol such as HTTPS.

Non-ASCII characters are not allowed in the password element. Table 2-2 shows a complete list of characters and their ASCII values that are allowed.

Table 2-2 • Allowable Characters in the Password Element

Global Request Elements for List Control

Choosing A Subset of Records

You can use the following two elements to cause a series of list transactions to span a possibly very large result set just once, in which case each transaction retrieves a record subset that has no overlap with prior record subsets. The startFrom element lets you set a threshold after which matching objects are not skipped, so you can skip startFrom matching objects. You must keep track of the total objects retrieved so far in your series of searches to be able to set the startFrom element to a value that prevents overlap with prior result sets, yet does not skip any records.

startFrom The number of (already retrieved) objects to be skipped before the next object that also matches the query criteria in the database is retrieved. Default value: 1 maximumNum The integer value for the maximum number of records to return from a search. Subsequent incremental searches can be made by incrementing the StartFrom attribute value. Default value: WBX_INFINITE, meaning as many objects as the search criteria selects.

Note For the sake of the server’s performance, Webex sets a default ceiling on the maximum number of records that can be returned. If the specified maximumNum is above this ceiling, only the number of records up to the ceiling are returned. For deprecated LstMeeting, LstTrainingSession and LstUser, the ceiling is set to 50 and the default value of maximumNum is 10. For other requests, the ceiling is set to 500 and the default value of maximumNum is 50.

In the corresponding response documents, the matchingRecords element is used to indicate the number of records returned, which makes it easier for you to parse and arrange the records returned. Under matchingRecords, there are three sub-elements, which are described respectively as follows:

total An integer indicating the total number of records matching your query. returned An integer indicating the number of records returned in this response. startFrom The record index number that the returned set starts from. An integer.

Specifying Boolean Relationships for Searches

The following attribute tells the Webex XML server the type of Boolean logic, either AND or OR, that you want applied when you supply two or more independent object attribute values for use as the selection criteria.

listMethod Specify the search selection logic as either AND or OR. when two or more search attributes are passed. AND requires that all attributes must exist in the user record in order to result in a positive match and the OR requires one or more of the attributes for a positive match. Default value: AND

Global Response Elements Showing Results and Errors

The following diagram shows the structure of the elements in the global response for results and errors.

Figure 2-1 • XSD Schema of the Global Response Type

The elements in the diagram are described as follows.

Element	Description
`performance`	String.
`result`	The two possible values for this element are `SUCCESS` and `FAILURE` depending on the outcome of the request.
`reason`	An exception reason string is returned if `result` is `FAILURE`. The value of this element is an empty string if `result` is `SUCCESS`. Note Integrations should only process the `<exceptionID>` codes and not parse the exception `<reason>` strings. Exception reason strings are subject to change in future releases. Integrations that are currently parsing the exception `<reason>` strings should update their code to process the `<exceptionID>` instead.
`gsbStatus`	Returns an enumeration value of either `PRIMARY` or `BACKUP`, depending on which site you are sending XML API requests on.
`exceptionID`	An `exceptionID` is returned if `result` is `FAILURE`, so that users can take further actions based on this ID. Its value takes the format of a six-digit number.
`subErrors`	Holds information about sub errors, if any, when `result` is `FAILURE`.
`value`	Holds the value that is going to replace the variable in a dynamic error message. For example: “Password must exceed `[n]` characters” is a dynamic error message. If “Password must exceed 6 characters” is returned in reason, then value is `6`.

User Service

This chapter describes operations related to user provisioning and maintenance that are supported by the Webex XML User Service.

This chapter contains sample XML documents that show example request messages and examples of possible response messages from the server.

Table 3-1 • Webex XML User-related Operations

*XML Request Message*	*Description*
`AuthenticateUser`	Accepts a SAML assertion in place of a user password.
`CreateUser`	Creates a user account. See information about default meeting types below.
`DelUser`	Deletes a user account.
`DelSessionTemplates`	Allows bulk delete of meeting session templates.
`GetloginTicket`	Generates and returns a host authentication ticket.
`GetloginurlUser`	Gets a user's login URL.
`GetlogouturlUser`	Gets a user's logout URL.
`GetUser`	Gets user information. See information about default meeting types below.
`LstsummaryUser`	Lists summary information about the user.
`LstUser` (deprecated)	Lists user accounts.
`SetUser`	Updates user account information. See information about default meeting types below.
`UploadPMRImage`	Uploads a photo or header image.

User Service In General

Spark Meet with Webex

In XML API 9.0 for WBS 30, Cisco Webex introduced features associated with a Common Identity site (CI-site): Common Architecture and Common User Profiles. These features were only available with new orders of Spark Meet with Webex. There was some impact to API backward compatibility for sites that were provisioned that way. The most significant impact was the limit of CI-enabled sites to perform user provisioning through API calls. On a CI-enabled site, operations associated with user provisioning were not supported through the API.

Note: On CI-enabled sites, the webExID of a user is the same as their email address. Requests to CI-enabled sites should use an email address for the value of the webExID element sent in the <securityContext> portion of a request message. For example:

 <header>
   <securityContext>
     <siteName>acme</siteName>
     <webExID>admincred@acme.com</webExID>
     <password>P@ssword123</password>
     <partnerID>mypartnerID</partnerID>
   </securityContext>
 </header>

Default Meeting Types

If a user has not set a default meeting type for scheduling (through their My Webex->Preference settings), the page and APIs set a default meeting type based on a pre-defined order in the system.

Before the release of XML API 10.0 SP1 for WBS 31, the pre-defined order was based on alphabetical order: EventCenter, MeetingCenter, SupportCenter, TrainingCenter.

With the release of XML API 10.0 SP1 for WBS 31 the pre-defined order changed to: MeetingCenter, EventCenter, TrainingCenter, SupportCenter.

To summarize:

Meeting type order for WBS 30 and before: EC -> MC -> SC -> TC
Meeting type order for WBS 31 and later: MC -> EC -> TC -> SC

In all cases, the ordering applies to both the 'getUser' and 'setUser' APIs when defaults are not provided or set by the user.

Teleconference Call-Back

A site admin can set the initial callback numbers for a host. See the Call-back Teleconferencing checkboxes in the following screenshot.

The <options> element has 4 elements related to callback numbers. The <options> element is used in the createUser, setUser, and getUser APIs. For consistency sake, the names of the callback elements are similar to the phone-number-related elements.

**NOTE: The labels on the end user panel are not the exact same wording as the schema elements: **

Office phone corresponds to the schema element workPhoneCallback
Cell phone corresponds to the schema element cellPhoneCallback
Alternate phone 1 corresponds to the schema element pagerCallback
Alternate phone 2 corresponds to the schema element faxCallback

A host can modify and change those preferences. The XML API supports this capability to set or update these callback numbers (for both site admins and hosts). Keep in mind that the site option for Call-back Teleconferencing must be enabled for the site in order for site admins and hosts to have this capability.

A host can set the callback information from their account, under the My Webex-> MyProfile menu. Each number can be enabled separately by checking the Call Me checkboxes. The following screenshot shows an example of a host's MyProfile panel.

AuthenticateUser

The AuthenticateUser API allows you to send authentication information.

In order to better support user authentication, WBS30 adds support for passwords as well as support for Common Identity (CI) access tokens.

In releases before WBS30, the authenticateUser API did not validate user passwords. Previous releases were able to validate SAML assertions from an Single-Sign-on (SSO) site. In WBS30, authentication has been expanded to accept passwords on SSO sites (in addition to SAML assertions) and passwords or CI Oauth access tokens on CI sites as methods of user authentication.

For sites that use the Common Identity (CI) service, a request to the authenticateUser API can use an accessToken as the input credential. The authentication server validates the input credential, and if successfully authenticated returns a value for the sessionTicket element, a createTime value, and a timeToLive value (in seconds).

Exception messages associated with this kind of request:

200006 : AS Server response error 000035: ASService not responding

The API can accept a SAML assertion in place of a user password. The <sessionTicket> returned can be used for subsequent XML API requests without using for the session duration as defined in Super Admin. This can take the place of the current requirement for a <webExID> and <password> for authentication.

Order Of Priority

In order to support backward compatibility, the authentication server checks input credentials in a specific order of priority.

SSO Sites

Order of processing input credentials for SSO sites: 1. samlResponse 1. password

The authentication server validates the input credentials, and if successfully authenticated, returns a value for the sessionTicket element.

CI Sites

Order of processing input credentials for CI sites: 1. password 2. accessToken

The authentication server validates the input credentials, and if successfully authenticated, returns a value for the sessionTicket element, a createTime value, and a timeToLive value (in seconds).

Request (using a `samlResponse`)

The following sample XML shows an example of a request that uses a <samlResponse> assertion.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>siteadmin@acme.com</webExID>
          <password>pass</password>            
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.user.AuthenticateUser">
          <samlResponse>a live samlResponse message</samlResponse>
        </bodyContent>
    </body>
</serv:message>

Request (using a `password` on a CI-enabled site)

The following sample XML shows an example of a request that uses a <password> for authentication on a site that uses the Common Identity service.

NOTE: For a CI-enabled site, the user name is the same as the user's email address.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
       <securityContext>
         <siteName>acme</siteName>
         <webExID>username.on.ciintegration@acme.com</webExID>
         <password>P@ssword000</password>
         <partnerID>s-PMok_wVv_EG_Mock</partnerID>
       </securityContext>
    </header>
    <body>
       <bodyContent xsi:type="java:com.webex.service.binding.user.AuthenticateUser">
       </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non-global elements, see Elements in Webex XML Schema Definitions for the User Service.

Schema Diagram

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

Figure 3-1 • Schema diagram for `authenticateUser`

Response

The following sample XML shows an example of an authenticateUserResponse 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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
          <serv:result>SUCCESS</serv:result>
          <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:authenticateUserResponse"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <use:sessionTicket>TicketInformationAAABTVl7rcMAAUijMSZH...DdXvynb9b7dF35zsn/l2hvA</use:sessionTicket>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The following sample XML shows an example of an authenticateUserResponse message returned in response to a request on a CI-enabled site.

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
          <serv:result>SUCCESS</serv:result>
          <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:authenticateUserResponse"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <use:sessionTicket>AAABTVl7rcMAAUijMSZH...DdXvynb9b7dF35zsn/l2hvA</use:sessionTicket>
          <use:createTime>1431725387202</use:createTime>
          <use:timeToLive>5400</use:timeToLive>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Schema Diagram

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

XSD Schema Diagram of `GetloginurlUserResponse`

CreateUser

The createUser API allows site administrators to create a new user.

If a super administrator has enabled the Limit Site Hosts functionality, and if the number of hosts exceeds the limit, the Webex XML service returns the error message: exceededSiteHostLimit.

Note: To enhance Personal Conference security, the XML API supports a telephone Personal Identification Number (PIN) for individual users, which improves security for Personal Conference Number (PCN) audio.

The 'PIN' element is available in createUser, setUser, and getUser operations:

Element	Parent	Definition	Type	Default
`PIN`	`<phones>`	Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees	string 0..1

The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support the "PCN Join Before Host" feature:

Element	Parent	Definition	Type	Default
`joinBeforeHost`	`<personalTeleconf>`	Indicates whether "PCN Join Before Host" is enabled for the user	boolean 0..1	`FALSE`

If an XML API user who has never had a PIN launches a PCN meeting and calls Webex audio access number, the Webex audio IVR will prompt the user to enter their PIN. The user needs to create their PIN before attempting to launch a PCN meeting. Otherwise, the user will not be able to launch meetings.

The host must set a PIN before a PCN account can be added or edited. The createUser and setUser APIs require the user to have a valid PIN to add or edit a PCN account. If a valid PIN does not exist, the XML API returns the error message: "valid PIN is required".

The PIN can be set through the XML API by using the createUser or setUser API. To retrieve the host's PIN, use the getUser API.

When using the createUser or setUser API to specify the PIN, the XML API service checks to see if the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If the value is not a valid PIN, the XML API returns an error message:

WBXValidationException (ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".

Join Before Host

The createUser and setUser APIs allow only the siteadmin to specify <personalTeleconf><joinBeforeHost> for the host. This option can be specified only on the SiteAdmin page. The host is not allowed to change the setting. An attempt by the host to change the value of <personalTeleconf><joinBeforeHost> results in the XML API services returning the error message:

NoPrivilegeException(ID = 000001, "Access denied, additional privileges are required")

Auto-enable CMR for new users

Be aware of the behavior of the createUser API for a site which has the site-level flag isEnableCET set to true.

A site level flag can be set that allows auto-enablement of CMR when a new user is created. When this flag is set, even if the API request does not set the site isEnableCET to true, the system creates the user with CMR enabled (as long as the license capacity has not been reached).

Request

The sample XML document shows an example of a request that creates a new user account for a user that will receive a Webex identifier of test1.pass.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.CreateUser">
            <firstName>fname</firstName>
            <lastName>lname</lastName>
            <webExId>username</webExId>
            <email>email@domain.com</email>
            <password>pass</password>
            <privilege>
                <host>true</host>
            </privilege>
            <active>ACTIVATED</active>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-3 • Schema diagram for createUser

Note

When you create a user, most options default to “true” or “false” depending on the site settings and the CreateUser request settings. After validation, any invalid settings will be automatically reset to “off”.

The following APIs synchronize their information if the syncWebOffice flag has been set to true: CreateUser, SetUser, DelUser, ActivateUser and InactivateUser.

The boolean element myWorkspaces has been added in order to support the WebOffice integration capabilities. The following containers and their associated elements were added: personalMeetingRoom, sessionOptions, supportCenter, schedulingTemplates, and orderTabs. This allows the API to return additional fields from My Profile.

When you create a user, if meetingTypes are not specified, all session types supported by your site will be assigned to the user. If you have specified the salesCenter related elements, CreateUser checks whether the site supports Sales Center; if not, an error occurs. If sme is TRUE, then both description and prodID should be specified. If sme is FALSE, then smeInfo related elements, such as description and prodID, cannot be specified; otherwise, a validation error occurs. The tspAccount and the personalTeleconf element cannot apply to a host account at the same time.

Users can be forced to change their password on their next login or locked out of their account entirely by Site Admin. The maximum password length is set to 60 characters. The enable element has been added to support the “Create this user as administrator on the Service Desk site” option in Site Admin. When CreateUser counts active host accounts, attendee account and designated chat user are excluded from the count, but site admin and admin view only are included. createOnBridge is for requesting the creation of a new account on the TSP Bridge. If your site allows TSP Account Provisioning, the account is created and the new account information is added to the user’s profile. Otherwise, only an existing TSP bridge account can be added to the user’s profile.

If the sendWelcome flag is set to TRUE, a successful call to the CreateUser API automatically sends a welcome email to the newly created host. Regarding the role of the user, one of the three elements (siteAdmin, roSiteAdmin or host) must be specified as TRUE. If more than one is set to TRUE, the role of the user is automatically determined by the sequence: siteAdmin, roSiteAdmin and host. For example, if both siteAdmin and host are set to TRUE, then the role of the user is siteAdmin. If none of the three elements are set to TRUE or specified, the default role of the user is host.

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
        <serv:body>
        <serv:bodyContent xsi:type="use:CreateUserResponse"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:userId>479423666</use:userId>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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”.

Figure 3-4 • Schema diagram for createUserResponse

DelUser

Deletes the specified user from your site. Permits up to 50 users to be deleted at a time.

Note This command actually deactivates a user. It does not remove the user data from the Webex database.

Request

The following sample XML document shows an example of a request to delete a user with a Webex identifier of johnson888. Your integration should provide a valid value that represents one of your website users.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.user.DelUser">
            <webExId>johnson888</webExId>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-6 • Schema diagram of `delUser`

Note

The following APIs synchronize their information if the syncWebOffice flag has been set to true: CreateUser, SetUser, DelUser, ActivateUser and InactivateUser.

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:delUserResponse"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 3-7 • Schema diagram of `delUserResponse`

DelSessionTemplates

Integrations are allowed to bulk delete meeting session templates. This is accomplished through the DelSessionTemplates function.

Request

The sample XML document shows an example request of the deletion of a template with the name of SACtemplate.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.DelSessionTemplates">
            <sessionTemplate>
                <name>SACtemplate</name>
                <serviceType>SalesCenter</serviceType>
            </sessionTemplate>
            <templateType>User</templateType>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-8 • Schema diagram of `delSessionTemplates`

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:delSessionTemplatesResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 3-9 • Schema diagram for `delSessionTemplatesResponse`

XSD Diagram of delSessionTemplatesResponse

GetloginTicket

Returns a host authentication ticket, which is a temporary identifier string associated with a host.

The ticket is typically used with the URL API login command for user authentication: an integration first calls GetLoginTicket to obtain the ticket string, and then calls the URL API p.php?AT=LI with TK= to authenticate the host.

Note This XML API will generate and return a new ticket for a host if there is no ticket available or that the last ticket has been used up by the host. This XML API is also allowed to be called by attendeeonly accounts that do not have session hosting privileges.

Request

The sample XML document shows an example request for a login ticket.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostname@acme.com</webExID>
          <password>P@ssword123</password>  
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.GetLoginTicket">
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-10 • Schema diagram of `getloginTicket`

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:use="http://www.webex.com/schemas/2002/06/service/user">
        <serv:header>
            <serv:response>
                <serv:result>SUCCESS</serv:result>
                <serv:gsbStatus>BACKUP</serv:gsbStatus>
            </serv:response>
        </serv:header>
        <serv:body>
            <serv:bodyContent xsi:type="use:getLoginTicketResponse"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <use:ticket>5e9733eb9efeb02d80aa0551ef7e9ccd</use:ticket>
                <use:apiVersion>Webex XML API V8.0.0</use:apiVersion>
            </serv:bodyContent>
        </serv:body>
</serv:message>

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

XSD Schema Diagram of `getloginTicketResponse`

GetloginurlUser

The GetloginurlUser request returns a Webex-generated Web address that can be used to prompt the user for a Webex sign-in name and password. The password is passed using a one-time login ticket string using the parameter &TK=[loginTicket].

Request

The sample XML document shows an example of a request for authentication of a user trying to access the account with webExID of test1.pass.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostid@acme.com</webExID>
          <password>hostPassword</password>            
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.GetloginurlUser">
            <webExID>hostid</webExID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-12 • Schema diagram of `getloginurlUser`

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:GetloginurlUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:userLoginURL>https://sitename.webex.com/sitename/p.php?AT=LI&FN=Fname&LN=Lname&EM=email@domain.com&WID=hostid&TK=ticket&MU=GoBack&BU=</use:userLoginURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

XSD Schema Diagram of `GetloginurlUserResponse`

GetlogouturlUser

The GetlogouturlUser request returns a Webex-generated address that can be used to close all communication connections with Webex for the specified user.

Request

The sample XML document shows an example of a request for a Web address that can be used to close all communications connections with Webex for the user with webExID test1.pass.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostid@acme.com</webExID>
          <password>hostPassword</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.GetlogouturlUser">
            <webExID>hostid</webExID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-14 • Schema diagram for getlogouturlUser

Response

The sample response message shows an example of a possible response to the preceding request.

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:GetlogouturlUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:userLogoutURL>https://sitename.webex.com/sitename/p.php?AT=LO&MU=GoBack&BU=</use:userLogoutURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 3-15 • Schema diagram for getlogouturlUserResponse

GetUser

Retrieves detailed information about the specified user.

Note: To enhance Personal Conference security, the XML API supports a user telephone Personal Identification Number (PIN), which is used to add security to Personal Conference Number audio.

The PIN element is available in the createUser, setUser, and getUser operations:

Element	Parent	Definition	Type	Default
`PIN	`<phones>`	Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees	string 0..1

The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support PCN Join Before Host:

Element	Parent	Definition	Type	Default
`joinBeforeHost`	`<personalTeleconf>`	Indicates if PCN Join Before Host is enabled for the user	boolean 0..1	`FALSE`

The PIN can be set through the XML API by using CreateUser/SetUser. You can use the GetUser operation to retrieve the host's PIN.

When using CreateUser/SetUser to specify the PIN, the XML API will check to see if the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If value is not a valid PIN, the XML API throws the exception: WBXValidationException (ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".

The CreateUser/SetUser operations allow only a siteadmin to specify <personalTeleconf><joinBeforeHost> for the host. This option can only be specified on the SiteAdmin page. The host is not allowed to change the setting. If this rule is violated, the XML API will throw the exception: NoPrivilegeException (ID = 000001, "Access denied, additional privileges are required").

If the deprecated element structure <personalTeleconf><account><joinBeforeHost> is used to set a value through CreateUser/SetUser requests, this input value will be ignored. Only the value of the element <personalTeleconf><joinBeforeHost> should be used.

The XML API GetUser response will still return <personalTeleconf><account><joinBeforeHost>, but the value will be identical to the value of the new element <personalTeleconf><joinBeforeHost>.

Request

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:getUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:firstName>aa</use:firstName>
            <use:lastName>bb</use:lastName>
            <use:categoryId>36</use:categoryId>
            <use:description>The system automatically creates this office when it
                creates your user account.</use:description>
            <use:company>ccccc</use:company>
            <use:webExId>hostid</use:webExId>
            <use:address>
                <com:addressType>PERSONAL</com:addressType>
                <com:country>1</com:country>
            </use:address>
            <use:phones>
                <com:phone>1,,,,,,</com:phone>
                <com:mobilePhone>1,,,,,,</com:mobilePhone>
                <com:fax>1,,,,,,</com:fax>
                <use:pager>1,,,,,,</use:pager>
            </use:phones>
            <use:email>email@domain.com</use:email>
            <use:password>******</use:password>
            <use:personalUrl>abcd</use:personalUrl>
            <use:expirationDate>12/31/2049 23:59:59</use:expirationDate>
            <use:commOptions>
                <use:prodAnnounce>false</use:prodAnnounce>
                <use:trainingInfo>false</use:trainingInfo>
                <use:electronicInfo>false</use:electronicInfo>
                <use:promos>false</use:promos>
                <use:press>false</use:press>
                <use:email>false</use:email>
                <use:fax>false</use:fax>
                <use:phone>false</use:phone>
                <use:mail>false</use:mail>
            </use:commOptions>
            <use:meetingTypes>
                <use:meetingType>1</use:meetingType>
                <use:meetingType>2</use:meetingType>
                <use:meetingType>3</use:meetingType>
                <use:meetingType>4</use:meetingType>
                <use:meetingType>5</use:meetingType>
                <use:meetingType>6</use:meetingType>
                <use:meetingType>7</use:meetingType>
                <use:meetingType>8</use:meetingType>
                <use:meetingType>9</use:meetingType>
                <use:meetingType>10</use:meetingType>
                <use:meetingType>11</use:meetingType>
                <use:meetingType>13</use:meetingType>
                <use:meetingType>14</use:meetingType>
                <use:meetingType>15</use:meetingType>
                <use:meetingType>16</use:meetingType>
            </use:meetingTypes>
            <use:options>
                <use:firstNameVisible>true</use:firstNameVisible>
                <use:lastNameVisible>true</use:lastNameVisible>
                <use:addressVisible>true</use:addressVisible>
                <use:workPhoneVisible>true</use:workPhoneVisible>
                <use:cellPhoneVisible>true</use:cellPhoneVisible>
                <use:pagerVisible>true</use:pagerVisible>
                <use:faxVisible>true</use:faxVisible>
                <use:officeUrlVisible>true</use:officeUrlVisible>
                <use:pictureVisible>true</use:pictureVisible>
                <use:notifyOnNewMessage>true</use:notifyOnNewMessage>
                <use:notifyOnMeeting>true</use:notifyOnMeeting>
                <use:followMeEnable>true</use:followMeEnable>
                <use:emailVisible>true</use:emailVisible>
                <use:listInCategory>true</use:listInCategory>
                <use:titleVisible>true</use:titleVisible>
                <use:folderRead>false</use:folderRead>
                <use:folderWrite>false</use:folderWrite>
                <use:messageVisible>false</use:messageVisible>
                <use:iconSelect1>false</use:iconSelect1>
                <use:iconSelect2>false</use:iconSelect2>
                <use:acceptLinkRequest>false</use:acceptLinkRequest>
                <use:holdOnLinkRequest>true</use:holdOnLinkRequest>
                <use:notifyOnLinkRequest>true</use:notifyOnLinkRequest>
                <use:supportVideo>true</use:supportVideo>
                <use:supportApp>true</use:supportApp>
                <use:supportFileShare>true</use:supportFileShare>
                <use:supportDesktopShare>true</use:supportDesktopShare>
                <use:supportMeetingRecord>true</use:supportMeetingRecord>
                <use:supportAppshareRemote>true</use:supportAppshareRemote>
                <use:supportWebTourRemote>true</use:supportWebTourRemote>
                <use:supportDesktopShareRemote>true
                </use:supportDesktopShareRemote>
                <use:subscriptionOffice>true</use:subscriptionOffice>
            </use:options>
            <use:timeZoneID>4</use:timeZoneID>
            <use:timeZone>GMT-08:00, Pacific (San Jose)</use:timeZone>
            <use:timeZoneWithDST>San Francisco (Pacific Time, GMT-08:00)
            </use:timeZoneWithDST>
            <use:tracking />
            <use:service>FREE_OFFICE</use:service>
            <use:privilege>
                <use:host>false</use:host>
                <use:teleConfCallOut>true</use:teleConfCallOut>
                <use:teleConfCallOutInternational>true
                </use:teleConfCallOutInternational>
                <use:teleConfCallIn>false</use:teleConfCallIn>
                <use:teleConfTollFreeCallIn>true</use:teleConfTollFreeCallIn>
                <use:siteAdmin>true</use:siteAdmin>
                <use:voiceOverIp>true</use:voiceOverIp>
                <use:roSiteAdmin>false</use:roSiteAdmin>
                <use:labAdmin>false</use:labAdmin>
                <use:otherTelephony>true</use:otherTelephony>
                <use:teleConfCallInInternational>true
                </use:teleConfCallInInternational>
                <use:attendeeOnly>false</use:attendeeOnly>
                <use:recordingEditor>true</use:recordingEditor>
                <use:meetingAssist>false</use:meetingAssist>
            </use:privilege>
            <use:language>ENGLISH</use:language>
            <use:locale>U.S.</use:locale>
            <use:active>ACTIVATED</use:active>
            <use:supportedServices>
                <use:meetingCenter>true</use:meetingCenter>
                <use:trainingCenter>true</use:trainingCenter>
                <use:supportCenter>true</use:supportCenter>
                <use:eventCenter>true</use:eventCenter>
                <use:salesCenter>true</use:salesCenter>
            </use:supportedServices>
            <use:myWebex>
                <use:isMyWebexPro>true</use:isMyWebexPro>
                <use:myContact>true</use:myContact>
                <use:myProfile>true</use:myProfile>
                <use:myMeetings>true</use:myMeetings>
                <use:myFolders>true</use:myFolders>
                <use:trainingRecordings>true</use:trainingRecordings>
                <use:recordedEvents>true</use:recordedEvents>
                <use:totalStorageSize>1000</use:totalStorageSize>
                <use:myReports>true</use:myReports>
                <use:myComputer>3</use:myComputer>
                <use:personalMeetingRoom>true</use:personalMeetingRoom>
                <use:myPartnerLinks>true</use:myPartnerLinks>
                <use:myWorkspaces>false</use:myWorkspaces>
            </use:myWebex>
            <use:personalTeleconf>
                <use:account>
                    <use:subscriberAccessCode>10148263</use:subscriberAccessCode>
                    <use:participantFullAccessCode>10059390
                    </use:participantFullAccessCode>
                    <use:participantLimitedAccessCode />
                    <use:accountIndex>1</use:accountIndex>
                    <use:defaultFlag>true</use:defaultFlag>
                    <use:joinBeforeHost>false</use:joinBeforeHost>
                </use:account>
            </use:personalTeleconf>
            <use:personalMeetingRoom>
                <use:welcomeMessage>test welcome msg!!</use:welcomeMessage>
                <use:photoURL>https://ian0830.webex.com/office_xml_wd1/20070788/t
                    est1/20070788.5480807.photo.gif?random=0.4094705581360112
                </use:photoURL>
            </use:personalMeetingRoom>
            <use:sessionOptions>
                <use:defaultSessionType>9</use:defaultSessionType>
                <use:defaultServiceType>EventCenter</use:defaultServiceType>
                <use:autoDeleteAfterMeetingEnd>false
                </use:autoDeleteAfterMeetingEnd>
                    <use:displayQuickStartHost>true</use:displayQuickStartHost>
                    <use:displayQuickStartAttendees>false
                </use:displayQuickStartAttendees>
            </use:sessionOptions>
            <use:supportCenter>
                <use:orderTabs>
                    <use:tab>Tools</use:tab>
                    <use:tab>Desktop</use:tab>
                    <use:tab>Application</use:tab>
                    <use:tab>Session</use:tab>
                </use:orderTabs>
                <use:serviceDesk>
                    <use:enable>false</use:enable>
                </use:serviceDesk>
            </use:supportCenter>
            <use:security>
                <use:forceChangePassword>false</use:forceChangePassword>
                <use:resetPassword>false</use:resetPassword>
                <use:lockAccount>false</use:lockAccount>
            </use:security>
            <use:languageID>1</use:languageID>
            <use:webACDPrefs>
                <use:isAgent>false</use:isAgent>
                <use:isMgr>false</use:isMgr>
                <use:numAgentSessions>1</use:numAgentSessions>
                <use:agentMonitorAllRSQueues>false</use:agentMonitorAllRSQueues>
                <use:managerMonitorAllRSQueues>false
                </use:managerMonitorAllRSQueues>
                <use:monitorAllRSAgents>false</use:monitorAllRSAgents>
            </use:webACDPrefs>
            <use:registrationDate>04/21/2010 21:13:39</use:registrationDate>
            <use:visitCount>0</use:visitCount>
            <use:userId>6624012</use:userId>
            <use:salesCenter>
                <use:roles>
                    <use:rep>true</use:rep>
                    <use:mgr>false</use:mgr>
                    <use:asst>false</use:asst>
                    <use:sme>false</use:sme>
                </use:roles>
            </use:salesCenter>
            <use:passwordExpires>false</use:passwordExpires>
            <use:passwordDaysLeft>0</use:passwordDaysLeft>
            <use:scheduleFor>
                <use:webExID>siteadmin</use:webExID>
            </use:scheduleFor>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The sample XML document shows an example of a request to retrieve a user account with a webExID value of hostid. Be sure to provide valid values for a user account on your site.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>hostid@acme.com</webExID>
          <password>hostPassword</password>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.user.GetUser">
            <webExId>hostid</webExId>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-16 • Schema diagram for getUser

Response

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

Figure 3-17 • Schema diagram for getUserResponse

Note

GetUser validates user options against the site options before returning the settings in the XML response. Users can be forced to change their password on their next login or locked out of their account entirely by Site Admin. The enable element has been added to support the “Create this user as administrator on the Service Desk site” option in Site Admin. 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”.

LstsummaryUser

Lists summary information of the users on your site. This API replaces LstUser.

Request

The sample XML requests the summary information of the users on the current site.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.LstsummaryUser">
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>10</serv:maximumNum>
                <serv:listMethod>AND</serv:listMethod>
            </listControl>
            <order>
                <orderBy>UID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
            <dataScope>
                <regDateStart>06/23/2004 01:00:00</regDateStart>
                <regDateEnd>06/23/2014 10:00:00</regDateEnd>
            </dataScope>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-20 • Schema diagram for lstsummaryUser

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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:LstsummaryUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <use:user>
                <use:webExId>hostid</use:webExId>
                <use:email>email@domain.com</use:email>
                <use:registrationDate>06/23/2004 20:53:08</use:registrationDate>
                <use:active>ACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
            </use:user>
            <use:user>
                <use:webExId>bush</use:webExId>
                <use:firstName>bush</use:firstName>
                <use:lastName>bush</use:lastName>
                <use:email>bush@email.com</use:email>
                <use:registrationDate>06/23/2005 21:07:55</use:registrationDate>
                <use:active>ACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
            </use:user>
            <use:user>
                <use:webExId>java</use:webExId>
                <use:firstName>java</use:firstName>
                <use:lastName>java</use:lastName>
                <use:email>java@email.com</use:email>
                <use:registrationDate>06/23/2006 21:36:05</use:registrationDate>
                <use:active>ACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
            </use:user>
            <use:user>
                <use:webExId>xml</use:webExId>
                <use:firstName>xml</use:firstName>
                <use:lastName>xml</use:lastName>
                <use:email>xml@email.com</use:email>
                <use:registrationDate>06/23/2007 16:56:41</use:registrationDate>
                <use:active>ACTIVATED</use:active>
                <use:timeZoneID>4</use:timeZoneID>
            </use:user>
            <use:matchingRecords>
                <serv:total>4</serv:total>
                <serv:returned>4</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </use:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 3-21 • Schema diagram for lstsummaryUserResponse

LstUser (Deprecated)

This function has been deprecated for performance reasons because it can potentially return too much data. Instead you should use LstsummaryUser (returns a list of essential user data) and GetUser (returns detailed information for one user) instead.

Sample code is not provided for deprecated XML messages.

Request

The following schema diagram shows the structure of the elements in the lstUser (Deprecated) request message.

Figure 3-5 • Schema diagram for lstUser (Deprecated)

Response

The following schema diagram shows the structure of the elements in the lstUserResponse (Deprecated) message.

Figure 3-23 • Schema diagram for lstUserResponse (Deprecated)

![]

SetUser

Allows site administrators to update the information of an existing user. If the Primary Large Telephony Server is unavailable, the page first tries to connect to the NextGen telephony server. If that connection is unavailable, the page will connect to the Backup 2 Large server instead.

The SetUser command returns an exceededSiteHostLimit error if an attempt to change a user's active=ACTIVATED parameter means that the Webex site's host limit would be exceeded.

Note: To enhance Personal Conference security, the XML API now supports a user's telephone PIN that is used to add security to Personal Conference Number audio.

The PIN element is available in the createUser, setUser, and getUser operations to support a user's telephone PIN:

Element	Parent	Definition	Type	Default
`PIN`	`<phones>`	Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees	string 0..1

The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support the "PCN Join Before Host" setting:

Element	Parent	Definition	Type	Default
`joinBeforeHost`	`<personalTeleconf>`	Indicates if PCN-Join Before Host is enabled for the user	boolean 0..1	`FALSE`

If an XML API user who has never had a PIN launches a PCN meeting and calls Webex audio access number, the Webex audio IVR will prompt user to enter their PIN. The user needs to create their PIN before attempting to launch a PCN meeting. Otherwise, the user will not be ale to launch meetings any more.

The host must set a PIN before a PCN account can be added or edited. The 'createUser' and 'setUser' API requires the user to have a valid PIN in order to add or edit a PCN account. If a valid PIN does not exist, the XML API returns the error message: "valid PIN is required".

The PIN can be set through the XML API by using CreateUser or SetUser API. Use the GetUser API to retrieve the host's PIN.

When using CreateUser or SetUser to specify the PIN, the XML API checks whether the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If value is not a valid PIN, the XML API throws the exception: WBXValidationException (ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".

Create/SetUser will only allow the site admin to specify for the host. This option can only be specified on the SiteAdmin page - so the host is not allowed to change the setting. If this rule is violated, the XML API will throw the exception: NoPrivilegeException(ID = 000001, "Access denied, additional privileges are required")

If the value is set through the XML API Create/SetUser request, this input value will now be ignored. Only the value of new element should be used.

The XML API GetUser response will still return , but the value will be identical to the value of the new element .

The setUser API includes video callback information (SIP URLs). The schema has changed to include this information as part of the videoSystems element as shown in the following schema diagram.

Request

In general, the SetUser request only updates the elements (simple or complex) that are explicitly specified. Unspecified elements remain unchanged. However, if a complex element (like <meetingType>) that contains 0..n or 1..n sub elements is specified, then the entire set of sub elements is updated.

The sample XML shows an example of a request to change the value of meetingType. The sample shows an example in which all previous <meetingType> values would be replaced by the single 105 value.

<meetingTypes>
    <meetingType>105</meetingType>
</meetingTypes>

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

Figure 3-25 • Schema diagram for setUser (Part 1)

Figure 3-25 • Schema diagram for setUser (Part 2)

Figure 3-25 • Schema diagram for setUser (Part 3)

Note The logic of some of the elements is as follows:

Most user options now default to “true” or “false” depending on the site settings and the SetUser request settings. The elements affected can be found in Table 2-5 and an example of how the settings interact can be found in Table 2-6.
After validation, any invalid settings will be automatically reset to “off”.
Users can be forced to change their password on their next login or locked out of their account entirely by Site Admin.
If sme is TRUE and a specified prodID does not exist on the site, a validation error occurs.
If more than one prodID is specified, the request updates the association between smeInfo and products. For example, the original values are “<products><prodID>120</prodID><prodID>123</prodID></products>”and you specified “<products><prodID>123</prodID><prodID>124</prodID></products>” with the request, then the result you will get is “<products><prodID>124</prodID><prodID>123</prodID></products>”.
If sme is FALSE, then all the smeInfo related records associated with this user are removed automatically.
The enable element has been added to support the “Create this user as administrator on the Service Desk site” option in Site Admin.
Regarding the role of the user, one of the three elements (siteAdmin, roSiteAdmin and host) must be specified as TRUE. If more than one is set to TRUE, the role of the user is automatically determined in the sequence of siteAdmin, roSiteAdmin and host. For example, if both siteAdmin and host are set to TRUE, then the role of the user is siteAdmin. If none of the three elements is set to TRUE, then the default role of the user is host.
SetUser allows the user to change their user name via the newWebexId element. If the Site Admin has enabled the “Allow user to change user name” setting then the user can change their setting as long as it does not conflict with a prior name.
The following APIs will now synchronize their information if the syncWebOffice flag has been set to true: CreateUser, SetUser, DelUser, ActivateUser and InactivateUser.

The following containers and their associated elements were added: personalMeetingRoom, sessionOptions, supportCenter, schedulingTemplates and orderTabs. This allows the API to return additional fields from My Profile.

When SetUser counts active host accounts, attendee account and designated chat user are excluded from the count, but site admin and admin view only are included.
The boolean element myWorkspaces has been added in order to support the WebOffice integration capabilities.

The sample XML document updates the information of an existing user account. Be sure to use key identification values that are correct for your website.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
<body>
    <bodyContent xsi:type="java:com.webex.service.binding.user.SetUser">
        <webExId>hostid</webExId>
        <personalMeetingRoom>
            <welcomeMessage>This is welcome message</welcomeMessage>
            <headerImageBranding>false</headerImageBranding>
        </personalMeetingRoom>
        <sessionOptions>
            <defaultSessionType>100</defaultSessionType>
            <defaultServiceType>EventCenter</defaultServiceType>
            <autoDeleteAfterMeetingEnd>false</autoDeleteAfterMeetingEnd>
            <displayQuickStartHost>true</displayQuickStartHost>
            <displayQuickStartAttendees>false</displayQuickStartAttendees>
        </sessionOptions>
        <supportCenter>
            <orderTabs>
            <tab>Tools</tab>
            <tab>Desktop</tab>
            <tab>Application</tab>
            <tab>Session</tab>
            </orderTabs>
        </supportCenter>
    </bodyContent>
</body>
</serv:message>

Response

The sample XML document shows the change that has been made to the existing service instance.

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:setUserResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </serv:body>
</serv:message>

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

Figure 3-28 • Schema diagram for setUserResponse

UploadPMRImage

Allows for the uploading of a photo or header image for the Webex user’s Personal meeting room. Both the Web page and the XML API can deal with a variety of image types. The UploadPMRImage operation acts similar to the existing UploadEventImage API which accepts images for uploading in a base64 binary encoding scheme.

Request

The following XML message shows an example of an UploadPMRImage request.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
          <siteName>acme</siteName>
          <webExID>admincred@acme.com</webExID>
          <password>P@ssword123</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.user.UploadPMRImage">
            <imageFor>Photo</imageFor>
            <imageData> .. the actual photo / image data goes here .. </imageData>
        </bodyContent>
    </body>
</serv:message>

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

Figure 3-29 • Schema diagram for uploadPMRImage

Response

The sample XML document shows an example of a possible uploadPMRImageResponse response to the preceding request.

<?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:use="http://www.webex.com/schemas/2002/06/service/user">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="use:uploadPMRImageResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 3-30 • Schema diagram for uploadPMRImageResponse

Elements in Webex XML Schema Definitions for the User Service

The following table describes all the elements that are used in the Webex XML API for the User Service.

*Element*	*Constraint(s)*	*Description*
`acceptLinkRequest`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of accepting link requests. Default: FALSE.
`accessCode`	Optional. String. Maximum of 32 characters.	The access code for a third party teleconference.
`accessToken`	Optional. String.	The string provided in a request as the credential for authentication. This method of authentication can be used on sites that use the Common Identity service.
`accountIndex`	Optional. An integer ranging from 1 to 3.	Specifies which of the user’s TSP accounts to use for teleconferencing.
`accountIndex` (in personalTeleconf element)	Required. An integer ranging from 1 to 3.	Holds the index of a Webex personal teleconference account.
`accountIndex` (in thirdPartyTeleconf element)	Required. An integer ranging from 1 to 3.	Holds the index of a third party teleconference account.
`active`	Optional. Valid values are ACTIVATED, REQUEST_TO_ACTIVATE, or DEACTIVATED.	Determines whether the user account has been staged for use. The CreateUser/SetUser command will return an exceededSiteHostLimit error if you set a user's active=ACTIVATED parameter so that the Webex site's host limit is exceeded. Default: ACTIVATED.
`address1`	Optional. Maximum of 128 characters.	The first line of the street address for the user’s Office Profile. Default: “”.
`address2`	Optional. Maximum of 128 characters.	The second line of the street address for the user’s Office Profile. Default: “”.
`addressType`	Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered Webex user.	Determines whether the meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. Default: “PERSONAL”.
`addressVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the address for the user. Default: FALSE.
`apiVersion`	Required. String.	The XML API version number.
`asst`	For Sales Center only. Optional. Valid values are TRUE and FALSE.	Indicates whether the user is a sales assistant.
`attendeeOnly`	Optional. Valid values are TRUE and FALSE.	If TRUE, then indicates that the user’s role is attendee only. If set to TRUE, then the host, the siteAdmin, the labAdmin and the roSiteAdmin elements should be FALSE. Default: FALSE.
		Note: The site must have Enable attendee accounts enabled. Otherwise, `createUser` and `setUser` with `attendeeOnly` set to TRUE will return an exception.
`autoDeleteAfterMeetingEnd`	Optional. Valid values are TRUE and FALSE.	Determines if meetings should be automatically deleted from My Meetings after a session is completed.
`autoGenerate`	Optional. Valid values are TRUE and FALSE.	Determines if the API automatically generates a PCN account by telephony server or not.
`backURL`	Optional.	A URL to which the user is returned after the command completes.
`categoryID`	Optional. A reference to another service or zero.	A reference to the office category for the user’s office. Default: 0.
`cellPhoneVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the cell phone number for the user. Default: FALSE.
`city`	Optional. Maximum of 64 characters.	The city for the user’s Office Profile. Default: “”.
`company`	Optional. Maximum of 128 characters.	The user’s company name.
`confBridgeNum`	Required for `createUser`. Optional for `setUser`. String.	The bridge telephone number in a third party teleconferencing account. The country code and the area code should be separated by hyphens. Example: 1-866- 555-5234.
`confName`	Required. String.	Specifies the name of a one-click conference.
`country`	Optional. Maximum of 64 characters.	The country for the user. Default: “”.
`createOnBridge`	Optional. Valid values are TRUE and FALSE.	If TRUE, then the user teleconferencing account will be created on the telephony bridge. If FALSE, then the account specified must already exist on the bridge. If your site allows TSP Account Provisioning, the account is created and the new account information is added to the user’s profile. Otherwise, only an existing TSP bridge account can be added to the user’s profile.
`createTime`	Optional. String.	Date when the `sessionTicket` was created.
`custom1`	Optional. String.	Stores additional fields associated with the user teleconferencing account.
`custom2`	Optional. String.	Stores additional fields associated with the user teleconferencing account.
`custom3`	Optional. String.	Stores additional fields associated with the user teleconferencing account.
`defaultFlag`	Optional. Valid values are TRUE and FALSE.	Determines if the account is to be used as the default account. Default value is FALSE.
`defaultServiceType`	Optional. com:serviceType Type.	Service info of a Default session type.
`defaultSessionType`	Optional. Integer.	Session info of a Default session type.
`delete`	Optional. Valid values are TRUE and FALSE.	Determines if an account is to be deleted by its index.
`description`	Optional. Maximum of 4000 characters.	A description of the user’s virtual office. Default: “”.
`description` (in smeInfo element)	For Sales Center only. Required if sme is specified. String. Maximum of 512 characters.	Description of the user’s subject matter expertise.
`displayQuickStartAttendees`	Optional. Valid values are TRUE and FALSE.	Determines whether or not to show QuickStart to the Attendees.
`displayQuickStartHost`	Optional. Valid values are TRUE and FALSE.	Determines whether or not to show QuickStart to the Host and the Presenter.
`electronicInfo`	Optional. Valid values are TRUE and FALSE.	Indicates electronic information. Default: FALSE.
`email`	Required for Create. Optional for Lst and Set. String. Must be a valid email address. Not applicable for all other actions. Maximum of 64 characters.	The email address of the user. Notifications of messages left by office visitors will be sent to this address.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`email` (in commOptions element)	Optional. Valid values are TRUE and FALSE.	Indicates the email address of the user. Default: FALSE.
`email2`	Optional. Maximum of 64 characters.	The secondary email address for the user’s Office Profile.
`emailVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of displaying Email addresses. Default: FALSE
`enable`	Optional. Valid values are TRUE and FALSE.	Enables Service Desk integration for user in Support Center. Default is FALSE.
`enable` (autoRequest element)	Required. Valid values are TRUE and FALSE.	Determines if the request is enabled when a session begins.
`enforce`	Required. Valid values are TRUE and FALSE.	Determines whether or not to enforce automatic recording.
`eventCenter`	Optional. Valid values are TRUE and FALSE.	If TRUE, enables the Event Center service (if available on the site) for the user.
`expirationDate`	Optional.	A Webex-maintained date and time at which the user’s account expires. Formatted as MM/DD/YYYY HH:MM:SS. Default: 12/31/2010 00:00:00.
`extTelephonyDescription`	Optional. Maximum of 2,048 characters.	A description of your telephony services, if you use your own as indicated in extTelephonyURL and in telephonySupport. By default, this is “Enter teleconference number, pass code, and other instructions here.”
`fax` (in commOptions element)	Optional. Maximum of 64 characters.	The fax number for the user’s Office Profile. Format is a series of comma- separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default: “”.
`fax` (in phones element)	Optional. Valid values are TRUE and FALSE.	Indicates the fax number for the user. Default: FALSE.
`faxVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the fax number for the user. Default: FALSE
`firstName`	Required for Create. Optional for Lst and Set. Must be a non-null value. Not applicable for all other actions. Maximum of 64 characters.	The user’s first name.
`firstNameVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the first name of the user. Default: FALSE.
`folderRead`	Optional. Valid values are TRUE and FALSE.	Toggles the accessibility of the folder. Default: FALSE.
`folderWrite`	Optional. Valid values are TRUE and FALSE.	Toggles the accessibility of the folder. Default: FALSE.
`followMeEnable`	Optional. Valid values are TRUE and FALSE.	Toggles the follow-me wizard for the meeting. Default: FALSE.
`forceChangePassword`	Optional. Valid values are TRUE and FALSE.	Determines if a user is forced to change their password on their next login. Is set to TRUE if resetPassword is set to TRUE. Defaults to FALSE.
`headerImageBranding`	Optional. Valid values are TRUE and FALSE.	Toggles whether or not to use the branding image of the header area.
`headerImageURL`	Optional. String.	A branding header image URL.
`holdOnLinkRequest`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of holding on link requests. Default: FALSE.
`host`	Optional. Valid values are TRUE and FALSE.	Indicates whether the user is the host for the meeting. Default: FALSE.
`hostWebexID`	Optional. String.	The Webex ID for a host.
`HQvideo`	Optional. Valid values are TRUE and FALSE.	Enables high-quality video for the user. Default: TRUE.
`iconSelect1`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of selecting icons. Default: FALSE.
`iconSelect2`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of selecting icons. Default: FALSE.
`inputMode`	Required. String.	Specifies a tracking code display type.
`imageData`	Optional. base64Binary.	Image data.
`imageFor`	Optional. imageForType {Photo, Header}.	What the image will be used for.
`index`	Required. Integer.	Specifies a tracking code.
`intlLocalCallIn`	Optional. String.	Specifies whether international call-in is enabled.
`intlLocalCallInNumber`	Optional. String.	Telephone number for international participants.
`isAgent`	Optional. Valid values are TRUE and FALSE.	Determines if a user is considered an agent.
`isMgr`	Optional. Valid values are TRUE and FALSE.	Determines if a user is considered a manager.
`isMyWebexPro`	Optional. Valid values are TRUE and FALSE.	If TRUE, then user has access to additional My Webex Pro features which usually includes My Reports, Access Anywhere, and Personal Meetings Page. Note If TRUE, and Webex super administrator has limited the number of My Webex Pro hosts, then the number of existing My Webex hosts can’t exceed the max number set by the super administrator; otherwise, a NoWebexProLicensesAvailable error occurs.
`joinBeforeHost`	Optional. Valid values are TRUE and FALSE.	Determines if attendees are allowed to join a meeting before the host.
`labAdmin`	Optional. Valid values are TRUE and FALSE.	If TRUE, then user has access to the Hands-on Lab administration pages. Defaults to site setting. This element is effective only when Hands-on Lab is enabled.
`label`	Required. String.	The label of an item.
`language`	Optional. String.	Sets the preferred language for the user.
`languageID`	Optional. Long.	The ID of a language in the database.
`lastName`	Required for Create. Optional for Lst and Set. Must be a non-null value. Not applicable for all other actions. Maximum of 64 characters.	The user’s last name.
`lastNameVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the last name of the user. Default: FALSE.
`listInCategory`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of listing in categories. Default: FALSE.
`listMethod`	Optional. Valid values are AND, and OR.	Specifies whether to use AND or OR for multiple search values as described in “Specifying Boolean Relationships for Searches” on page 55.
`locale`	Optional. String.	Holds user locale information.
`location`	Optional. String.	Holds the recording location.
`lockAccount`	Optional. Valid values are TRUE and FALSE.	Prevents a user from being able to login.
`mail`	Optional. Valid values are TRUE and FALSE.	Indicates the mail information for the user. Default: FALSE
`manager`	For Sales Center only. Optional. String. Maximum of 128 characters.	The webExID of the user’s sales manager. See also webExID.
`maximumNum`	Optional. Integer.	Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`meetingAssist`	Optional. Valid values are TRUE and FALSE.	Enables Meeting Assist.
`meetingCenter`	Optional. Valid values are TRUE and FALSE.	If TRUE, enables the Meeting Center service for the user.
`meetingType`	Optional. Integer.	The meeting type ID.
`messageVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of displaying messages. Default: FALSE.
`mgr`	For Sales Center only. Optional. Valid values are TRUE and FALSE.	Indicates whether the user is a sales manager.
`mobilePhone`	Optional. Maximum of 64 characters.	The attendee’s mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`mobilePhone2`	Optional. Maximum of 64 characters.	This element is deprecated.
`mpProfileNumber`	Optional. String.	Holds the MeetingPlace profile number.
`myComputer`	Optional. Integer.	Enables the My Webex, Access Anywhere feature and sets the number of Access Anywhere computers for the user. Setting this value to 0 disables Access Anywhere.
		Note The logic of this element is as follows: ■ If the myComputer value exceeds the Access Anywhere # of computers set for each user on the site then the user's Additional computers field will be set to the difference. The Access Anywhere # of computers and Additional computers per user are fields in the Site Administration tool. ■ If the site strictly limits the Additional number of Access Anywhere Computers for this site and the sum of this user and other user's Additional computers exceeds the limit then `exceptionID=030017` is returned. For details, see “Exception Messages in Response Documents” on page 701. The Additional number of Access Anywhere Computers for this site value is defined in the Super Administration tool.
`myContact`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Contacts feature for the user.
`myFolders`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Folders feature for the user.
`myMeetings`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Meetings feature for the user.
`myPartnerLinks`	Optional. Valid values are TRUE and FALSE.	Indicates whether the partner links for a host are displayed in My Webex. Default: FALSE.
`myProfile`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Profile feature for the user.
`myReports`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Reports feature for the user.
`myWorkspaces`	Optional. Valid values are TRUE and FALSE.	Defines whether or not My Workspaces is enabled for WebOffice integration.
`name`	Required. String. Maximum of 128 characters.	Holds the name of the item.
`name` (in thirdPartyTeleconf element)	Required for CreateUser. Optional for SetUser. String. Maximum of 32 characters.	The name for a third party teleconferencing account. The name can include alphanumeric, underscore, dot, hyphen, and space characters.
`nbrDialOut`	Optional. Enum {TOLL, TOLL_FREE}	Selects the call out number to use for network based recording and audio broadcasts. Defaults to TOLL_FREE.
`newWebexId`	Optional. String.	Allows a new user name to be created.
`notes`	Optional. Maximum of 2,048 characters.	The host’s notes about the user. Default is “”.
`notifyOnLinkRequest`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of notifying on link request. Default: FALSE.
`notifyOnMeeting`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of notification upon the meeting’s start time. Default: FALSE.
`notifyOnNewMessage`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of notification upon new messages’ arrival. Default: FALSE.
`officeGreeting`	Optional. Maximum of 512 characters.	The welcoming greeting for the user. This text appears in a welcome pop-up window.
`officeurl`	Optional. String.	Deprecated field.
`officeUrlVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the URL for the user office. Default: FALSE.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy, whether to sort in ascending or descending order.
`orderBy`	Optional. Valid values are HOSTWEBEXID, CONFNAME, STARTTIME, TRACKINGCODE1..10.	Which elements to sort by in the meetings returned.
`otherTelephony`	Optional. Valid values are TRUE and FALSE.	Specifies whether a user account has the privilege to schedule a session with “other teleconferencing” feature enabled. Default value depends on the configurations on the user’s website.
`pager`	Optional. Maximum of 64 characters.	The user’s Office Profile pager number. Default: “”.
`pagerVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the pager number for the user. Default: FALSE.
`participantAccessCode`	Optional. String.	The teleconferencing participant access code supplied by the telephony service provider.
`participantAccessCodeLabel`	Required. String.	Name of the participant access code.
`participantFullAccessCode`	Optional. String.	User-defined access code for a participant with the full speaking privilege in a Webex personal teleconference.
`participantLimitedAccessCode`	Optional. String.	User-defined access code for a participant with the limited speaking privilege in a Webex personal teleconference.
`participantLimitedAccessCodeLabel`	Optional. String.	Name of the listen-only attendee access code.
`password`	Required for `createUser`. Optional for `setUser`. Maximum of 60 characters.	User password. A user password will be validated against the password security options if enabled in the Site Administration tool: Require strict passwords for user account (for Create/SetUser). Do not allow cyclic passwords (for SetUser). ■ Do not allow site administrator to input password for other hosts (for Create/SetUser and ActivateUser). If any of the above password security rules is violated, an exception then occurs.
`passwordDaysLeft`	Optional. Integer.	Holds the number of days until the password must be changed.
`passwordExpires`	Required. Boolean.	Indicates whether the “Force users to change password every X days” option is enabled in the Site Administration tool.
`passwordHint`	Optional. Maximum of 128 characters.	The question for which passwordHintAnswer is an answer for the user. Default: “”.
`passwordHintAnswer`	Optional. Maximum of 32 characters.	The answer to the passwordHint for the user. If the user can answer the challenge correctly then he can be instantly presented with the password or it can be sent to him in an email message. Default: “”.
`passwordLifetime`	Required. Integer.	Indicates the number of days left until the password of a user will expire if the “Force users to change password every X days” option is enabled in the Site Administration tool.
`pause`	Optional. A nonnegative integer with maximum value of 99.	The number of seconds to pause during Webex Network Based Recording (NBR) server’s dialing to a third party teleconference. Default: 0 (zero).
`peActive`	Optional. Boolean.	Applies to Personal Edition > Credit Card Billing sites. If TRUE, indicates user Subscription is active. Note can have a different value than the user’s status.
`peExpired`	Optional. Boolean.	Applies to Personal Edition > Credit Card Billing sites. If TRUE, indicates either: ■ For Subscriptions (non-PPU), the expiration date is past. ■ For Trial Offers, the trial duration days or trial minutes are used up. Note will not be returned when is FALSE.
`personalAccountIndex`	Optional. Integer.	Specifies the personal telephony account.
`personalMeetingRoom`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, Personal Meetings Page feature for the user.
`personalUrl`	Optional. Maximum of 128 characters.	The user’s website. Default: “”.
`phone` (in commOptions element)	Optional. Maximum of 64 characters.	The user’s Office Profile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default: “”.
`phone` (in phones element)	Optional. Valid values are TRUE and FALSE.	Indicates the phone number for the user. Default: FALSE.
`phone2`	Optional. Maximum of 64 characters.	The user’s secondary Office Profile phone number. Format is a series of comma- separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default: “”.
`photoURL`	Optional. String	Holds the URL for a personal photo.
`pictureVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the pictures of the user office. Default: FALSE.
`press`	Optional. Valid values are TRUE and FALSE.	Indicates press releases. Default: FALSE.
`prodAnnounce`	Optional. Valid values are TRUE and FALSE.	Indicates product/service announcements. Default: FALSE.
`prodID`	For Sales Center only. Required. Integer.	ID of the product in which the user specializes.
`promos`	Optional. Valid values are TRUE and FALSE.	Indicates promotions and special offers. Default: FALSE.
`protocol`	Optional. Enum{SAML1.1, SAML2.0}	Specifies the SAML authentication protocol version. Default: SAML1.1.
`recordedEvents`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Files: Recorded Events feature for the user.
`recordingEditor`	Optional. Valid values are TRUE and FALSE.	Indicates whether a user has the privilege to download Webex Recording Editor from My Webex > Support. Default: FALSE. Note In the Site Administration tool, Recording Editor must be enabled for a host. Otherwise, setting recordingEditor to TRUE will throw an exception.
`regDateEnd`	Optional.	End of range to select for a user’s registration date. Formatted as MM/DD/YYYY HH:MM:SS.
`regDateStart`	Optional.	Beginning of range to select for a user’s registration date. Formatted as MM/DD/YYYY HH:MM:SS.
`registrationDate`	Optional. String.	Returns the creation date for the user in the following format: MM/DD/YYYY HH:MM:SS.
`rep`	For Sales Center only. Optional. Valid values are TRUE and FALSE.	Indicates whether the user is a sales representative.
`request`	Optional. Enum{DESK_VIEW, DESK_CTRL, APP_VIEW, APP_CTRL}	Contains the action that is being requested from the customer.
`resetPassword`	Optional. Valid values are TRUE and FALSE.	Resets the user’s password to a random string and notifies the user of the change. Automatically sets forceChangePassword to TRUE. Defaults to FALSE.
`returned`	Required if matchingRecords is specified. Integer.	The number of records returned in the response.
`returnPrefs`	Optional. Valid values are TRUE and FALSE.	Determines if the WebACD preferences are returned. Defaults to TRUE.
`roSiteAdmin`	Optional. Valid values are TRUE and FALSE.	Indicates whether the current user is a site administrator with view only privilege. Default: FALSE.
`salesCenter`	Optional. Valid values are TRUE and FALSE.	Enables the Sales Center service (if available on the site) for the user.
`samlResponse`	Required. String.	An X.509 signed SAML 1.1 response which contains an assertion with uid=webexID.
`schedulingPermission`	Optional. String.	A semi-colon (;) separated list of Webex IDs for other users that are allowed to schedule Training Center sessions on behalf of this user. Example: `<schedulingPermission> jeffr;jasony;benh</schedulingPermission>`
`sendWelcome`	Optional. Valid values are TRUE and FALSE.	Sends a welcome email to the new host if set to TRUE. Default is FALSE.
`service`	Optional. Valid values are FREE_OFFICE, STANDARD_OFFICE, and PRO_OFFICE.	The type of service that the user has. Default: FREE_OFFICE.
`serviceType`	Required. Enumerated string. Valid values are MeetingCenter, TrainingCenter, EventCenter, SupportCenter, SalesCenter.	In a Set API, specifies the default service type in a host’s one-click settings; in a Get API, holds the default service type returned from a query for a host’s one- click settings. Note When calling SetOneClickSettings, the service type cannot be set to EventCenter since Event Center does not support one-click.
`sessionPassword`	Optional. String.	Specifies the password for a meeting.
`sessionTemplate`	Optional. 0..n	Holds the user’s current session scheduling template.
`sessionTicket`	Required. String.	A random 32 alphanumeric character string that is associated with an authenticated user for the duration of a session.
`sessionType`	Required. Integer.	In a Set API, specifies the default session type in a host’s one-click settings; in a Get API, holds the default session type returned from a query for a host’s one- click settings. Note When calling SetOneClickSettings, the session type cannot be set to AUO since an audio- only session does not support one-click.
`sharingColor`	Optional. Enum {256, 16BIT}	Contains the sharing color.
`sharingView`	Optional. Enum{FS_SCALE, FS, WIN, WIN_SCALE}	Contains the sharing view.
`singleSessClient`	Optional, Enum{NEW_CONSL, OLD_CONSL}	Determines the single session client console type.
`siteAdmin`	Optional. Valid values are TRUE and FALSE.	Indicates whether the user has administrative privilege for the meeting. Default: FALSE.
`sme`	For Sales Center only. Optional. Valid values are TRUE and FALSE.	Indicates whether the user is a subject matter expert.
`startFrom` (in listControl element)	Optional. Integer.	Works with maximumNum to limit the quantity of returned objects as described in "Choosing A Subset of Records”.
`startFrom` (in matchingRecords element)	Required. Integer.	Record index number that the returned set starts from.
`state`	Optional. Maximum of 32 characters.	The country of residence for the user’s Office Profile. Default: “”.
`status`	Required. Valid values are SUCCESS and FAILURE.	Denotes if the specified username is disabled or not.
`subscriberAccessCode`	Optional. String.	The teleconferencing subscriber access code supplied by the telephony service provider.
`subscriberAccessCode` (in personalTeleconf element)	Required. String.	Holds the access code for the host in a Webex personal teleconference.
`subscriberAccessCodeLabel`	Optional. String.	Name for the subscriber access code.
`subscriptionOffice`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of subscription office. Default: FALSE.
`supportApp`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting applications. Default: FALSE.
`supportAppshareRemote`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting remote application sharing. Default: FALSE.
`supportCenter`	Optional. Valid values are TRUE and FALSE.	Enables the Support Center service for the user.
`supportDesktopShare`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting desktop sharing. Default: FALSE.
`supportDesktopShareRemote`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting remote desktop sharing. Default: FALSE.
`supportFileShare`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting file sharing. Default: FALSE.
`supportMeetingRecord`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting meeting recording. Default: FALSE.
`supportVideo`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting video for the meeting. Default: FALSE.
`supportWebTourRemote`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of supporting remote web tour. Default: FALSE.
`syncWebOffice`	Optional. Valid values are TRUE and FALSE.	Indicates whether or not the user account is synchronized with WebOffice. Default: TRUE.
`tab`	Enum {Tools, Desktop, Application, Session}, 4..4.	Tab labels.
`teleConfCallIn`	Optional. Valid values are TRUE and FALSE.	Indicates whether conference calling into meetings is supported for the meeting. Defaults to site setting.
`teleConfCallInInternational`	Optional. Valid values are TRUE and FALSE.	Allows a user to access Webex teleconferencing via international local call-in telephone numbers. Defaults to site setting. Note This option applies when the site has both Call-in teleconferencing and Allow access to teleconference via international local call-in numbers enabled in the Site Administration tool.
`teleConfCallOut`	Optional. Valid values are TRUE and FALSE.	Indicates whether conference calling out of meetings is supported for the meeting. Defaults to site setting.
`teleConfCallOutInter national`	Optional. Valid values are TRUE and FALSE.	Indicates whether international calling out of meetings is supported for the meeting. Defaults to site setting.
`teleconfLocation`	Optional. String.	Locale of the teleconference.
`teleconfServiceName`	Optional. String.	Name of the teleconferencing service.
`teleConfTollFreeCallIn`	Optional. Valid values are TRUE and FALSE.	Indicates whether toll-free calling into meetings is supported for the user. Defaults to site setting.
`telephonySupport`	Required Enumerated string. Valid values are NONE, CALLIN, CALLBACK, OTHER.	Specifies the type of telephone support.
`templateType`	Optional. Enum {User Site}.	Specifies the type of template to be used.
`ticket`	Required. String.	A random 32-character identifier string that is associated with a host, used for login authentication.
`timeToLive`	Optional. String.	Number of seconds that the `sessionTicket` is valid.
`timeZone`	Optional. Requires a value from among those listed in Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the user or user’s office. Default is “GMT -08:00, Pacific Time (San Jose)”.
`timeZoneID`	Optional. An integer ranging from 0 to 61. For details, see Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the meeting.
`timeZoneWithDST`	Optional. String.	A timezone description which is adjusted by DST, e.g. GMT-7:00, Pacific (San Francisco).
`title`	Optional. Maximum of 128 characters.	The user’s title. Default is “”.
`titleVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the feature of displaying the user’s title. Default: FALSE.
`tollCallInData`	Optional. String.	Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”. ■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it). ■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
`tollCallInNumber`	Optional. String.	Teleconference toll call in number for the user as assigned by the telephony service provider.
		Note: The telephone number should include a country code and an area code. For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on Webex Web pages. Commas do NOT represent a dialing pause.
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in is enabled.
`tollFreeCallInData`	Optional. String.	Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”. ■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it). ■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
`tollFreeCallInNumber`	Optional. String.	Teleconference toll free call in number for the user as assigned by the telephony service provider.
		Note: The telephone number should include a country code and an area code. For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on Webex Web pages. Commas do NOT represent a dialing pause.
`total`	Required if matchingRecords is specified.	Total number of records matching the query request.
`tollFreeCallInNumberLabel`	Required. String.	Name displayed for toll-free numbers.
`tollCallInNumberLabel`	Required. String.	Name displayed for toll numbers.
`totalStorageSize`	Optional. Integer.	Default My Webex file storage size for the user. Note The logic of this element is as follows: If the totalStorageSize value exceeds the Total storage size set for each user on the site, then the user’s Additional storage field will be set to the difference. (The Total storage size and Additional storage per user are fields in the Site Administration tool.) If the site strictly limits the Additional storage for this site and the sum of this user and other user’s Additional storage values exceeds the site limit, then exceptionID=030016 is returned. For details, see “Exception Messages in Response Documents”. (The Additional storage for this site value is defined in the Super Administration Tool.)
`trackingCode1..10`	Optional. Maximum of 128 characters each.	Ten text elements that you can use for any information about a user, such as project names, departments, or anything else of your choice. Default: “”.
`trainingCenter`	Optional. Valid values are TRUE and FALSE.	Enables the Training Center service (if available on the site) for the user.
`trainingInfo`	Optional. Valid values are TRUE and FALSE.	Indicates training information. Default: FALSE.
`trainingRecordings`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Files: Training Recordings feature for the user.
`tspAccountIndex`	Optional. Integer.	Specifies the tsp account.
`type`	Optional. Enum {NBR, LOCAL}	`specifies the recording type.
`type` (defaultClient)	Required. Enum{MULTI_SESS, SINGLE_SESS}	Contains the default client type to be used.
`url`	Optional. Maximum of 128 characters.	The user’s URL, such as the URL of the user’s office. Default is “”.
`userId`	Optional.	A Webex-assigned identification number that uniquely identifies a user within your website.
`userloginURL`	Optional. Maximum of 128 characters.	The URL for the user to log into Webex services. Default is “”.
`userlogoutURL`	Optional. Maximum of 128 characters.	The URL for the user to log out Webex services. Default is “”.
`value`	Optional. String.	Specifies the value of a tracking code.
`value` (in sessionTemplateSummaryType)	Required. String.	The value of a template.
`visitCount`	Optional. A nonnegative integer value.	A Webex-maintained visitor count reflecting how many times users have visited the office Web page for the user. Default: 0.
`voiceOverIp`	Optional. Valid values are TRUE and FALSE.	Indicates voice communications over Internet protocols is supported for the meeting. Defaults to site setting.
`voip`	Optional. Valid values are TRUE and FALSE.	Specifies whether Voice Over IP telephony is enabled.
`webExID`	Required for `SetUser` and `DelUser`. Optional for `CreateUser` and `LstUser`. String. Maximum of 64 characters.	A reference to the Webex user account for the meeting participant. Empty if the attendee is a VISITOR.
`welcomeMessage`	Optional. String.	Holds a welcome message for when people enter the meeting room.
`workPhoneVisible`	Optional. Valid values are TRUE and FALSE.	Toggles the work phone number for the user. Default: FALSE.
`zipCode`	Optional. Maximum of 16 characters.	The ZIP Code portion of the user’s Office Profile address. Default: “”.

Complex Types Used By The User Session Service

The following diagrams show the complex types used by the User Service.

Schema diagram: `privilegeType` element

Schema Diagram of privilegeType

Schema diagram: `address` element

Schema Diagram of address

Schema diagram: `user` element of type `delUserStatusType`

XSD Schema Diagram of user

General Session Service

The functionality and API calls in the General session service are available to other API services. Some of these API calls can provide functionality for several services at once. Other API calls simply do not fit clearly into any of the main services.

This chapter contains sample XML documents that show example request messages and example responses from the server.

Table 4-1 • Webex General Session Service XML Messages

*XML Request Message*	*Description*
`CreateContacts`	Creates an entry in the My Contacts list.
`CreateDistList`	Creates a distribution list of contacts.
`DelRecording`	Deletes a recording.
`DelSession`	Deletes a scheduled Webex session.
`DetectSessionByCallback`	Detect meeting number according to site, callback number, and occurred time scope.
`GetAPIVersion`	Returns the current XML API version.
`LstDistList`	Lists existing distribution lists.
`LstOpenSession`	Lists currently open Webex sessions.
`LstRecording`	Lists existing recordings.
`LstsummarySession`	Lists scheduled Webex sessions.
`SetDistList`	Updates a distribution list.
`GetOneClickSettings`	Retrieves One Click settings.
`SetOneClickSettings`	Sets One Click service type and meeting type.
`GetRecordingInfo`	Retrieves recording details.
`GetSessionInfo`	Retrieves Webex session details.
`LstContact`	Lists site contacts..
`SetRecordingInfo`	Sets recording details.
`SetupOneClickSettings`	Sets One Click scheduling options.

CreateContacts

Adds one or more new contacts. On a Webex service site, contacts can be added in My Contacts of My Webex.

Request

The sample XML shows an example of a request to add two new contacts.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.CreateContacts">
            <contact>
                <name>Some Body</name>
                <email>some@body.com</email>
            </contact>
            <contact>
                <name>Another Body</name>
                <email>another@body.com</email>
            </contact>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-1 • Schema diagram of createContacts

Response

The sample XML shows an example of a possible response to the preceding XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:createContactsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:contactID>123456</ep:contactID>
            <ep:contactID>123457</ep:contactID>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-2 • Schema diagram of `createContactsResponse`

CreateDistList

Adds a new distribution list. A distribution list holds one or more contacts as a group.

Request

The sample XML shows an example of a request to add a new distribution list having 3 contacts.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>

            <partnerID>000abc<partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.CreateDistList">
            <distList>
                <name>mydist</name>
                <desc>Distribution List</desc>
                <contactID>123456</contactID>
                <contactID>123457</contactID>
            </distList>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-3 • Schema diagram for createDistList

Response

The sample XML shows an example of a possible response to the preceding XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:createDistListResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:distListID>1234</ep:distListID>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-4 • Schema diagram for createDistListResponse

DelRecording

Allows the user to delete an NBR file. If the file to be deleted was uploaded from a local machine, then the file is deleted from physical storage.

Request

The XML samples shows an example of a request to delete a recording.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>

            <partnerID>000abc<partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.DelRecording">
            <recordingID>1234567</recordingID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-5 • Schema diagram for delRecording

Response

The sample XML document shows an example of a possible response to the preceding XML 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: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:delRecordingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:recordingID>1234567</ep:recordingID>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-6 • Schema diagram for delRecordingResponse

DelSession

Allows hosts to delete their own scheduled session that is not currently in progress. This operation can be used in place of DelMeeting, DelTrainingSession, DelEvent, etc.

Note Audio only RCN account information is deleted from the telephony server when delSession deletes an RCN session.

Request

The sample XML document deletes the meeting with a sessionKey value of 48591508. Be sure to provide a valid value for your website.


<?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.DelSession">
            <sessionKey>123456789</sessionKey>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 4-8 • Schema diagram for delSessionResponse

The sample XML document shows an example of a possible response for the preceding query XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:DelSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
    </serv:body>
</serv:message>

DetectSessionByCallback

This API allows a site administrator to check the list of Webex sessions using the callback teleconference number specified in the request during a specific time period.

APIs impacted

New API called detectSessionByCallback.

XML Request Schema

Request

XML Response Schema

XML Response

Changed Behavior

This is a new API, so there is no change in behavior.

Design

Check if the login account is SiteAdmin role. If not, return exception;
Check the format of callbackNumber. It should be all digits including country code and area code if there is one. Else, return exception;
Check date scope of dataScopeGMT. If the time scope between occurredDateStart and occurredDateEnd is more than 5 minutes, return exception;
Get SiteID is based on login SiteAdmin account;
Call Tahoe API to get the list of meeting numbers (there may be none, one, or more than one). Tahoe queries and gets the meeting numbers by callbackNumber and occurred time scope;
Loop all the meetingNumbers from Tahoe, show their meeting information one by one in the response. Refer to Schema Changes section to know which elements should be returned.

Notes:

Only a SiteAdmin has the ability to use this API for querying, else it returns exception 000001 (Message: You do not have the privilege to perform this request. New exception: No).
The maximum occurred time scope is 5 minutes, else it returns exception 140015 (Message: Query time range cannot be over 5 minutes. New exception: Yes).
The content of the callback number must be digits only (for example, 14086664444), else it throws exception 140016 (Message: The callbackNumber can be accepted only as numeric characters. New exception: Yes);
If no meeting is found, it returns 000015 (Message: Sorry, no record found. New exception: No).
This API supports meetings that already occurred and ongoing meetings, it does not support future meetings.

GetAPIVersion

Webex partners can use the GetAPIVersion command to get the current XML API version number that are enabled for their Webex service sites. This request takes no parameter and requires no security context.

Request

The sample XML document shows an example of a request for the version number of the current XML API enabled for the site.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.GetAPIVersion">
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-9 • Schema diagram for getAPIVersion

Response

The sample XML document shows an example of a possible response for the preceding query XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:GetAPIVersionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:apiVersion>Webex XML API V7.3.0</ep:apiVersion>
            <ep:release>SP7</ep:release>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-10 • Schema diagram for getAPIVersionResponse

LstDistList

Queries contact distribution lists by a distribution list name or ID. Allows users to query other hosts for their contact lists along with company wide lists.

Request

The sample XML shows an example of a request that searches for a specified distribution list ID (distListID).

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>

            <webExID>hostid</webExID>
            <password>hostpassword</password>

        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.LstDistList">
        <distListID>15987</distListID>
            <name>Dis1</name>
            <addressType>PERSONAL</addressType>
            <hostWebexID>test1</hostWebexID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-11 • Schema diagram for lstDistList

Response

The sample XML shows an example of a possible response to the preceding XML 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: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:lstDistListResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:distList>
                <ep:distListID>15987</ep:distListID>
                <ep:name>Dis1</ep:name>
                <ep:desc>This is Distribution list 1</ep:desc>
                <ep:addressType>PERSONAL</ep:addressType>
            </ep:distList>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-12 • Schema diagram for lstDistListResponse

LstOpenSession

Allows any host to retrieve all sessions (of all service types) that are currently in progress on the site. The user can list the open sessions of a certain service type. If no service type is specified, the returned sessions are grouped based on their service types.

Request

The sample XML shows an example of a request for a list of all the open sessions of Meeting Center, Training Center, Event Center and Support Center on the site.

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

        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.LstOpenSession">
            <serviceType>EventCenter</serviceType>
            <serviceType>MeetingCenter</serviceType>
            <serviceType>TrainingCenter</serviceType>
            <serviceType>SupportCenter</serviceType>
        </bodyContent>
    </body>
</serv:message>

Response

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

The sample XML shows an example of a possible response for the preceding query XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:LstOpenSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:matchingRecords>
                <serv:total>1</serv:total>
                <serv:returned>1</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </ep:matchingRecords>
            <ep:services>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:sessions>
                    <ep:sessionKey>82679427</ep:sessionKey>
                    <ep:sessionName>Sample Meeting</ep:sessionName>
                    <ep:hostWebexID>hostid</ep:hostWebexID>
                    <ep:startTime>08/05/2014 12:10:00</ep:startTime>
                    <ep:timeZoneID>4</ep:timeZoneID>
                    <ep:listStatus>UNLISTED</ep:listStatus>
                </ep:sessions>
            </ep:services>
        </serv:bodyContent>
    </serv:body>
</serv:message>

LstRecording

Allows users to see a list of all recordings within a certain date range. Site Admin users can return the recording information for all users on the site.

Request

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

Figure 4-15 • Schema diagram for lstRecording

The sample XML code shows a request for recordings.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>
            <siteID>0000</siteID>

        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.LstRecording">
            <listControl>
                <startFrom>0</startFrom>
                <maximumNum>10</maximumNum>
            </listControl>
            <sessionKey>123456789</sessionKey>
            <hostWebexID>lm</hostWebexID>
            <returnSessionDetail>true</returnSessionDetail>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 4-16 • Schema diagram for lstRecordingResponse

The sample XML code returns a list of recordings.


<?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:lstRecordingResponse"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <ep:matchingRecords>
            <serv:total>3</serv:total>
            <serv:returned>3</serv:returned>
            <serv:startFrom>1</serv:startFrom>
        </ep:matchingRecords>
        <ep:recording>
            <ep:recordingID>3693257</ep:recordingID>
            <ep:hostWebexID>lm</ep:hostWebexID>
            <ep:name>test1000-20070528 0116</ep:name>
            <ep:createTime>05/28/2007 09:16:26</ep:createTime>
            <ep:timeZoneID>45</ep:timeZoneID>
            <ep:size>0.1248045</ep:size>
            <ep:streamURL>https://sitename.webex.com/sitename/nbrshared.php?a
                ction=playback&recordID=3693257&recordKey=431FF40390A29DAB449
                0FE8D456CC70261C0736C883866F4F4DCF6A9EA59E525
            </ep:streamURL>
            <ep:fileURL>https://sitename.webex.com/sitename/nbrshared.php?act
                ion=publishfile&recordID=3693257&recordKey=431FF40390A29DAB44
                90FE8D456CC70261C0736C883866F4F4DCF6A9EA59E525
            </ep:fileURL>
            <ep:sessionKey>14232890</ep:sessionKey>
            <ep:trackingCode />
            <ep:recordingType>0</ep:recordingType>
            <ep:duration>147</ep:duration>
        </ep:recording>
        <ep:recording>
            <ep:recordingID>3693272</ep:recordingID>
            <ep:hostWebexID>lm</ep:hostWebexID>
            <ep:name>test1000-20070528 0128</ep:name>
            <ep:createTime>05/28/2007 09:28:16</ep:createTime>
            <ep:timeZoneID>45</ep:timeZoneID>
            <ep:size>0.12263203</ep:size>
            <ep:streamURL>https://sitename.webex.com/sitename/nbrshared.php?a
                ction=playback&recordID=3693272&recordKey=512D08429BB228A137E
                FE0F26E227DB70983C08272394C176BE559DFC6F089EC
            </ep:streamURL>
            <ep:fileURL>https://sitename.webex.com/sitename/nbrshared.php?act
                ion=publishfile&recordID=3693272&recordKey=512D08429BB228A137
                EFE0F26E227DB70983C08272394C176BE559DFC6F089EC
            </ep:fileURL>
            <ep:sessionKey>14232890</ep:sessionKey>
            <ep:trackingCode />
            <ep:recordingType>0</ep:recordingType>
            <ep:duration>18</ep:duration>
        </ep:recording>
        <ep:recording>
            <ep:recordingID>3693282</ep:recordingID>
            <ep:hostWebexID>lm</ep:hostWebexID>
            <ep:name>test1000-20070528 0128</ep:name>
            <ep:createTime>05/28/2007 09:28:40</ep:createTime>
            <ep:timeZoneID>45</ep:timeZoneID>
            <ep:size>0.1256485</ep:size>
            <ep:streamURL>https://sitename.webex.com/sitename/nbrshared.php?a
                ction=playback&recordID=3693282&recordKey=39D9A0CDA4B528333E6
                8E9907DBD6E7FD660183595268CAB15485037B27CA06A
            </ep:streamURL>
            <ep:fileURL>https://sitename.webex.com/sitename/nbrshared.php?act
                ion=publishfile&recordID=3693282&recordKey=39D9A0CDA4B528333E
                68E9907DBD6E7FD66018359526CAB15485037B27CA06A
            </ep:fileURL>
            <ep:sessionKey>14232890</ep:sessionKey>
            <ep:trackingCode />
            <ep:recordingType>0</ep:recordingType>
            <ep:duration>18</ep:duration>
        </ep:recording>
    </serv:bodyContent>
    </serv:body>
</serv:message>

LstsummarySession

Lists summary information of scheduled sessions. You can specify criteria such as the host email and Webex ID, service type, session type and status (in progress or not in progress) for the search. This operation will return information for all service types including Meeting Center, Training Center, Event Center, Sales Center and Support Center. It can be used in place of LstsummaryMeeting, LstsummaryTrainingSession, and LstsummaryEvent.

A regular host can normally specify another or in 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. This site setting does not apply to site administrators, who can always use LstsummarySession to retrieve any host's PUBLIC, PRIVATE, and UNLISTED sessions.

Note

When you call LstsummarySession without user authentication — that is, the and are not specified in the security context header, you can retrieve all the 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.
Subsequent types of MeetingCenter, TrainingCenter, SupportCenter, and EventCenter specified in will be returned.
If any are specified, then audio-only (AUO=16), access anywhere (RAS=10) and SMARTtech (SMT=14) sessions will be filtered out unless they are specified in . Sessions of AUO, RAS, and SMT will not be filtered out.
If both and are unspecified, a site administrator calling LstSummarySession will return scheduled sessions for all hosts on the site. A regular host will return only his or her own sessions.
in the response will always be returned in GMT.
The returned session list will include those sessions that the user is invited to if is set to TRUE.
The returned session list will include whether or not a session is a repeating or a single event.
The returned session list will include sessions where the specified or is an alternate host.
The start time will be returned in the timezone specified in the of the request. This will be adjusted for daylight saving and standard time based on if the falls in the timeZoneID’s DST span.
Can return a session list based on the ConfID.
Can return a session list based on a case-insensitive search for meeting topics that start with the string specified in the query field.
Looks for all sessions that an attendee is invited to. This search can be combined with a date range to narrow down the results.
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.

Request

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

Figure 4-17 • Schema diagram for lstsummarySession

The sample XML document requests the summary information about scheduled sessions.


<?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 the lstsummarySessionResponse message.

Figure 4-18 • Schema diagram for lstsummarySessionResponse

The sample XML document shows an example of a possible response for the preceding query XML 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: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>

SetDistList

Updates a distribution list to add/delete specific contacts, or to remove all the contacts from the distribution list.

Request

The sample XML shows an example of a request to add a contact to an existing distribution list.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.SetDistList">
            <distList>
                <distListID>7267</distListID>
                <name>new dist</name>
                <desc>updated with setDist</desc>
                <contactID>690587</contactID>
                <contactOperation>ADD</contactOperation>
            </distList>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-19 • Schema diagram for setDistList

Response

The sample XML document shows an example of a possible response to the preceding XML 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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:setDistListResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 4-20 • Schema diagram for setDistListResponse

GetOneClickSettings

Retrieves one-click settings for a host.This API now fully supports Webex telephony, PCN telephony and TSP.

Note Site administrator can get one-click settings for any user with a specified webExID, while a regular host can only retrieve his or her own one-click settings.

Request

The sample XML document shows an example of a request to retrieve one-click settings for a specific Webex ID.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service
    http://www.webex.com/schemas/2002/06/service/service.xsd">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.GetOneClickSettings"
            xmlns:cong="http://www.webex.com/schemas/2002/06/service/ep"
            xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/user"
            xmlns:ep="http://www.webex.com/schemas/2002/06/service/ep/ep.xsd">
            <hostWebexID>hostid</hostWebexID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-21 • Schema diagram for getOneClickSettings

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: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:getOneClickSettingsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:metaData>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:sessionType>3</ep:sessionType>
                <ep:confName>sany's meeting</ep:confName>
                <ep:sessionPassword>111111</ep:sessionPassword>
                <ep:listing>UNLISTED</ep:listing>
                <ep:sessionTemplate>
                    <ep:name>MC_3</ep:name>
                    <ep:type>User</ep:type>
                    <ep:value>U;MC;en_US;8.5;111832;MC_3; ; ;</ep:value>
                </ep:sessionTemplate>
            </ep:metaData>
            <ep:trackingCodes>
                <ep:trackingCode>
                    <ep:index>1</ep:index>
                    <ep:name>Division</ep:name>
                    <ep:inputMode>Input Text</ep:inputMode>
                    <ep:value />
                </ep:trackingCode>
                <ep:trackingCode>
                    <ep:index>2</ep:index>
                    <ep:name>Department</ep:name>
                    <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                    <ep:index>3</ep:index>
                    <ep:name>Project</ep:name>
                    <ep:inputMode>Input Text</ep:inputMode>
                    <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>4</ep:index>
                <ep:name>Other</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>5</ep:index>
                <ep:name>Custom5</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>6</ep:index>
                <ep:name>Custom6</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>7</ep:index>
                <ep:name>Custom7</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value>test17777</ep:value>
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>8</ep:index>
                <ep:name>Custom8</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>9</ep:index>
                <ep:name>Custom9</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            <ep:trackingCode>
                <ep:index>10</ep:index>
                <ep:name>Custom10</ep:name>
                <ep:inputMode>Input Text</ep:inputMode>
                <ep:value />
            </ep:trackingCode>
            </ep:trackingCodes>
                <ep:telephony>
                <ep:telephonySupport>CALLIN</ep:telephonySupport>
                <ep:tspAccountIndex>1</ep:tspAccountIndex>
                <ep:account>
                    <serv:tollFreeCallInNumber>1-408197041
                    </serv:tollFreeCallInNumber>
                    <serv:tollCallInNumber>1-408197043</serv:tollCallInNumber>
                    <serv:subscriberAccessCode>10060189
                    </serv:subscriberAccessCode>
                    <serv:participantAccessCode>10133851
                    </serv:participantAccessCode>
                    <ep:participantLimitedAccessCode />
                    <ep:globalNum>
                        <serv:countryAlias>Turks and Caicos</serv:countryAlias>
                        <serv:phoneNumber>785643556436545</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Sweden</serv:countryAlias>
                        <serv:phoneNumber>010-111222</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1111112243433</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Thailand</serv:countryAlias>
                        <serv:phoneNumber>45545454</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1-408-197-042</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>32534645656456456456</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>4564445</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>456546545456546456546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1242315436546757</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Togo</serv:countryAlias>
                        <serv:phoneNumber>346547657868</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>355476658989767456</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>3453465546-657658657865
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>354365-567657657657</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>4565676745(768768768)67567
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>5464576568(657567865)(-676
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>546456765785676523213-675
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>45345-787686575654</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>3244365768768768</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Taiwan</serv:countryAlias>
                        <serv:phoneNumber>56768909(676547)-786587
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>4564563543453543543</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Slovenia</serv:countryAlias>
                        <serv:phoneNumber>568765443212</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Syria</serv:countryAlias>
                        <serv:phoneNumber>456543214122323</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Uzbekistan</serv:countryAlias>
                        <serv:phoneNumber>4564210124114</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Philippines</serv:countryAlias>
                        <serv:phoneNumber>4532768769325321332</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Slovakia</serv:countryAlias>
                        <serv:phoneNumber>543123123456546546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>South Africa</serv:countryAlias>
                        <serv:phoneNumber>45312.1213546456546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>45201456354654654</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>454576879879576</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Myanmar</serv:countryAlias>
                        <serv:phoneNumber>4565476567678753</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>125457768678767</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1445675876987897687</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>14355476879879</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1446658789879870879879</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>(76876876)76876876867-7685
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>3545768(546457567)78676876
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>234365776(67657657)7567686
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>3243243254365546546546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>34543543654643534</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>12342143455657546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>324354645766546456</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>43546545766756754656</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>1243466588690890879967</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>988655463466876798-8567547
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>5465676867456589-657675675
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>5665767856 567655687658678
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>5675687097657-657867876876
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>436567678(65767658)7686575
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>54634769897645065754-76865
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Tanzania</serv:countryAlias>
                        <serv:phoneNumber>5567568769879476867</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Wallis And Futuna Islands
                        </serv:countryAlias>
                        <serv:phoneNumber>4356587897547978976</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Zimbabwe</serv:countryAlias>
                        <serv:phoneNumber>14457698078567456534543</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>3456576790456346067546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>346565869789789</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Panama</serv:countryAlias>
                        <serv:phoneNumber>2354656765767567567575</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Tajikistan</serv:countryAlias>
                        <serv:phoneNumber>4567567567856745643879</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Taiwan</serv:countryAlias>
                        <serv:phoneNumber>6786787845676</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Wallis And Futuna Islands
                        </serv:countryAlias>
                        <serv:phoneNumber>5675674564242445657657</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>5674564576874565445645</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Papua New Guinea</serv:countryAlias>
                        <serv:phoneNumber>4564576789674652345456</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Thailand</serv:countryAlias>
                        <serv:phoneNumber>3456537687684686788768</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Tonga Islands</serv:countryAlias>
                        <serv:phoneNumber>4543265654765756756765</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>Tajikistan</serv:countryAlias>
                        <serv:phoneNumber>254656754675546765546</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>45654654645654</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>23462345234556756545</serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>246547657(5465466)45646554
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>(1234422)43546576767-8888
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                    <ep:globalNum>
                        <serv:countryAlias>United States of America
                        </serv:countryAlias>
                        <serv:phoneNumber>(6575786876)565467-888888
                        </serv:phoneNumber>
                        <serv:tollFree>false</serv:tollFree>
                    </ep:globalNum>
                </ep:account>
                <ep:accountLabel>
                    <serv:tollFreeCallInNumberLabel>
                        Call-in toll-free number (US/Canada)
                    </serv:tollFreeCallInNumberLabel>
                    <serv:tollCallInNumberLabel>Call-in toll number (US/Canada)
                    </serv:tollCallInNumberLabel>
                    <serv:subscriberAccessCodeLabel>Host access code
                    </serv:subscriberAccessCodeLabel>
                    <serv:participantAccessCodeLabel>
                        Attendee access code(Full Speaking)
                    </serv:participantAccessCodeLabel>
                    <ep:participantLimitedAccessCodeLabel>
                        Attendee access code(Listen Only)
                    </ep:participantLimitedAccessCodeLabel>
                </ep:accountLabel>
                <ep:teleconfServiceName>Personal Conference No.
                </ep:teleconfServiceName>
                <ep:intlLocalCallIn>true</ep:intlLocalCallIn>
                <ep:tollfree>true</ep:tollfree>
                <ep:entryExitTone>BEEP</ep:entryExitTone>
            </ep:telephony>
            <ep:enableOptions>
                <ep:voip>false</ep:voip>
            </ep:enableOptions>
            <ep:attendeeOptions>
                <ep:joinApproval>false</ep:joinApproval>
            </ep:attendeeOptions>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-22 • Schema diagram for getOneClickSettingsResponse

GetOneClickSettingsResponse allows a user to retrieve the listing type of One-Click settings for a user account.
The metadata container holds the CUVCMeetingID element for inviting remote video devices to a Webex meeting.
GetOneClickSettingsResponse sets the “Ask for my approval when someone joins” option.

SetOneClickSettings

Sets one-click settings for a host.

Note Site administrator can set the one-click settings for any host with a webExID specified, while a host can only set his or her own one-click settings.

Request

The sample XML document sets up the default one-click settings for a host with the specified Webex ID.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/service.xsd">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.SetOneClickSettings">
            <hostWebexID>hostid</hostWebexID>
            <oneClickMetaData>
                <serviceType>MeetingCenter</serviceType>
                <sessionType>1</sessionType>
            </oneClickMetaData>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-23 • Schema diagram for setOneClickSettings

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:ep="http://www.webex.com/schemas/2002/06/service/ep">
    <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:setOneClickSettingsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 4-24 • Schema diagram for setOneClickSettingsResponse

GetRecordingInfo

The GetRecordingInfo function allows users to retrieve information about a recording. This function is currently limited to TC services.

Request

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

Figure4-25 • Schema diagram for getRecordingInfo

The sample XML document requests recording information for a specific recording ID.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.GetRecordingInfo">
            <recordingID>123456789</recordingID>
            <isServiceRecording>false</isServiceRecording>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 4-26 • Schema diagram for getRecordingInfoResponse

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: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:GetRecordingInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:basic>
                <ep:topic>nbr_update toc_unlist</ep:topic>
                <ep:listing>UNLISTED</ep:listing>
                <ep:presenter>presenter</ep:presenter>
                <ep:email>test@abc.update</ep:email>
                <ep:agenda>test agenda testtest agenda testtest test</ep:agenda>
            </ep:basic>
            <ep:playback>
                <ep:chat>true</ep:chat>
                <ep:supportQandA>true</ep:supportQandA>
                <ep:video>true</ep:video>
                <ep:polling>true</ep:polling>
                <ep:notes>true</ep:notes>
                <ep:fileShare>true</ep:fileShare>
                <ep:toc>true</ep:toc>
                <ep:attendeeList>true</ep:attendeeList>
                <ep:includeNBRcontrols>true</ep:includeNBRcontrols>
                <ep:range>PARTIAL</ep:range>
                <ep:partialStart>11</ep:partialStart>
                <ep:partialEnd>77</ep:partialEnd>
            </ep:playback>
            <ep:fileAccess>
                <ep:endPlayURL>http://test.abc.com.update</ep:endPlayURL>
                <ep:registration>true</ep:registration>
                <ep:attendeeView>true</ep:attendeeView>
                <ep:attendeeDownload>true</ep:attendeeDownload>
            </ep:fileAccess>
        </serv:bodyContent>
    </serv:body>
</serv:message>

GetSessionInfo

GetSessionInfo will return the meeting information for an invited attendee. New integration capabilities require that the meeting information for an attendee is able to be retrieved.

Request

The following sample code shows an example of a request for session information using a specific key and password.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.GetSessionInfo">
            <sessionPassword>123456</sessionPassword>
            <sessionKey>123456789</sessionKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-27 • Schema diagram for getSessionInfo

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: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:getSessionInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:status>NOT_INPROGRESS</ep:status>
            <ep:sessionkey>801413456</ep:sessionkey>
            <ep:confID>63596348</ep:confID>
            <ep:verifyFlashMediaURL>https://sitename.webex.com/mc0800l/meetingce
                nter/meetinginfo/sysdiagnosis.do?siteurl=sitename&supportUCFToolk
                it=1
            </ep:verifyFlashMediaURL>
            <ep:verifyWinMediaURL>https://sitename.webex.com/mc0800l/meetingcent
                er/meetinginfo/sysdiagnosis.do?siteurl=sitename&supportUCFToolkit
                =2
            </ep:verifyWinMediaURL>
            <ep:accessControl>
                <ep:sessionPassword>111111</ep:sessionPassword>
                <ep:listStatus>PUBLIC</ep:listStatus>
                <ep:registration>false</ep:registration>
                <ep:passwordReq>true</ep:passwordReq>
            </ep:accessControl>
            <ep:metaData>
                <ep:confName>meeting</ep:confName>
                <ep:sessionType>2</ep:sessionType>
                <ep:serviceType>MeetingCenter</ep:serviceType>
                <ep:isRecurring>false</ep:isRecurring>
            </ep:metaData>
            <ep:telephony>
                <ep:telephonySupport>NONE</ep:telephonySupport>
            </ep:telephony>
            <ep:host>
                <ep:firstName>aa</ep:firstName>
                <ep:lastName>bb</ep:lastName>
                <ep:email>test1@webex.com</ep:email>
                <ep:webExId>test1</ep:webExId>
            </ep:host>
            <ep:schedule>
                <ep:startDate>09/12/2007 11:04:11</ep:startDate>
                <ep:duration>60</ep:duration>
                <ep:timeZone>GMT-07:00, Pacific (San Francisco)</ep:timeZone>
            </ep:schedule>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-28 • Schema diagram for getSessionInfoResponse (Part 1)

Figure 4-28 • Schema diagram for getSessionInfoResponse (Part 2)

Note The information returned by GetSessionInfoResponse is based on who is asking for the information. Table 4-3 contains information on each element and whether or not it gets returned based on the caller of the function. A blank entry means that the element is always returned, while an ‘X’ designates an element that is never returned. Finally, an entry of “PW” designates an element that is returned only if the meeting password has been supplied or if the caller is the session host, an invited attendee, a panelist or a presenter.

Table 4-3 • GetSessionInfoResponse Element and Restrictions

Table 4-4 • Global Call-In URL Variable Definitions

LstContact

The lstContact function allows users to query personal or company-wide Webex contacts.

Request

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

Figure 4-30 • Schema diagram for lstContact

The sample XML code shows a typical lstContact request.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.ep.LstContact">
            <distListName>Dis1</distListName>
            <addressType>PERSONAL</addressType>
            <hostWebexID>test1</hostWebexID>
            <distListID>15987</distListID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 4-31 • Schema diagram for lstContactResponse

The following is piece of sample XML code for lstContactResponse.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message>
    <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:lstContactResponse">
            <ep:contact>
                <com:name>bb</com:name>
                <com:address>
                    <com:addressType>PERSONAL</com:addressType>
                </com:address>
                <com:phones>
                    <com:phone>14085550000</com:phone>
                    <com:mobilePhone>14085550000</com:mobilePhone>
                    <com:fax>1408550000</com:fax>
                </com:phones>
                <com:email>bb@bb.com</com:email>
                <com:type>VISITOR</com:type>
            </ep:contact>
            <ep:contact>
                <com:name>aa</com:name>
                <com:address>
                    <com:addressType>PERSONAL</com:addressType>
                </com:address>
                <com:phones>
                    <com:phone>14085550000</com:phone>
                    <com:mobilePhone>14085550000</com:mobilePhone>
                    <com:fax>14085550000</com:fax>
                </com:phones>
                <com:email>aa@aa.com</com:email>
                <com:type>VISITOR</com:type>
            </ep:contact>
        </serv:bodyContent>
    </serv:body>
</serv:message>

SetRecordingInfo

The SetRecordingInfo function allows users to set specific information about a recording. This information includes, but is not limited to the recordingID, description, and password.

Request

The sample XML shows an example of how to set up a recording.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.SetRecordingInfo">
            <recording>
                <recordingID>972831222</recordingID>
                <description>test description</description>
                <password>112233</password>
            </recording>
            <isServiceRecording>true</isServiceRecording>
            <basic>
                <topic>nbr_update toc_unlist</topic>
                <listing>UNLISTED</listing>
                <presenter>presenter</presenter>
                <email>test@abc.update</email>
                <agenda>test agenda testtest agenda testtest agenda test</agenda>
            </basic>
            <playback>
                <chat>true</chat>
                <supportQandA>true</supportQandA>
                <video>true</video>
                <polling>true</polling>
                <notes>true</notes>
                <fileShare>true</fileShare>
                <toc>true</toc>
                <attendeeList>true</attendeeList>
                <includeNBRcontrols>true</includeNBRcontrols>
                <range>PARTIAL</range>
                <partialStart>11</partialStart>
                <partialEnd>77</partialEnd>
            </playback>
            <fileAccess>
                <endPlayURL>http://test.abc.com.update</endPlayURL>
                <registration>true</registration>
                <attendeeView>true</attendeeView>
                <attendeeDownload>true</attendeeDownload>
            </fileAccess>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-32 • Schema diagram for setRecordingInfo

Response

The sample XML shows an example of a successful response.


<?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:setRecordingInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ep:recordingID>972831222</ep:recordingID>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 4-33 • Schema diagram for setRecordingInfoResponse

SetupOneClickSettings

SetupOneClickSettings allows the one-click (OC) client to configure one click settings for a user.

Request

The XML sample is an example of a request to set up one-click settings.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.SetupOneClickSettings">
            <metaData>
                <serviceType>MeetingCenter</serviceType>
                <sessionType>3</sessionType>
                <confName>Test Meeting</confName>
                <sessionPassword>654321</sessionPassword>
                <listing>UNLISTED</listing>
                <sessionTemplate>
                    <name>MC_3</name>
                    <type>User</type>
                </sessionTemplate>
            </metaData>
            <tracking>
                <trackingCode>
                    <index>7</index>
                    <value>test17777</value>
                </trackingCode>
            </tracking>
            <telephony>
                <telephonySupport>CALLIN</telephonySupport>
                <extTelephonyDescription>TEST OTHER</extTelephonyDescription>
                <personalAccountIndex>1</personalAccountIndex>
                <intlLocalCallIn>false</intlLocalCallIn>
                <tollfree>false</tollfree>
            </telephony>
            <attendeeOptions>
                <joinApproval>false</joinApproval>
            </attendeeOptions>
        </bodyContent>
    </body>
</serv:message>

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

Figure 4-34 • Schema diagram for setupOneClickSettings

The next sample is an example of how to set up a Cisco Unified Video Conferencing (CUVC) meeting:


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>hostid</webExID>
            <password>hostpassword</password>


        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.ep.SetupOneClickSettings">          
            <metaData>
                <serviceType>MeetingCenter</serviceType>
                <sessionType>2</sessionType>
                <confName>valid CUVCMeetingID</confName>
                <sessionPassword>P@ssword</sessionPassword>
                <listing>PUBLIC</listing>
                <CUVCMeetingID>${validCUVCMeetingID}</CUVCMeetingID>
                <sessionTemplate>
                    <name>template1</name>
                    <type>Site</type>
                </sessionTemplate>
            </metaData>
        </bodyContent>
    </body>
</serv:message>

Response

The sample XML shows an example of a possible setupOneClickSettingsReponse message in response to the preceding request.

<?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:setupOneClickSettingsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 4-35 • Schema diagram for setupOneClickSettingsResponse

Elements in Webex XML Schema Definitions for the General Session Service

The following table describes all the elements that are used in the Webex XML API for the General session service.

*Element*	*Constraint(s)*	*Description*
`account`	Optional. String.	Account in SaC.
`action`	Optional. String.	Clickable test action.
`actionURL`	Optional. String.	The URL used to show if an action clicked.
`actualStartTime`	Optional. String.	The actual start time of the meeting.
`address1`	Optional. Maximum of 128 characters.	The first line of an contact’s street address.
`address2`	Optional. Maximum of 128 characters.	The second line of an contact’s street address.
`addressType`	Optional. Enumerated string. Valid values are PERSONAL and GLOBAL.	Holds the type of the address. Default: PERSONAL. Note: `This element is ignored in CreateContacts.`
`agenda`	Optional. String.	The agenda for the meeting.
`alternateHost`	Optional. String.	The full name of a session’s alternate host.
`altHost`	Optional. Valid values are TRUE and FALSE.	Determines if a session invites an alternative host that is specified in `<hostWebexID>` or `<hostEmail>`.
`apiVersion`	Optional. String.	Version information of Webex API service on the current XML server.
`attendeeDownload`	Optional. Valid values are TRUE and FALSE.	Indicates whether an attendee can download a recording.
`attendeeList`	Optional. Valid values are TRUE and FALSE.	Indicates whether participant listing is enabled during recording playback.
`attendeeOptions`	Optional. Container.	Holds the attendee options.
`attendeeView`	Optional. Valid values are TRUE and FALSE.	Indicates whether an attendee can view a recording.
`author`	Optional. String.	Holds the name of the author.
`backupTollNum`	Optional. String.	Holds the backup toll call in number for PCN telephony.
`basic`	Optional. Container.	Holds the basic recording options.
`callInNum`	Optional. callInNumType.	Holds the call in telephony info for Webex and TSP telephony.
`caseSensitive`	Optional. Boolean.	Indicates whether or not to sort returned records in a case sensitive manner. Default: TRUE.
`chat`	Optional. Valid values are TRUE and FALSE.	Indicates whether chat is enabled during recording playback.
`city`	Optional. Maximum of 64 characters.	The city for a contact.
`company`	Optional. Maximum of 128 characters.	The company name for a contact.
`confID`	Required. Long.	A unique identification number associated with a session.
`confID` (in lstRecording)	Optional. Long.	A unique identification number associated with a session recording.
`confID` (in lstsummarySession)	Optional. Long.	A unique identification number associated with a session.
`confName`	Required. String.	Specifies the name of a one-click conference.
`confName` (in GetSessionInfoResponse)	Required. String.	Specifies the session name.
`confName` (in lstsummarySession)	Optional. String.	Matches all meeting topic names that start with the string specified in this query field.
`contact`	Optional. personType.	Holds contact data.
`contactID`	Integer.	The identifier of a contact.
`contactOperation`	Enumerated string. Valid values are ADD, DELETE, and DELETE_ALL.	Performs contact distribution list operations. Valid values are: ■ ADD: Adds contacts, as specified by contactID, to a distribution list. ■ DELETE: Deletes contacts, as specified by contactID, from a distribution list. ■ DELETE_ALL: Removes all the contacts from a distribution list.
`country`	Optional. Maximum of 64 characters.	The country for a contact.
`countryAlias`	Required. String.	Holds an alias for a country.
`createTime`	Required. Time String.	The creation time of the recording with respect to a specified time zone.
`createTimeEnd`	Required. Time string.	Creates the recording end time.
`createTimeScope`	Optional. Container.	Holds the date scope range.
`createTimeStart`	Required. Time string.	Creates the recording start time.
`CUVCMeetingID`	Optional. String.	CUVC customized meeting ID.
`delivery`	Required. Enum {WEBSITE, IN_SESSION}.	How the test will be delivered.
`desc`	Optional. String.	The descriptive information about a distribution list.
`description`	Optional. String.	Session description for TC and EC only.
`distListID`	Integer. Required for SetDistList.	The identifier of a distribution list.
`distListID` (in LstContact)	Optional. Integer.	ID of a distribution list in order to retrieve contacts.
`distListName`	Optional. String.	Name of a distribution list in order to retrieve contacts.
`duration`	Required. Integer.	The duration of the session in seconds.
`email`	Required. Maximum of 64 characters.	Stores a person’s email address.
`endDateEnd`	Optional.	End of range of dates from which a user can select for the end date for a meeting.
`endDateStart`	Optional.	Beginning of range of dates from which a user can select for the end date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`endPlayURL`	Optional. String.	Defines the URL to display at the end of recording playback.
`entryExitTone`	Optional. Valid values are TRUE and FALSE.	Determines if entry and exit tones are played.
`extTelephonyDescription`	Optional. Maximum of 2,048 characters.	A description of your telephony services, if you use your own as indicated in extTelephonyURL and in telephonySupport. By default, this is “Enter teleconference number, pass code, and other instructions here.”
`fax`	Optional. Maximum of 64 characters.	The contact’s fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234".
`fileAccess`	Optional. Container.	Holds the recording file access options.
`fileShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether file sharing is enabled during recording playback.
`fileURL`	Required. String.	URL to download the file.
`firstName`	Required. String.	The first name of the session’s host.
`format`	Required. String.	Holds the format type.
`globalCallInNumbersLabel`	Optional. String.	The display label for the TSP global callin URL.
`globalCallInNumbersURL`	Optional. String.	The URL used to display international global call in numbers.
`globalNum`	Optional. Container.	Corresponds to the Global Call-in Numbers in the telephony domain.
`hostEmail`	Optional. String.	Specifies the host email address used for a query, or holds the email address returned from the query. If not specified, defaults to the current host.
`hostFirstName`	Optional. String.	Returns the host’s first name.
`hostJoined`	Boolean.	If TRUE, indicates that the host is now in the session; otherwise, returns FALSE.
`hostLastName`	Optional. String.	Returns the host’s last name.
`hostType`	Optional. String.	Holds the hostType column in the mtgconference table.
`hostWebexID`	Optional. String.	The Webex ID of the host of the returned open session.
`hostWebexID` (in lstContact)	Optional. String.	Allows the Site Admin to specify another user’s Webex ID to retrieve their contacts. Default: SecurityContext.webExID.
`imageURL`	Optional. String.	The URL to upload a session image.
`inclAudioOnly`	Optional. Valid values are TRUE and FALSE.	Determines if an AUO meeting is included in the query or not. Defaults to FALSE.
`includeNBRcontrols`	Optional. Valid values are TRUE and FALSE.	Indicates whether the NBR player controls are enabled during recording playback.
`index`	Required. Integer.	Specifies a tracking code index with values [1..10].
`inputMode`	Required. String.	Specifies a tracking code display type.
`intlLocalCallIn`	Optional. Valid values are TRUE and FALSE.	Specifies whether international call-in is enabled or displayed.
`intlLocalCallInNumber`	Optional. String.	Telephone number for international participants.
`invited`	Required. Valid values are TRUE and FALSE.	Determines whether or not returned sessions include those that a user is invited to. Defaults to FALSE.
`isInternal`	Optional. Valid values are TRUE and FALSE.	Determines if a meeting is internal or not. TRUE = internal.
`isRecurring`	Required. Valid values are TRUE and FALSE.	Defines whether or not the session is a repeating or a single event.
`isServiceRecording`	Optional. Valid values are TRUE and FALSE.	Indicates whether the recording is service specific (TRUE) or networkbased (FALSE).
`joinApproval`	Optional. Valid values are TRUE and FALSE.	Determines if attendees ask for approval from the user when they join.
`joinRequiresAccount`	Optional. Valid values are TRUE and FALSE.	Determines if attendees are required to have an account to join.
`label`	Optional. String.	Label for the phone number.
`language`	Optional. String.	The language of the contact.
`lastName`	Required. String.	The last name of the session’s host.
`listControl`	Optional. Container.	Controls the data result set.
`listing`	Optional. Enum {PUBLIC, PRIVATE, UNLISTED}	Holds the listing type.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in “Specifying Boolean Relationships for Searches” on page 55. Default is AND.
`listStatus`	Optional. Enumerated string. Valid values are PUBLIC, PRIVATE, and UNLISTED.	Indicates which users can see this session in lists of sessions on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host. ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users. Default is PUBLIC.
`locale`	Optional. String.	The locale for the contact.
`language`	Optional. String.	The primary language for the contact.
`matchingRecords`	Optional.	Contains information about the returned records. See also total, returned and startFrom for more information.
`maximumNum`	Optional. A nonnegative integer.	Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`metaData`	Required. Container.	Holds the meeting options.
`mobilePhone`	Optional. Maximum of 64 characters.	The contact’s mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234".
`mpProfileNumber`	Optional. String.	Contains the Cisco Unified MeetingPlace number for the host.
`name`	Required. String.	Holds the name of the complex element.
`notes`	Optional. Maximum of 2,048 characters.	Any note information about a contact.
`notes` (in playback)	Optional. Valid values are TRUE and FALSE.	Indicates whether taking notes is enabled during recording playback.
`openTime`	Optional. Integer.	The number of minutes an attendee can join before the host.
`opportunity`	Optional. String.	Account in SaC.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy, whether to sort in ascending or descending order.
`orderBy`	Optional. Valid values are HOSTWEBEXID, CONFNAME, STARTTIME, TRACKINGCODE1..10.	Which elements to sort by in the meetings returned.
`otherHostWebexID`	Optional. String.	In lstsummarySessionResponse, this designates another user that can also edit and host the session.
`panelist`	Optional. String.	Panelist who made the recording.
`panelistsInfo`	Optional. String.	Panelist information for EC only.
`partialEnd`	Optional. Integer.	The location in a recording to start playback, in seconds.
`partialStart`	Optional. Integer.	The location in a recording to stop playback, in seconds.
`participantAccessCode`	Optional. String.	The teleconferencing participant access code.
`participantAccessCodeLabel`	Optional. String.	Name of the participant access code.
`participantAccessLabel`	Optional. String.	Returns the attendee access code label as defined in Super Admin >` Telephony Config. Suffixed with (full speaking) for Webex telephony.
`participantLimitedAccessCode`	Optional. String.	User-defined access code for a participant with the limited speaking privilege in a Webex personal teleconference.
`participantLimitedAccessCodeLabel`	Optional. String.	Name of the listen-only attendee access code.
`participantLimitedAccessLabel`	Optional. String.	Returns the attendee access code label as defined in Super Admin >` Webex Telephony Config. Suffixed with (Listen Only).
`participantsJoined`	Boolean.	If TRUE, indicates that there is at least one participant who has joined the session; otherwise, returns FALSE.
`password`	Optional. String.	The password required to access a recording.
`passwordReq`	Required. Boolean.	TRUE if a session requires a password; otherwise, FALSE.
`personalAccountIndex`	Optional. Integer.	Specifies the personal telephony account.
`phone`	Optional. Maximum of 64 characters.	The contact’s phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234".
`phoneNumber`	Required. String.	Holds the associated phone number.
`playback`	Optional. Container.	Holds the recording playback options.
`polling`	Optional. Valid values are TRUE and FALSE.	Indicates whether survey polling is supported during recording playback.
`postRecordingSurvey`	Optional. Valid values are TRUE and FALSE.	Indicates whether to conduct a survey after the recording.
`presenter`	Optional. String.	The name of the presenters in the TC.
`programName`	Optional. String.	The name of the EC program.
`range`	Optional. Enumerated string. Valid values are FULL and PARTIAL.	Indicates the recording playback range. ■ FULL: Play the entire recording. ■ PARTIAL: Play a portion of the recording as indicated by partialStart and partialEnd.
`recording`	Optional. Container.	Holds information about NBR recordings.
`recordingID`	Required. Integer.	The unique identifier for a recording.
`recordingType`	Required. Integer.	Holds the type of recording. ■ 0: Network ■ 2: Local
`recordingType` (in recording)	Required. Integer.	Determines the formatting of the recording. ■ 1: URL ■ 2: Local File ■ 5: NBR recording
`recordName`	Optional. String.	Holds the name of a record.
`recurrence`	Optional. Valid values are TRUE and FALSE.	Allows recurring sessions to be retrieved over a specified date range.
`registerReq`	Optional. Valid values are TRUE and FALSE.	Determines whether or not registration is required.
`registration`	Required. Valid values are TRUE and FALSE.	Specifies whether registration is required for each session.
`registrationURL`	Optional. String.	The URL for the attendee session registration page. Is only returned if registration is enabled.
`release`	Optional. String.	The release number of Webex XML API in addition to its major version expressed in the apiVersion element. For example, for XML API 3.9.1, apiVersion returns “XML API V3.9.0” while release will return “SP1”.
`returnAssistFields`	Optional. Valid values are TRUE and FALSE.	Determines whether or not to return assist fields. Defaults to FALSE.
`returned`	Required. Integer.	Number of records returned in this response. See also matchingRecords.
`returnPSOFields`	Optional. Valid values are TRUE and FALSE.	Determines whether or not to return psoFields.
`returnSessionDetails`	Optional. Valid values are TRUE and FALSE.	Returns the sessionKey and tracking codes is set to TRUE.
`returnSpecifiedTimeZone`	Optional. Valid values are TRUE and FALSE.	Determines if `<startTime>` is returned in the timezone specified in `<dateScope><timeZoneID>`. Default is FALSE.
`returnTrainReleaseVersion`	Optional. Valid values are TRUE and FALSE.	Determines if the release version is returned.
`sendReminder`	Optional. Valid values are TRUE and FALSE.	Indicates whether to send reminders to attendee/presenter.
`services`	Optional.	Contains service information and session information about the returned open sessions.
`serviceType`	Enumerated string. Valid values are MeetingCenter, EventCenter, TrainingCenter, SupportCenter, and SalesCenter.	The services (Meeting Center, Event Center, Training Center, Support Center, Sales Center) that are supported for this site.
`serviceTypes`	Optional. Container.	Holds the service types.
`sessionKey`	Required. Long.	A Webex-assigned session-unique value that is needed to identify the returned sessions.
`sessionName`	Optional. String.	The name of the open session.
`sessionPassword`	Optional. String.	The session password.
`sessions`	Optional.	Contains information about the returned open sessions.
`sessionTemplate`	Optional. Container.	Holds the session template.
`sessionType`	Required. Integer.	Webex XML API provides two kinds of session types: root session types and sub-session types. Root session types are fixed, which include the following valid values: ■ 1: FRE (Free meeting) ■ 2: STD (Standard meeting) ■ 3: PRO (Pro meeting) ■ 4: SOS (Standard subscription office meeting) ■ 5: SOP (Pro subscription office meeting) ■ 6: PPU (Pay-per-use meeting) ■ 7: OCS (OnCall support session) ■ 8: COB (OnTour Session) ■ 9: ONS (OnStage meeting) ■ 10: RAS (Access Anywhere session) ■ 11: TRS (Training session) ■ 13: SC3 (Support Center Session) ■ 14: SMT (SMARTtech session) ■ 15: SAC (Sales session) ■ 16: AUO (Teleconference Only meeting) Sub-session types are customizable. For detailed information on sub-session types, please contact Webex API Support team. Note: `When calling SetOneClickSettings, the session type cannot be set to AUO since an audio-only session does not support one-click.`
`setupStatus`	Required. Valid values are TRUE and FALSE.	Specifies whether one-click sessions are set up.
`size`	Required. Integer.	Size of the file in bytes.
`size` (in recordedEvent)	Required. Float.	Size of the recording in MB.
`startDate`	Required. String.	Holds the session starting date and time in the selected time zone. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateEnd`	Optional.	End of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateStart`	Optional.	Beginning of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`startFrom`	Required. Integer.	Record index number that the returned set starts from. See also matchingRecords.
`startTime`	Optional. String.	The time when the session starts. Formatted as MM/DD/YYYY HH:MM:SS.
`state`	Optional. Maximum of 32 characters.	The contact’s state of residence.
`status`	Optional. Enumerated string. Valid values are NOT_INPROGRESS, INPROGRESS.	Specifies the session status used for a query. If not specified, the query returns sessions of all statuses.
`status` (in GetSessionInfoResponse)	Required. Enum {NOT_STARTED, STARTED, ENDED}.	Defines the status of the test.
`streamURL`	Required. String.	The URL for the recording stream.
`subscriberAccessCode`	Optional. String.	The teleconferencing subscriber access code supplied by the telephony service provider.
`subscriberAccessCodeLabel`	Optional. String.	The subscriber access code label for TSP audio.
`subscriberAccessLabel`	Optional. String.	Host access code label to TSP/PCN accounts.
`supportQandA`	Optional. Valid values are TRUE and FALSE.	Indicates whether the Training Center client Q&A feature is enabled during recording playback.
`teleconfLocation`	Optional. String.	Locale of the teleconference.
`teleconfServiceName`	Optional. String.	Name of the teleconferencing service.
`telephony`	Optional. Container.	Holds the audio conference.
`telephonySupport`	Required Enumerated string. Valid values are NONE, CALLIN, CALLBACK, OTHER.	Specifies the type of telephone support.
`timeZone`	Required. String.	Selected time zone description for a session.
`timeZoneID`	Optional. Integer. An integer ranging from 0 to 61. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the session.
`title`	Optional. Maximum of 128 characters.	The title of a contact.
`title` (in GetSessionInfoResponse)	Required. String.	Name of the test.
`titleURL`	Required. String.	URL to show if the test tile was clicked.
`toc`	Optional. Valid values are TRUE and FALSE.	Indicates whether a table of contents is available during recording playback.
`tollCallInData`	Optional. String.	Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”. ■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it). ■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
`tollCallInLabel`	Required. String.	Returns the phone number label as defined for the Webex or TSP Telephony Domain.
`tollCallInNumber`	Optional. String.	Teleconference toll call in number for the user as assigned by the telephony service provider. Note: `The telephone number should include a country code and an area code For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on Webex Web pages. Commas do NOT represent a dialing pause. tollCallInNumberLabel Required String. Name displayed for toll numbers.`
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in is enabled.
`tollFreeCallInData`	Optional. String.	Information about the call. This field controls the Toll-Free checkbox and sets the country code. The value must be formatted as “TollFreeFlag,CountryCode”. ■ The TollFreeFlag value will be 1 or 0 (“1” enables the checkbox and “0” will disable it). ■ The CountryCode value must be set to the specific country code value as shown in Appendix A.3, Telephone Country Codes. For example “86” represents China.
`tollFreeCallInLabel`	Required. String.	Returns the phone number label as defined for the Webex or TSP Telephony Domain.
`tollFreeCallInNumber`	Optional. String.	Teleconference toll free call in number for the user as assigned by the telephony service provider. Note: `The telephone number should include a country code and an area code. For example, 1,408,555-1212. Commas are required to parse the country code and the area code into different fields on Webex Web pages. Commas do NOT represent a dialing pause.`
`tollFreeCallInNumberLabel`	Required. String.	Name displayed for toll-free numbers.
`tollFreeRestrictionsURL`	Optional. String.	The URL used to display toll free dialing restrictions.
`topic`	Optional. String.	The recording topic.
`total`	Required. Integer.	Total number of records matching the query. See also matchingRecords.
`tracking`	Optional. Container.	Holds the tracking codes.
`trackingCode1..10`	Optional. String.	Holds the value for a tracking code. Up to 10 tracking codes are available at a time, trackingCode1, trackingCode2, ...
`trainingRecordings`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex, My Files: Training Recordings feature for the user.
`trainReleaseVersion`	Optional. String.	Holds the release version of the site.
`tspAccountIndex`	Optional. Integer.	Specifies the tsp account.
`type`	Optional. Valid values are MEMBER and VISITOR.	Default: VISITOR. Note: `This element is ignored by CreateContacts.`
`type` (in sessionTemplate)	Required. Enum {User, Site, Service}	Holds the template type.
`url`	Optional. Maximum of 128 characters.	The URL for a contact.
`URL` (in `GetSessionInfoResponse`)	Required. String.	The URL that tells attendees where to download the document.
`value`	Optional. String.	Specifies the value of a tracking code.
`value`	Optional. String.	Specifies the value of a tracking code.
`verifyFlashMediaURL`	Optional. String.	The URL used to verify the user’s Adobe Flash player.
`verifyWinMediaURL`	Optional. String.	The URL used to verify the user’s Windows Media player.
`video`	Optional. Valid values are TRUE and FALSE.	Indicates whether video is supported during recording playback.
`viewURL`	Required. String.	The URL string used to access the streaming recording. Corresponds to “Stream recording link” in the web page.
`voip`	Optional. Valid values are TRUE and FALSE.	Specifies whether Voice Over IP telephony is enabled.
`webExID`	Optional. Maximum of 64 characters.	Webex user account name.
`webExID` (in GetSessionInfoResponse)	Required. String.	The Webex username of the session’s host.
`zipCode`	Optional. Maximum of 16 characters.	The ZIP code for a contact.

Complex Types Used By The General Session Service

The following diagrams show the complex types used by the General Session Service.

Schema diagram: `contact` element

XSD Schema Diagram of contact

Meeting Service

This chapter describes Webex XML operations related to the Meeting service as well as sample XML documents that show example request messages and examples of possible response messages from the server.

Table 5-1 • Webex XML Request Messages Related to Meeting Operations

*XML*	*Description*
`CreateMeeting`	Schedules a Meeting.
`CreateTeleconferenceSession`	Schedules a Teleconference-only Meeting.
`DelMeeting`	Deletes a Scheduled Meeting.
`GethosturlMeeting`	Gets a URL for the Host to Start a Scheduled Meeting.
`GetjoinurlMeeting`	Gets a URL for an Attendee to Join a Scheduled Meeting.
`GetMeeting`	Gets Details for a Scheduled Meeting.
`GetTeleconferenceSession`	Gets Details for a Scheduled Teleconference-only Meeting.
`LstsummaryMeeting`	Lists summary information of scheduled meetings.
`SetMeeting`	Allows hosts to update the information of their scheduled meeting.
`SetTeleconferenceSession`	Allows hosts to update the information of their scheduled Teleconference-only Meeting.

CreateMeeting

Allows hosts to schedule a meeting. Returns a unique meeting key for the session.

You can use the CreateMeeting API to create End-to-end Encryption (E2EE) sessions. If E2EE is enabled, networkBasedRecording, joinBeforeHost, and remoteComputer sharing features are automatically disabled.

Request

The sample XML document shows an example of creating a new meeting service instance with the confName of Sample Meeting.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
        <securityContext>
            <siteName>acme</siteName>
            <webExID>hostid@acme.com</webExID>
            <password>passw0rd</password>   
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.meeting.CreateMeeting">
            <accessControl>
                <meetingPassword>pass123</meetingPassword>
            </accessControl>
            <metaData>
                <confName>Sample Meeting</confName>
                <meetingType>1</meetingType>
                <agenda>Test</agenda>
            </metaData>
            <participants>
                <maxUserNumber>4</maxUserNumber>
                <attendees>
                    <attendee>
                        <person>
                            <name>James Kirk</name>
                            <email>Jkirk@sz.webex.com</email>
                        </person>
                    </attendee>
                </attendees>
            </participants>
            <enableOptions>
                <chat>true</chat>
                <poll>true</poll>
                <audioVideo>true</audioVideo>
            </enableOptions>
            <schedule>
                <startDate>05/31/2004 10:10:10</startDate>
                <openTime>900</openTime>
                <joinTeleconfBeforeHost>true</joinTeleconfBeforeHost>
                <duration>20</duration>
                <timeZoneID>4</timeZoneID>
            </schedule>
            <telephony>
                <telephonySupport>CALLIN</telephonySupport>
                <extTelephonyDescription>
                    Call 1-800-555-1234, Passcode 98765
                </extTelephonyDescription>
            </telephony>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-1 • Schema diagram for `createMeeting`

CreateMeeting allows users to specify whether attendees can join the teleconference before the host does. This functionality is part of the schedule element.

CreateMeeting supports Cisco Unified MeetingPlace audio conferencing.
CreateMeeting supports Join Before Host Telephony for TSP and MP audio conferencing sessions.

For descriptions of the global elements in the security context of the header, see “Global Request Elements in Security Context”. For descriptions of the non-global elements, refer to “Elements in Webex XML Schema Definitions for the Meeting Service”.

Response

The sample XML document shows an example of a response document populated with values based upon the preceding sample XML request.

<?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:createMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:meetingkey>48591508</meet:meetingkey>
            <meet:iCalendarURL>
                <serv:host>https://www.webex.com/calendarurl1/j.php?ED=48591508&U
                    ID=BA24987F&ICS=MIFH&ST=12</serv:host>
                <serv:attendee>https://www.webex.com/calendarurl1/j.php?ED=485915
                    08&UID=BA24987F&ICS=MIFA&ST=12</serv:attendee>
            </meet:iCalendarURL>
            <meet:guestToken>f10324e2af4823c278fa1a6efadc426c</meet:guestToken>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-2 • Schema diagram for `createMeetingResponse`

CreateTeleconferenceSession

Allows hosts to schedule a teleconference-only meeting. Returns a unique teleconference-only meeting key for the session. If the Primary Large Telephony Server is unavailable, the page first tries to connect to the NextGen telephony server. If that connection is unavailable, the page will connect to the Backup 2 Large server instead.

Request

The sample XML document creates a new teleconference-only meeting service instance with the name of Sample Teleconference-only meeting.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <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.auo.CreateTeleconf
            erenceSession"
            xmlns:att="http://www.webex.com/schemas/2002/06/service/meeting">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>123456</sessionPassword>
            </accessControl>
            <metaData>
                <confName>Sample Teleconference-only meeting</confName>
            </metaData>
            <fullAccessAttendees>
                <attendee>
                    <name>1</name>
                    <phones>
                        <phone/>
                        <mobilePhone/>
                        <fax/>
                    </phones>
                    <email>1@1.com</email>
                </attendee>
            </fullAccessAttendees>
            <limitedAccessAttendees>
                <attendee>
                    <name>2</name>
                    <phones>
                        <phone/>
                        <mobilePhone/>
                        <fax/>
                    </phones>
                    <email>2@2.com</email>
                </attendee>
            </limitedAccessAttendees>
            <schedule>
                <startDate>04/18/2005 15:08:51</startDate>
                <timeZoneID>45</timeZoneID>
                <entryExitTone>ANNOUNCENAME</entryExitTone>
            </schedule>
            <teleconference>
                <extTelephonyDescription>xml</extTelephonyDescription>
            </teleconference>
            <tracking>
                <trackingCode1>1</trackingCode1>
                <trackingCode2>2</trackingCode2>
                <trackingCode3>3</trackingCode3>
                <trackingCode4>4</trackingCode4>
                <trackingCode5>5</trackingCode5>
                <trackingCode6>6</trackingCode6>
                <trackingCode7>7</trackingCode7>
                <trackingCode8>8</trackingCode8>
                <trackingCode9>9</trackingCode9>
                <trackingCode10>10</trackingCode10>
            </tracking>
            <repeat>
                <repeatType>DAILY</repeatType>
                <interval>1</interval>
            </repeat>
            <attendeeOptions>
                <emailInvitations>true</emailInvitations>
            </attendeeOptions>
        </bodyContent>
    </body>
</serv:message>

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

Schema diagram for createTeleconferenceSession

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non-global elements, refer to “Elements in Webex XML Schema Definitions for the Meeting Service”.

Response

The sample XML document shows an example of a response document populated with values based upon the preceding sample XML request.

<?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:auo="http://www.webex.com/schemas/2002/06/service/meeting/auo">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="auo:createTeleconferenceSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <auo:sessionKey>11320765</auo:sessionKey>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-3 • Schema diagram for createTeleconferenceSessionResponse

DelMeeting

Allows hosts to delete a meeting that is not currently in progress.

Request

The sample XML document deletes the meeting with a meetingKey value of 48591508. Be sure to provide a valid value for your website.


<?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.DelMeeting">
            <meetingKey>48591508</meetingKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-4 • Schema diagram for delMeeting

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: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:delMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:iCalendarURL>
                <serv:host>https://www.webex.com/calendarurl1/j.php?ED=48591508&U
                    ID=BA24987F&ICS=CMC&LD=ENGLISH&RD=na&ST=12&CN=Business%20Deve
                    lopment&STI=20070120120000&TD=utc
                </serv:host>
                <serv:attendee>https://www.webex.com/calendarurl1/j.php?ED=485915
                    08&UID=BA24987F&ICS=CMC&LD=ENGLISH&RD=na&ST=12&CN=Business%20
                    Development&STI=20070120120000&TD=utc
                </serv:attendee>
            </meet:iCalendarURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-5 • Schema diagram for delMeetingResponse

Note The expanded diagram for meet:iCalendarURL can be found in schema diagrams.

When a meeting is deleted via the web interface, a notification email is sent to attendees.

GethosturlMeeting

The GethosturlMeeting request returns a Webex-generated Web address that, when rendered by host’s Web browser, starts a meeting by offering the meeting views and functionality that are appropriate for the meeting host.

Note In Meeting Center and Training Center, if user A schedules a session for user B, only user B is allowed to start the session. If user A calls GethosturlMeeting, the system can realize that user B is the effective host, and retrieves user B's Webex ID and password, which are then returned in hostMeetingURL. The password is passed using a one-time login ticket string using the parameter &TK=[loginTicket].

Request

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

Figure 5-6 • Schema diagram for gethosturlMeeting

Note The meetingKey element has been deprecated. We keep this for backward compatibility. New users please use sessionKey instead.

The sample XML document requests the host’s Web address for starting the meeting identified by the sessionKey value of 48591508.


<?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.GethosturlMeeting">
            <sessionKey>48591508</sessionKey>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 5-7 • Schema diagram for gethosturlMeetingResponse

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: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:GethosturlMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:hostMeetingURL>https://rose22.webex.com/rose22/p.php?AT=LI&WI
                D=hostid&PW=pass&MU=https%3A%2F%2Frose22.webex.com%2Frose22%2Fm.
                php%3FAT%3DHM%26MK%3D48591508%26Rnd%3D0.9044222067369163
            </meet:hostMeetingURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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”.

GetjoinurlMeeting

The GetjoinurlMeeting request returns a Webex-generated Web address that can direct meeting participants to the Webex Web page that provides the meeting views and functionality that are appropriate for attendees other than the host.

Request

The sample XML document requests the meeting Web address for a meeting identified by the sessionKey value of 48591508.

<?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.GetjoinurlMeeting">
            <sessionKey>48591508</sessionKey>
            <attendeeName>James Kirk</attendeeName>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-8 • Schema diagram for getjoinurlMeeting

Note The meetingKey element has been deprecated. We keep this for backward compatibility. New users please use sessionKey instead.

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: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:GetjoinurlMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:joinMeetingURL>https://rose22.webex.com/rose22/m.php?AT=JM&MK
                =48591508&AN=James Kirk&PW=pass123
            </meet:joinMeetingURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-9 • Schema diagram for getjoinurlMeetingResponse

GetMeeting

Gets detailed information about the specified meeting.

Note Site administrators or regular hosts can only get information of the meeting sessions scheduled or owned by themselves. An exceptionID of 000001 is returned if a user tries to get information of the sessions scheduled by other hosts.

Request

The sample XML document shows an example of a request to retrieve the meeting with the meetingKey value of 48591508. Be sure to provide valid values for a meeting from one of your website users.

<?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.GetMeeting">
            <meetingKey>48591508</meetingKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-10 • Schema diagram for getMeeting

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: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:getMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:accessControl>
                <meet:listToPublic>false</meet:listToPublic>
                <meet:isPublic>false</meet:isPublic>
                <meet:meetingPassword>123456</meet:meetingPassword>
            </meet:accessControl>
            <meet:metaData>
                <meet:confName>Sample Meeting</meet:confName>
                <meet:meetingType>1</meet:meetingType>
                <meet:agenda>Test</meet:agenda>
                <meet:invitation />
            </meet:metaData>
            <meet:participants>
                <meet:maxUserNumber>4</meet:maxUserNumber>
                <meet:attendees>
                    <meet:attendee>
                        <att:person>
                            <com:name>site admin</com:name>
                            <com:firstName>site</com:firstName>
                            <com:lastName>admin</com:lastName>
                            <com:webExId>siteadmin</com:webExId>
                            <com:address>
                                <com:addressType>PERSONAL</com:addressType>
                            </com:address>
                            <com:phones />
                            <com:email>siteadmin@webex.com</com:email>
                            <com:type>MEMBER</com:type>
                        </att:person>
                        <att:contactID>13118223</att:contactID>
                        <att:joinStatus>INVITE</att:joinStatus>
                        <att:meetingKey>48591508</att:meetingKey>
                        <att:language>ENGLISH</att:language>
                        <att:role>HOST</att:role>
                        <att:languageID>1</att:languageID>
                    </meet:attendee>
                </meet:attendees>
            </meet:participants>
            <meet:enableOptions>
                <meet:chat>true</meet:chat>
                <meet:poll>true</meet:poll>
                <meet:audioVideo>true</meet:audioVideo>
                <meet:attendeeList>true</meet:attendeeList>
                <meet:fileShare>true</meet:fileShare>
                <meet:presentation>true</meet:presentation>
                <meet:applicationShare>true</meet:applicationShare>
                <meet:desktopShare>true</meet:desktopShare>
                <meet:webTour>true</meet:webTour>
                <meet:meetingRecord>false</meet:meetingRecord>
                <meet:annotation>false</meet:annotation>
                <meet:importDocument>false</meet:importDocument>
                <meet:saveDocument>false</meet:saveDocument>
                <meet:printDocument>false</meet:printDocument>
                <meet:pointer>false</meet:pointer>
                <meet:switchPage>false</meet:switchPage>
                <meet:fullScreen>false</meet:fullScreen>
                <meet:thumbnail>false</meet:thumbnail>
                <meet:zoom>false</meet:zoom>
                <meet:copyPage>false</meet:copyPage>
                <meet:rcAppShare>true</meet:rcAppShare>
                <meet:rcDesktopShare>true</meet:rcDesktopShare>
                <meet:rcWebTour>true</meet:rcWebTour>
                <meet:javaClient>false</meet:javaClient>
                <meet:nativeClient>false</meet:nativeClient>
                <meet:attendeeRecordMeeting>false</meet:attendeeRecordMeeting>
                <meet:voip>false</meet:voip>
                <meet:faxIntoMeeting>true</meet:faxIntoMeeting>
                <meet:enableReg>false</meet:enableReg>
                <meet:supportQandA>true</meet:supportQandA>
                <meet:supportFeedback>true</meet:supportFeedback>
                <meet:supportBreakoutSessions>true</meet:supportBreakoutSessions>
                <meet:supportPanelists>true</meet:supportPanelists>
                <meet:supportRemoteComputer>false</meet:supportRemoteComputer>
                <meet:supportShareWebContent>true</meet:supportShareWebContent>
                <meet:supportUCFWebPages>true</meet:supportUCFWebPages>
                <meet:supportUCFRichMedia>true</meet:supportUCFRichMedia>
                <meet:autoDeleteAfterMeetingEnd>false
                </meet:autoDeleteAfterMeetingEnd>
                <meet:viewAnyDoc>false</meet:viewAnyDoc>
                <meet:viewAnyPage>false</meet:viewAnyPage>
                <meet:allowContactPrivate>false</meet:allowContactPrivate>
                <meet:chatHost>true</meet:chatHost>
                <meet:chatPresenter>true</meet:chatPresenter>
                <meet:chatAllAttendees>true</meet:chatAllAttendees>
                <meet:multiVideo>false</meet:multiVideo>
                <meet:notes>true</meet:notes>
                <meet:closedCaptions>false</meet:closedCaptions>
                <meet:singleNote>false</meet:singleNote>
                <meet:sendFeedback>false</meet:sendFeedback>
                <meet:displayQuickStartHost>false</meet:displayQuickStartHost>
                <meet:displayQuickStartAttendees>false
                </meet:displayQuickStartAttendees>
                <meet:supportE2E>false</meet:supportE2E>
                <meet:supportPKI>false</meet:supportPKI>
            </meet:enableOptions>
            <meet:schedule>
                <meet:startDate>05/10/2010 19:00:00</meet:startDate>
                <meet:timeZoneID>4</meet:timeZoneID>
                <meet:timeZone>GMT-08:00, Pacific (San Jose)</meet:timeZone>
                <meet:duration>60</meet:duration>
                <meet:openTime>300</meet:openTime>
                <meet:hostWebexID>hostid</meet:hostWebexID>
                <meet:templateFilePath />
                <meet:showFileStartMode>true</meet:showFileStartMode>
                <meet:showFileContPlayFlag>false</meet:showFileContPlayFlag>
                <meet:showFileInterVal>30</meet:showFileInterVal>
                <meet:entryExitTone>0</meet:entryExitTone>
                <meet:extNotifyTime>0</meet:extNotifyTime>
                <meet:joinTeleconfBeforeHost>false</meet:joinTeleconfBeforeHost>
            </meet:schedule>
            <meet:telephony>
                <meet:telephonySupport>OTHER</meet:telephonySupport>
                <meet:numPhoneLines>500</meet:numPhoneLines>
                <meet:extTelephonyDescription>Call 1-800-555-1234, Passcode 98765
                </meet:extTelephonyDescription>
                <meet:enableTSP>false</meet:enableTSP>
                <meet:intlLocalCallIn>false</meet:intlLocalCallIn>
                <meet:callInNum />
            </meet:telephony>
            <meet:tracking />
            <meet:repeat>
                <meet:repeatType>NO_REPEAT</meet:repeatType>
            </meet:repeat>
            <meet:remind>
                <meet:enableReminder>true</meet:enableReminder>
                <meet:emails>
                    <meet:email>test@email.com</meet:email>
                </meet:emails>
                <meet:sendEmail>true</meet:sendEmail>
                <meet:sendMobile>false</meet:sendMobile>
                <meet:daysAhead>0</meet:daysAhead>
                <meet:hoursAhead>0</meet:hoursAhead>
                <meet:minutesAhead>15</meet:minutesAhead>
            </meet:remind>
            <meet:attendeeOptions>
                <meet:request>false</meet:request>
                <meet:registration>false</meet:registration>
                <meet:auto>false</meet:auto>
                <meet:excludePassword>false</meet:excludePassword>
                <meet:joinRequiresAccount>false</meet:joinRequiresAccount>
            </meet:attendeeOptions>
            <meet:meetingkey>48591508</meet:meetingkey>
            <meet:status>NOT_INPROGRESS</meet:status>
            <meet:hostJoined>false</meet:hostJoined>
            <meet:participantsJoined>false</meet:participantsJoined>
            <meet:hostKey>885837</meet:hostKey>
            <meet:eventID>10764972</meet:eventID>
            <meet:hostType>1001001</meet:hostType>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Note GetMeeting returns information about whether or not attendees can join the teleconference before the host does. This functionality is a part of the schedule element.

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

Figure 5-11 • Schema diagram for GetMeetingResponse

GetTeleconferenceSession

Gets detailed information about the specified teleconference-only session scheduled on your website.

Request

The sample XML document shows an example of a request for the retrieval of the teleconference-only session with the sessionKey value of 37480497. Be sure to provide valid values for a session of your website users.

<?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.auo.GetTeleconferenceSession">
            <sessionKey>37480497</sessionKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-12 • Schema diagram for getTeleconferenceSession

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:auo="http://www.webex.com/schemas/2002/06/service/meeting/auo">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="auo:getTeleconferenceSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <auo:accessControl>
                <auo:listing>PUBLIC</auo:listing>
                <auo:sessionPassword>111111</auo:sessionPassword>
            </auo:accessControl>
            <auo:metaData>
                <auo:confName>Test Setting Teleconf-only</auo:confName>
                <auo:sessionType>16</auo:sessionType>
            </auo:metaData>
            <auo:schedule>
                <auo:startDate>04/18/2015 15:15:17</auo:startDate>
                <auo:timeZoneID>16</auo:timeZoneID>
                <auo:timeZone>GMT-03:00, S. America Eastern (Brasilia)
                </auo:timeZone>
                <auo:duration>60</auo:duration>
                <auo:entryExitTone>BEEP</auo:entryExitTone>
                <auo:hostWebexID>hostid</auo:hostWebexID>
            </auo:schedule>
            <auo:teleconference>
                <auo:extTelephonyDescription>xmlSet</auo:extTelephonyDescription>
            </auo:teleconference>
            <auo:tracking />
            <auo:repeat>
                <auo:repeatType>WEEKLY</auo:repeatType>
                <auo:expirationDate>04/18/2016 15:15:17</auo:expirationDate>
                <auo:dayInWeek>
                    <auo:day>SATURDAY</auo:day>
                    <auo:day>TUESDAY</auo:day>
                </auo:dayInWeek>
                <auo:dayInMonth>0</auo:dayInMonth>
                <auo:weekInMonth>0</auo:weekInMonth>
            </auo:repeat>
            <auo:remind>
                <auo:enableReminder>true</auo:enableReminder>
                <auo:daysAhead>0</auo:daysAhead>
                <auo:hoursAhead>0</auo:hoursAhead>
                <auo:minutesAhead>15</auo:minutesAhead>
            </auo:remind>
            <auo:fullAccessAttendees />
            <auo:limitedAccessAttendees />
            <auo:attendeeOptions>
                <auo:requireUcfDiagnosis>false</auo:requireUcfDiagnosis>
                <auo:excludePassword>false</auo:excludePassword>
                <auo:requireAccount>false</auo:requireAccount>
            </auo:attendeeOptions>
            <auo:telephony>
                <auo:extTelephonyDescription>xmlSet</auo:extTelephonyDescription>
            </auo:telephony>
            <auo:hostType>1019001</auo:hostType>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-13 • Schema diagram for getTeleconferenceSessionResponse

LstsummaryMeeting

Lists summary information of scheduled meetings. (This operation replaces LstMeeting.)

Note Site administrators can list meetings scheduled by all users on the site. Regular hosts can list only their own meetings of any access type (i.e., PUBLIC, PRIVATE, and UNLISTED).

Request

The sample XML shows an example of a request for the summary information for meetings that were 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>

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

Figure 5-16 • Schema diagram for lstsummaryMeeting

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”.

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: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>

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

Figure 5-17 • Schema diagram for lstsummaryMeetingResponse

Note The expanded diagram for meet:matchingRecords can be found in schema diagrams.

SetMeeting

Allows hosts to update the information of their scheduled meeting.

End-to-end Encryption (E2EE) sessions are edited using the SetMeeting API. If E2EE is enabled, networkBasedRecording, joinBeforeHost, and remoteComputer sharing features are automatically disabled.

Note When updating a meeting, SetMeeting ignores the emailInvitations and status elements because it does not send out any email messages nor change the status of the meeting.

Request

The sample XML document show an example of a request to update a meeting. In the sample XML document, the key identification value is given as 48591508, but you should be sure to provide a valid value for your website user.

<?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.SetMeeting">
            <metaData>
                <confName>test meeting.SetMeeting</confName>
                <meetingType>1</meetingType>
                <agenda>Test</agenda>
            </metaData>
            <participants>
                <maxUserNumber>4</maxUserNumber>
                <attendees></attendees>
            </participants>
            <enableOptions>
                <chat>false</chat>
                <poll>true</poll>
                <audioVideo>true</audioVideo>
            </enableOptions>
            <schedule>
                <startDate>06/01/2004 23:06:27</startDate>
                <duration>60</duration>
                <timeZone>GMT-05:00, S. America Pacific (Bogota)</timeZone>
            </schedule>
            <telephony>
                <numPhoneLines>0</numPhoneLines>
                <telephonySupport>NONE</telephonySupport>
            </telephony>
            <remind>
                <enableReminder>true</enableReminder>
                <emails>
                    <email>user@user.com</email>
                </emails>
            </remind>
            <attendeeOptions>
                <auto>true</auto>
            </attendeeOptions>
            <meetingkey>48591508</meetingkey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-18 • Schema diagram for setMeeting

Note SetMeeting 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.

SetMeeting supports Join Before Host Telephony for TSP and MP audio conferencing sessions.

Response

The sample XML document shows the change that has been made to the existing service instance.

<?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:setMeetingResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <meet:iCalendarURL>
                <serv:host>https://www.webex.com/calendarurl1/j.php?ED=48591508&U
                    ID=BA24987F&ICS=MIFH&ST=12
                </serv:host>
                <serv:attendee>https://www.webex.com/calendarurl1/j.php?ED=485915
                    08&UID=BA24987F&ICS=MIFA&ST=12
                </serv:attendee>
            </meet:iCalendarURL>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 5-19 • Schema diagram for setMeetingResponse

Note The expanded diagram for meet:iCalendarURL can be found in schema diagrams.

SetTeleconferenceSession

Allows updating the information about a scheduled teleconference-only meeting. If the Primary Large Telephony Server is unavailable, the page first tries to connect to the NextGen telephony server. If that connection is unavailable, the page will connect to the Backup 2 Large server instead.

Note The API checks the password according to strict password criteria settings in Site Admin for audio only meetings.

Request

The sample XML document shows an example of a request to update a teleconference-only meeting where the sessionKey is 11320765.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <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.auo.SetTeleconferenceSession"
            xmlns:att="http://www.webex.com/schemas/2002/06/service/meeting">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>123456</sessionPassword>
            </accessControl>
            <metaData>
                <confName>Test Setting Teleconf-only</confName>
            </metaData>
            <schedule>
                <startDate>04/18/2005 15:15:17</startDate>
                <timeZoneID>16</timeZoneID>
                <entryExitTone>BEEP</entryExitTone>
            </schedule>
            <teleconference>
                <extTelephonyDescription>xmlSet</extTelephonyDescription>
            </teleconference>
            <repeat>
                <repeatType>WEEKLY</repeatType>
                <dayInWeek>
                    <day>TUESDAY</day>
                    <day>SATURDAY</day>
                </dayInWeek>
            </repeat>
            <sessionKey>11320765</sessionKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 5-20 • Schema diagram for setTeleconferenceSession

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:auo="http://www.webex.com/schemas/2002/06/service/meeting/auo">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="auo:setTeleconferenceSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

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

Figure 5-21 • Schema diagram for setTeleconferenceSessionResponse

Elements in Webex XML Schema Definitions for the Meeting Service

The following table describes all the elements that are used in the Webex XML API for the Meeting service.

*Element*	*Constraint(s)*	*Description*
`accountIndex`	Optional. Integer.	Indicates the account number of a personal conference number, not available for request conference number.
`address1`	Optional. Maximum of 128 characters.	The first line of the attendee’s street address. Default is “”.
`address2`	Optional. Maximum of 128 characters.	The second line of the attendee’s street address. Default is ““.
`addressType`	Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered Webex user.	Determines whether the meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. Default: “PERSONAL”.
`afterMeetingNumber`	Optional. An integer in the range 0 - 999.	For recurring meetings, determines the number of meeting instances to repeat.
`agenda`	Optional. Maximum of 2,500 characters.	An agenda of the meeting.
`allowContactPrivate`	Optional. Valid values are TRUE and FALSE.	Whether to allow attendees to contact the operator privately. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`annotation`	Optional. Valid values are TRUE and FALSE.	Indicates whether annotation is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`applicationShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether application sharing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`assistConfirm`	Optional. Enum {Pending, Confirmed, Cancelled}	Assist meeting’s confirm type. Defaults to Pending.
`assistRequest`	Optional. Enum {None, Dry Run, Consult, Live Event Support, Audio Streaming, Video}	Assist meeting’s request type. Defaults to None.
`attendee`	Required. String.	The URL of an iCalendar file containing meeting information for an attendee.
`attendeeEmail`	Optional. String. Maximum of 64 characters.	The email address of the attendee.
`attendeeList`	Optional. Valid values are TRUE and FALSE.	Indicates whether an attendee listing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`attendeeName`	Optional. String.	The attendee’s first name and last name.
`attendeeOptions`	Optional. Complex.	Meeting options for the attendees. Note: `For the sake of backward compatibility, the enclosed elements follow the following logic:` `■ If auto is set to TRUE, then both registration and request are set to TRUE automatically.` `■ If auto is set to FALSE, and either registration or request is set to TRUE, then both registration and request are set to TRUE automatically.` `■ If auto is set to FALSE, and both registration and request are set to FALSE, then all the three elements (auto, registration and request) remain unchanged.` See also auto, registration and request.
`attendeeRecordMeeting`	Optional. Valid values are TRUE and FALSE.	Indicates whether attendees can record the meeting. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`audioVideo`	Optional. Valid values are TRUE and FALSE.	Indicates whether audio and/or video (from a webcam) is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`auto`	Optional. Valid values are TRUE and FALSE.	Indicates whether all registration requests are automatically accepted. Default: FALSE. See also attendeeOptions.
`autoDeleteAfterMeetingEnd`	Optional. Valid values are TRUE and FALSE.	Automatically deletes the meeting from calender after the meeting ends. Defaults to the host’s setting of this option in My Profile of My Webex.
`chat`	Optional. Valid values are TRUE and FALSE.	Indicates whether chat is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`chatAllAttendees`	Optional. Valid values are TRUE and FALSE.	Allows an attendee to participate in private chat with all other attendees. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`chatHost`	Optional. Valid values are TRUE and FALSE.	Allows attendees to participate in private chat with host. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`chatPresenter`	Optional. Valid values are TRUE and FALSE.	Allows attendees to participate in private chat with presenter. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`city`	Optional. Maximum of 64 characters.	The attendee’s city. Default is “”.
`closedCaptions`	Optional. Valid values are TRUE and FALSE.	Enables the Closed Captions note taking functionality. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`company`	Optional. Maximum of 128 characters.	The attendee’s company name.
`confName`	Required for Create. Must be a non-null value. Optional for Lst and Set. Not applicable for all other actions. Maximum of 512 characters.	The name of the meeting.
`contactID`	Optional. Long. If populated, A reference to another service.	A Webex-maintained reference to the contact information for a meeting attendee.
`copyPage`	Optional. Valid values are TRUE and FALSE.	Indicates whether page copying is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`country`	Optional. Maximum of 64 characters.	The attendee’s country. Default is ““.
`countyAlias`	Required. String.	Holds the country’s alias.
`day`	Optional. Enumerated string. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY.	For a recurring session, when repeatType=WEEKLY, multiple days can be specified.
`dayInMonth`	Optional. An integer from 1 to 31.	For a recurring session, when repeatType=MONTHLY, a specific day in each month can be specified.
`dayInWeek`	Optional. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY.	For a recurring event, on which days of the week it recurs. Works in conjunction with repeatType and interval.
`dayInYear`		This element is deprecated.
`daysAhead`	Optional. If populated, must be a positive integer.	Number of days ahead of the meeting to send RemindEmail or call RemindMobile when sendMail or sendMobile is TRUE. Works with hoursAhead and minutesAhead to determine exactly when the message is sent. 0 means the day of the event. Default: “0”.
`default`	Optional. Boolean.	Indicates whether to use the site default session template of a service for meeting scheduling. Default: FALSE.
`desktopShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether desktop sharing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`displayQuickStartAttendees`	Optional. Boolean.	Indicates whether the Quick Start tab in the session manager is displayed to attendees as they enter a meeting.
`displayQuickStartHost`	Optional. Boolean.	Indicates whether the Quick Start tab in the session manager is displayed to the host and presenter as they enter a meeting.
`duration`	Optional. If populated, must be a positive integer.	The duration of the meeting in minutes. Default is 60. Must be no more than the MaxMeetingDuration, which has been set by the Webex administrator and is defined in the Super Admin Site.
`email`	Required. Maximum of 64 characters.	The user’s email address.
`emailInvitations`	Optional. Valid values are TRUE and FALSE.	Whether to send invitation email messages to the meeting session attendees. Default is FALSE.
`enableReg`	Optional. Valid values are TRUE and FALSE.	This is a deprecated field. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`enableReminder`	Optional. Valid values are TRUE and FALSE.	TRUE for reminders to be enabled; FALSE for no reminder. Webex turns this value to TRUE if sendMail or sendMobile is set.
`enableTSP`	Optional. Valid values are TRUE and FALSE.	Enables the integrated partner Teleconferencing Service Provider functionality.
`endDateEnd`	Optional.	End of range of dates from which a user can select for the end date for a meeting.
`endDateStart`	Optional.	Beginning of range of dates from which a user can select for the end date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`enforcePassword`	Optional. Boolean. Default value is FALSE.	If TRUE, throw an exception when specified meetingPassword does not meet any of the strict password criteria defined in the Site Administration tool. To enforce password security when creating a Meeting with XML API, make sure you have both selected the Apply strict password option and defined strict password criteria in Site Administration, and then set this element to TRUE. If FALSE, the meeting password will not be checked for security even if Apply strict password is selected in Site Administration.
`entryExitTone`	Optional. Valid values are: ■ 0: No Tone ■ 1: Beep ■ 2: Announcement	The sound that all attendees hear when an attendee joins or exits a meeting.
`eventID`	Optional. Long.	An internal unique ID number for a Meeting Center session. Equivalent to meetingKey.
`excludePassword`	Optional. Valid values are TRUE and FALSE.	Specifies whether the meeting password should be excluded (true) from the email invitation to an attendee.
`expirationDate`	Optional.	The date and time after which a meeting that was set to automatically repeat stops repeating; leave empty to let the meeting repeat forever. Formatted as MM/DD/YYYY HH:MM:SS.
`extNotifyTime`	Optional. Integer.	The number of times to notify someone.
`extTelephonyDescription`	Optional. Maximum of 2,048 characters.	A description of your telephony services, if you use your own as indicated in extTelephonyURL.
`extTelephonyURL`	Optional. Maximum of 2,048 characters.	The URL of your telephony server, if you want to use it as an alternative to Webex to support the meeting’s voice communications (meeting is still recordable). Can be set only if you have super administration privilege.
`extURL`	Optional. String.	External URL. Only supports URLs that accept POST request method.
`fax`	Optional. Maximum of 64 characters.	The attendee’s fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`faxIntoMeeting`	Optional. Valid values are TRUE and FALSE.	Internal use only. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`fileShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether file sharing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`firstName`	Optional. String.	The first name of the attendee.
`fullScreen`	Optional. Valid values are TRUE and FALSE.	Indicates whether full screen is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`globalNum`	Optional. Container.	Corresponds to the Global Call-in Numbers in the telephony domain.
`greeting`	Optional. Maximum of 512 characters.	The welcoming greeting for the participants of the meeting. This text appears in a welcome pop-up window.
`host`	Required. String.	The URL of an iCalendar file containing meeting information for the host.
`hostJoined`	Boolean.	If TRUE, indicates that the host is now in the session; otherwise, returns FALSE.
`guestToken`	Optional. String.	Contains the guest’s token for a session.
`hostKey`	Optional. String.	The host key of a session host. The host key allows the host to pass privileges to another attendee or to reclaim the host role upon rejoining a session.
`hostMeetingURL`	Optional. Maximum of 128 characters.	The URL for the host to start the meeting. Default is “”. This element takes the following format: https://customer.webex.com/customer/ p.php?AT=LI&WID=&PW =&MU=https://customer.w ebex.com/customer/m.php?AT=HM& MK=
`hostType`	Optional. String.	Returns a code that specifies the application used to schedule and start the meeting. hostType has the following format xyyyzzz where: ■ (x) Meeting type: 1 - Regular, 2 - one-click ■ (yyy) Scheduled from: 001 - webpage, 002 - PT, 003 - OI, 004 - NI, 005 - MSN, 006 - Yahoo, 007 - AIM, 008 - Skype, 009 - Gtalk, 010 - Sametime, 011 - LCS, 012 - WebexToolbar, 013 - IPPhone, 016 - iPhone dusting, 017 - Webex Connect, 018 - TP meeting, 019 - generic XML API app. ■ (zzz) Started from: Uses the same codes as yyy.
`hostWebexID`	Optional. Maximum of 64 characters.	The Webex ID of the host user.
`hoursAhead`	Optional. A positive integer.	Number of hours ahead of the meeting to send email to RemindEmail or to call RemindMobile when sendEmail or sendMobile is TRUE. Works with daysAhead and minutesAhead to determine exactly when the message is sent. 0 means at the same time of day as indicated in the startDate, 1 is an hour earlier, and so on. Default: “0”. ■ Example 1: If daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent on the day and the time of the event. ■ Example 2: If startDate is noon on a particular day, daysAhead is 1, and hoursAhead is 1, any reminders are sent at 11:00 on the day before the event.
`HQvideo`	Optional. Valid values are TRUE and FALSE.	Enables high-quality video for the session. Defaults to the video options set in Site Admin “Default Scheduler Options”.
`importDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document importing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`interval`	Optional. An integer in the range 1 - 99.	The interval for a repeating calendar session, as determined by repeatType. Default: 1. daysInWeek determines which days of the week specifically the repetitions occur.
`intlLocalCallInNumber`	Required. String.	Indicates the international local call-in telephone numbers for a teleconference-only session.
`intLocalCallIn`	Optional. Valid values are TRUE and FALSE.	Allows access to Webex teleconferencing via international local call-in telephone numbers in a Webex meeting. Default: FALSE.
`intLocalNum`	Optional. String.	Returns the international local call-in telephone numbers for Webex teleconferencing in a meeting. This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
`invitation`	Optional. Maximum of 1,024 characters.	The invitation for the meeting.
`inviteMeetingURL`	Optional. String.	The URL to have an attendee directly join a meeting from a PC or mobile. Only returned for Meeting Center sessions.
`isInternal`	Optional. Valid values are TRUE and FALSE.	Sets the meeting as internal. Defaults to FALSE.
`isPublic`	Optional. Valid values are TRUE or FALSE.	Determines whether the meeting displays to public users in Today’s Meetings list. Private meetings show only to the host; invited attendees must have information from the host about how to access the meeting. Default: FALSE.
`javaClient`	Optional. Valid values are TRUE and FALSE.	If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type. If the session needs to support only the Java-based Meeting Center client, then you should specify: `<javaClient>TRUE</javaClient>` If the session needs to support both Java and native clients, then specify both: `<javaClient>FALSE</javaClient> <nativeClient>FALSE</nativeClient>`
`joinMeetingURL`	Optional. Maximum of 128 characters.	The URL for the attendee to join the meeting. Default is “”. Note: `If attendeeName is specified, joinMeetingURL takes the form of the AT=JM URL API command. Otherwise, the current join meeting URL is returned, which requires the user to enter his or her name, email and meeting password before the session starts.`
`joinNotifyURL`	Optional. String.	URL of the notification message.
`joinRequiresAccount`	Optional. Valid values are TRUE and FALSE.	Specifies that attendees must have (true) an account.
`joinStatus`	Optional. Valid values are REGISTER, ACCEPT, REJECT, and INVITE.	Indicates the join status of the meeting attendee. Default: REGISTER.
`joinTeleconfBeforeHost`	Optional. Valid values are TRUE and FALSE.	Determines whether or not attendees are allowed to join the teleconference before the host. Defaults to FALSE.
`language`	Required. String. Valid values are: ENGLISH, INTERNATIONAL ENGLISH, SIMPLIFIED CHINESE, TRADITIONAL CHINESE, JAPANESE, KOREAN, FRENCH, CANADIAN FRENCH, GERMAN, ITALIAN, CASTILIAN SPANISH, SPANISH, SWEDISH, DUTCH, and BRAZILIAN PORTUGUESE.	Language setting for the session attendee.
`lastName`	Optional. String.	The last name of the attendee.
`listing`	Optional.	Holds any control listings.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in “Specifying Boolean Relationships for Searches” on page 55. Default is AND.
`listStatus`	Optional.	Indicates which users can see this scheduled session in lists of sessions on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host. ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users.
`listToPublic`	Optional. Valid values are TRUE and FALSE.	Determines whether the meeting is listed in the Today’s Scheduled Meetings page on the Webex website. Default: FALSE. This element coexists with isPublic for backward compatibility.
`location`	Optional. Maximum of 256 characters.	Any site-defined location for the meeting.
`maximumNum`	Optional. A nonnegative integer.	Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`maxUserNumber`	Optional. Numeric.	A Webex-maintained estimated number of participants (excluding the host) that can be in the meeting at the same time. Default is 4.
`meetingKey`	Not applicable for Create and Lst. Required for all other requests. Must be non-null.	A Webex-assigned meeting-unique value that is needed to join or identify the particular meeting. A meeting may also be accessible from the Today’s Scheduled Meetings Web page. See also listToPublic.
`meetingPassword`	Optional. Maximum of 16 characters.	The password for the meeting. If a value is specified, then attendees are prompted for a password before they can join the meeting. A null password for this element is the same as not using this element. A meeting password will be validated against the password security options (if enabled) in the Site Administration tool. If any of the password security rules is violated, an exception will then occur.
`meetingPW`	Optional. Maximum of 16 characters.	The password for the meeting.
`meetingRecord`	Optional. Valid values are TRUE and FALSE.	Indicates whether recording of meetings is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`meetingType`	Optional. Integer.	The session type ID for a Meeting Center session. Note: `If meetingType is not specified when you use CreateMeeting, the system will automatically determine a proper meeting type based on the following logic:` 1`Among all the meeting types allowed for a host, choose a MC PRO based meeting type with the highest meeting type ID.` 2`If unavailable, choose a MC STD based meeting type with the highest meeting type ID.` 3`If unavailable, choose a MC FRE based meeting type with the highest meeting type ID.` 4`If none of the meeting types are available, the system throws an exception.`
`minutesAhead`	Optional.	Number of minutes ahead of the meeting to send RemindEmail or call RemindMobile when sendEmail or sendMobile is TRUE. Works with daysAhead and hoursAhead to determine exactly when the message is sent. 0 means no minutes beyond the number of hours in hoursAhead. Therefore, if daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent at the time of the event. Default: 15.
`mobile`	Optional. Maximum of 64 characters.	A mobile phone number for the system to call as a reminder before the event. User can enter pager, cell phone, etc. Format is a series of commaseparated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default: “”.
`mobilePhone`	Optional. Maximum of 64 characters.	The attendee’s mobile phone number. Format is a series of commaseparated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`monthInYear`	Optional. An integer from 1 to 12, respectively representing each month of a year.	For recurring sessions, when repeatType=MONTHLY or YEARLY, specifies the month number.
`multiVideo`	Optional. Valid values are TRUE and FALSE.	Enables Multi-point Video capability. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`name`	Required. Maximum of 64 characters.	The name of the meeting participant.
`nativeClient`	Optional. Valid values are TRUE and FALSE.	If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type. If the session needs to support only the native (Windows, Macintosh, etc.) Meeting Center client, then you should specify: `<nativeClient>TRUE</nativeClient>` If the session needs to support both Java and native clients, then specify: `<javaClient>FALSE</javaClient>` and `<nativeClient>FALSE</nativeClient>`
`notes`	Optional. Valid values are TRUE and FALSE.	Activates the session note-taking feature. If this is TRUE, then either `<closedCaptions>` or `<singleNote>` should be set to TRUE as well. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`numPhoneLines`	Optional. If populated, must be a nonzero value.	The number of phone lines to reserve, when using Webex-supplied telephony, for the meeting. By accurately forecasting this number, you enable Webex to reserve the appropriate number of phone lines for the meeting. Default: 0.
`openTime`	Optional. Integer. Valid values are 0, 560, 1060, and 15*60.	The number of seconds attendees can join a session before its scheduled start time. Specifying a value other than the four valid values may cause problems. If this is 0, then attendees can only join the session after the host has started it. Default: 0. If registration is set to TRUE, and openTime is set to a nonzero value, a validation error occurs.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy, whether to sort in ascending or descending order.
`orderBy`	Optional. Valid values are HOSTWEBEXID, CONFNAME, STARTTIME, TRACKINGCODE1..10.	Which elements to sort by in the meetings returned.
`otherHostWebexID`	Optional. Maximum of 64 characters.	In lstsummaryMeetingResponse, this designates another user that can also edit and host the meeting.
`participantFullAccessCode`	Required. String.	Indicates the access code for attendees who have full speaking privileges during a teleconference-only session.
`participantLimit`	Optional. Integer.	Maximum number of participants allowed in the meeting.
`participantLimitedAccessCode`	Required. String.	Indicates the access code for attendees who have limited speaking privileges during a teleconference-only session.
`participantsJoined`	Boolean.	If TRUE, indicates that there is at least one participant who has joined the session; otherwise, returns FALSE.
`personalAccountIndex`	Optional. Integer.	The index number of the personal teleconference account to be used; if not specified, then personal teleconferencing is not used.
`personalConferenceNumber`	Required. Valid values are TRUE and FALSE.	Indicates whether this is a personal conference number or request conference number. Default is FALSE.
`phone`	Optional. Maximum of 64 characters.	The attendee’s phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`phoneNumber`	Optional. String.	Holds the phone number.
`pointer`	Optional. Valid values are TRUE and FALSE.	Indicates whether a screen pointer is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`poll`	Optional. Valid values are TRUE and FALSE.	Indicates whether survey polling is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`presentation`	Optional. Valid values are TRUE and FALSE.	Indicates whether whiteboard, presentation and document sharing are supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`printDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document printing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`rcAppShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote application sharing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`rcDesktopShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote desktop sharing is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`rcWebTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote Web touring is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`RegID`	Optional. String.	The registration ID of the attendee.
`registerMeetingURL`	Optional. String.	The URL used by an attendee to register for a meeting from a PC or mobile device.
`registration`	Optional. Valid values are TRUE and FALSE.	Whether attendees must register to attend the meeting. Default: FALSE. See also attendeeOptions.
`repeatType`	Optional. Valid values are DAILY, WEEKLY, NO_REPEAT, MONTHLY, YEARLY and CONSTANT.	Determines whether the meeting repeats and at what interval. Works together with Interval to determine the exact number of days or weeks apart the repetitions occur. Default: NO_REPEAT. Meanings are: ■ DAILY: The event occurs every day of the week. ■ WEEKLY: The meeting recurs every week. Also see dayInWeek for which days. ■ NO_REPEAT: The meeting does not recur. ■ MONTHLY: The meeting recurs every month. Also see dayInMonth. ■ YEARLY: The meeting recurs every year. Also see monthInYear. ■ CONSTANT: The meeting has no fixed date or time so it that it always appears in the My Meetings list, even after it has occurred one or more times, but not in the Meeting Calendar (except for the originally scheduled date and time). A user can start another occurrence of this meeting at any time.
`request`	Optional. Valid values are TRUE and FALSE.	Request detailed attendee information. Default: FALSE. See also attendeeOptions.
`requestConferenceNumber`	Optional. Boolean.	Request the number of the conference.
`requireAccount`	Optional. Boolean.	Determines if a valid account is required.
`requireUcfDiagnosis`	Optional. Boolean.	Determines if a UCF diagnosis is required.
`returned`	Required if matchingRecords is specified. Integer.	The number of records returned in the response.
`role`	Optional. Enumerated string. Valid values are ATTENDEE, PRESENTER and HOST.	The role of the session attendee. The default is ATTENDEE. Note: `By setting role to HOST, you specify an attendee as an alternate host in a Meeting Center session.` `If the site does not enable alternate host functionality, an exception is thrown.`
`saveDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document saving is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`scheduleConfID`	Required. Integer.	Indicates the unique identifier of a scheduled teleconference-only session.
`sendEmail`	Optional. Valid values are TRUE and FALSE.	Indicates whether to send email as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to send the email. If TRUE, the system sends a reminder email to the email address listed in RemindEmail. The default is FALSE.
`sendFeedback`	Optional. Valid values are TRUE and FALSE.	If TRUE, sends the feedback form responses to the host’s email. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`sendMobile`	Optional. Valid values are TRUE and FALSE.	Indicates whether to call RemindMobile as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to call the mobile number. If TRUE, the system calls the number in RemindMobile. The default is FALSE.
`sessionKey`	Not applicable for Create and Lst. Required for all other requests. Must be non-null.	A Webex-assigned meeting-unique value that is needed to join or identify the particular meeting. A meeting may also be accessible from the Today’s Scheduled Meetings Web page. See also listToPublic.
`sessionPassword`	Optional. Maximum of 16 characters.	The password for a teleconferenceonly meeting. A session password will be validated against the password security options (if enabled) in the Site Administration tool. If the password security rules are violated, an exception occurs.
`sessionType`	Optional. Integer.	The session type ID for a teleconference-only session. If sessionType is not specified when you use CreateTeleconferenceSession, the system will choose an AUO based session type with the highest session type ID.
`setNonMTOptions`	Optional. Boolean.	Activates the non MT Options.
`showFileContPlayFlag`	Optional. Valid values are TRUE and FALSE.	If TRUE, continuously plays the presentation specified in showFilePath.
`showFileInterval`	Optional. Integer.	Designates the number of seconds to wait in between each page of the automatically played document.
`showFilePath`	Optional. String.	Full file path of the document that shows automatically when participant joins the meeting.
`showFileStartMode`	Optional. Valid values are TRUE and FALSE.	If showFilePath is specified, then the meaning is: ■ TRUE: Automatically starts showing the document. ■ FALSE: Allows the participant to control the file.
`singleNote`	Optional. Valid values are TRUE and FALSE.	Enables the Single Note Taker functionality. A FALSE value enables the “Allow all participants to take notes” option on the webpage. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`startDate`	Required for Create. Optional for Lst and Set. Not applicable for all other actions.	The starting date and time for the first (or only) occurrence of the meeting. Formatted as MM/DD/YYYY HH:MM:SS. Default is current time. Note: `If an empty element is specified, for example, <startDate/>, then the current time of the XML server is used as the default starting time of the meeting.`
`startDateEnd`	Optional.	End of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateStart`	Optional.	Beginning of range of dates from which a user can select for the start date for a meeting. Formatted as MM/DD/YYYY HH:MM:SS.
`startFrom`	Optional. Integer.	Works with maximumNum to limit the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`startFrom` (in matchingRecords element)	Required. Integer.	Record index number that the returned set starts from.
`state`	Optional. Maximum of 32 characters.	The attendee’s state of residence. Default is “”.
`status`	Optional. Valid values are INPROGRESS or NOT_INPROGRESS.	Indicates whether the meeting is either started and active or not active. Its value is generated by Webex and cannot be changed. Default: NOT_INPROGRESS.
`subscriberAccessCode`	Required. String.	Indicates the access code for a teleconference-only service subscriber.
`supportBreakoutSessions`	Optional. Valid values are TRUE and FALSE.	DEPRECATED. Breakout sessions are enabled per Session Type, not at the individual session level.
`supportFeedback`	Optional. Valid values are TRUE and FALSE.	Determines whether or not the Feedback form will be displayed after the session ends. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`supportPanelists`	Optional. Valid values are TRUE and FALSE.	For Meeting Center only. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`supportQandA`	Optional. Valid values are TRUE and FALSE.	DEPRECATED. Q and A sessions are enabled per Session Type, not at the individual session level.
`supportRemoteComputer`	Optional. Valid values are TRUE and FALSE.	Determines whether or not sharing a remote computer is enabled. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`supportShareWebContent`	Optional. Valid values are TRUE and FALSE.	Determines whether or not sharing Web Content is enabled. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`supportUCFRichMedia`	Optional. Valid values are TRUE and FALSE.	Enables UCF support for audio, video and Flash files. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`supportUCFWebPages`	Optional. Valid values are TRUE and FALSE.	Enables UCF support for standard Web pages. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`switchPage`	Optional. Valid values are TRUE and FALSE.	Indicates whether page switching is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`teleconfLocation`	Optional. String.	Holds information about teleconferencing country location.
`telephonySupport`	Optional. Valid values are NONE, CALLIN, CALLBACK, and OTHER.	Indicates whether telephony is supported and, if so, in what mode. Default: NONE. Meanings are: ■ NONE: The session does not support telephony; for all other values, telephony is supported. ■ CALLIN: Call-in teleconference (attendees call in to join the meeting or session). ■ CALLBACK: Call-back teleconference (attendees receive a callback to join the meeting or session). ■ OTHER: Other teleconferencing service; in this case, you can describe the service using extTelephonyDescription.
`templateFilePath`	Optional. String.	File path of the document that appears on the Info tab.
`thumbnail`	Optional. Valid values are TRUE and FALSE.	Indicates whether thumbnail is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`timeZone`	Optional. If specified, must be a value from among those listed in Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the meeting. Default is “GMT-08:00, Pacific Time (San Jose)”.
`timeZoneID`	Optional. An integer ranging from 0 to 61. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the meeting.
`title`	Optional. Maximum of 128 characters.	The attendee’s title. Default is “”.
`tollCallInNumber`	Required. String.	Indicates the toll call-in telephone number for a teleconference-only session.
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in numbers are enabled.
`tollFreeCallInNumber`	Required. String.	Indicates the toll-free call-in telephone number for a teleconference-only session.
`tollFreeNum`	Optional. String.	Returns the toll-free call-in number for Webex teleconferencing in a Webex meeting. This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
`tollNum`	Required if callInNum is specified. String.	Returns the toll call-in number for a Webex integrated teleconference. This element is only returned in GetMeeting and its value is ignored in Create/SetMeeting.
`total`	Required if matchingRecords is specified. Integer.	Total number of records matching the query request.
`trackingCode1..10`	Optional. Maximum of 128 characters.	Ten text elements that you can use for any information about a meeting, such as project names, departments, or anything else of your choice. Note: `Validation of the tracking code template will be added in future release. If your tracking code has customized templates, please consult your site administrator about relevant tracking code values before specifying them.`
`tspAccessCodeOrder`	Optional.	Determines in which order access codes should be used.
`tspAccountIndex`	Optional. An integer ranging from 1 to 3.	Specifies which of the user's TSP Accounts to use for teleconferencing. The TSP accounts are defined in CreateUser/tspAccount. Note: `This element follows the following logic:` `■ If the specified value is outside the valid range, a validation error occurs.` `■ If the specified value is within the valid range, then the system checks the TSP setting of the host and decides which TSP account to use.` `■ If no value is specified, then the default TSP account of the host is used.`
`type`	Optional. Valid values are MEMBER and VISITOR.	The Webex-maintained determination of whether the meeting participant represented by a service of this type is a member (registered on your Webex XML server as a user) or a visitor. Default: VISITOR.
`url`	Optional. Maximum of 128 characters.	The attendee’s URL, such as the URL of the attendee’s office. Default is “”.
`use`	Optional. String.	Indicates the name of the session template whose settings are used for meeting scheduling options.
`viewAnyDoc`	Optional. Valid values are TRUE and FALSE.	Allows attendees to view any document. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`viewAnyPage`	Optional. Valid values are TRUE and FALSE.	Allows attendees to view any page of the document. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`voip`	Optional. Valid values are TRUE and FALSE.	Indicates whether voice communications over the Internet (VoIP) is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`webExID`	Optional. String. Maximum of 64 characters.	A reference to the Webex user account for the meeting participant. Empty if the attendee is a VISITOR.
`webTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether web tour is supported for meeting of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`weekInMonth`	Integer. Valid values are 1 to 5.	The week number in a month.
`zipCode`	Optional. Maximum of 16 characters.	The ZIP Code portion of the attendee’s address. Default is “”.
`zoom`	Optional. Valid values are TRUE and FALSE.	Indicates whether zooming is supported for meetings of this type. If this element is unspecified, its value will default to the session template specified in: Template Name If a template name is not specified, setting: true will use the default template for the Meeting Type.

Complex Types Used By The Meeting Service

The following diagrams show the complex types used by the Meeting Service.

Training Session Service

Training Center is a Webex service that provides a virtual classroom environment. This chapter describes APIs that can be used to automate the management of Training Center sessions.

Table 6-1 • Webex XML Messages Requesting Training Session-related Operations

*XML Request Message*	*Description*
`AddScheduledTest`	Add a Library Test to a Training Session.
`CheckLabAvailability`	Checks Availability of Lab Computers.
`CopyLibTests`	Copy Tests between Private and Shared Libraries.
`CreateTrainingSession`	Creates Training Session.
`DelLibTests`	Deletes Tests from Library.
`DelScheduledTest`	Deletes a Test from a Training Session.
`DelTrainingSession`	Deletes Training Session.
`GetIMStestDetails`	Gets IMS Test Details.
`GetIMStestResult`	Gets IMS Test Result.
`GetLabInfo`	Gets Information of Hands-on Lab.
`GetLabSchedule`	Gets Reservation Schedule of Hands-on Lab.
`GetTestInformation`	Gets Test Information.
`GetTrainingSession`	Gets Training Session.
`LstLibTests`	Lists All Private and Shared Tests.
`LstScheduledTests`	Lists Scheduled Tests.
`LstsummaryTrainingSession`	Lists Training Session Summary Information.
`LstTrainingSession` (deprecated)	Lists Training Session.
`ReserveLab`	Reserves Hands-on Lab Computers
`SetScheduledTest`	Edits a Training Session Test.
`SetTrainingSession`	Sets Training Session.
`UploadIMStest`	Uploads IMS Tests.

You can schedule recurring training sessions using XML API. For details on the available recurrence options, see “Recurring Session Options”.

AddScheduledTest

Adds a library test to a Training Session.

Request

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

Figure 6-1 • Schema diagram for `addScheduledTest`

The sample XML document adds the test with ID value of 102 to Training Session 12345678.

<?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>ad
            <partnerID>9999</partnerID>
            <email>johnsmith@xyz.com</email>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type=
            "java:com.webex.service.binding.training.AddScheduledTest">
            <testID>102</testID>
            <sessionKey>12345678</sessionKey>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-2 • Schema diagram for `addScheduledTestResponse`**

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:AddScheduledTestResponse"
            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”.

CheckLabAvailability

Allows you to check the availability of a Hands-on Lab and its computers for a certain period of time, so that you can reserve appropriate number of lab computers for your training session.

Request

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

Figure 6-3 • Schema diagram for `checkLabAvailability`

The sample XML document retrieves the availability information of a Hands-on Lab named “bill's lab for xml”. Be sure to provide a valid value for the Hands-on Lab of your website.

<?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.CheckLabAvailability">
            <labName>bill's lab for xml</labName>
            <numComputers>1</numComputers>
            <sessionStartTime>09/26/2003 08:00:00</sessionStartTime>
            <sessionEndTime>09/26/2004 16:00:00</sessionEndTime>
            <timeZoneID>45</timeZoneID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-4 • Schema diagram for `checkLabAvailabilityResponse`

XSD Diagram of checkLabAvailabilityResponse

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:checkLabAvailabilityResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:availabilityLabs>
                <train:labName>bill's lab for xml</train:labName>
                <train:timeZoneID>45</train:timeZoneID>
                <train:sessionStartTime>09/26/2010 08:00:00
                </train:sessionStartTime>
                <train:sessionEndTime>09/26/2010 10:00:00</train:sessionEndTime>
                <train:numComputers>1</train:numComputers>
                <train:status>AVAILABLE</train:status>
            </train:availabilityLabs>
            <train:availabilityLabs>
                <train:labName>bill's lab for xml</train:labName>
                <train:timeZoneID>45</train:timeZoneID>
                <train:sessionStartTime>09/26/2010 10:30:00
                </train:sessionStartTime>
                <train:sessionEndTime>09/26/2010 16:00:00</train:sessionEndTime>
                <train:numComputers>1</train:numComputers>
                <train:status>AVAILABLE</train:status>
            </train:availabilityLabs>
        </serv:bodyContent>
    </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.

CopyLibTests

Allows users to copy tests between their private and shared libraries.

Request

The sample XML shows an example of a request to copy the test with testID value of 102 from the user’s shared library to their PRIVATE library.

<?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.CopyLibTests">
            <testID>102</testID>
            <copyToType>PRIVATE</copyToType>
        </bodyContent>
    </body>
</serv:message>

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

Figure 6-5 • Schema diagram for copyLibTests

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, refer to “Elements in Webex XML Schema Definitions for the Training Session 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: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:CopyLibTestsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:testID>2105</train:testID>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-6 • Schema diagram for `copyLibTestsResponse`

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.

CreateTrainingSession

Allows training session hosts to schedule a new training session. CreateTrainingSession returns a unique training session key. This API 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 older integrations that have attendee email in mixed case.

Request

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

CreateTrainingSession supports Join Before Host Telephony for TSP sessions.
Set <role>=HOST to add the user as an alternate host.

The sample XML document creates a training session with the corresponding information specified.

<?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.CreateTrainingSession">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>111111</sessionPassword>
            </accessControl>
            <schedule>
                <startDate>4/05/2004 10:00:00</startDate>
                <timeZone>GMT-12:00, Dateline (Eniwetok)</timeZone>
                <duration>60</duration>
                <timeZoneID>46</timeZoneID>
                <openTime>20</openTime>
            </schedule>
            <metaData>
                <confName>jimz hol test</confName>
                <agenda>agenda 1</agenda>
                <description>description</description>
                <greeting>greeting</greeting>
                <location>location</location>
                <invitation>invitation</invitation>
            </metaData>
            <enableOptions>
                <attendeeList>false</attendeeList>
                <javaClient>false</javaClient>
                <nativeClient>true</nativeClient>
                <chat>false</chat>
                <poll>false</poll>
                <audioVideo>false</audioVideo>
                <fileShare>false</fileShare>
                <presentation>false</presentation>
                <applicationShare>false</applicationShare>
                <desktopShare>false</desktopShare>
                <webTour>false</webTour>
                <trainingSessionRecord>false</trainingSessionRecord>
                <annotation>false</annotation>
                <importDocument>false</importDocument>
                <saveDocument>false</saveDocument>
                <printDocument>false</printDocument>
                <pointer>false</pointer>
                <switchPage>false</switchPage>
                <fullScreen>false</fullScreen>
                <thumbnail>false</thumbnail>
                <zoom>false</zoom>
                <copyPage>false</copyPage>
                <rcAppShare>false</rcAppShare>
                <rcDesktopShare>false</rcDesktopShare>
                <rcWebTour>false</rcWebTour>
                <attendeeRecordTrainingSession>false
                </attendeeRecordTrainingSession>
                <voip>false</voip>
                <faxIntoTrainingSession>false</faxIntoTrainingSession>
                <autoDeleteAfterMeetingEnd>true</autoDeleteAfterMeetingEnd>
            </enableOptions>
            <telephony>
                <telephonySupport>NONE</telephonySupport>
                <numPhoneLines>4</numPhoneLines>
                <extTelephonyURL>String</extTelephonyURL>
                <extTelephonyDescription>String</extTelephonyDescription>
                <enableTSP>false</enableTSP>
                <tspAccountIndex>1</tspAccountIndex>
            </telephony>
            <tracking>
                <trackingCode1>trackingCode1</trackingCode1>
                <trackingCode2>trackingCode2</trackingCode2>
                <trackingCode3>trackingCode3</trackingCode3>
                <trackingCode4>trackingCode4</trackingCode4>
                <trackingCode5>trackingCode5</trackingCode5>
                <trackingCode6>trackingCode6</trackingCode6>
                <trackingCode7>trackingCode7</trackingCode7>
                <trackingCode8>trackingCode8</trackingCode8>
                <trackingCode9>trackingCode9</trackingCode9>
                <trackingCode10>trackingCode10</trackingCode10>
            </tracking>
            <repeat>
                <repeatType>RECURRING_SINGLE</repeatType>
                <dayInWeek>
                    <day>SUNDAY</day>
                </dayInWeek>
                <endAfter>5</endAfter>
                <occurenceType>WEEKLY</occurenceType>
                <interval>5</interval>
                <dayInMonth>1</dayInMonth>
                <weekInMonth>1</weekInMonth>
                <monthInYear>1</monthInYear>
                <dayInYear>1</dayInYear>
            </repeat>
            <remind>
                <enableReminder>true</enableReminder>
                <emails>
                    <email>String</email>
                </emails>
                <sendEmail>false</sendEmail>
                <mobile>String</mobile>
                <sendMobile>false</sendMobile>
                <daysAhead>1</daysAhead>
                <hoursAhead>1</hoursAhead>
                <minutesAhead>1</minutesAhead>
            </remind>
            <presenters>
                <participants>
                    <participant>
                        <person>
                            <name>alternatehost1</name>
                            <email>host1@test.com</email>
                            <type>MEMBER</type>
                        </person>
                        <role>HOST</role>
                    </participant>
                </participants>
            </presenters>
            <attendees>
                <participants>
                    <participant>
                        <person>
                            <name>alternatehost3</name>
                            <email>host3@test.com</email>
                            <type>MEMBER</type>
                        </person>
                        <role>HOST</role>
                    </participant>
                </participants>
            </attendees>
            <attendeeOptions>
                <request>true</request>
                <registration>true</registration>
                <auto>true</auto>
                <registrationPWD>pass</registrationPWD>
                <maxRegistrations>10</maxRegistrations>
                <registrationCloseDate>04/10/2004 00:00:00
                </registrationCloseDate>
                <emailInvitations>true</emailInvitations>
            </attendeeOptions>
        </bodyContent>
    </body>
</serv:message>

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

Figure 6-7 • Schema diagram for `createTrainingSession`

Response

The sample XML document shows 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:createTrainingSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:sessionkey>807643542</train:sessionkey>
            <train:additionalInfo>
                <train:sessionkey>807643542</train:sessionkey>
                <train:guestToken>514d8fd53f1ce7d22107bbc25e586fc1
                </train:guestToken>
            </train:additionalInfo>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-8 • Schema diagram for `createTrainingSessionResponse`

XSD Diagram of createTrainingSessionResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

DelLibTests

Deletes the specified test and all associated information from a test library. DelLibTests can delete other host’s shared tests; however, only a host can delete their own private tests.

Request

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

Figure 6-9 • Schema diagram for `delLibTests`

The sample XML document deletes the test with ID 123 from the user’s library.

<?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.DelLibTests">
            <testID>123</testID>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see “Elements in Webex XML Schema Definitions for the Training Session Service”.

Response

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

Figure 6-10 • Schema diagram for `delLibTestsResponse`

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:DelLibTestsResponse"
            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 Elements in Webex XML Schema Definitions for the Training Session Service.

DelScheduledTest

Deletes a scheduled library test from a Training Session.

Request

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

Figure 6-11 • Schema diagram for `delScheduledTest`

The sample XML document removes the test with ID 102 from Training Session 12345678.

<?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.DelScheduledTest">
            <sessionKey>12345678</sessionKey>
            <testID>102</testID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-12 • Schema diagram for `delScheduledTestResponse`

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:DelScheduledTestResponse"
            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.

DelTrainingSession

Allows training session hosts to delete their own previously scheduled training sessions.

Request

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

Figure 6-13 • Schema diagram for `delTrainingSession`

The sample XML document deletes a training session with the sessionKey of 101072918.

<?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.DelTrainingSession">
            <sessionKey>101072918</sessionKey>
        </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 delTrainingSessionResponse message.

Figure 6-14 • Schema diagram for `delTrainingSessionResponse`

XSD Diagram of delTrainingSessionResponse

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:DelTrainingSessionResponse"
            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. See Global Response Elements Showing Results and Errors.

GetIMStestDetails

Returns detailed question information for a single test in a format compatible with the IMS Question and Test Interoperability (QTI) ASI Specification Version 1.2. For the IMS QTI ASI specification and samples, refer to:

http://www.imsglobal.org/question/qtiv1p2/imsqti_asi_bindv1p2.html (spec)

http://www.imsglobal.org/question/qtiv1p2/imsqti_asi_bestv1p2.html (samples)

Request

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

Figure 6-15 • Schema diagram for `getIMStestDetails`

The sample XML document retrieves the detailed question structures of the test with testID of 102.

<?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.GetIMStestDetails">
            <testID>102</testID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Note The question structures are returned in IMS QTI result reporting format. For more information about the format, please go to http://www.imsglobal.org.

Figure 6-16 • Schema diagram for `getIMStestDetailsResponse`

XSD Diagram of getIMStestDetailsResponse

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:getIMStestDetailsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:questestinterop>
                <qtiasi:assessment ident="26007" title="Webex employee test(2)">
                    <qtiasi:qticomment>To the webex employee test.
                    </qtiasi:qticomment>
                    <qtiasi:duration>P0Y0M0DT0H30M</qtiasi:duration>
                        <qtiasi:section ident="IMS_V01_Webex employee test (2)000">
                            <qtiasi:item ident="IMS_V01_Webex employee test (2)0">
                                <qtiasi:presentation>
                                    <qtiasi:flow>
                                        <qtiasi:material>
                                            <qtiasi:mattext>How does Oracle guarantee data
                                                integrity of data changes? &#xd;
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                        <qtiasi:response_str ident="10177"
                                            rcardinality="Single">
                                            <qtiasi:render_fib fibtype="String" prompt="Box"
                                                maxchars="200">
                                                <qtiasi:response_label ident="0" />
                                            </qtiasi:render_fib>
                                        </qtiasi:response_str>
                                    </qtiasi:flow>
                                </qtiasi:presentation>
                            </qtiasi:item>
                            <qtiasi:item ident="IMS_V01_Webex employee test (2)1">
                                <qtiasi:presentation>
                                    <qtiasi:flow>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Physical Disk Resources in an
                                                Oracle Database are: &#xd;</qtiasi:mattext>
                                        </qtiasi:material>
                                        <qtiasi:response_lid ident="10182"
                                            rcardinality="Single">
                                            <qtiasi:render_choice>
                                                <qtiasi:response_label ident="22972">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>Control Files
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="22977">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>Redo Log Files
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="22982">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>Data Files
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="22987">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>All of the above
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                            </qtiasi:render_choice>
                                        </qtiasi:response_lid>
                                    </qtiasi:flow>
                                </qtiasi:presentation>
                                <qtiasi:resprocessing>
                                    <qtiasi:outcomes>
                                        <qtiasi:decvar vartype="Integer" minvalue="0"
                                            maxvalue="20" />
                                        <qtiasi:interpretvar>
                                            <qtiasi:material>
                                                <qtiasi:mattext>20 points if answer is correct
                                                </qtiasi:mattext>
                                            </qtiasi:material>
                                        </qtiasi:interpretvar>
                                    </qtiasi:outcomes>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:varequal respident="10182">22987
                                            </qtiasi:varequal>
                                        </qtiasi:conditionvar>
                                        <qtiasi:setvar action="Set">1</qtiasi:setvar>
                                            <qtiasi:displayfeedback feedbacktype="Response"
                                                linkrefid="Correct" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:resprocessing>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:not>
                                                <qtiasi:and>
                                                    <qtiasi:varequal respident="10182">22987
                                                    </qtiasi:varequal>
                                                </qtiasi:and>
                                            </qtiasi:not>
                                        </qtiasi:conditionvar>
                                        <qtiasi:displayfeedback feedbacktype="Response"
                                            linkrefid="Incorrect" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:itemfeedback ident="Correct" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Yes, you are correct.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                                <qtiasi:itemfeedback ident="Incorrect" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>No, you are incorrect.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                            </qtiasi:item>
                            <qtiasi:item ident="IMS_V01_Webex employee test (2)2">
                                <qtiasi:presentation>
                                    <qtiasi:flow>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Which of the following is a valid
                                                background server processes in
                                                Oracle?</qtiasi:mattext>
                                        </qtiasi:material>
                                        <qtiasi:response_lid ident="10187"
                                            rcardinality="Multiple">
                                            <qtiasi:render_choice minnumber="1"
                                                maxnumber="3">
                                                <qtiasi:response_label ident="22992">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>ARCHiver
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="22997">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>LGWR ( Log Writer )
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="23002">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>DBWR ( Dbwriter )
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="23007">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>DB Reader
                                                            </qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                            </qtiasi:render_choice>
                                        </qtiasi:response_lid>
                                    </qtiasi:flow>
                                </qtiasi:presentation>
                                <qtiasi:resprocessing>
                                    <qtiasi:outcomes>
                                        <qtiasi:decvar vartype="Integer" minvalue="0"
                                            maxvalue="20" />
                                        <qtiasi:interpretvar>
                                            <qtiasi:material>
                                                <qtiasi:mattext>20 points if answer is correct
                                                </qtiasi:mattext>
                                            </qtiasi:material>
                                        </qtiasi:interpretvar>
                                    </qtiasi:outcomes>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:varequal respident="10187">22992
                                            </qtiasi:varequal>
                                            <qtiasi:varequal respident="10187">22997
                                            </qtiasi:varequal>
                                            <qtiasi:varequal respident="10187">23002
                                            </qtiasi:varequal>
                                            <qtiasi:not>
                                                <qtiasi:varequal respident="10187">23007
                                                </qtiasi:varequal>
                                            </qtiasi:not>
                                        </qtiasi:conditionvar>
                                        <qtiasi:setvar action="Set">1</qtiasi:setvar>
                                        <qtiasi:displayfeedback feedbacktype="Response"
                                            linkrefid="Correct" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:resprocessing>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:not>
                                                <qtiasi:and>
                                                    <qtiasi:varequal respident="10187">22992
                                                    </qtiasi:varequal>
                                                    <qtiasi:varequal respident="10187">22997
                                                    </qtiasi:varequal>
                                                    <qtiasi:varequal respident="10187">23002
                                                    </qtiasi:varequal>
                                                    <qtiasi:not>
                                                        <qtiasi:varequal respident="10187">23007
                                                        </qtiasi:varequal>
                                                    </qtiasi:not>
                                                </qtiasi:and>
                                            </qtiasi:not>
                                        </qtiasi:conditionvar>
                                        <qtiasi:displayfeedback feedbacktype="Response"
                                            linkrefid="Incorrect" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:itemfeedback ident="Correct" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Yes, you are correct.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                                <qtiasi:itemfeedback ident="Incorrect" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>No, you are incorrect.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                            </qtiasi:item>
                            <qtiasi:item ident="IMS_V01_Webex employee test(2)3">
                                <qtiasi:presentation>
                                    <qtiasi:flow>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Oracle does not consider a
                                                transaction committed until the LGWR
                                                successfully writes the changes to
                                                redo?</qtiasi:mattext>
                                        </qtiasi:material>
                                        <qtiasi:response_lid ident="10192"
                                            rcardinality="Single">
                                            <qtiasi:render_choice>
                                                <qtiasi:response_label ident="23012">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>True</qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                                <qtiasi:response_label ident="23017">
                                                    <qtiasi:flow_mat>
                                                        <qtiasi:material>
                                                            <qtiasi:mattext>False</qtiasi:mattext>
                                                        </qtiasi:material>
                                                    </qtiasi:flow_mat>
                                                </qtiasi:response_label>
                                            </qtiasi:render_choice>
                                        </qtiasi:response_lid>
                                    </qtiasi:flow>
                                </qtiasi:presentation>
                                <qtiasi:resprocessing>
                                    <qtiasi:outcomes>
                                        <qtiasi:decvar vartype="Integer" minvalue="0"
                                            maxvalue="20" />
                                        <qtiasi:interpretvar>
                                            <qtiasi:material>
                                                <qtiasi:mattext>20 points if answer is correct
                                                </qtiasi:mattext>
                                            </qtiasi:material>
                                        </qtiasi:interpretvar>
                                    </qtiasi:outcomes>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:varequal respident="10192">23012
                                            </qtiasi:varequal>
                                        </qtiasi:conditionvar>
                                        <qtiasi:setvar action="Set">1</qtiasi:setvar>
                                        <qtiasi:displayfeedback feedbacktype="Response"
                                            linkrefid="Correct" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:resprocessing>
                                    <qtiasi:respcondition>
                                        <qtiasi:conditionvar>
                                            <qtiasi:not>
                                                <qtiasi:and>
                                                    <qtiasi:varequal respident="10192">23012
                                                    </qtiasi:varequal>
                                                </qtiasi:and>
                                            </qtiasi:not>
                                        </qtiasi:conditionvar>
                                        <qtiasi:displayfeedback feedbacktype="Response"
                                            linkrefid="Incorrect" />
                                    </qtiasi:respcondition>
                                </qtiasi:resprocessing>
                                <qtiasi:itemfeedback ident="Correct" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>Yes, you are correct.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                                <qtiasi:itemfeedback ident="Incorrect" view="All">
                                    <qtiasi:flow_mat>
                                        <qtiasi:material>
                                            <qtiasi:mattext>No, you are incorrect.
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:flow_mat>
                                </qtiasi:itemfeedback>
                            </qtiasi:item>
                            <qtiasi:item ident="IMS_V01_Webex employee test (2)4">
                                <qtiasi:presentation>
                                    <qtiasi:flow>
                                        <qtiasi:material>
                                            <qtiasi:mattext>The process that performs
                                                internal operations like Tablespace Coalescing
                                                is</qtiasi:mattext>
                                        </qtiasi:material>
                                        <qtiasi:response_str ident="10197_0"
                                            rcardinality="Single">
                                            <qtiasi:render_fib fibtype="String" prompt="Box"
                                                maxchars="0">
                                                <qtiasi:response_label ident="0" />
                                            </qtiasi:render_fib>
                                        </qtiasi:response_str>
                                    </qtiasi:flow>
                                </qtiasi:presentation>
                                <qtiasi:resprocessing>
                                    <qtiasi:outcomes>
                                        <qtiasi:decvar vartype="Integer" minvalue="0"
                                            maxvalue="20" />
                                    <qtiasi:interpretvar>
                                        <qtiasi:material>
                                            <qtiasi:mattext>20 points per correct answer
                                            </qtiasi:mattext>
                                        </qtiasi:material>
                                    </qtiasi:interpretvar>
                                </qtiasi:outcomes>
                                <qtiasi:respcondition>
                                    <qtiasi:conditionvar>
                                        <qtiasi:varequal respident="10197_0">SMON
                                        </qtiasi:varequal>
                                    </qtiasi:conditionvar>
                                    <qtiasi:setvar action="Add">1</qtiasi:setvar>
                                    <qtiasi:displayfeedback feedbacktype="Response"
                                        linkrefid="Correct" />
                                </qtiasi:respcondition>
                            </qtiasi:resprocessing>
                            <qtiasi:resprocessing>
                                <qtiasi:respcondition>
                                    <qtiasi:conditionvar>
                                        <qtiasi:not>
                                            <qtiasi:and>
                                                <qtiasi:varequal respident="10197_0">SMON
                                                </qtiasi:varequal>
                                            </qtiasi:and>
                                        </qtiasi:not>
                                    </qtiasi:conditionvar>
                                    <qtiasi:displayfeedback feedbacktype="Response"
                                        linkrefid="Incorrect" />
                                </qtiasi:respcondition>
                            </qtiasi:resprocessing>
                            <qtiasi:itemfeedback ident="Correct" view="All">
                                <qtiasi:flow_mat>
                                    <qtiasi:material>
                                        <qtiasi:mattext>Yes, you are correct.
                                        </qtiasi:mattext>
                                    </qtiasi:material>
                                </qtiasi:flow_mat>
                            </qtiasi:itemfeedback>
                            <qtiasi:itemfeedback ident="Incorrect" view="All">
                                <qtiasi:flow_mat>
                                    <qtiasi:material>
                                        <qtiasi:mattext>No, you are incorrect.
                                        </qtiasi:mattext>
                                    </qtiasi:material>
                                </qtiasi:flow_mat>
                            </qtiasi:itemfeedback>
                        </qtiasi:item>
                    </qtiasi:section>
                </qtiasi:assessment>
            </train:questestinterop>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetIMStestResult

Returns one participant's detailed test results in a format compatible with the IMS Question and Test Interoperability (QTI) Results Reporting Specification Version 1.2. For the IMS QTI specification and samples, refer to:

http://www.imsglobal.org/question/qtiv1p2/imsqti_res_bindv1p2.html (spec)

http://www.imsglobal.org/question/qtiv1p2/imsqti_res_bestv1p2.html (samples)

Request

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

Figure 6-17 • Schema diagram for `getIMStestResult`

The sample XML document retrieves the detailed test result of the participant whose email address is amyl@sz.webex.com for the test with testID of 102.

<?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.GetIMStestResult">
            <testID>102</testID>
            <participantEmail>amyl@sz.webex.com</participantEmail>
        </bodyContent>
    </body>
</serv:message>

Response

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

Note The test result is returned in IMS QTI result reporting format. For more information about the format, go to http://www.imsglobal.org.

The sample XML document shown is 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:GetIMStestResultResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:qti_result_report>
                <qti:result>
                    <qti:context>
                        <qti:name>java java</qti:name>
                        <qti:generic_identifier>
                            <qti:type_label>Participant Email</qti:type_label>
                            <qti:identifier_string>georgew@sz.webex.com
                            </qti:identifier_string>
                        </qti:generic_identifier>
                    </qti:context>
                    <qti:assessment_result asi_title="Test1 (3)" ident_ref="207">
                        <qti:asi_description>basic ability test
                        </qti:asi_description>
                        <qti:date>
                            <qti:type_label>Start Time</qti:type_label>
                            <qti:datetime>2003-12-12T16:17:11</qti:datetime>
                        </qti:date>
                        <qti:duration>P0Y0M0DT0H30M</qti:duration>
                        <qti:outcomes>
                            <qti:score varname="SCORE" vartype="Integer">
                                <qti:score_value>45</qti:score_value>
                                <qti:score_min>0</qti:score_min>
                                <qti:score_max>100</qti:score_max>
                            </qti:score>
                            <qti:grade varname="GRADE" members="">
                                <qti:grade_value />
                            </qti:grade>
                        </qti:outcomes>
                        <qti:num_sections>6</qti:num_sections>
                        <qti:section_result>
                            <qti:item_result>
                                <qti:response ident_ref="237">
                                    <qti:response_form cardinality="single"
                                        response_type="lid" render_type="choice">
                                        <qti:correct_response>357</qti:correct_response>
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">357
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>15</qti:score_value>
                                        <qti:score_interpretation>
                                            15 points if answer is correct
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>15</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                                <qti:feedback_displayed ident="Correct">Response
                                </qti:feedback_displayed>
                            </qti:item_result>
                            <qti:item_result>
                                <qti:response ident_ref="242">
                                    <qti:response_form cardinality="single"
                                        response_type="lid" render_type="choice">
                                        <qti:correct_response>372</qti:correct_response>
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">372
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>15</qti:score_value>
                                        <qti:score_interpretation>
                                            15 points if answer is correct
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>15</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                                <qti:feedback_displayed ident="Correct">Response
                                </qti:feedback_displayed>
                            </qti:item_result>
                            <qti:item_result>
                                <qti:response ident_ref="247">
                                    <qti:response_form cardinality="multiple"
                                        response_type="lid" render_type="choice">
                                        <qti:correct_response>377</qti:correct_response>
                                        <qti:correct_response>382</qti:correct_response>
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">382
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>0</qti:score_value>
                                        <qti:score_interpretation>
                                            20 points if answer is correct
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>20</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                                <qti:feedback_displayed ident="Incorrect">Response
                                </qti:feedback_displayed>
                            </qti:item_result>
                            <qti:item_result>
                                <qti:response ident_ref="252">
                                    <qti:response_form cardinality="single"
                                        response_type="lid" render_type="choice">
                                        <qti:correct_response>402</qti:correct_response>
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">392
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>0</qti:score_value>
                                        <qti:score_interpretation>
                                            20 points if answer is correct
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>20</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                                <qti:feedback_displayed ident="Incorrect">Response
                                </qti:feedback_displayed>
                            </qti:item_result>
                            <qti:item_result>
                                <qti:response ident_ref="262_0">
                                    <qti:response_form cardinality="single"
                                        response_type="str" render_type="fib">
                                        <qti:correct_response>hello
                                        </qti:correct_response>
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">bnbvnvb
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>0</qti:score_value>
                                        <qti:score_interpretation>
                                            15 points per correct answer
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>15</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                                <qti:feedback_displayed ident="Incorrect">Response
                                </qti:feedback_displayed>
                            </qti:item_result>
                            <qti:item_result>
                                <qti:response ident_ref="267">
                                    <qti:response_form cardinality="single"
                                        response_type="str" render_type="fib">
                                        <qti:correct_response />
                                    </qti:response_form>
                                    <qti:response_value response_status="Valid">
                                        fngnmhmjh,gj
                                    </qti:response_value>
                                </qti:response>
                                <qti:outcomes>
                                    <qti:score varname="SCORE" vartype="Integer">
                                        <qti:score_value>15</qti:score_value>
                                        <qti:score_interpretation>
                                            15 points if answer is correct
                                        </qti:score_interpretation>
                                        <qti:score_min>0</qti:score_min>
                                        <qti:score_max>15</qti:score_max>
                                    </qti:score>
                                </qti:outcomes>
                            </qti:item_result>
                        </qti:section_result>
                    </qti:assessment_result>
                </qti:result>
            </train:qti_result_report>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Figure 6-18A • Schema diagram for `getIMStestResultResponse`

Figure 6-18B • Schema diagram for `qti_result_report`

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetLabInfo

Allows you to get the general information of a Hands-on Lab, so that you can reserve an appropriate number of lab computers for your training sessions. If labName is unspecified, the request returns information for all labs configured on the site.

Request

The sample XML document retrieves the information of a Hands-on Lab named “Jill's lab for xml”. Be sure to provide a valid value for the Hands-on Lab of your website.

<?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.GetLabInfo">
            <labName>Jill's lab for xml</labName>
        </bodyContent>
    </body>
</serv:message>

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

Figure 6-22 • Schema diagram for `getLabInfo`

For descriptions of the global elements in the security context of the header, please see Global Request Elements in Security Context. For descriptions on the non-global elements, please refer to “Elements in Webex XML Schema Definitions for the Training Session 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: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:getLabInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:labInfo>
                <train:labName>Jill's lab for xml</train:labName>
                <train:description>Test Lab description.</train:description>
                <train:totalComputers>1</train:totalComputers>
                <train:computersInSession>0</train:computersInSession>
            </train:labInfo>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-23 • Schema diagram for `getLabInfoResponse`

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetLabSchedule

Allows you to retrieve the reservation schedule of a Hands-on Lab for a certain period of time, so that you can choose the right time to reserve lab computers for your training session.

Request

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

Figure 6-24 • Schema diagram for `getLabSchedule`

The sample XML document retrieves the schedule information of a Hands-on Lab named “bill's lab for xml”. Be sure to provide a valid value for the Hands-on Lab of your website.

<?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.GetLabSchedule">
            <labName>bill's lab for xml</labName>
            <timeZoneID>45</timeZoneID>
            <sessionStartTime>09/18/2003 14:00:00</sessionStartTime>
            <sessionEndTime>09/18/2003 16:00:00</sessionEndTime>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-25 • Schema diagram for `getLabScheduleResponse`

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:getLabScheduleResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:scheduledLabs>
                <train:labName>bill's lab for xml</train:labName>
                <train:confName>test for hand on lab</train:confName>
                <train:timeZoneID>45</train:timeZoneID>
                <train:sessionStartTime>09/26/2010 10:00:00
                </train:sessionStartTime>
                <train:sessionEndTime>09/26/2010 10:30:00</train:sessionEndTime>
                <train:hostWebexID>bill</train:hostWebexID>
                <train:numComputers>1</train:numComputers>
            </train:scheduledLabs>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetTestInformation

Returns detailed information for a scheduled test associated with a training session. Information returned includes the names of the participants who took the test and their grades.

Request

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

Figure 6-26 • Schema diagram for `getTestInformation`

The sample XML document retrieves detailed information of the test with testID of 202.

<?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.GetTestInformation">
            <testID>202</testID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-27 • Schema diagram for `getTestInformationResponse`

XSD Diagram of getTestInformationResponse

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:getTestInformationResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:testID>26007</train:testID>
            <train:title>Webex employee test (2)</train:title>
            <train:delivery>WEBSITE</train:delivery>
            <train:status>NOT_STARTED</train:status>
            <train:dueDate>05/19/2010 19:05:00</train:dueDate>
            <train:sessionKey>901674008</train:sessionKey>
            <train:description>To the webex employee test.</train:description>
            <train:startDate>05/12/2010 19:05:00</train:startDate>
            <train:timeLimit>30</train:timeLimit>
            <train:author>bill</train:author>
            <train:numQuestions>5</train:numQuestions>
            <train:numSubmitted>0</train:numSubmitted>
            <train:numStarted>0</train:numStarted>
            <train:numSubmittedUnscroed>0</train:numSubmittedUnscroed>
            <train:numSubmittedUnscored>0</train:numSubmittedUnscored>
            <train:maxScore>0</train:maxScore>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetTrainingSession

Allows any user to get the detailed session information if he or she has the session key for a specific training session.

Note Site administrators or regular hosts can only get information of the training sessions scheduled or owned by themselves. An exceptionID of 000001 is returned if a user tries to get information of the sessions scheduled by other hosts.

Request

The sample XML document retrieves detailed information of the training session with sessionKey of 76736484.


<?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.GetTrainingSession">
            <sessionKey>76736484</sessionKey>
        </bodyContent>
    </body>
</serv:message>

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

Figure 6-28 • Schema diagram of `getTrainingSession`

Response

Note GetTrainingSessionResponse now allows users to see 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.

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:getTrainingSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <sess:accessControl>
                <sess:listing>PUBLIC</sess:listing>
                <sess:sessionPassword>111111</sess:sessionPassword>
            </sess:accessControl>
            <sess:schedule>
                <sess:startDate>04/11/2004 10:00:00</sess:startDate>
                <sess:timeZone>GMT+08:00, Australia Western (Perth)
                </sess:timeZone>
                <sess:duration>60</sess:duration>
                <sess:timeZoneID>46</sess:timeZoneID>
                <sess:hostWebexID>hostid</sess:hostWebexID>
                <sess:openTime>20</sess:openTime>
                <sess:extNotifyTime></sess:extNotifyTime>
                <sess:joinTeleconfBeforeHost>false</sess:joinTeleconfBeforeHost>
            </sess:schedule>
            <train:metaData>
                <sess:confName>jimz hol test</sess:confName>
                <train:agenda>agenda 1</train:agenda>
                <train:description>description</train:description>
                <train:location>location</train:location>
                <train:invitation>invitation;</train:invitation>
            </train:metaData>
            <train:enableOptions>
                <sess:attendeeList>false</sess:attendeeList>
                <sess:javaClient>false</sess:javaClient>
                <sess:nativeClient>true</sess:nativeClient>
                <train:chat>false</train:chat>
                <train:poll>false</train:poll>
                <train:audioVideo>false</train:audioVideo>
                <train:fileShare>false</train:fileShare>
                <train:presentation>false</train:presentation>
                <train:applicationShare>false</train:applicationShare>
                <train:desktopShare>false</train:desktopShare>
                <train:webTour>false</train:webTour>
                <train:trainingSessionRecord>false</train:trainingSessionRecord>
                <train:annotation>false</train:annotation>
                <train:importDocument>false</train:importDocument>
                <train:saveDocument>false</train:saveDocument>
                <train:printDocument>false</train:printDocument>
                <train:pointer>false</train:pointer>
                <train:switchPage>false</train:switchPage>
                <train:fullScreen>false</train:fullScreen>
                <train:thumbnail>false</train:thumbnail>
                <train:zoom>false</train:zoom>
                <train:copyPage>false</train:copyPage>
                <train:rcAppShare>false</train:rcAppShare>
                <train:rcDesktopShare>false</train:rcDesktopShare>
                <train:rcWebTour>false</train:rcWebTour>
                <train:attendeeRecordTrainingSession>false
                </train:attendeeRecordTrainingSession>
                <train:voip>false</train:voip>
                <train:faxIntoTrainingSession>false
                </train:faxIntoTrainingSession>
                <train:autoDeleteAfterMeetingEnd>true
                </train:autoDeleteAfterMeetingEnd>
            </train:enableOptions>
            <train:telephony>
                <sess:telephonySupport>NONE</sess:telephonySupport>
                <sess:numPhoneLines>4</sess:numPhoneLines>
                <sess:extTelephonyURL>String</sess:extTelephonyURL>
                <sess:enableTSP>false</sess:enableTSP>
                <sess:tspAccountIndex>0</sess:tspAccountIndex>
            </train:telephony>
            <train:tracking>
                <com:trackingCode1>trackingCode1</com:trackingCode1>
                <com:trackingCode2>trackingCode2</com:trackingCode2>
                <com:trackingCode3>trackingCode3</com:trackingCode3>
                <com:trackingCode4>trackingCode4</com:trackingCode4>
                <com:trackingCode5>trackingCode5</com:trackingCode5>
                <com:trackingCode6>trackingCode6</com:trackingCode6>
                <com:trackingCode7>trackingCode7</com:trackingCode7>
                <com:trackingCode8>trackingCode8</com:trackingCode8>
                <com:trackingCode9>trackingCode9</com:trackingCode9>
                <com:trackingCode10>trackingCode10</com:trackingCode10>
            </train:tracking>
            <train:repeat>
                <train:repeatType>RECURRING_SINGLE</train:repeatType>
                <train:expirationDate>05/09/2004 10:00:00
                </train:expirationDate>
                <train:dayInWeek>
                    <train:day>SUNDAY</train:day>
                </train:dayInWeek>
                <train:endAfter>5</train:endAfter>
                <train:occurenceType>WEEKLY</train:occurenceType>
                <train:interval>5</train:interval>
                <train:dayInMonth>1</train:dayInMonth>
                <train:weekInMonth>1</train:weekInMonth>
            </train:repeat>
            <train:remind>
                <sess:enableReminder>true</sess:enableReminder>
                <sess:emails>
                    <sess:email>String</sess:email>
                </sess:emails>
                <sess:sendEmail>false</sess:sendEmail>
                <sess:mobile>String</sess:mobile>
                <sess:sendMobile>true</sess:sendMobile>
                <sess:daysAhead>1</sess:daysAhead>
                <sess:hoursAhead>1</sess:hoursAhead>
                <sess:minutesAhead>1</sess:minutesAhead>
            </train:remind>
            <train:presenters>
                <sess:maxUserNumber>1</sess:maxUserNumber>
                <sess:participants>
                    <sess:participant>
                        <sess:person>
                            <com:name>alternatehost3</com:name>
                            <com:webExId>host3</com:webExId>
                            <com:address>
                                <com:addressType>PERSONAL</com:addressType>
                            </com:address>
                            <com:phones />
                            <com:email>host3@test.com</com:email>
                            <com:type>MEMBER</com:type>
                        </sess:person>
                        <sess:contactID>1697837</sess:contactID>
                            <sess:joinStatus>ACCEPT</sess:joinStatus>
                            <sess:role>HOST</sess:role>
                    </sess:participant>
                    <sess:participant>
                        <sess:person>
                            <com:name>alternatehost1</com:name>
                            <com:webExId>host1</com:webExId>
                            <com:address>
                                <com:addressType>PERSONAL</com:addressType>
                            </com:address>
                            <com:phones />
                            <com:email>host1@test.com</com:email>
                            <com:type>MEMBER</com:type>
                        </sess:person>
                        <sess:contactID>1697842</sess:contactID>
                            <sess:joinStatus>ACCEPT</sess:joinStatus>
                            <sess:role>HOST</sess:role>
                    </sess:participant>
                </sess:participants>
            </train:presenters>
            <train:attendees>
                <sess:maxUserNumber>4</sess:maxUserNumber>
                <sess:participants>
                    <sess:participant>
                        <sess:person>
                            <com:name>attendee004</com:name>
                            <com:title>String</com:title>
                            <com:company>String</com:company>
                            <com:webExId>attendee004</com:webExId>
                            <com:address>
                                <com:addressType>PERSONAL</com:addressType>
                                <com:address1>String</com:address1>
                                <com:address2>String</com:address2>
                                <com:city>String</com:city>
                                <com:state>String</com:state>
                                <com:zipCode>String</com:zipCode>
                                <com:country>String</com:country>
                            </com:address>
                            <com:phones>
                                <com:phone>121212</com:phone>
                                <com:mobilePhone>1122</com:mobilePhone>
                                <com:fax>12312</com:fax>
                            </com:phones>
                            <com:email>attendee004</com:email>
                            <com:notes>String</com:notes>
                            <com:type>VISITOR</com:type>
                        </sess:person>
                        <sess:contactID>13118048</sess:contactID>
                        <sess:joinStatus>ACCEPT</sess:joinStatus>
                    </sess:participant>
                </sess:participants>
            </train:attendees>
            <train:attendeeOptions>
                <train:request>true</train:request>
                <train:registration>true</train:registration>
                <train:auto>true</train:auto>
                <train:registrationPWD>pass</train:registrationPWD>
                <tain:maxRegistrations>10</train:maxRegistrations>
                <train:registrationCloseDate>04/10/2004 00:00:00
                </train:registrationCloseDate>
            </train:attendeeOptions>
            <train:handsOnLab>
                <train:reserveHOL>false</train:reserveHOL>
                <train:numComputers>0</train:numComputers>
            </train:handsOnLab>
            <train:sessionKey>76736484</train:sessionKey>
            <train:status>NOT_INPROGRESS</train:status>
            <train:eventID>10765492</train:eventID>
            <train:guestToken>ed983acb971117c67e75582507bc1dba</train:guestToken>
            <train:hostType>1019001</train:hostType>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-29 • Schema diagram `getTrainingSessionResponse`

XSD Diagram of getTrainingSessionResponse

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.

LstLibTests

Lists all private and shared tests in the host’s library.

Request

The sample XML document returns the list of tests in the user’s library.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <webExID>johnsmith@xyz.com</webExID>
            <password>hostpassword</password>
            <siteID>0000</siteID>
            <partnerID>9999</partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.training.LstLibTests" />
    </body>
</serv:message>

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

Figure 6-30 • Schema diagram `lstLibTests`

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: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:LstLibTestsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:libTest>
                <train:testID>102</train:testID>
                <train:type>PRIVATE</train:type>
                <train:title>Test 1</train:title>
                <train:description>Example test 1 description</train:description>
                <train:author>max</train:author>
            </train:libTest>
            <train:libTest>
                <train:testID>107</train:testID>
                <train:type>SHARE</train:type>
                <train:title>Test 2</train:title>
                <train:description>Example test 2 description</train:description>
                <train:author>max</train:author>
            </train:libTest>
        </serv:bodyContent
    </serv:body>
</serv:message>

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

Figure 6-31 • Schema diagram of `lstLibTestsResponse`

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.

LstScheduledTests

Lists scheduled tests associated with the specified training sessions on the site.

Note Site administrators can retrieve all the scheduled tests on the current website, whereas regular hosts can only retrieve tests associated with their own training sessions.

Request

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

Note If the request is called by a regular host, then author is ignored, and only tests associated with the host’s training sessions are returned.

The sample XML document either returns the scheduled tests of all the users on the site to a site administrator, or returns the host’s own scheduled tests to a regular host.

<?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.LstScheduledTests">
        </bodyContent>
    </body>
</serv:message>

Figure 6-32 • Schema diagram of `lstScheduledTests`

Response

Only tests that have been added to a training session are returned.

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:lstScheduledTestsResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:test>
                <train:testID>26007</train:testID>
                <train:title>Webex employee test(2)</train:title>
                <train:delivery>WEBSITE</train:delivery>
                <train:status>NOT_STARTED</train:status>
                <train:dueDate>05/19/2010 19:05:00</train:dueDate>
                <train:sessionKey>901674008</train:sessionKey>
            </train:test>
            <train:test>
                <train:testID>26012</train:testID>
                <train:title>Webex employee test(3)</train:title>
                <train:delivery>WEBSITE</train:delivery>
                <train:status>NOT_STARTED</train:status>
                <train:dueDate>05/25/2010 00:10:00</train:dueDate>
                <train:sessionKey>909685385</train:sessionKey>
            </train:test>
            <train:test>
                <train:testID>26017</train:testID>
                <train:title>Webex employee test(4)</train:title>
                <train:delivery>IN_SESSION</train:delivery>
                <train:status>NOT_STARTED</train:status>
                <train:sessionKey>904715033</train:sessionKey>
            </train:test>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-33 • Schema diagram of `LstScheduledTestsResponse`

XSD Diagram of lstScheduledTestsResponse

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.

LstsummaryTrainingSession

Lists summary information for your scheduled training sessions.This function should be used instead of LstTrainingSession.

Note Site administrators can list training sessions scheduled by all users on the site. Regular hosts can list only their own sessions of any access type (PUBLIC, PRIVATE, and UNLISTED).

Request

The sample XML shows an example of a request for the summary information of the training sessions hosted during 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.training.LstsummaryTrainingSession">
            <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>
            <dateScope>
                <startDateStart>03/10/2004 00:00:00</startDateStart>
                <timeZoneID>45</timeZoneID>
            </dateScope>
        </bodyContent>
    </body>
</serv:message>

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

Figure 6-34 • Schema diagram of `lstsummaryTrainingSession`

XSD Diagram of lstsummaryTrainingSession

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: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:lstsummaryTrainingSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <train:trainingSession>
                <train:sessionKey>60740226</train:sessionKey>
                <train:confName>waynez-xmlapi-test002</train:confName>
                <train:meetingType>11</train:meetingType>
                <train:hostWebexID>java</train:hostWebexID>
                <train:otherHostWebexID>java</train:otherHostWebexID>
                <train:timeZoneID>45</train:timeZoneID>
                <train:timeZone>GMT+08:00, China (Beijing)</train:timeZone>
                <train:status>NOT_INPROGRESS</train:status>
                <train:startDate>04/01/2004 20:00:00</train:startDate>
                <train:duration>60</train:duration>
                <train:listStatus>PUBLIC</train:listStatus>
            </train:trainingSession>
            <train:trainingSession>
                <train:sessionKey>16318987</train:sessionKey>
                <train:confName>attendee verify</train:confName>
                <train:meetingType>11</train:meetingType>
                <train:hostWebexID>java</train:hostWebexID>
                <train:otherHostWebexID>java</train:otherHostWebexID>
                <train:timeZoneID>45</train:timeZoneID>
                <train:timeZone>GMT+08:00, China (Beijing)</train:timeZone>
                <train:status>NOT_INPROGRESS</train:status>
                <train:startDate>04/01/2004 06:00:10</train:startDate>
                <train:duration>60</train:duration>
                <train:listStatus>PUBLIC</train:listStatus>
            </train:trainingSession>
            <train:trainingSession>
                <train:sessionKey>11859182</train:sessionKey>
                <train:confName>jim test reminder</train:confName>
                <train:meetingType>11</train:meetingType>
                <train:hostWebexID>java</train:hostWebexID>
                <train:otherHostWebexID>java</train:otherHostWebexID>
                <train:timeZoneID>4</train:timeZoneID>
                <train:timeZone>GMT-08:00, Pacific (San Jose)</train:timeZone>
                <train:status>NOT_INPROGRESS</train:status>
                <train:startDate>03/30/2004 17:15:10</train:startDate>
                <train:duration>60</train:duration>
                <train:listStatus>PUBLIC</train:listStatus>
            </train:trainingSession>
            <train:trainingSession>
                <train:sessionKey>76736484</train:sessionKey>
                <train:confName>jimz hol test</train:confName>
                <train:meetingType>11</train:meetingType>
                <train:hostWebexID>hostid</train:hostWebexID>
                <train:otherHostWebexID>hostid</train:otherHostWebexID>
                <train:timeZoneID>46</train:timeZoneID>
                <train:timeZone>GMT+08:00, Australia Western (Perth)
                </train:timeZone>
                <train:status>NOT_INPROGRESS</train:status>
                <train:startDate>04/11/2004 10:00:00</train:startDate>
                <train:duration>60</train:duration>
                <train:listStatus>PUBLIC</train:listStatus>
            </train:trainingSession>
            <train:trainingSession>
                <train:sessionKey>11265015</train:sessionKey>
                <train:confName>sdfg</train:confName>
                <train:meetingType>11</train:meetingType>
                <train:hostWebexID>hostid</train:hostWebexID>
                <train:otherHostWebexID>hostid</train:otherHostWebexID>
                <train:timeZoneID>4</train:timeZoneID>
                <train:timeZone>GMT-08:00, Pacific (San Jose)</train:timeZone>
                <train:status>NOT_INPROGRESS</train:status>
                <train:startDate>04/01/2004 18:02:44</train:startDate>
                <train:duration>60</train:duration>
                <train:listStatus>PUBLIC</train:listStatus>
            </train:trainingSession>
            <train:matchingRecords>
                <serv:total>5</serv:total>
                <serv:returned>5</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </train:matchingRecords>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 6-35 • Schema diagram of `lstsummaryTrainingSessionResponse`

XSD Diagram of lstsummaryTrainingSessionResponse

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.

LstTrainingSession (Deprecated)

This function has been deprecated for performance reasons because it can potentially return too much data.

You should instead use LstsummaryTrainingSession (returns a list of essential session data) and GetTrainingSession (returns detailed information for one session).

Sample codes are not provided for deprecated XML messages.

Request

The following schema diagram shows the structure of the elements in the lstTrainingSession (Deprecated) request message.

Figure 6-36 • Schema diagram of `lstTrainingSession` (Deprecated)

Response

The following schema diagram shows the structure of the elements in the lstTrainingSessionResponse (Deprecated) message.

Figure 6-37 • Schema diagram of `lstTrainingSessionResponse` (deprecated)

XSD Diagram of lstTrainingSessionResponse

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.

ReserveLab

Reserves lab computers in a Hand-on Lab for a specific time.

Request

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

Figure 6-38 • Schema diagram for reserveLab

The sample XML document requests to reserve 1 computer in the lab named “Lab2” for 1 hour.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>steve</webExID>
            <password>pass</password>
            <partnerID>partnerid</partnerID>
            <siteName>johnsmith@xyz.com</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.training.ReserveLab">
            <labName>Lab2</labName>
            <numComputers>1</numComputers>
            <topic>reserve test01</topic>
            <timeLimit>60</timeLimit>
            <startDate>04/20/2011 10:00:00</startDate>
            <endDate>04/20/2011 11:00:00</endDate>
            <timeZoneID>4</timeZoneID>
            <sendMail>false</sendMail>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-39 • Schema diagram for reserveLabResponse

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:ReserveLabResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
            <train:holSessionID>65192</train:holSessionID>
        </serv:bodyContent>
    </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”.

SetScheduledTest

Edits the scheduling of a Training Session library test. This API only changes the test schedule, it does not modify the actual test content.

Request

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

Figure 6-40 • Schema diagram for setScheduledTest

Figure 6-41 • Schema diagram for setScheduledTest

The sample XML document requests to change the schedule for the test with ID 105 from Training Session 12345678.


<?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.SetScheduledTest">
            <sessionKey>12345678</sessionKey>
            <testID>105</testID>
            <deliveryMethod>
                <startDate>10/10/2010 00:10:00</startDate>
                <dueDate>10/12/2010 00:10:00</dueDate>
            </deliveryMethod>
            <timeLimit>
                <withinMinutes>30</withinMinutes>
            </timeLimit>
            <attemptLimit>
                <noLimit>true</noLimit>
            </attemptLimit>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-42 • Schema diagram for setScheduledTestResponse

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:SetScheduledTestResponse"
            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”.

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

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>

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”.

UploadIMStest

Uploads tests to a user’s Training Center private test library using a subset of the IMS Question and Test Interoperability (QTI) Specification Version 1.2. For the IMS QTI specification and samples, refer to: http://www.imsglobal.org/question/.

Note UploadIMStest does not support the IMS QTI specification itemfeedback element.

Note Based on the TC web page features, UploadIMStest only supports single choice, multiple choice, blank fill, and essay test items.

Request

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

The sample XML document shows an example that uploads a test with a single response (with only one correct answer).

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <siteID>700021717</siteID>
            <webExID>sherry</webExID>
            <password>pass</password>
            <partnerID>webexpartner</partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.training.UploadIMStest">
            <display>
                <allOnePage>true</allOnePage>
            </display>
            <assignGrades>true</assignGrades>
            <train:questestinterop>
                <qtiasi:assessment ident="396317" title="Test018">
                    <qtiasi:qticomment>test018</qtiasi:qticomment>
                    <qtiasi:duration>P0Y0M0DT0H30M</qtiasi:duration>
                    <qtiasi:section ident="IMS_V01_Test01(15)000">
                        <qtiasi:item ident="IMS_V01_Test01(15)0">
                            <qtiasi:presentation>
                                <qtiasi:flow>
                                    <qtiasi:material>
                                        <qtiasi:mattext>what is your
                                            name?</qtiasi:mattext>
                                    </qtiasi:material>
                                    <qtiasi:response_lid ident="1171372"
                                        rcardinality="Single">
                                        <qtiasi:render_choice>
                                            <qtiasi:response_label ident="3736872">
                                                <qtiasi:flow_mat>
                                                    <qtiasi:material>
                                                        <qtiasi:mattext>Steve</qtiasi:mattext>
                                                    </qtiasi:material>
                                                </qtiasi:flow_mat>
                                            </qtiasi:response_label>
                                            <qtiasi:response_label ident="3736877">
                                                <qtiasi:flow_mat>
                                                    <qtiasi:material>
                                                        <qtiasi:mattext>Honj</qtiasi:mattext>
                                                    </qtiasi:material>
                                                </qtiasi:flow_mat>
                                            </qtiasi:response_label>
                                            <qtiasi:response_label ident="3736882">
                                                <qtiasi:flow_mat>
                                                    <qtiasi:material>
                                                        <qtiasi:mattext>Jamma</qtiasi:mattext>
                                                    </qtiasi:material>
                                                </qtiasi:flow_mat>
                                            </qtiasi:response_label>
                                            <qtiasi:response_label ident="3736887">
                                                <qtiasi:flow_mat>
                                                    <qtiasi:material>
                                                        <qtiasi:mattext>Jack</qtiasi:mattext>
                                                    </qtiasi:material>
                                                </qtiasi:flow_mat>
                                            </qtiasi:response_label>
                                            <qtiasi:response_label ident="3736892">
                                                <qtiasi:flow_mat>
                                                    <qtiasi:material>
                                                        <qtiasi:mattext>Wayne</qtiasi:mattext>
                                                    </qtiasi:material>
                                                </qtiasi:flow_mat>
                                            </qtiasi:response_label>
                                        </qtiasi:render_choice>
                                    </qtiasi:response_lid>
                                </qtiasi:flow>
                        </qtiasi:presentation>
                        <qtiasi:resprocessing>
                            <qtiasi:outcomes>
                                <qtiasi:decvar vartype="Integer" minvalue="0"
                                    maxvalue="10" />
                            </qtiasi:outcomes>
                                <qtiasi:respcondition>
                                    <qtiasi:conditionvar>
                                        <qtiasi:varequal
                                            respident="1171372">3736872</qtiasi:varequal>
                                    </qtiasi:conditionvar>
                                    <qtiasi:setvar action="Set">10</qtiasi:setvar>
                                </qtiasi:respcondition>
                            </qtiasi:resprocessing>
                        </qtiasi:item>
                    </qtiasi:section>
                </qtiasi:assessment>
            </train:questestinterop>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 6-46 • Schema diagram for uploadIMStestResponse

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:UploadIMStestResponse"
            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”.

Elements in Webex XML Schema Definitions for the Training Session Service

The following table describes all the elements that are used in the Webex XML API for the Training Center service.

*Element*	*Constraint(s)*	*Description*
`action`	Optional. Valid values are EDIT and DELETE.	Indicates what action is to be performed.
`address1`	Optional. Maximum of 128 characters.	The first line of the attendee’s street address. Default is ““.
`address2`	Optional. Maximum of 128 characters.	The second line of the attendee’s street address. Default is ““.
`addressType`	Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered Webex user.	Determines whether the session participant is a personal contact of the session host or is a site-wide (global) contact. Default: “PERSONAL”.
`agenda`	Optional. Maximum of 2,500 characters.	An agenda of the training session.
`allOnePage`	Required. Boolean.	Indicates whether all test items display in a single page. Only allOnePage or onePerPage can be specified (and set to TRUE) as the display type for the test upload.
`annotation`	Optional. Valid values are TRUE and FALSE.	Indicates whether annotation is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`applicationShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether application sharing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`asi_description`	Optional. String. Maximum of 2048 characters.	Description of the test.
`assignGrades`	Optional. Valid values are TRUE and FALSE.	Indicates whether grades are assigned based on score to the student. ■ TRUE: Grade will be assigned. ■ FALSE: No grade assigned to the student.
`assistConfirm`	Optional. Enum {Pending, Confirmed, Cancelled}	Assist meeting’s confirm type. Defaults to Pending.
`assistRequest`	Optional. Enum {None, Dry Run, Consult, Live Event Support, Audio Streaming, Video}	Assist meeting’s request type. Defaults to None.
`attemptLimit`	Required. Choice. A valid child element is either noLimit or attemptTimes.	Holds an attempt limit choice for a scheduled test.
`attemptTimes`	Required. Integer.	Number of times an attendee can take a scheduled test.
`attendeeAssign`	Required if enable is TRUE. Enumerated string. Valid values are AUTO and MANUAL.	Specifies whether attendees are automatically or manually assigned to a breakout session.
`attendeeBreakoutSession`	Optional. Boolean.	Indicates whether the Quick Start tab is displayed to attendees as they enter a breakout session.
`attendeeList`	Optional. Valid values are TRUE and FALSE.	Indicates whether attendee listing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`attendeeRecordTrainingSession`	Optional. Valid values are TRUE and FALSE.	Indicates whether attendees can record the session. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`attendees`	Optional. Container.	Holds attendee reminder options.
`attendeesPerSess`	Optional. Integer.	Number of attendees in each breakout session.
`audioVideo`	Optional. Valid values are TRUE and FALSE.	Indicates whether audio/video is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`author`	Optional. String. Maximum of 128 characters.	Author of the test. Note: `This element refers to the session host, not the person who first created the test in the test library.`
`auto`	Optional. Valid values are TRUE and FALSE.	Indicates whether all registration requests are automatically accepted. Default: FALSE.
`autoDeleteAfterMeetingEnd`	Optional. Valid values are TRUE and FALSE.	Automatically deletes the session from the calender after it ends. Default: FALSE.
`beforeDays`	Optional. Integer.	Number of days before the start of the test to send an email reminder to attendees. Works with beforeHours and beforeMinutes to determine when the email is sent.
`beforeHours`	Optional. Integer.	Number of minutes before the start of the test to send an email reminder to attendees. Works with beforeDays and beforeMinutes to determine when the email is sent.
`beforeMinutes`	Optional. Integer.	Number of hours before the start of the test to send an email reminder to attendees. Works with beforeDays and beforeHours to determine when the email is sent.
`chat`	Optional. Valid values are TRUE and FALSE.	Indicates whether chat is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`city`	Optional. Maximum of 64 characters.	The attendee’s city. Default is “”.
`company`	Optional. Maximum of 128 characters.	The attendee’s company name.
`computersInSession`	Optional. Integer.	Total number of computers in the Handson Lab that are currently in use.
`confName`	Required for Create command and GetLabScheduleResponse. Optional for Lst and Set. Must be a non-null value. Not applicable for all other actions. Maximum of 512 characters.	The name of the training session.
`contactID`	Optional. Long. If populated, A reference to another service.	A Webex-maintained reference to the contact information for a session attendee.
`copyPage`	Optional. Valid values are TRUE and FALSE.	Indicates whether page copying is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`copyToType`	Required. Enumerated string. Valid values are PRIVATE and SHARE.	Specifies which library to copy the test to. ■ PRIVATE: Copies the test from the shared library to the private library. ■ SHARE: Copies the test from the private library to the shared library.
`correct_response`	Required. String.	Indicates the correct response to each test question.
`country`	Optional. Maximum of 64 characters.	The attendee’s country. Default is “”.
`countryAlias`	Required. String.	Holds the country’s alias.
`day`	Optional. Enumerated string. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY and SATURDAY.	When repeatType=RECURRING_SINGLE or MULTIPLE_SESSION, this designates the day of the week that the sessions repeat on.
`dayInMonth`	Optional. Its value ranges from 1 to 31.	For a recurring event, on which day of the month it recurs.
`dayInWeek`	Optional. Valid values are SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY.	For a recurring event, on which days of the week it recurs. Default is SATURDAY. Works with repeatType, expirationDate, and endAfter.
`dayInYear`	Optional. Integer.	Deprecated after XML 3.5. Represents a day in a year, ranging from 1 to 365.
`daysAhead`	Optional. If populated, must be a nonnegative integer.	Number of days ahead of the session to send email to the Remind Email. Works with hoursAhead and minutesAhead to determine exactly when the message is sent. 0 means the day of the event. Default: “0”.
`decvar`	Required.	Declarations of the scoring variables.
`default`	Optional. Boolean.	Indicates whether to use the site default session template of a service for meeting scheduling. Default: FALSE.
`defaultHighestMT`	Optional. Boolean. Defaults to TRUE.	This element is used in conjunction with the sessionType element to set the session type when creating a Training Center session. If sessionType is specified, then CreateTrainingSession will use this session type and defaultHighestMT will be ignored. If sessionType is unspecified, then: ■ If defaultHighestMT = TRUE (the default), CreateTrainingSession will use the highest Training session type available for a host. ■ If defaultHighestMT = FALSE, CreateTrainingSession will use the default Training session type = 11. Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Training Center session type available for a host.
`delivery`	Required. Enumerated string. Valid values are WEBSITE and IN_SESSION.	Indicates the delivery method of the test. Meanings are: ■ WEBSITE: Delivers the test on the website. ■ IN_SESSION: Delivers the test during a training session. Default: IN_SESSION.
`deliveryMethod`	Required. Choice. A valid child element is either session or website.	Holds the scheduled test delivery method type.
`description`	Optional. Maximum of 2500 characters.	Description of the item.
`desktopShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether desktop sharing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`destinationURL`	Optional. String. Maximum of 128 characters.	The destination URL attendees are taken to after the training session ends.
`display`	Required. Choice. A valid child element is either allOnePage or onePerPage.	Holds the test question display settings.
`displayfeedback`	Required.	Assigns corresponding feedback if the response condition is true.
`displayQuickStartAttendees`	Optional. Boolean.	Indicates whether the Quick Start tab in the session manager is displayed to attendees as they enter a training session.
`displayQuickStartHost`	Optional. Boolean.	Indicates whether the Quick Start tab in the session manager is displayed to the host and presenter as they enter a training session.
`dueDate`	Optional. String.	The date and time at which the test is due. The meaning of dueDate depends on the following conditions: ■ If the test is delivered on the website, and the value of status is STARTED or NOT_STARTED, then dueDate means the scheduled due date of the test. ■ If the test is delivered on the website, and the value of status is ENDED, then dueDate means the actual ending time of the training session. ■ If the test is delivered during the training session, then no dueDate is returned.
`dueDate` (in website)	Required. String.	The date and time (in GMT) at which the scheduled website test is due. Formatted as MM/DD/YYYY HH:MM:SS.
`duration`	Optional. If populated, must be a positive integer.	The duration of the training session in minutes. Default is 60. Must be no more than the MaxSessionDuration, which has been set by the Webex administrator and is defined in the Super Admin Site.
`duration` (in assessment_result element)	Required. String.	The duration of the test in the format of YYYY-MM-DDTHH:MM:SS.
`email`	Required for each attendee or presenter specified. Maximum of 64 characters.	The email address of a user. Default is ““. This is an optional field when used with request APIs.
`emailAttendee`	Optional. Container.	Holds the email attendee settings.
`emailInvitations`	Optional. Valid values are TRUE and FALSE.	Whether to send invitation email messages to the training session attendees. Default is FALSE.
`enable`	Optional. Valid values are TRUE and FALSE.	Indicates whether the pre-session assignment fields are enabled.
`enableGreeting`	Optional. Valid values are TRUE and FALSE.	Indicates whether the attendee greeting message is enabled.
`enableReminder`	Optional. Valid values are TRUE and FALSE.	TRUE for reminders to be enabled; FALSE for no reminder.
`enableTSP`	Boolean.	Determines whether an integrated non-Webex teleconferencing service is active.
`endAfter`	Optional. Integer.	How many times a recurring event occurs. Works with repeatType. If you specify this, also using expirationDate causes an error.
`endDate`	Required. String.	The ending date and time to reserve the Hands-on Lab. Formatted as MM/DD/YYYY HH:MM:SS. The minute value must be 00, 15, 30, or 45. The seconds value must be 00.
`endDateEnd`	Optional.	End of range of dates from which a user can select for the end date for a training session.
`endDateStart`	Optional.	Beginning of range of dates from which a user can select for the end date for a training session. Formatted as MM/DD/YYYY HH:MM:SS.
`enforcePassword`	Optional. Boolean. Default value is FALSE.	If TRUE, throw an exception when specified sessionPassword does not meet any of the strict password criteria defined in the Site Administration tool. To enforce password security when creating a Training session with XML API, make sure you have selected the Apply strict password option and defined strict password criteria in Site Administration, and then set this element to TRUE. If FALSE, the session password will not be checked for security even if Apply strict password is selected in Site Administration.
`entryExitTone`	Optional. Enumerated string. Valid values are: NOTONE, BEEP, and ANNOUNCENAME.	The sound all attendees here when an attendee enters or exits the training session. Default is the same as the webpage.
`eventID`	Optional. Long.	An internal unique ID number for a Training Center session. Equivalent to sessionKey.
`expirationDate`	Optional.	The date and time after which a session that was set to automatically repeat stops repeating. Formatted as MM/DD/YYYY HH:MM:SS. Works with repeatType. If you specify this, also using endAfter causes an error.
`extNotifyTime`	Optional. Integer.	When to send out a notification.
`extTelephonyDescription`	Optional. Maximum of 2,048 characters.	A description of your telephony services, if you use your own as indicated in extTelephonyURL and in telephonySupport. By default, this is “Enter teleconference number, pass code, and other instructions here.”.
`extTelephonyURL`	Optional. Maximum of 2,048 characters.	The URL of your telephony server, if you want to use it as an alternative to Webex to support the session’s voice communications (session is still recordable). Can be set only if you have super admin privilege.
`extURL`	Optional. String.	External URL.
`fax`	Optional. Maximum of 64 characters.	The attendee’s fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`faxIntoTrainingSession`	Optional. Valid values are TRUE and FALSE.	Internal use only. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`feedback_displayed`	Optional. String.	The type of feedback for the specified participant. Default: Response.
`field_name`	Required. String.	Specifies the field of overall comments. Default: overall_comments in assessment_result and question_comments in item_result.
`field_value`	Required. String.	Specifies actual overall comments to the specified participant.
`fileShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether file sharing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`firstReminder`	Required if using secondReminder. Enumerated string. Valid values are 15MIN, 30MIN, 1HR, 2HR, 24HR, 2DAY, 7DAY, and 14DAY.	Specifies when the first reminder is sent before the session starts. Default: 24HR. If null, reminder is deleted.
`fullScreen`	Optional. Valid values are TRUE and FALSE.	Indicates whether full screen is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`globalNum`	Optional. Container.	Corresponds to the Global Call-in Numbers in the telephony domain.
`grade`	Required. String.	The grade of the submitted test.
`grade_value`	Required. String.	The grade of the specified participant.
`greeting`	Optional. String. Maximum of 4k characters.	The greeting message for the participants of the training session. This text appears in a welcome pop-up window.
`guestToken`	Optional. String.	Contains the guest’s token for a session.
`holSessionID`	Optional. Integer.	The unique identifier for a Hands-on Lab session.
`hostKey`	Optional. String.	The host key of a session host. The host key allows the host to pass privileges to another attendee or to reclaim the host role upon rejoining a session.
`hostType`	Optional. String.	Returns a code that specifies the application used to schedule and start the meeting. hostType has the following format xyyyzzz where: ■ (x) Meeting type: 1 - Regular, 2 - oneclick ■ (yyy) Scheduled from: 001 - webpage, 002 - PT, 003 - OI, 004 - NI, 005 - MSN, 006 - Yahoo, 007 - AIM, 008 - Skype, 009 - Gtalk, 010 - Sametime, 011 - LCS, 012 - WebexToolbar, 013 - IPPhone, 016 - iPhone dusting, 017 - Webex Connect, 018 - TP meeting, 019 - generic XML API app. ■ (zzz) Started from: Uses the same codes as yyy.
`hostWebexID`	Optional. Maximum of 64 characters.	The Webex ID of a user on your site. Site administrator can list sessions of a user by specifying his or her hostWebexID.
`hoursAhead`	Optional.	Number of hours ahead of the session to send email to the Remind Email. Works with daysAhead and minutesAhead to determine exactly when the message is sent. 0 means at the same time of day as indicated in the startDate, 1 is an hour earlier, and so on. Default: “0”. ■ Example 1: If daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent on the day and the time of the event. ■ Example 2: If startDate is noon on a particular day, daysAhead is 1, and hoursAhead is 1, any reminders are sent at 11:00 on the day before the event.
`HQvideo`	Optional. Valid values are TRUE and FALSE.	Enables high-quality video for the session. Defaults to the video options set in Site Admin “Default Scheduler Options”.
`importDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document importing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`index`	Required. Integer.	Indicates the session index of repeat sessions.
`interval`	Optional. If populated, must be a nonnegative integer. Valid values: ■ 0: Do not repeat ■ 1: Every day (or week) ■ 2: Every other day (or week) ■ 3: Every third day (or week) ■ 4: Every fourth day (or week)	The interval for a repeating calendar event, as determined by repeatType, or zero if the event is date-based. Default: 0. dayInWeek determines which days of the week specifically the repetitions occur. Note: `In Training Center, interval and expirationDate cannot be specified or un-specified together.`
`intLocalCallIn`	Optional. Valid values are TRUE and FALSE.	Allows access to Webex teleconferencing via international local call-in telephone numbers in a Webex training session. Default: FALSE.
`intLocalNum`	Optional. String.	Returns the international local call-in telephone numbers for Webex teleconferencing in a training session. This element is only returned in GetTrainingSession and its value is ignored in Create/SetTrainingSession.
`invitation`	Optional. Maximum of 1,024 characters.	The invitation for the participants of the training session.
`invite`	Optional. Valid values are TRUE and FALSE.	Indicates whether an invitation email to take the test is sent to all attendees.
`javaClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Java-based Webex Training Center client is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`joinNotifyURL`	Optional. String.	URL holding notification information.
`joinStatus`	Optional. Valid values are REGISTER, ACCEPT, REJECT, and INVITE.	Indicates whether the user has received notification of the session or the outcome of any plans to attend. Default: REGISTER.
`joinTeleconfBeforeHost`	Optional. Valid values are TRUE and FALSE.	Determines whether or not attendees are allowed to join the teleconference before the host. Defaults to FALSE.
`labName`	Optional. String. Required for CheckLabAvailability, GetLabSchedule, and ReserveLab.	The name of the Hands-on Lab.
`libTest`	Optional. Container.	Holds the library test details.
`listing`	Optional.	Indicates which users can see this scheduled meeting in lists of meetings on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host (this is the default). ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users. Default is PUBLIC.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in “Specifying Boolean Relationships for Searches” on page 55.
`listStatus`	Optional.	Indicates which users can see this scheduled meeting in lists of meetings on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host (this is the default). ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users. Default is PUBLIC.
`location`	Optional. Maximum of 256 characters.	Any site-defined location for the meeting.
`mattext`	Required. String.	Holds the text or scoring guidelines for a question.
`maximumNum`	Optional. Integer.	Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`maxRegistrations`	Optional. Integer.	The maximum number of users who can be registered for the training session, if registration is required. If it is not required, maxUserNumber provides an alternative way of limiting participants.
`maxScore`	Optional. Integer.	The highest score for a test associated with a training session.
`maxUserNumber`	Optional. Numeric.	A Webex-maintained maximum number of participants (excluding the host) that can be in the session at the same time. Default is the value defined in session/meeting type (usually 4).
`meetingType`	Optional. Integer.	The meeting type number that identifies the type of the training session configured for the site.
`minutesAhead`	Optional.	Number of minutes ahead of the session to send email to the Remind Email. Works with daysAhead and hoursAhead to determine exactly when the message is sent. 0 means no minutes beyond the number of hours in hoursAhead. Therefore, if daysAhead, hoursAhead, and minutesAhead are all zero, any reminders are sent at the time of the event. Default: “5”.
`mobile`	Optional. Maximum of 64 characters.	The attendee’s mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`mobilePhone`	Optional. Maximum of 64 characters.	The attendee’s mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`monthInYear`	Optional. An integer of 1 to 12. Not applicable to Training Center.	For a recurring event, on which month of the year it recurs.
`multiVideo`	Optional. Valid values are TRUE and FALSE.	Indicates whether multi-point video is enabled. To enable multi-point video audioVideo must be enabled (TRUE).
`muteOnEntry`	Optional. Boolean.	Indicates whether the Mute Attendees On Entry feature is enabled.
`name`	Required for each attendee or presenter specified. Maximum of 64 characters.	The name of the session participant.
`nativeClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Macintosh-based Webex Training Center client is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`networkBasedRecord`	Optional. Boolean.	Indicates whether Network Based Recording (NBR) of a session is enabled.
`noLimit`	Required. Boolean. If specified, value must be TRUE.	Sets no time or attempt limit for the scheduled test.
`notes`	Optional. Maximum of 2,048 characters.	The host’s notes about the session participant. Default is “”.
`notifySubmits`	Optional. Valid values are TRUE and FALSE.	Indicates whether to notify the host when an attendee submits a test.
`numComputers`	Optional. Integer. Required for ReserveLab.	The number of computers to be reserved in the Hands-on Lab.
`numPhoneLines`	Optional. If populated, must be a nonzero value.	The number of phone lines to reserve, when using Webex-supplied telephony, for the session. By accurately forecasting this number, you enable Webex to reserve the appropriate number of phone lines for the meeting. Default: 0.
`numQuestions`	Required. Integer.	Total number of questions in the test.
`numSessions`	Optional. Integer.	Number of breakout sessions.
`numStarted`	Required. Integer.	Total number of students who have started their tests.
`numSubmitted`	Required. Integer.	Total number of students who have submitted their tests.
`numSubmittedUnscored`	Required. Integer.	Total number of students whose tests have been submitted, but not yet scored.
`occurenceType`	Optional. Enumerated string. Valid values are WEEKLY, DAILY, NO_REPEAT, MONTHLY and IRREGULARLY.	Determines whether the training session repeats and at what interval. Works together with interval to determine the exact number of days or weeks apart the repetitions occur. Default: NO_REPEAT. Meanings are: ■ DAILY: The session occurs every day of the week. ■ WEEKLY: The session occurs at the specified days of every week. Also see DaysInWeek for which days. ■ MONTHLY: The session occurs at the specified days of every month. ■ NO_REPEAT: The session does not recur. ■ IRREGULARLY: The session recurs irregularly.
`onePerPage`	Required. Boolean.	Indicates whether only one test item displays in a page. Only allOnePage or onePerPage can be specified (and set to TRUE) as the display type for the test upload.
`openTime`	Optional. Integer. Valid values are 5, 10, 15, 20, 25, and 30.	Defines the number of minutes allowed for the attendees to join the training session before the start time. Default is 5. Note: `Specifying a value other than the valid values may cause problems.`
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy whether to sort in ascending or descending order. Default: ASC.
`orderBy`	Optional. For LstsummaryTrainingSe ssion and LstTrainingSession, valid values are HOSTWEBEXID, CONFNAME, STARTTIME, and TRACKINGCODE1..10.	Which elements to sort by in the sessions returned.
`otherHostWebexID`	Optional. String.	The effective host for the session. This host is specified in create/SetTrainingSession, .
`participantEmail`	Required. String. Maximum of 64 characters.	The email address of the participant for whom you want to get detailed test result.
`participantLimit`	Optional. Integer.	Maximum number of participants allowed.
`personalAccountIndex`	Optional. Integer.	The index number of the personal teleconference account to be used; if not specified, then personal teleconferencing is not used.
`phone`	Optional. Maximum of 64 characters.	The attendee’s phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, “11,444,5551212” or "5553234". Default is “”.
`phoneNumber`	Required. String.	Holds the global phone number.
`pointer`	Optional. Valid values are TRUE and FALSE.	Indicates whether a screen pointer is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`poll`	Optional. Valid values are TRUE and FALSE.	Indicates whether survey polling is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`preAssignBreakout`	Optional. Container.	Holds pre-session breakout assignment fields.
`presentation`	Optional. Valid values are TRUE and FALSE.	Indicates whether whiteboard, presentation and document sharing are supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`presenterBreakoutSession`	Optional. Boolean.	Indicates whether the Quick Start tab is displayed to the host, presenter, and panelists as they enter a breakout session.
`presenters`	Optional. Container.	Holds presenter reminder options.
`printDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document printing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`psoFields`	Optional. Container.	Holds custom fields to be used internally by the Webex Professional Services Organization (PSO). Not for public use.
`psoField1`	Optional. String. Max length of 128 character.	The first PSO field. For internal Webex use only.
`qti:datetime`	Required. String.	Stores the actual starting time of the test in ISO 8601 format. See also type_label.
`qti:identifier_string`	Required. String.	Stores the email address of the participant. See also type_label.
`qti:num_sections`	Required. Integer.	Number of sections contained in the test.
`qtiasi:duration`	Optional. String.	Allowed test duration in the format of YYYY-MM-DDTHH:MM:SS.
`qticomment`	Optional. String.	The description of the test.
`rcAppShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote application sharing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`rcDesktopShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote desktop sharing is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`rcWebTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote Web touring is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`registerID`	Required. Integer.	An registration ID for each attendee who submitted the test associated with a training session.
`registration`	Optional. Valid values are TRUE and FALSE.	Whether attendees must register to attend the session. Default: FALSE.
`registrationCloseDate`	Optional. String.	Time and date past which users can no longer register for this training session. Formatted as MM/DD/YYYY HH:MM:SS.
`registrationPWD`	Optional. String.	Password for registration.
`reminderAfterStart`	Optional. Valid values are TRUE and FALSE.	Indicates whether a reminder email to take the test is sent to attendees after the test starts.
`repeatSession`	Optional. Container.	Holds the repeat session the user wants to edit or delete.
`repeatType`	Optional. Valid values are SINGLE, RECURRING_SINGLE, or MULTIPLE_SESSION.	Determines whether the session repeats and in what manner. Works with dayInWeek, expirationDate, and endAfter to determine when repetitions occur. Valid values are: ■ SINGLE: Single-session class (default). ■ RECURRING_SINGLE: A single session that occurs more than once. ■ MULTIPLE_SESSION: A training course with multiple sessions.
`request`	Optional. Valid values are TRUE and FALSE.	Request detailed attendee information. Default: FALSE.
`reserveHOL`	Optional. Valid values are TRUE and FALSE.	Whether to reserve Hands-on Lab for the training session. If TRUE, the start time of the session should be at 15 minutes interval of the hour. For example, 12/03/2003 10:15:00 is acceptable, while 12/03/2003 10:14:00 is not.
`response_value`	Required. String.	The actual response of the participant to each test question.
`returned`	Required if matchingRecords is specified. Integer.	The number of records returned in the response.
`role`	Optional. Enum.	Holds the attendee’s role type. Specify HOST to denote alternateHost role type.
`saveDocument`	Optional. Valid values are TRUE and FALSE.	Indicates whether document saving is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`score`	Required. Integer.	The score of the submitted test.
`score_interpretation`	Required. String. Maximum of 2048 characters.	The scoring guidelines for each test question.
`score_max`	Required. Integer.	The maximum possible score for an item.
`score_min`	Required. Integer.	The minimum possible score for an item.
`score_value`	Required. Integer.	The actual score of the specified participant.
`secondReminder`	Required if using thirdReminder. Enumerated string. Valid values are 15MIN, 30MIN, 1HR, 2HR, 24HR, 2DAY, 7DAY, and 14DAY.	Specifies when the second reminder is sent before the session starts. Default: 24HR. If null, reminder is deleted.
`send`	Optional. Valid values are TRUE and FALSE.	Indicates whether to send a reminder email to attendees.
`sendEmail`	Optional. Valid values are TRUE and FALSE.	Indicates whether to send email as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to send the email. If TRUE, the system sends a reminder email to the email address listed in RemindEmail. The default is FALSE.
`sendMail`	Optional. Valid values are TRUE and FALSE.	Indicates whether a confirmation email is sent to the host upon reserving a Handson Lab. The default is FALSE.
`sendMobile`	Optional. Valid values are TRUE and FALSE.	Indicates whether to call RemindMobile as a reminder before the event. Works with daysAhead, hoursAhead, and minutesAhead to determine when to call the mobile number. If TRUE, the system calls the number in RemindMobile. The default is FALSE.
`sendReport`	Optional. Valid values are TRUE and FALSE.	Indicates whether to send a scoring and grading report.
`sendToRegister`	Optional. Valid values are TRUE and FALSE.	Indicates whether an email is sent to attendees that register after the test starts.
`session`	Required. Boolean. If specified, value must be TRUE.	Sets the scheduled test delivery method to session. Only session or website can be specified as the scheduled test delivery method.
`sessionEndTime`	Required.	The ending time of the period that you want to check information of the Handson Lab. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionKey`	Required for Get, Set, and Del. Optional for Lst. Not applicable for Create. Must be non-null.	A Webex-assigned session-unique value that is needed to join or identify the particular training session.
`sessionPassword`	Optional. Maximum of 16 characters.	The password for the training session. If a value is specified, then attendees are prompted for a password before they can join the training session. A null password for this element is the same as not using this element. The training session password will be validated against the password security options (if enabled) in the Site Administration tool. If the password security rules are violated, an exception occurs.
`sessionStartTime`	Required.	The starting time of the period that you want to check information of the Handson Lab. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionType`	Optional. Integer.	In CreateTrainingSession, if sessionType is specified, then CreateTrainingSession will use this session type and defaultHighestMT will be ignored. If sessionType is unspecified, then: ■ If defaultHighestMT = TRUE (the default), CreateTrainingSession will use the highest Training session type available for a host. ■ If defaultHighestMT = FALSE, CreateTrainingSession will use the default Training session type = 11. Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Training Center session type available for a host. In GetTrainingSessionResponse, returns the session type of a Training session. In SetTrainingSession, updates the session type of a Training session.
`setvar`	Required. Integer.	Assigns new value to the scoring variable.
`startDate`	Required for Create. Optional for Lst and Set. Not applicable for all other actions.	The starting date and time for the first (or only) occurrence of the training session. Formatted as MM/DD/YYYY HH:MM:SS. Default is current time.
`startDate` (in ReserveLab)	Required. String.	The starting date and time to reserve the Hands-on Lab. Formatted as MM/DD/YYYY HH:MM:SS. The minute value must be 00, 15, 30, or 45. The seconds value must be 00.
`startDate` (in website)	Required. String.	The starting date and time (in GMT) for the scheduled website test. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateEnd`	Optional.	End of range of dates from which a user can select for the start date for a training session. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateStart`	Optional.	Beginning of range of dates from which a user can select for the start date for a training session. Formatted as MM/DD/YYYY HH:MM:SS.
`startFrom` (in listControl element)	Optional. Integer.	Works with maximumNum to limit the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`startFrom` (in matchingRecords element)	Required. Integer.	Index number that the returned set starts from.
`state`	Optional. Maximum of 32 characters.	The attendee’s state of residence. Default is “”.
`status`	Optional. Valid values are INPROGRESS or NOT_INPROGRESS.	Indicates whether the session is either started and active or not active. Its value is generated by Webex and cannot be changed. Default: NOT_INPROGRESS.
`status` (in CheckLabAvailability response)	Required. Enumerated string. Valid values are AVAILABLE and UNAVAILABLE.	The availability status of the Hands-on Lab.
`status` (in test element)	Required. Enumerated string. Valid values are STARTED, ENDED and NOT_STARTED.	Indicates the delivery status of the test. Default is NOT_STARTED.
`submitDate`	Required. String.	The date and time at which the test is submitted.
`supportBreakoutSessions`	Optional. Boolean.	Indicates whether the breakout session feature is enabled. If FALSE, presenterBreakoutSession and attendeeBreakoutSession will be disabled.
`supportFeedback`	Optional. Boolean.	Indicates whether the Training Center client attendee Feedback column is enabled.
`supportPanelists`	Optional. Boolean.	Indicates whether the client Panelists feature is enabled.
`supportQandA`	Optional. Boolean.	Indicates whether the Training Center client Q&A feature is enabled.
`supportRemoteComputer`	Optional. Boolean.	Indicates whether remote computer desktop sharing is enabled.
`supportShareWebContent`	Optional. Boolean.	Indicates whether sharing Web pages in the main Training Center panel is enabled.
`supportUCFRichMedia`	Optional. Boolean.	Indicates whether attendees are allowed to share UCF objects.
`switchPage`	Optional. Valid values are TRUE and FALSE.	Indicates whether page switching is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`teleconfLocation`	Optional. String.	Holds information about teleconferencing country location.
`telephonySupport`	Optional. Valid values are NONE, CALLIN, CALLBACK, and OTHER.	Indicates whether telephony is supported and, if so, in what mode. Default: NONE. Meanings are: ■ NONE: The session does not support telephony; for all other values, telephony is supported. ■ CALLIN: Call-in teleconference (attendees call in to join the meeting or session). ■ CALLBACK: Call-back teleconference (attendees receive a callback to join the meeting or session). ■ OTHER: Other teleconferencing service; in this case, you can describe the service using extTelephonyDescription.
`testID`	Required. Integer.	A unique ID identifying a test on the site.
`thirdReminder`	Optional. Enumerated string. Valid values are 15MIN, 30MIN, 1HR, 2HR, 24HR, 2DAY, 7DAY, and 14DAY.	Specifies when the third reminder is sent before the session starts. Default: 24HR. If null, reminder is deleted.
`thumbnail`	Optional. Valid values are TRUE and FALSE.	Indicates whether thumbnail is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`timeLimit`	Required. Integer.	Number of minutes allowed for test taking.
`timeLimit` (in SetScheduledTest)	Required. Choice. A valid child element is either noLimit or withinMinutes.	Holds a time limit choice for a scheduled test.
`timeLimit` (in ReserveLab)	Optional. Integer.	Number of minutes allowed per attendee. Default: 60
`timeZone`	Optional. If specified, must be a value from among those listed in Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the training session. Default is “GMT -08:00, Pacific Time (San Jose)””.
`timeZoneID`	Optional. An integer ranging from 0 to 61.	Determines the time zone for the geographic location of the session or Hands-on Lab. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.
`title`	Optional. Maximum of 128 characters.	The attendee’s title. Default is “”.
`title` (in test and libTest elements)	Required. String. Maximum of 128 characters.	Name of the test.
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in numbers are enabled.
`tollFreeNum`	Optional. String.	Returns the toll-free call-in number for Webex teleconferencing in a Webex training session. This element is only returned in GetTrainingSession and its value is ignored in Create/SetTrainingSession.
`tollNum`	Required if callInNum is specified. String.	Returns the toll call-in number for Webex teleconferencing in a Webex training session. This element is only returned in GetTrainingSession and its value is ignored in Create/SetTrainingSession.
`topic`	Required. String.	The Hands-on Lab topic.
`total`	Required if matchingRecords is specified. Integer.	Total number of records matching the query request.
`totalComputers`	Optional. Integer.	Total number of computers in the Handson Lab.
`trackingCode1..10`	Optional. Maximum of 128 characters.	Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
`trainingSessionRecord`	Optional. Valid values are TRUE and FALSE.	Indicates whether recording of training session is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`tspAccessCodeOrder`	Optional.	Holds the access codes in order.
`tspAccountIndex`	Optional. An integer ranging from 1 to 3.	Designates which of the subscriber's teleconferencing accounts (1-3) to use for the session. Requires enableTSP=TRUE and the user to have defined their teleconferencing service provider accounts in create/SetUser.
`type`	Optional. Valid values are MEMBER and VISITOR.	The Webex-maintained determination of whether the session participant represented by a service of this type is a member (registered on your Webex XML server as a user) or a visitor. Default: VISITOR.
`type` (in libTest element)	Required. Valid values are PRIVATE and SHARE.	Indicates the library type.
`type_label`	Required. String.	Identifies the type of the corresponding data object. For example, Participant Email or qti:identifier_string.
`url`	Optional. Maximum of 128 characters.	The attendee’s URL, such as the URL of the attendee’s office. Default is “”.
`use`	Optional. String.	Indicates the name of the session template whose settings are used for session scheduling options.
`validateFormat`	Optional. Valid values are TRUE and FALSE.	Indicates whether the training session is validated when created or modified.
`varequal`	Required. String.	Indicates the value of the variable.
`veryLargeSess`	Optional. Valid values are TRUE and FALSE.	Indicates whether the training session will have more than 500 attendees.
`voip`	Optional. Valid values are TRUE and FALSE.	Indicates whether voice communications over the Internet (VoIP) is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`webExId`	Optional. Maximum of 64 characters.	A reference to the Webex user account for the session participant.
`website`	Required. Container.	Sets the scheduled test delivery method to website; holds the website delivery details. Only session or website can be specified as the scheduled test delivery method.
`webTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether Web tour is supported for training session of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.
`weekInMonth`	Optional. Integer.	For a recurring event, on which week of the month it recurs.
`withinMinutes`	Required. Integer.	Sets a time limit for the scheduled test.
`zipCode`	Optional. Maximum of 16 characters.	The ZIP Code portion of the attendee’s address. Default is “”.
`zoom`	Optional. Valid values are TRUE and FALSE.	Indicates whether zooming is supported for sessions of this type. If this element is unspecified, its value will default to the session template specified in: `<sessionTemplate> <use>Template Name</use> </sessionTemplate>` If a template name is not specified, setting: `<sessionTemplate> <default>true</default> </sessionTemplate>` will use the default template for the Meeting Type.

Complex Types Used By The Training Session Service

The following diagrams show the complex types used by the Training Session Service.

Event Center Sessions

This section provides descriptions of the Webex XML API's for the Event Center service. Samples are given for the outbound request messages and expected server response messages. The table below lists the available XML Requests for this service.

Table 7-1 • Webex XML Request Messages Related to Event Center Operations

*XML Request Message*	*Description*
`CreateEvent`	Schedule a new Event Center session.
`DelEvent`	Delete a previously scheduled Event.
`GetEvent`	Returns information for an existing Event.
`LstrecordedEvent`	Returns a list of recorded Events.
`LstsummaryEvent`	Returns a list of scheduled Events.
`LstsummaryProgram`	Returns a list of the programs that are associated with an Event Center enabled Webex site.
`SendInvitationEmail`	Send invitation email messages to Event participants for a previously scheduled Event.
`SetEvent`	Update a previously scheduled Event.
`UploadEventImage`	Add a picture to the description of a previously scheduled Event.

CreateEvent

Allows event session hosts to schedule a new event session. This API filters for unsafe HTML input fields. See Table 2-8, “HTML Tags Checked” for the fields affected.

Note: Lower Case email address modification

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

Figure 7-1 • Schema diagram for createEvent

The ability to programmatically assign an Event Center event to a specific program can now be done from the scheduling web pages.

The CreateEvent API allows you to specify whether or not attendees can join the teleconference before the host does. This functionality is located in the schedule element. It also adds the functionality to determine whether or not participant callers will be muted upon joining the meeting.

An “Include iCalendar Attachments” options has been incorporated.

The <endURLAfterEnroll> field redirects an attendee to a designated page after registering for an Event session.

The CreateEvent API supports Join Before Host Telephony for TSP sessions. It also supports the <panelistsInfo> field that is part of Event Center.

The following sample XML document shows an example that creates a new event service instance named “Example1112”.

<?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.event.CreateEvent">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>111111</sessionPassword>
            </accessControl>
            <schedule>
                <startDate>04/05/2004 10:00:00</startDate>
                <duration>60</duration>
                <timeZoneID>45</timeZoneID>
                <entryExitTone>NOTONE</entryExitTone>
            </schedule>
            <enrollment>
                <endURLAfterEnroll>www.yahoo.com</endURLAfterEnroll>
            </enrollment>
            <metaData>
                <sessionName>Example1112</sessionName>
                <sessionType>9</sessionType>
                <description>this is a test</description>
            </metaData>
            <telephony>
                <telephonySupport>CALLIN</telephonySupport>
                <enableTSP>true</enableTSP>
                <tspAccountIndex>1</tspAccountIndex>
                <muteUponEntry>true</muteUponEntry>
            </telephony>
            <tracking>
                <trackingCode1>test1</trackingCode1>
                <trackingCode2>test2</trackingCode2>
                <trackingCode3>test3</trackingCode3>
                <trackingCode4>test4</trackingCode4>
                <trackingCode5>test5</trackingCode5>
                <trackingCode6>test6</trackingCode6>
                <trackingCode7>test7</trackingCode7>
                <trackingCode8>test8</trackingCode8>
                <trackingCode9>test9</trackingCode9>
                <trackingCode10>test10</trackingCode10>
            </tracking>
            <panelists>
                <panelistPassword>String</panelistPassword>
                <panelist>
                    <name>panelist01</name>
                    <title>panelistTitle</title>
                    <company>webex</company>
                    <webExId>test</webExId>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <address1>String1</address1>
                        <address2>String2</address2>
                        <city>String1</city>
                        <state>String2</state>
                        <zipCode>215011</zipCode>
                        <country>china</country>
                    </address>
                    <phones>
                        <phone>123456</phone>
                        <mobilePhone>0123545</mobilePhone>
                        <fax>0123545</fax>
                    </phones>
                    <email>stevez@sz.webex.com</email>
                    <notes>String</notes>
                    <url>String</url>
                    <type>PANELIST</type>
                </panelist>
            </panelists>
            <attendees>
                <attendee>
                    <name>attendee01</name>
                    <title>attendeeTitle</title>
                    <company>webex</company>
                    <webExId>test</webExId>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <address1>String1</address1>
                        <address2>String2</address2>
                        <city>String1</city>
                        <state>String2</state>
                        <zipCode>215011</zipCode>
                        <country>china</country>
                    </address>
                    <phones>
                        <phone>456566</phone>
                        <mobilePhone>9076</mobilePhone>
                        <fax>46</fax>
                    </phones>
                    <email>test@sz.webex.com</email>
                    <notes>String</notes>
                    <url>String</url>
                    <type>VISITOR</type>
                </attendee>
            </attendees>
            <extOptions>
                <enrollmentNumber>100</enrollmentNumber>
                <destinationURL>String</destinationURL>
                <allowInviteFriend>true</allowInviteFriend>
                <viewAttendeeList>HOST,PRESENTER,PANELISTS</viewAttendeeList>
            </extOptions>
            <emailTemplates>
                <format>TEXT</format>
                <invitationMsgs>
                    <participantsEmail>
                        <subject>Your invitation to -- %Topic%</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %ParticipantName%, %HostName% has invited you
                            to attend a Webinar on the web using Webex. Topic: %Topic%
                            Date: %MeetingDate% Time: %MeetingTime%, %EventTimeZone%
                            Enrollment password: %RegistrationPassword% To attend
                            this webinar, you must first register for it. Please click
                            the following link to see more information about and
                            register for this event. Once you have registered for the
                            session, you will receive an email message confirming your
                            registration. This message will provide the information
                            that you need to join the session. Please click the
                            following link to see more information about the event and
                            register. %MeetingInfoURL% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </participantsEmail>
                    <panelistsEmail>
                        <subject>
                            You're invited to be a panelist a Webinar: -- %Topic%
                        </subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %PanelistName%, %HostName% has invited you to
                            be a panelist in a Webinar on the web using Webex. Topic:
                            %Topic% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Event Number: %MeetingNumber% Event
                            Entrance for Attendees: %MeetingInfoURL% Panelist
                            Password: %PanelistPassword% (Please do not share
                            panelist password) Teleconference: %TeleconferenceInfo%
                            %PanelistJoinBeforeHost% %PanelistEntranceURL%
                            %UCFAttendeeVerifyPlayers% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </panelistsEmail>
                </invitationMsgs>
                <enrollmentMsgs>
                    <pendingEmail>
                        <subject>Enrollment Pending</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %AttendeeName%, Your registration for this
                            event is now pending. Topic: %Topic% Date: %MeetingDate%
                            Time: %MeetingTime%, %EventTimeZone% We will send an
                            updated email to you once your status changes. To contact
                            %HostName%, call %HostPhone% send a message to this
                            address: %HostEmail% %EmailFooter%
                        </content>
                        <send>true</send>
                    </pendingEmail>
                </enrollmentMsgs>
                <reminderMsgs>
                    <firstReminder>
                        <subject>Event Reminder</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Dear %AttendeeName%, This is a reminder that you
                            have enrolled in %Topic%. We look forward to seeing you
                            online at this event.
                            Event Information: Event: %Topic% Event Number:
                            %MeetingNumber% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Please join us at least 10 minutes prior
                            to the presentation to ensure the automatic system set-up
                            has been properly established. %UCFAttendeeVerifyPlayers%
                            Attendee Instructions:
                            1) Direct your web browser to %MeetingInfoURL% 2) Locate
                            the event on the list 3) Click the Join button for this
                            event 3a) If prompted, enter the enrollment ID:
                            %EnrollmentID% 4) If prompted, enter the password:
                            %EventPassword% Teleconference Information: Dial the
                            appropriate number according to your geographic location:
                            %TeleconferenceInfo% For operator assistance, please dial
                            *0 on your touch-tone phone. If you have any questions or
                            require online assistance, please contact the event
                            coordinator. Sincerely, Your Webex Event Center Team.
                            Webex Events Requirements: -
                            Internet connection=56K kbps connection or better(AOL
                            users: AOL5.0 and above only) -Netscape 4.x or Internet
                            Explorer 4.x and above -For teleconference participants,
                            a separate telephone line is required (in addition to the
                            line used to dial up to ISP, if applicable)
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </firstReminder>
                </reminderMsgs>
                <followUpMsgs>
                    <thanksForAttending>
                        <subject>Event Thank you</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %AttendeeName%, Thank you for attending the
                            event %Topic% on %MeetingDate%. If you have comments or
                            questions concerning the event, you can contact %HostName%
                            by: Phone: %HostPhone% Email: %HostEmail% We look forward
                            to seeing you again. %EmailFooter%
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </thanksForAttending>
                </followUpMsgs>
            </emailTemplates>
            <enrollment>
                <idReq>true</idReq>
                <passwordReq>true</passwordReq>
                <password>password</password>
                <approvalReq>true</approvalReq>
                <approvalRules>
                    <rule>
                        <enrollFieldID>-4</enrollFieldID>
                        <condition>CONTAINS</condition>
                        <queryField>query word</queryField>
                        <action>REJECT</action>
                        <matchCase>false</matchCase>
                    </rule>
                </approvalRules>
            </enrollment>
            <enrollmentForm>
                <standardFields>
                    <city>
                        <incl>true</incl>
                        <req>false</req>
                    </city>
                    <state>
                        <incl>true</incl>
                        <req>false</req>
                    </state>
                </standardFields>
                <customFields>
                    <textBox>
                        <incl>true</incl>
                        <req>true</req>
                        <label>old</label>
                        <type>SINGLE_LINE</type>
                        <width>50</width>
                    </textBox>
                    <checkBoxGroup>
                        <incl>true</incl>
                        <req>false</req>
                        <label>sex</label>
                        <checkBox>
                            <label>man</label>
                            <score>1</score>
                            <state>SELECTED</state>
                        </checkBox>
                        <checkBox>
                            <label>woman</label>
                            <score>2</score>
                            <state>CLEARED</state>
                        </checkBox>
                    </checkBoxGroup>
                </customFields>
            </enrollmentForm>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

For enrollment, reminder, and follow-up email messages, your event service website sends them automatically. However, you can also send those messages manually at any time after you schedule or update the event, or take actions upon the enrollment requests.

For invitation emails, your event service website does not send them automatically. You need to call the SendInvitationEmail API to send the invitation email messages to invited attendees and panelists. For details, please refer to “SendInvitationEmail”. You can also send those messages on the Event Information page, after you schedule or update the event.

Response

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

Figure 7-2 • Schema diagram for `createEventResponse`

The following 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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:createEventResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:sessionKey>804606039</event:sessionKey>
            <event:guestToken>66d8f3aae7e410a9ed2d1e95bd6486f4</event:guestToken>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

DelEvent

Allows event session hosts to delete their own previously scheduled event sessions.

If a call is made to delSession, delEvent, or delTrainingSession to delete an already started EC or TC session, the server returns an exception (ID=060042). Once a session starts, it cannot be deleted or changed.

Request

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

Figure 7-3 • Schema diagram for `delEvent`

The following sample XML document deletes the event session with the sessionKey value of 46401604. Be sure that your request provides a valid value for your site.

<?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.event.DelEvent">
            <sessionKey>46401604</sessionKey>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-4 • Schema diagram for `delEventResponse`

The sample XML document shows an example of a possible response to the preceding delEvent request 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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:DelEventResponse"
            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. See Global Response Elements Showing Results and Errors.

GetEvent

Allows hosts to get detailed information of their own sessions by specifying corresponding session keys.

Note Site administrators or hosts can only get information of the event sessions scheduled or owned by themselves. An exceptionID of 000001 is returned if a user tries to get information of the sessions scheduled by other hosts.

Request

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

Figure 7-5 • Schema diagram for `getEvent`

The sample XML document gets the detailed information of the event session with the sessionKey value of 46401604. Be sure to provide a valid value for your website.

<?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.event.GetEvent">
            <sessionKey>46401604</sessionKey>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-6 • Schema diagram for `getEventResponse`

The ability to programmatically assign an Event Center event to a specific program can be done from the scheduling web pages.

The GetEventResponse message allows you to see whether or not attendees can join the teleconference before the host does. This functionality is located in the schedule element. It also adds the functionality to determine whether or not participant callers will be muted upon joining the meeting.

Note the “Include iCalendar Attachments” option that allows you to specify whether to attach an iCal file to the response.

The <endURLAfterEnroll> element redirects an attendee to a designated page after registering for an Event session.

The GetEventResponse message allows hosts to create a survey for attendees to take after an event. The GetEventResponse includes the <panelistsInfo> field in Event Center.

The following sample XML document shows an example of a possible response to the preceding getEvent request 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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
        <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:getEventResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:accessControl>
                <event:listing>PUBLIC</event:listing>
                <event:sessionPassword>111111</event:sessionPassword>
            </event:accessControl>
            <event:metaData>
                <event:sessionName>EC post event survey</event:sessionName>
                <event:sessionType>1027</event:sessionType>
                <event:description />
                <event:postEventSurvey>
                    <event:display>POPUP_WINDOW</event:display>
                </event:postEventSurvey>
            </event:metaData>
            <event:schedule>
                <event:startDate>04/05/2004 10:00:00</event:startDate>
                <event:timeZoneID>45</event:timeZoneID>
                <event:duration>60</event:duration>
                <event:openTime>15</event:openTime>
                <event:hostWebexID>hostid</event:hostWebexID>
                <event:entryExitTone>NOTONE</event:entryExitTone>
            </event:schedule>
            <event:telephony>
                <event:telephonySupport>NONE</event:telephonySupport>
                <event:numPhoneLines>0</event:numPhoneLines>
                <event:enableTSP>false</event:enableTSP>
                <event:tspAccountIndex>0</event:tspAccountIndex>
            </event:telephony>
            <event:tracking>
                <com:trackingCode1>test1</com:trackingCode1>
                <com:trackingCode2>test2</com:trackingCode2>
                <com:trackingCode3>test3</com:trackingCode3>
                <com:trackingCode4>test4</com:trackingCode4>
                <com:trackingCode5>test5</com:trackingCode5>
                <com:trackingCode6>test6</com:trackingCode6>
                <com:trackingCode7>test7</com:trackingCode7>
                <com:trackingCode8>test8</com:trackingCode8>
                <com:trackingCode9>test9</com:trackingCode9>
                <com:trackingCode10>test10</com:trackingCode10>
            </event:tracking>
            <event:remind>
                <event:minutesAhead>15</event:minutesAhead>
            </event:remind>
            <event:panelists>
                <event:panelistPassword>String</event:panelistPassword>
                <event:panelist>
                    <com:name>panelist01</com:name>
                    <com:title>panelistTitle</com:title>
                    <com:company>webex</com:company>
                    <com:webExId>panelist01</com:webExId>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                        <com:address1>String1</com:address1>
                        <com:address2>String2</com:address2>
                        <com:city>String1</com:city>
                        <com:state>String2</com:state>
                        <com:zipCode>215011</com:zipCode>
                        <com:country>china</com:country>
                    </com:address>
                    <com:phones>
                        <com:phone>123456</com:phone>
                        <com:mobilePhone>0123545</com:mobilePhone>
                        <com:fax>0123545</com:fax>
                    </com:phones>
                    <com:email>stevez@sz.webex.com</com:email>
                    <com:notes>String</com:notes>
                    <com:type>PANELIST</com:type>
                </event:panelist>
            </event:panelists>
            <event:attendees>
                <event:attendee>
                    <com:name>attendee01</com:name>
                    <com:title>attendeeTitle</com:title>
                    <com:company>webex</com:company>
                    <com:webExId>attendee01</com:webExId>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                        <com:address1>String1</com:address1>
                        <com:address2>String2</com:address2>
                        <com:city>String1</com:city>
                        <com:state>String2</com:state>
                        <com:zipCode>215011</com:zipCode>
                        <com:country>china</com:country>
                    </com:address>
                    <com:phones>
                        <com:phone>456566</com:phone>
                        <com:mobilePhone>9076</com:mobilePhone>
                        <com:fax>46</com:fax>
                    </com:phones>
                    <com:email>test@sz.webex.com</com:email>
                    <com:notes>String</com:notes>
                    <com:type>VISITOR</com:type>
                </event:attendee>
            </event:attendees>
            <event:extOptions>
                <event:enrollmentNumber>100</event:enrollmentNumber>
                <event:destinationURL>String</event:destinationURL>
                <event:allowInviteFriend>true</event:allowInviteFriend>
                <event:viewAttendeeList>HOST,PRESENTER,PANELISTS
                </event:viewAttendeeList>
            </event:extOptions>
            <event:emailTemplates>
                <event:format>TEXT</event:format>
                <event:invitationMsgs>
                    <event:participantsEmail>
                        <event:subject>Your invitation to -- %Topic%</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %ParticipantName%, %HostName% has
                            invited you to attend a Webinar on the web using Webex.
                            Topic: %Topic% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Enrollment password:
                            %RegistrationPassword% To attend this webinar, you must
                            first register for it. Please click the following link to
                            see more information about and register for this event.
                            Once you have registered for the session, you will receive
                            an email message confirming your registration. This
                            message will provide the information that you need to join
                            the session. Please click the following link to see more
                            information about the event and register.
                            %MeetingInfoURL% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </event:content>
                    </event:participantsEmail>
                    <event:panelistsEmail>
                        <event:subject>
                            You're invited to be a panelist a Webinar: -- %Topic%
                        </event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %PanelistName%, %HostName% has invited
                            you to be a panelist in a Webinar on the web using Webex.
                            Topic: %Topic% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Event Number: %MeetingNumber% Event
                            Entrance for Attendees: %MeetingInfoURL% Panelist
                            Password: %PanelistPassword% (Please do not share
                            panelist password) Teleconference: %TeleconferenceInfo%
                            %PanelistJoinBeforeHost% %PanelistEntranceURL%
                            %UCFAttendeeVerifyPlayers% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </event:content>
                    </event:panelistsEmail>
                </event:invitationMsgs>
                <event:enrollmentMsgs>
                    <event:pendingEmail>
                        <event:subject>Enrollment Pending</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %AttendeeName%, Your registration for
                            this event is now pending. Topic: %Topic% Date:
                            %MeetingDate% Time: %MeetingTime%, %EventTimeZone% We
                            will send an updated email to you once your status
                            changes. To contact %HostName%, call %HostPhone% send a
                            message to this address: %HostEmail% %EmailFooter%
                        </event:content>
                        <event:send>true</event:send>
                    </event:pendingEmail>
                </event:enrollmentMsgs>
                <event:reminderMsgs>
                    <event:firstReminder>
                        <event:subject>Event Reminder</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Dear %AttendeeName%, This is a reminder that
                            you have enrolled in %Topic%. We look forward to seeing
                            you online at this event.
                            Event Information: Event: %Topic% Event Number:
                            %MeetingNumber% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Please join us at least 10 minutes prior
                            to the presentation to ensure the automatic system set-up
                            has been properly established. %UCFAttendeeVerifyPlayers%
                            Attendee Instructions:
                            1) Direct your web browser to %MeetingInfoURL% 2) Locate
                            the event on the list 3) Click the Join button for this
                            event 3a) If prompted, enter the enrollment ID:
                            %EnrollmentID% 4) If prompted, enter the password:
                            %EventPassword% Teleconference Information: Dial the
                            appropriate number according to your geographic location:
                            %TeleconferenceInfo% For operator assistance, please dial
                            *0 on your touch-tone phone. If you have any questions or
                            require online assistance, please contact the event
                            coordinator. Sincerely, Your Webex Event Center Team.
                            Webex Events Requirements: -
                            Internet connection=56K kbps connection or better(AOL
                            users: AOL5.0 and above only) -Netscape 4.x or Internet
                            Explorer 4.x and above -For teleconference participants,
                            a separate telephone line is required (in addition to the
                            line used to dial up to ISP, if applicable)
                        </event:content>
                        <event:send>true</event:send>
                        <event:sendDateTime>05/20/2004 10:00:00</event:sendDateTime>
                    </event:firstReminder>
                </event:reminderMsgs>
                <event:followUpMsgs>
                    <event:thanksForAttending>
                        <event:subject>Event Thank you</event:subject>
                        <event:from>%SenderEmailAddress%</event:from>
                        <event:replyTo>%HostEmail%</event:replyTo>
                        <event:content>Hello %AttendeeName%, Thank you for attending
                            the event %Topic% on %MeetingDate%. If you have comments
                            or questions concerning the event, you can contact
                            %HostName% by: Phone: %HostPhone% Email: %HostEmail% We
                            look forward to seeing you again. %EmailFooter%
                        </event:content>
                        <event:send>true</event:send>
                        <event:sendDateTime>05/20/2004 10:00:00</event:sendDateTime>
                    </event:thanksForAttending>
                </event:followUpMsgs>
            </event:emailTemplates>
            <event:sessionKey>46401604</event:sessionKey>
            <event:status>NOT_INPROGRESS</event:status>
            <event:enrollment>
                <event:idReq>true</event:idReq>
                <event:passwordReq>true</event:passwordReq>
                <event:password>password</event:password>
                <event:approvalReq>true</event:approvalReq>
                <event:approvalRules>
                    <event:rule>
                        <event:enrollFieldID>-4</event:enrollFieldID>
                        <event:condition>CONTAINS</event:condition>
                        <event:queryField>query word</event:queryField>
                        <event:action>REJECT</event:action>
                        <event:matchCase>false</event:matchCase>
                        <event:enrollField>ZIPCode</event:enrollField>
                    </event:rule>
                </event:approvalRules>
                <event:endURLAfterEnroll>www.yahoo.com</event:endURLAfterEnroll>
            </event:enrollment>
            <event:enrollmentForm>
                <event:standardFields>
                    <event:firstName>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-14</event:fieldID>
                    </event:firstName>
                    <event:lastName>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-13</event:fieldID>
                    </event:lastName>
                    <event:emailAddress>
                        <event:incl>true</event:incl>
                        <event:req>true</event:req>
                        <event:fieldID>-12</event:fieldID>
                    </event:emailAddress>
                    <event:phone>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-11</event:fieldID>
                    </event:phone>
                    <event:company>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-10</event:fieldID>
                    </event:company>
                    <event:title>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-9</event:fieldID>
                    </event:title>
                    <event:numEmployees>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-2</event:fieldID>
                    </event:numEmployees>
                    <event:futureInfo>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-1</event:fieldID>
                    </event:futureInfo>
                    <event:address1>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-8</event:fieldID>
                    </event:address1>
                    <event:address2>
                        <event:incl>true</event:incl>
                        <event:req>false</event:req>
                        <event:fieldID>-7</event:fieldID>
                    </event:addres
                    <event:incl>true</event:incl>
                    <event:req>false</event:req>
                    <event:fieldID>-6</event:fieldID>
                </event:city>
                <event:state>
                    <event:incl>true</event:incl>
                    <event:req>false</event:req>
                    <event:fieldID>-5</event:fieldID>
                </event:state>
                <event:postalCode>
                    <event:incl>true</event:incl>
                    <event:req>false</event:req>
                    <event:fieldID>-4</event:fieldID>
                </event:postalCode>
                <event:country>
                    <event:incl>true</event:incl>
                    <event:req>false</event:req>
                    <event:fieldID>-3</event:fieldID>
                </event:country>
            </event:standardFields>
            <event:customFields>
                <event:textBox>
                    <event:incl>true</event:incl>
                    <event:req>true</event:req>
                    <event:label>sample text box</event:label>
                    <event:type>SINGLE_LINE</event:type>
                    <event:width>s50</event:width>
                    <event:height>0</event:height>
                    <event:fieldID>2111959119</event:fieldID>
                </event:textBox>
                <event:checkBoxGroup>
                    <event:incl>true</event:incl>
                    <event:req>false</event:req>
                    <event:label>sex</event:label>
                        <event:checkBox>
                            <event:label>man</event:label>
                            <event:score>1</event:score>
                            <event:state>SELECTED</event:state>
                        </event:checkBox>
                        <event:checkBox>
                            <event:label>woman</event:label>
                            <event:score>2</event:score>
                            <event:state>CLEARED</event:state>
                        </event:checkBox>
                        <event:fieldID>2111959124</event:fieldID>
                    </event:checkBoxGroup>
                </event:customFields>
            </event:enrollmentForm>
            <event:hostKey>795921</event:hostKey>
            <event:eventID>10765527</event:eventID>
            <event:guestToken>59c812d323d586fc0ae2bba9ae804b3f</event:guestToken>
            <event:hostType>1019001</event:hostType>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

LstRecordedEvent

Lists all the recorded events stored at the site.

Note Site administrators can retrieve all the recorded events on their sites, but regular hosts can only retrieve the recorded events of their own.

Request

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

Figure 7-7 • Schema diagram for `lstRecordedEvent`

The sample XML document is a query for all the recorded events at the user’s current site.

<?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.event.LstrecordedEvent">
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>OR</listMethod>
            </listControl>
            <dateScope>
                <startDateStart>11/01/2003 10:00:00</startDateStart>
                <startDateEnd>11/30/2004 10:00:00</startDateEnd>
                <endDateStart>11/01/2003 10:00:00</endDateStart>
                <endDateEnd>11/30/2004 10:00:00</endDateEnd>
                <timeZoneID>45</timeZoneID>
            </dateScope>
            <order>
                <orderBy>EVENTNAME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>HOSTWEBEXID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-8 • Schema diagram for `lstRecordedEventResponse`

The sample XML document shows an example of a possible response to the preceding lstRecordedEvent request 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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:lstrecordedEventResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:matchingRecords>
                <serv:total>4</serv:total>
                <serv:returned>4</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </event:matchingRecords>
            <event:event>
                <event:webExID>ian</event:webExID>
                <event:recordedEvent>
                    <event:eventName>by ian 1-20070710 0220</event:eventName>
                    <event:eventType>Unlisted</event:eventType>
                    <event:recordingStartTime>07/09/2007 15:39:47
                    </event:recordingStartTime>
                    <event:timeZoneID>0</event:timeZoneID>
                    <event:playTime>4</event:playTime>
                    <event:description> </event:description>
                    <event:size>125166</event:size>
                    <event:isAccessPassword>false</event:isAccessPassword>
                    <event:isEnrollmentPassword>false</event:isEnrollmentPassword>
                    <event:hostWebexID>ian</event:hostWebexID>
                    <event:viewURL>https://lmec1000.webex.com/lmec1000/onstage/g.p
                        hp?AT=VR&RecordingID=3695887&viewType=0&recordKey=A5BAC3EAB
                        315221641507BACC15CDE89B4626DBFFBBFF5881142F1FCE14423F7
                    </event:viewURL>
                </event:recordedEvent>
            </event:event>
            <event:event>
                <event:webExID>ian</event:webExID>
                <event:recordedEvent>
                    <event:eventName>by ian 2-20070710 0229</event:eventName>
                    <event:eventType>Unlisted</event:eventType>
                    <event:recordingStartTime>07/09/2007 15:39:48
                    </event:recordingStartTime>
                    <event:timeZoneID>0</event:timeZoneID>
                    <event:playTime>4</event:playTime>
                    <event:description> </event:description>
                    <event:size>2587041</event:size>
                    <event:isAccessPassword>false</event:isAccessPassword>
                    <event:isEnrollmentPassword>false</event:isEnrollmentPassword>
                    <event:hostWebexID>ian</event:hostWebexID>
                    <event:viewURL>https://lmec1000.webex.com/lmec1000/onstage/g.p
                        hp?AT=VR&RecordingID=3695912&viewType=0&recordKey=F7BF0FAA4
                        737AEEFEF227EC58490812509CF937DEFE4A568C67E28272F74A2BE
                    </event:viewURL>
                </event:recordedEvent>
            </event:event>
            <event:event>
                <event:webExID>ian</event:webExID>
                <event:recordedEvent>
                    <event:eventName>by ian with 10 tracking codes-20070710 0405
                    </event:eventName>
                    <event:eventType>Unlisted</event:eventType>
                    <event:recordingStartTime>07/09/2007 17:11:30
                    </event:recordingStartTime>
                    <event:timeZoneID>0</event:timeZoneID>
                    <event:playTime>4</event:playTime>
                    <event:description> </event:description>
                    <event:size>408183</event:size>
                    <event:isAccessPassword>false</event:isAccessPassword>
                    <event:isEnrollmentPassword>false</event:isEnrollmentPassword>
                    <event:hostWebexID>ian</event:hostWebexID>
                    <event:viewURL>https://lmec1000.webex.com/lmec1000/onstage/g.p
                        hp?AT=VR&RecordingID=3696052&viewType=0&recordKey=3C874CD45
                        68C10CB48E4D488A28172FB0AA75BA5A5D22A5F9CA4AF4D94BBA899
                    </event:viewURL>
                </event:recordedEvent>
            </event:event>
            <event:event>
                <event:webExID>ian</event:webExID>
                <event:recordedEvent>
                    <event:eventName>mp3</event:eventName>
                    <event:eventType>Unlisted</event:eventType>
                    <event:recordingStartTime>07/12/2007 18:30:00
                    </event:recordingStartTime>
                    <event:timeZoneID>4</event:timeZoneID>
                    <event:playTime>60</event:playTime>
                    <event:description>fdsa</event:description>
                    <event:recordFilePath>
                        /webex_doc/seminar/0&#19990;&#20107;&#22914;&#26827;.mp3
                    </event:recordFilePath>
                    <event:destinationURL>http://</event:destinationURL>
                    <event:size>5142561</event:size>
                    <event:isAccessPassword>false</event:isAccessPassword>
                    <event:isEnrollmentPassword>false</event:isEnrollmentPassword>
                    <event:hostWebexID>ian</event:hostWebexID>
                    <event:viewURL>https://lmec1000.webex.com/lmec1000/onstage/g.p
                        hp?AT=VR&RecordingID=3696302&viewType=0&recordKey=D302A20A3
                        15526E32CA79965E86AFF331E9CCB983397A42066C8FF14C4601449
                    </event:viewURL>
                </event:recordedEvent>
            </event:event>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

LstsummaryEvent

Lists all the scheduled events on the current site.

Note Site administrators can list event sessions scheduled by all users on the site. Regular hosts can list only their own sessions of any access type (i.e., PUBLIC, PRIVATE, and UNLISTED).

Request

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

Figure 7-9 • Schema diagram for `lstsummaryEvent`

The sample XML document lists all the scheduled event sessions on the current 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.event.LstsummaryEvent">
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>OR</listMethod>
            </listControl>
            <order>
                <orderBy>HOSTWEBEXID</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>EVENTNAME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>STARTTIME</orderBy>
                <orderAD>ASC</orderAD>
            </order>
            <dateScope>
                <startDateStart>03/10/2004 00:00:00</startDateStart>
                <timeZoneID>45</timeZoneID>
            </dateScope>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-10 • Schema diagram for `lstsummaryEventResponse`

Figure 7-10a • Schema diagram for `eventSummaryInstanceType`

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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:lstsummaryEventResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:matchingRecords>
                <serv:total>8</serv:total>
                <serv:returned>3</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </event:matchingRecords>
            <event:event>
                <event:sessionKey>23357393</event:sessionKey>
                <event:sessionName>ec 0000000000</event:sessionName>
                <event:sessionType>9</event:sessionType>
                <event:hostWebexID>bill</event:hostWebexID>
                <event:startDate>04/03/2004 10:00:00</event:startDate>
                <event:endDate>04/03/2004 11:00:00</event:endDate>
                <event:timeZoneID>45</event:timeZoneID>
                <event:duration>60</event:duration>
                <event:description>xbxbxcxcbbsbsd</event:description>
                <event:status>NOT_INPROGRESS</event:status>
                <event:panelists>georgew</event:panelists>
                <event:listStatus>PUBLIC</event:listStatus>
            </event:event>
            <event:event>
                <event:sessionKey>77555295</event:sessionKey>
                <event:sessionName>ec8888888</event:sessionName>
                <event:sessionType>9</event:sessionType>
                <event:hostWebexID>bill</event:hostWebexID>
                <event:startDate>04/02/2004 01:06:49</event:startDate>
                <event:endDate>04/02/2004 02:06:49</event:endDate>
                <event:timeZoneID>4</event:timeZoneID>
                <event:duration>60</event:duration>
                <event:description>ascacacacaas</event:description>
                <event:status>NOT_INPROGRESS</event:status>
                <event:panelists />
                <event:listStatus>PUBLIC</event:listStatus>
            </event:event>
            <event:event>
                <event:sessionKey>11756692</event:sessionKey>
                <event:sessionName>eventnagasdasd</event:sessionName>
                <event:sessionType>9</event:sessionType>
                <event:hostWebexID>bill</event:hostWebexID>
                <event:startDate>04/02/2004 04:30:00</event:startDate>
                <event:endDate>04/02/2004 05:30:00</event:endDate>
                <event:timeZoneID>4</event:timeZoneID>
                <event:duration>60</event:duration>
                <event:description>fyugjgbuygigbhjkbk</event:description>
                <event:status>NOT_INPROGRESS</event:status>
                <event:panelists />
                <event:listStatus>PUBLIC</event:listStatus>
            </event:event>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

LstSummaryProgram

Retrieves a list of programs that are associated with an Event Center service website.

Request

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

Figure 7-12 • Schema diagram of `lstSummaryProgram`

Note When you specify the programID element, the request returns information about a specific program (campaign); otherwise, all programs associated with an Event Center site are returned.

The sample XML document retrieves information about an Event Center program with a specified program ID.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>host</webExID>
            <password>pass</password>
            <siteName>evat26</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.event.LstsummaryProgram">
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-13 • Schema diagram for `lstsummaryProgramResponse`

XSD Diagram of lstsummaryProgramResponse

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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:lstsummaryProgramResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:matchingRecords>
                <serv:total>2</serv:total>
                <serv:returned>2</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </event:matchingRecords>
            <event:program>
                <event:programID>4342</event:programID>
                <event:programName>program1</event:programName>
                <event:hostWebexID>hostid</event:hostWebexID>
                <event:expectedEnrollment>100</event:expectedEnrollment>
                <event:budget>200</event:budget>
                <event:status>PUBLIC</event:status>
                <event:programURL>
                    https://evat26.webex.com/evat26/onstage/g.php?p=0&t=m
                </event:programURL>
                <event:afterEnrollmentURL>http://www.abc.com
                </event:afterEnrollmentURL>
            </event:program>
            <event:program>
                <event:programID>4347</event:programID>
                <event:programName>program2</event:programName>
                <event:hostWebexID>hostid</event:hostWebexID>
                <event:expectedEnrollment>50</event:expectedEnrollment>
                <event:budget>2000</event:budget>
                <event:status>UNLISTED</event:status>
                <event:programURL>
                    https://evat26.webex.com/evat26/onstage/g.php?p=2&t=m
                </event:programURL>
                <event:afterEnrollmentURL>http://www.abc.com
                </event:afterEnrollmentURL>
            </event:program>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

SendInvitationEmail

The SendInvitationEmail API allows the event host to send invitation emails to event participants.

For invitation email messages to attendees: - If it is a PRIVATE event session, the template titled “Invitee Invitation for Private Event” is used. - If it is a PUBLIC or UNLISTED event session, the template titled “Invitee Invitation for Public or Unlisted Event” is used. - If it is an event session in progress, the template titled “Event In Progress Invitation” is used.

For the invitation email messages to panelists, the template titled “Panelist Invitation” is always used.

Request

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

Figure 7-14 • Schema diagram for `sendInvitationEmail`

The following sample XML document shows an example that sends invitation emails for an event session with sessionKey 46401604. Be sure in your request to provide a valid value for your site.

<?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.event.SendInvitationEmail">
            <sessionKey>46401604</sessionKey>
            <attendees>true</attendees>
            <panelists>false</panelists>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-15 • Schema diagram for `sendInvitationEmailResponse`

XSD Diagram of sendInvitationEmailResponse

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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:sendInvitationEmailResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <event:deliveredEmail>test1@webex.com</event:deliveredEmail>
            <event:deliveredEmail>test2@webex.com</event:deliveredEmail>
        </serv:bodyContent>
    </serv:body> </serv:message>

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

SetEvent

Updates an existing event 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

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

Figure 7-16 • Schema diagram for `setEvent`

Note

The ability to programmatically assign an Event Center event to a specific program can now be done from the scheduling web pages.
SetEvent 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. It also adds the functionality to determine whether or not participant callers will be muted upon joining the meeting.
The <endURLAfterEnroll> field redirects an attendee to a designated page after registering for an Event session.
SetEvent supports Join Before Host Telephony for TSP sessions.
An “Include iCalendar Attachments” options has been incorporated. This is supported by T25L and above releases.
SetEvent now supports the <panelistsInfo> field in Event Center.

The sample XML document requests to update an event session with the sessionKey value of 46401604. Be sure to provide valid values for your website.

<?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.event.SetEvent">
            <accessControl>
                <listing>PUBLIC</listing>
                <sessionPassword>String123</sessionPassword>
            </accessControl>
            <schedule>
                <startDate>5/22/2004 10:00:00</startDate>
                <duration>60</duration>
                <timeZoneID>45</timeZoneID>
                <entryExitTone>BEEP</entryExitTone>
            </schedule>
            <metaData>
                <sessionName>APICreateEvent01</sessionName>
                <sessionType>9</sessionType>
                <description>APItest</description>
            </metaData>
            <telephony>
                <telephonySupport>NONE</telephonySupport>
            </telephony>
            <tracking>
                <com:trackingCode1>String</com:trackingCode1>
                <com:trackingCode2>String</com:trackingCode2>
                <com:trackingCode3>String</com:trackingCode3>
                <com:trackingCode4>String</com:trackingCode4>
                <com:trackingCode5>String</com:trackingCode5>
                <com:trackingCode6>String</com:trackingCode6>
                <com:trackingCode7>String</com:trackingCode7>
                <com:trackingCode8>String</com:trackingCode8>
                <com:trackingCode9>String</com:trackingCode9>
                <com:trackingCode10>String</com:trackingCode10>
            </tracking>
            <panelists>
                <panelistPassword>String</panelistPassword>
                <panelist>
                    <com:name>panelist01</com:name>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                        <com:address1>String</com:address1>
                        <com:address2>String</com:address2>
                        <com:city>String</com:city>
                        <com:state>String</com:state>
                        <com:zipCode>String</com:zipCode>
                        <com:country>String</com:country>
                    </com:address>
                    <com:phones>
                        <com:phone>Stringphone</com:phone>
                        <com:mobilePhone>StringmobilePhone</com:mobilePhone>
                        <com:fax>String</com:fax>
                    </com:phones>
                    <com:email>String@dgd.com</com:email>
                    <com:notes>String</com:notes>
                    <com:type>VISITOR</com:type>
                </panelist>
            </panelists>
            <attendees />
            <extOptions>
                <enrollmentNumber>88</enrollmentNumber>
                <destinationURL>StringdestinationURL</destinationURL>
                <allowInviteFriend>1</allowInviteFriend>
                <viewAttendeeList>ALL</viewAttendeeList>
            </extOptions>
            <emailTemplates>
                <format>TEXT</format>
                <invitationMsgs>
                    <participantsEmail>
                        <subject>Your invitation to -- %Topic%</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %ParticipantName%, %HostName% has invited you
                            to attend a Webinar on the web using Webex. Topic: %Topic%
                            Date: %MeetingDate% Time: %MeetingTime%, %EventTimeZone%
                            Enrollment password: %RegistrationPassword% To attend
                            this webinar, you must first register for it. Please click
                            the following link to see more information about and
                            register for this event. Once you have registered for the
                            session, you will receive an email message confirming your
                            registration. This message will provide the information
                            that you need to join the session. Please click the
                            following link to see more information about the event and
                            register. %MeetingInfoURL% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </participantsEmail>
                    <panelistsEmail>
                        <subject>
                            You're invited to be a panelist a Webinar: -- %Topic%
                        </subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %PanelistName%, %HostName% has invited you to
                            be a panelist in a Webinar on the web using Webex. Topic:
                            %Topic% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Event Number: %MeetingNumber% Event
                            Entrance for Attendees: %MeetingInfoURL% Panelist
                            Password: %PanelistPassword% (Please do not share
                            panelist password) Teleconference: %TeleconferenceInfo%
                            %PanelistJoinBeforeHost% %PanelistEntranceURL%
                            %UCFAttendeeVerifyPlayers% To contact %HostName%,
                            %PhoneContactInfo% send a message to this address:
                            %HostEmail% %EmailFooter%
                        </content>
                    </panelistsEmail>
                </invitationMsgs>
                <enrollmentMsgs>
                    <pendingEmail>
                        <subject>Enrollment Pending</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %AttendeeName%, Your registration for this
                            event is now pending. Topic: %Topic% Date: %MeetingDate%
                            Time: %MeetingTime%, %EventTimeZone% We will send an
                            updated email to you once your status changes. To contact
                            %HostName%, call %HostPhone% send a message to this
                            address: %HostEmail% %EmailFooter%
                        </content>
                        <send>true</send>
                    </pendingEmail>
                </enrollmentMsgs>
                <reminderMsgs>
                    <firstReminder>
                        <subject>Event Reminder</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Dear %AttendeeName%, This is a reminder that you
                            have enrolled in %Topic%. We look forward to seeing you
                            online at this event.
                            Event Information: Event: %Topic% Event Number:
                            %MeetingNumber% Date: %MeetingDate% Time: %MeetingTime%,
                            %EventTimeZone% Please join us at least 10 minutes prior
                            to the presentation to ensure the automatic system set-up
                            has been properly established. %UCFAttendeeVerifyPlayers%
                            Attendee Instructions:
                            1) Direct your web browser to %MeetingInfoURL% 2) Locate
                            the event on the list 3) Click the Join button for this
                            event 3a) If prompted, enter the enrollment ID:
                            %EnrollmentID% 4) If prompted, enter the password:
                            %EventPassword% Teleconference Information: Dial the
                            appropriate number according to your geographic location:
                            %TeleconferenceInfo% For operator assistance, please dial
                            *0 on your touch-tone phone. If you have any questions or
                            require online assistance, please contact the event
                            coordinator. Sincerely, Your Webex Event Center Team.
                            Webex Events Requirements: -
                            Internet connection=56K kbps connection or better(AOL
                            users: AOL5.0 and above only) -Netscape 4.x or Internet
                            Explorer 4.x and above -For teleconference participants,
                            a separate telephone line is required (in addition to the
                            line used to dial up to ISP, if applicable)
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </firstReminder>
                </reminderMsgs>
                <followUpMsgs>
                    <thanksForAttending>
                        <subject>Event Thank you</subject>
                        <from>%SenderEmailAddress%</from>
                        <replyTo>%HostEmail%</replyTo>
                        <content>Hello %AttendeeName%, Thank you for attending the
                            event %Topic% on %MeetingDate%. If you have comments or
                            questions concerning the event, you can contact %HostName%
                            by: Phone: %HostPhone% Email: %HostEmail% We look forward
                            to seeing you again. %EmailFooter%
                        </content>
                        <send>true</send>
                        <sendDateTime>05/20/2004 10:00:00</sendDateTime>
                    </thanksForAttending>
                </followUpMsgs>
            </emailTemplates>
            <event:sessionKey>46401604</event:sessionKey>
            <enrollment>
                <idReq>true</idReq>
                <passwordReq>true</passwordReq>
                <password>password</password>
                <approvalReq>true</approvalReq>
                <approvalRules>
                    <rule>
                        <enrollFieldID>-4</enrollFieldID>
                        <condition>CONTAINS</condition>
                        <queryField>query word</queryField>
                        <action>REJECT</action>
                        <matchCase>false</matchCase>
                    </rule>
                </approvalRules>
            </enrollment>
            <enrollmentForm>
                <standardFields>
                    <city>
                        <incl>true</incl>
                        <req>false</req>
                    </city>
                    <state>
                        <incl>true</incl>
                        <req>false</req>
                    </state>
                </standardFields>
                <customFields>
                    <textBox>
                        <incl>true</incl>
                        <req>true</req>
                        <label>old</label>
                        <type>SINGLE_LINE</type>
                        <width>50</width>
                        <fieldID>2111959119</fieldID>
                    </textBox>
                    <checkBoxGroup>
                        <incl>true</incl>
                        <req>false</req>
                        <label>sex</label>
                        <checkBox>
                            <label>man</label>
                            <score>1</score>
                            <state>SELECTED</state>
                        </checkBox>
                        <checkBox>
                            <label>woman</label>
                            <score>2</score>
                            <state>CLEARED</state>
                        </checkBox>
                        <fieldID>2111959124</fieldID>
                    </checkBoxGroup>
                </customFields>
            </enrollmentForm>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-17 • Schema diagram for `setEventResponse`

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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:SetEventResponse"
            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. See Global Response Elements Showing Results and Errors.

UploadEventImage

Allows the event host to add an image to an event description. An event session can have one image at most.

Note The image file should be in GIF or JPG format, approximately 75x38 pixels in dimensions, and less than 100 KB in file size.

Request

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

Figure 7-18 • Schema diagram for uploadEventImage

The sample XML document uploads an image file to the event session with the sessionKey value of 46401604. Be sure to provide a valid value for your website.

<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <header>
        <securityContext>
            <siteName>acme</siteName>
            <webExID>hostid@acme.com</webExID>
            <password>hostpassword</password>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.event.UploadEventImage">
            <sessionKey>46401604</sessionKey>
            <imageType>JPG</imageType>
            <imageData>Base64Binary encoded data of JPG/GIF image</imageData>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context.

For descriptions of the non-global elements, see Elements in the Event Session Service.

Response

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

Figure 7-19 • Schema diagram for uploadEventImageResponse

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:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="event:UploadEventImageResponse"
            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. See Global Response Elements Showing Results and Errors.

Elements in Webex XML Schema Definitions for the Event Session Service

The following table describes all the elements that are used in the Webex XML API for the service of event sessions.

*Element*	*Constraint(s)*	*Description*
`absenteeFollowUp`	Optional. Complex.	Defines the template for Absentee Followup Email that is sent to the enrollees who did not attend the event session.
`acceptedEmail`	Optional. Complex.	Defines the template for Enrollment Accepted Email which notifies an enrollee that his or her enrollment request has been accepted by the host.
`action`	Required. Enumeration. Valid values are REJECT and APPROVE.	Indicates which action to take upon the attendees' enrollments according to the approval rules. Default is REJECT.
`address1`	Optional. Maximum of 128 characters.	The first line of the attendee's street address. Default is "".
`address2`	Optional. Maximum of 128 characters.	The second line of the attendee's street address. Default is "".
`addressType`	Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered Webex user.	Determines whether the session participant is a personal contact of the session host or is a site-wide (global) contact. Default is PERSONAL.
`afterEnrollmentURL`	Optional. String.	The URL after a program enrollment.
`allowInviteFriend`	Optional. Boolean. Valid values are TRUE and FALSE.	Indicates whether the current event session allows its attendee to invite a friend to the session. Default is TRUE.
`approvalReq`	Optional. Boolean. Valid values are TRUE and FALSE.	Indicates whether the current event session requires enrollment. Default is TRUE.
`assistConfirm`	Optional. Enum {Pending, Confirmed, Canceled}	Assist meeting's confirm type. Defaults to Pending.
`assistRequest`	Optional. Enum {None, Dry Run, Consult, Live Event Support, Audio Streaming, Video}	Assist meeting's request type. Defaults to None.
`attendees`	Optional. Boolean. Valid values are TRUE and FALSE.	Indicates whether to send invitation email messages to attendees. Default is TRUE.
`avgLeadScore`	Required. Float.	The average score of the leading user.
`broadcastAudioStream`	Boolean. Optional. Default value is FALSE.	Indicates whether the audio streaming broadcast of a teleconference of an event session is enabled. Note: `If you want to use audio streaming, your Webex service site should have the multimedia platform option enabled.`
`budget`	Optional. String.	The budget for one program.
`city`	Optional. Maximum of 64 characters.	The attendee's city. Default is "".
`company`	Optional. Maximum of 128 characters.	The attendee's company name. Default is "".
`condition`	Required. Enumeration. Valid values are CONTAINS, DOESNOT_CONTAIN, BEGINS_WITH, and ENDS_WITH.	Specifies the conditions for the approval rules upon attendee enrollments. Default is CONTAINS.
`content`	Optional. String.	The body text in an email template.
`count`	Required. Long.	The source count.
`country`	Optional. Maximum of 64 characters.	The attendee's country. Default is "".
`countryAlias`	Required. String.	Holds a country's alias.
`default`	Optional. Boolean.	Indicates whether to use the site default session template of a service for session scheduling. Default: FALSE.
`defaultChoice`	Optional. Integer.	Indicates the index number of the default choice.
`defaultHighestMT`	Optional. Boolean. Defaults to TRUE.	This element is used in conjunction with the sessionType element to set the session type when creating an Event Center session. If sessionType is specified, then CreateEvent will use this session type and defaultHighestMT will be ignored. If sessionType is unspecified, then: ■ If defaultHighestMT = TRUE (the default), CreateEvent will use the highest Event session type available for a host. ■ If defaultHighestMT = FALSE, CreateEvent will use the default Event session type = 9. Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Event Center session type available for a host.
`deliveredEmail`	Optional. Enumerated string.	Address of invitation emails that have been sent successfully. Default is "".
`description`	Optional. Required for Create. Maximum of 2500 characters.	The description of the event session.
`destinationURL`	Optional. String.	The URL for accessing the recorded event session.
`display`	Optional. Enum {NO_DISPLAY, POPUP_WINDOW, MAIN_WINDOW}	Determines how to display a post event survey to attendees.
`displayQuickStartHost`	Optional. Boolean.	Indicates whether the Quick Start tab in the session manager is displayed to the host and presenter as they enter an event session.
`duration`	Optional. If populated, must be a positive integer.	The duration of the event session in minutes.
`email`	Required if attendee or panelist element is specified. String.	The email address of the corresponding attendee or panelist.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`emailInvitations`	Optional. Valid values are TRUE and FALSE.	Whether to send invitation email messages to the meeting session attendees. Default is FALSE.
`enableTSP`	Optional. Valid values are TRUE and FALSE.	Enables the integrated partner Teleconferencing Service Provider functionality.
`endDate`	Optional. String.	The ending date and time of the event session. Formatted as MM/DD/YYYY HH:MM:SS.
`endDateEnd`	Optional. String.	End of range of dates from which a user can select for the end date for an event session. Formatted as MM/DD/YYYY HH:MM:SS.
`endDateStart`	Optional.	Beginning of range of dates from which a user can select for the end date for an event session. Formatted as MM/DD/YYYY HH:MM:SS.
`endURLAfterEnroll`	Optional. String (max length of 128).	The destination URL after attendee enrollment.
`enforcePassword`	Optional. Boolean. Default value is FALSE.	If TRUE, throw an exception when specified sessionPassword does not meet any of the strict password criteria defined in the Site Administration tool. To enforce password security when creating an Event with XML API, make sure you have both selected the Apply strict password option and defined strict password criteria in Site Administration, and then set this element to TRUE. If FALSE, the session password will not be checked for security even if Apply strict password is selected in Site Administration.
`enrollField`	Required. String.	Name of an enrollment field.
`enrollFieldID`	Required. Long.	Unique identifier for an enrollment field that the approval rule applies to. Default is -13.
`enrollmentNumber`	Optional. Integer.	Maximum number of enrollments for the event session.
`entryExitTone`	Optional. Enumerated string. Valid values are NOTONE, BEEP, ANNOUNCENAME.	The sound that all attendees hear when an attendee joins or exits the event session.
`estAttendance`	Required. Long.	Holds the estimated attendance.
`estEnrollment`	Required. Long.	Holds the estimated enrollment.
`eventID`	Optional. Long.	An internal unique ID number for an Event Center session. Equivalent to sessionKey.
`eventName`	Required. String.	The name of the recorded event.
`eventType`	Required. String.	List status of the recorded event session. Valid values are PUBLIC and PRIVATE. For more information, see listStatus.
`eventUpdatedEmail`	Optional. Complex.	Defines the template for Event Updated Email which notifies an enrollee that the event has been updated by the host.
`expectedEnrollment`	Optional. String.	The expected enrollment for one program.
`extNotifyTime`	Optional. Integer.	The number of times to notify someone.
`extTelephonyDescription`	Optional. Maximum of 2,048 characters.	A description of your telephony services if you use your own as indicated in extTelephonyURL and in telephonySupport. By default, this is "Enter teleconference number, pass code, and other instructions here."
`extTelephonyURL`	Optional. Maximum of 2,048 characters.	The URL of your telephony server if you want to use it as an alternative to Webex to support the session's voice communications (session is still recordable). Can be set only if you have super admin privilege.
`extURL`	Optional. String.	External URL.
`fax`	Optional. Maximum of 64 characters.	The user's fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`fieldID`	Optional. Long.	Unique identifier generated by the API server for the field.
`firstReminder`	Optional. Complex.	Defines the template for First Reminder Email which notifies an enrollee that he or she has enrolled an event with the event information included.
`format`	Optional. Enumeration. Valid values are TEXT and HTML.	Specifies the email format for all email templates. Default is TEXT.
`from`	Optional. String. Maximum of 128 characters.	Indicates the email address of the sender.
`futureInfo`	Optional. Complex.	Allows the attendees to specify whether they would like to receive information about future seminars via email messages.
`globalNum`	Optional. Container.	Corresponds to the Global Call-in Numbers in the telephony domain.
`guestToken`	Optional. String.	Contains the guest's token for a session.
`height`	Optional. Integer.	Specifies the number of lines for the text box on the enrollment form.
`hostKey`	Optional. String.	The host key of a session host. The host key allows the host to pass privileges to another attendee or to reclaim the host role upon rejoining a session.
`hostType`	Optional. String.	Returns a code that specifies the application used to schedule and start the meeting. hostType has the following format xyyyzzz where: ■ (x) Meeting type: 1 - Regular, 2 - oneclick. ■ (yyy) Scheduled from: 001 - webpage, 002 - PT, 003 - OI, 004 - NI, 005 - MSN, 006 - Yahoo, 007 - AIM, 008 - Skype, 009 - Gtalk, 010 - Sametime, 011 - LCS, 012 - WebexToolbar, 013 - IPPhone, 016 - iPhone dusting, 017 - Webex Connect, 018 - TP meeting, 019 - generic XML API app. ■ (zzz) Started from: Uses the same codes as yyy.
`hostWebexID`	String.	The user name of a host.
`iCalendar`	Optional. Boolean. Valid values are TRUE and FALSE.	Mapping to EC scheduler page "include iCalendar attachments" options, determines whether or not to send the including iCalendar attachment. Defaults to either the Meeting Template or Site setting.
`idReq`	Optional. Boolean. Valid values are TRUE and FALSE.	Specifies whether the current event session requires attendees to provide enrollment ID before they can join. Default is FALSE. Note: `The value switches to TRUE if passwordReq=TRUE`.
`imageData`	Required. Base64Binary encoded data.	The Base64Binary encoded data of the JPG/GIF image that the host uploads.
`imageType`	Required. Enumeration. Valid values are JPG and GIF.	The image type for the picture that the host uploads.
`incl`	Optional. Boolean. Valid values are TRUE and FALSE.	Specifies whether to include current field in the enrollment form. Default is TRUE.
`index`	Optional. Integer.	Indexing number of the item.
`intLocalCallIn`	Optional. Valid values are TRUE and FALSE.	Allows access to Webex teleconferencing via international local call-in telephone numbers in a Webex event. Default: FALSE.
`intLocalNum`	Optional. String.	Returns the international local call-in telephone numbers for Webex teleconferencing in an event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
`isAccessPassword`	Optional. Valid values are TRUE and FALSE.	Whether accessing the recorded event requires password.
`isEnrollmentPassword`	Optional. Valid values are TRUE and FALSE.	Whether the event session requires a password for enrollment. The default value is FALSE.
`joinNotifyURL`	Optional. String.	URL of the notification message.
`joinTeleconfBeforeHost`	Optional. Valid values are TRUE and FALSE.	Determines whether or not attendees are allowed to join the teleconference before the host. Defaults to FALSE.
`label`	Required. String. Maximum of 256 characters.	Specifies the label for the current field. Default is "".
`leadSourceID`	Required. String.	The ID of the leading user.
`listing`	Optional.	Indicates which users can see this scheduled session in lists of events on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host. ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users. Default is PUBLIC.
`listMethod`	Optional. Enumerated string. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in "Specifying Boolean Relationships for Searches" on page 55. Default is AND.
`listStatus`	Optional.	Indicates which users can see this scheduled session in lists of events on pages on your Webex-hosted website. Valid values are: ■ UNLISTED: Unlisted for all users except the host. ■ PUBLIC: Listed for all users. ■ PRIVATE: Listed only for authorized users.
`matchCase`	Optional. Boolean. Valid values are TRUE and FALSE.	Specifies whether the query field of the approval rule is case sensitive. Default is FALSE.
`matchingRecords`	Optional.	Contains information about the returned records. See also total, returned, and startFrom for more information.
`maximumNum`	Optional. Integer.	Limits the quantity of returned records as described in "Choosing A Subset of Records" on page 54.
`minutesAhead`	Optional. Integer.	Number of minutes ahead of the event session to send the reminding messages.
`mobilePhone`	Optional. Maximum of 64 characters.	The user's mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`muteUponEntry`	Optional. Valid values are TRUE and FALSE.	Determines whether or not all participant callers will be muted upon joining the meeting. Defaults to FALSE.
`name`	Required for each attendee or panelist specified. Maximum of 64 characters.	The name of the session participant (attendee or panelist).
`notes`	Optional. Maximum of 2,048 characters.	The host's notes about the session attendee or panelist. Default is "".
`numEmployees`	Optional. Complex.	Allows the enrollee to specify the number of employees in his or her organization.
`numPhoneLines`	Optional. If populated, must be a nonzero value.	The number of phone lines to reserve, when using Webex-supplied telephony, for the session. By accurately forecasting this number, you enable Webex to reserve the appropriate number of phone lines for the event. Default: 4.
`openTime`	Optional. Integer. Valid values are 0, 5, 10, 15, 20, 30, 45, and 60.	Defines the number of minutes allowed for the attendees to join the event session before the start time. Default is 15. Note: `Specifying a value other than the valid values may cause problems.`
`orderAD`	Optional. Valid values are ASC and DESC.	Whether to sort the result in ascending or descending order when using orderBy.
`orderBy`	Optional. Enumerated string. Valid values are EVENTNAME, STARTTIME and HOSTWEBEXID.	Which elements to sort by in the sessions returned.
`panelistPassword`	Optional. String.	Session password of a panelist.
`panelists`	Optional. Boolean. Valid values are TRUE and FALSE.	Indicates whether to send invitation email messages to panelists. Default is FALSE.
`panelistsEmail`	Optional. Complex.	Defines the template for Panelists Invitation Email that is sent to all panelists of the event session.
`panelistsInfo`	Optional. String.	Panelists Info for a scheduled event.
`participantLimit`	Optional. Integer.	Maximum number of participants allowed.
`participantsEmail`	Optional. Complex.	Defines the template for Invitee Invitation Email that is sent to all invited participants of the event session. Note: `If the event session's listing status is PRIVATE, this template is titled "Invitee Invitation for Private Event"; otherwise, this template is titled "Invitee Invitation for Public or Unlisted Event".`
`password`	Optional. String. Maximum of 16 characters.	The password for the attendees when they enroll for the event. Default is "".
`passwordReq`	Optional. Boolean. Valid values are TRUE and FALSE.	Specifies whether the current event session requires attendees to provide password before they can enroll. Default is FALSE. Note: `The value switches to TRUE if the host specifies an enrollment password when scheduling.`
`pendingEmail`	Optional. Complex.	Defines the template for Enrollment Pending Email that notifies an enrollee that his or her enrollment status is now pending.
`personalAccountIndex`	Optional. Integer.	The index number of the personal teleconference account to be used; if not specified, then personal teleconferencing is not used.
`phone`	Optional. Maximum of 64 characters.	The user's phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`phoneNumber`	Required. String.	Holds the global phone number.
`playTime`	Optional. Integer.	The duration of the recorded event session.
`postalCode`	Optional. Maximum of 16 characters.	The postal code of the enrollee's address. Default is "".
`postEventSurvey`	Optional. Container.	Holds the post event survey fields.
`programID`	Optional. Long.	The identifier for a program (campaign).
`programID` (in metaData element)	Optional. Integer.	Assigns the program identifier for an event. Default is 0.
`programName`	Required. String.	The topic for one program in a returned set of programs.
`programURL`	Optional. String.	The URL of a Web page for one program.
`queryField`	Required. String. Maximum of 50 characters.	The query word that matches the approval rule. Default is "". Note: `Quotation marks are not allowed in the queryField.`
`recordFilePath`	Optional. String.	The file path of the recorded event session on the server.
`recordingStartTime`	Optional. String.	The starting time of the recording.
`registration`	Optional. Boolean. Valid values are TRUE and FALSE.	Indicates whether or not the event requires registration.
`rejectedEmail`	Optional. Complex.	Defines the template for Enrollment Rejected Email that notifies an enrollee that his or her enrollment request has been declined by the host.
`replyTo`	Optional. String. Maximum of 128 characters.	The email address for the recipients to send reply email messages.
`req`	Optional. Boolean. Valid values are TRUE and FALSE.	Specifies whether to make the current field required in the enrollment form. Default is FALSE.
`returned`	Required. Integer.	Number of records returned in this response. See also matchingRecords.
`score`	Optional. Integer.	The score for current field.
`secondReminder`	Optional. Complex.	Defines the template for First Reminder Email which notifies an enrollee that he or she has enrolled an event with the event information included.
`send`	Optional. Boolean. Valid values are TRUE and FALSE.	Whether to send current email message. Default is TRUE.
`sendDateTime`	Optional. String.	Specifies the time to send current email message. Default is session scheduled start time. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionKey`	Required for Get, Set, and Del. Optional for Lst. Not applicable for Create. Must be non-null.	A Webex-assigned session-unique value that is needed to identify the particular event session.
`sessionName`	Required for Create. String.	The name of the event session.
`sessionPassword`	Optional. Maximum of 16 characters.	The password for the event session. If a value is specified, then attendees are prompted for a password before they can join the event session. A null password for this element is the same as not using this element. The event session password will be validated against the password security options (if enabled) in the Site Administration tool. If the password security rules are violated, an exception occurs.
`sessionType`	Optional. Integer.	In CreateEvent, if sessionType is specified, then CreateEvent will use this session type and defaultHighestMT will be ignored. If sessionType is unspecified, then: ■ If defaultHighestMT=TRUE (the default), CreateEvent will use the highest Event session type available for a host. ■ If defaultHighestMT=FALSE, CreateEvent will use the default Event session type = 9. Most applications should leave sessionType and defaultHighestMT unspecified, which will automatically select the preferred highest Event Center session type available for a host. In GetEventResponse, returns the session type of an Event session. In SetEvent, updates the session type of an Event session.
`size`	Required. Integer.	The file size of the recorded event.
`startDate`	Optional. String.	The starting date and time of the event session. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateEnd`	Optional. String.	End of range of dates from which a user can select for the start date for the event sessions. Formatted as MM/DD/YYYY HH:MM:SS.
`startDateStart`	Optional. String.	Beginning of range of dates from which a user can select for the start date for the event sessions. Formatted as MM/DD/YYYY HH:MM:SS.
`startFrom`	Required. Integer.	When a records set is returned, indicates the record index number from which the set starts. See also matchingRecords.
`state` (in attendee element)	Optional. Maximum of 32 characters.	The attendee's state of residence. Default is "".
`state` (in checkBox element)	Optional. Enumeration. Valid values are CLEARED and SELECTED.	The status of current check box. Default is CLEARED.
`status`	Optional. String. Valid values are INPROGRESS or NOT_INPROGRESS.	Indicates whether the session is either started and active or not active. Its value is generated by Webex and cannot be changed. Default: NOT_INPROGRESS.
`subject`	Optional. String. Maximum of 512 characters.	The subject of current email template.
`teleconfLocation`	Optional. String.	Holds information about teleconferencing country location.
`telephonySupport`	Optional. Valid values are NONE, CALLIN, CALLBACK, and OTHER.	Indicates whether telephony is supported and, if so, in what mode. Default: NONE. Meanings are: ■ NONE: The session does not support telephony; for all other values, telephony is supported. ■ CALLIN: Call-in teleconference (attendees call in to join the meeting or session). ■ CALLBACK: Call-back teleconference (attendees receive a callback to join the meeting or session). ■ OTHER: Other teleconferencing service; in this case, you can describe the service using extTelephonyDescription.
`thanksForAttending`	Optional. Complex.	Defines the template for Thanks For Attending Email that is sent to all participants after the event session ends.
`timeZoneID`	Optional. An integer ranging from 0 to 61.	Determines the time zone for the geographic location of the event. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.
`title`	Optional. Maximum of 128 characters.	The participant's title. Default is "".
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in numbers are enabled.
`tollFreeNum`	Optional. String.	Returns the toll-free call-in number for Webex teleconferencing in a Webex event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
`tollNum`	Required if callInNum is specified. String.	Returns the toll call-in number for Webex teleconferencing in a Webex event. This element is only returned in GetEvent and its value is ignored in Create/SetEvent.
`total`	Required. A positive integer.	Total number of records matching the query. See also matchingRecords.
`trackingCode1..10`	Optional. Maximum of 128 characters.	Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
`tspAccessCodeOrder`	Optional.	Determines in which order access codes should be used.
`tspAccountIndex`	Optional. An integer ranging from 1 to 3.	Designates which of the subscriber's teleconferencing accounts (1-3) to use for the session. Requires enableTSP=TRUE and the user to have defined their teleconferencing service provider accounts in create/SetUser.
`type` (in attendees or panelists element)	Optional. Valid values are MEMBER, VISITOR and PANELIST.	The Webex-maintained determination of whether the session participant (attendee or panelist) represented by a service of this type is a member (registered on your Webex XML server as a user) or a visitor or a panelist. Default: VISITOR.
`type` (in textBox element)	Optional. Enumeration.	Valid values are SINGLE_LINE and MULTI_LINE.
`url` (in attendee element)	Optional. Maximum of 128 characters.	The user's URL, such as the URL of the attendee's office. Default is "".
`use`	Optional. String.	Indicates the name of the session template whose settings are used for meeting scheduling options.
`viewAttendeeList`	Optional. Enumerated string.	Indicates the role that can view the attendee list. Valid values are: ■ ALL ■ HOST,PRESENTER,PANELISTS
`viewURL`	Required. String.	An URL string to access the streaming recording. Corresponds to "Stream recording link" in the web page.
`voip`	Optional. Valid values are TRUE and FALSE.	Specifies if voice over IP is enabled for the session. Default is defined in the Site Admin and session template.
`webExId`	Optional. Maximum of 64 characters.	A reference to the Webex user account for the session participant.
`width`	Optional. Integer.	Specifies the number of lines for the text box on the enrollment form.
`zipCode`	Optional. Maximum of 16 characters.	The ZIP Code portion of the participant's address. Default is "".

Complex Types Used By The Event Session Service

The following diagrams show the complex types used by the Event Session Service.

Schema diagram: `listControl` element

Figure 7A-01 • Schema diagram of `listControl` element

Schema diagram: `order` element

Figure 7A-02 • Schema diagram of `order` element

Schema diagram: `dateScope` element

Figure 7A-03 • Schema diagram of `dateScope` element)

Schema diagram: `matchingRecords` element

Figure 7A-04 • Schema diagram of `matchingRecords` element

Schema diagram: `attendeeCountType`

Figure 7A-05 • Schema diagram of `attendeeCount` element

Schema diagram: `source` element

Figure 7A-06 • Schema diagram of `source` element)

Support Center Service

The Webex Support Center service gives the end users the ability to receive a live assist from a Webex Support Center host. This section describes APIs that can be used to automate the creation of the Support Center sessions and collection of information from the Post-session feedback form.

Table 8-1 • Webex XML Request Messages related to Support Center Session Operations

*XML Request Message*	*Description*
`CreateSupportSession`	Schedule a new Support Center session.
`GetFeedbackInfo`	Returns information about post-session feedback form.

CreateSupportSession

Allows a customer support representative (CSR) to create a Support Session.

Request

The sample XML document shows an example of a request to create a new Support Session.

<?xml version="1.0" encoding="UTF-8"?> <serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service">
    <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.supportsession.CreateSupportSession">
            <metaData>
                <sessionType>13</sessionType>
            </metaData>
            <tracking>
                <trackingCode1>trackingCode1</trackingCode1>
                <trackingCode2>trackingCode2</trackingCode2>
                <trackingCode3>trackingCode3</trackingCode3>
                <trackingCode4>trackingCode4</trackingCode4>
                <trackingCode5>trackingCode5</trackingCode5>
                <trackingCode6>trackingCode6</trackingCode6>
                <trackingCode7>trackingCode7</trackingCode7>
                <trackingCode8>trackingCode8</trackingCode8>
                <trackingCode9>trackingCode9</trackingCode9>
                <trackingCode10>trackingCode10</trackingCode10>
            </tracking>
        </bodyContent>
    </body>
</serv:message>

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

Figure 8-1 • Schema diagram of `createSupportSession`

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non global elements, refer to Elements in Webex XML Schema Definitions for the Support Session 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:sc="http://www.webex.com/schemas/2002/06/service/supportsession">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="sc:createSupportSessionResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <sc:sessionKey>11916961</sc:sessionKey>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 8-2 • Schema diagram for `createSupportSessionResponse`

XSD Diagram of createSupportSessionResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

GetFeedbackInfo

Gets information about the post-session form that attendees fill in after a Support Center session ends.

Request

The sample XML document shows an example of getting feedback information with a specified conference ID.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service/service.xsd">
    <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.attendee.GetFeedbackInfo">
            <confID>62916711</confID>
        </bodyContent>
    </body>
</serv:message>

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

Schema diagram of `getFeedbackInfo`

Note One Support Center session may have multiple sub sessions (different confID but the same session key).

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: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="att:getFeedbackInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:session>
                <att:confID>62916711</att:confID>
                <att:attendee>
                    <att:attendeeID>58</att:attendeeID>
                    <att:feedbackFields>
                        <att:defaultFields>
                            <att:setup>Above average</att:setup>
                            <att:easeOfUse>Above average</att:easeOfUse>
                            <att:performance>Yes</att:performance>
                            <att:comment>test123456</att:comment>
                        </att:defaultFields>
                        <att:customFields>
                            <att:field>
                                <att:label>Other</att:label>
                                <att:value>other</att:value>
                            </att:field>
                        </att:customFields>
                    </att:feedbackFields>
                </att:attendee>
                <att:attendee>
                    <att:attendeeID>63</att:attendeeID>
                    <att:feedbackFields>
                        <att:defaultFields>
                            <att:setup>Average</att:setup>
                            <att:easeOfUse>Average</att:easeOfUse>
                            <att:performance>Not sure</att:performance>
                            <att:comment>test123456</att:comment>
                        </att:defaultFields>
                        <att:customFields>
                            <att:field>
                                <att:label>Other</att:label>
                                <att:value/>
                            </att:field>
                        </att:customFields>
                    </att:feedbackFields>
                </att:attendee>
                <att:matchingRecords>
                    <serv:total>2</serv:total>
                    <serv:returned>2</serv:returned>
                    <serv:startFrom>1</serv:startFrom>
                </att:matchingRecords>
            </att:session>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 8-4 • Schema diagram of `getFeedbackInfoResponse`

** (Part 2: The feedbackFields element)**

Figure 8-5 • Schema diagram of `session:feedbackSessionType`

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

Elements in Webex XML Schema Definitions for the Support Session Service

The following table describes all the elements that are used in Webex XML API for the support session service.

*Element*	*Constraint(s)*	*Description*
`attendeeID`	Required. Long.	Indicates the identifier of an attendee.
`comment`	Optional. String.	Different services have different meanings. In Support Center, it means any other suggestions.
`confID`	Required. Long.	The conference ID of a Support session.
`easeOfUse`	Optional. String.	Different services have different meanings. In Support Center, it means rating of the subject matter expertise of support representatives.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`label`	Required. String.	The label for a custom field.
`performance`	Optional. String.	Different services have different meanings. In Support Center, it means if the issues address to your satisfaction.
`returned`	Required. Integer.	Indicates the returned number of matched records.
`sessionKey`	Optional. Long.	Unique identifier for a session.
`sessionType`	Optional. Integer.	In CreateSupportSession, specifies the session type of the Support session to be created. If not specified, defaults to the highest Support session type allowed for a host. The standard session type for Support Center is 13.
`setup`	Optional. String.	Different services have different meanings. In Support Center, it means rating of overall experience.
`startFrom`	Required. Integer.	The record index number that the returned set starts from.
`total`	Required. Integer.	Indicates the total number of matched records.
`trackingCode1..10`	Optional. Maximum of 128 characters.	Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
`value`	Optional. String.	The value for a custom field.

Complex Types Used By The Support Session Service

The following diagrams show the complex types used by the Support Service.

The following schema diagram shows the structure of the tracking element.

Schema diagram: `tracking` element in the Support Service

Schema diagram of `tracking`

Schema diagram: `tracking` element in the Support Service

XSD Schema Diagram:

History Service

This section provides descriptions of the Webex XML API's for the History Service. The History Service provides access to usage data for Webex sessions hosted within the last 90 days. Samples are given for the outbound request messages and expected server response messages.

The table below lists the available XML Requests for the History Service.

Table 9-1 • Webex XML Request Messages Related to History Operations

*XML Request Message*	*Description*
`LsteventattendeeHistory`	Returns Event Attendee History.
`LsteventsessionHistory`	Returns Event Session History.
`LstmeetingattendeeHistory`	Returns Meeting Attendee History.
`LstmeetingusageHistory`	Returns Meeting Usage History.
`LstrecordaccessDetailHistory`	Returns detailed Recording Access History for Training Sessions.
`LstrecordaccessHistory`	Returns Recording Access History for Training Sessions.
`LstsupportattendeeHistory`	Returns Support Attendee History.
`LstsupportsessionHistory`	Returns Support Session History.
`LsttrainingattendeeHistory`	Returns Training Attendee History.
`LsttrainingsessionHistory`	Returns Training Session History.

LsteventattendeeHistory

Allows event hosts or site administrators to request detailed attendee information for the event sessions previously hosted on the site.

Note Site administrators can retrieve the attendee information of all the event sessions hosted on their sites, whereas regular hosts can only retrieve the attendee information of their own event sessions.

Request

The sample XML document shows an example of a request for attendee information related to the events hosted during 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.LsteventattendeeHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/08/2004 07:34:45
                </sessionStartTimeStart>
                <sessionStartTimeEnd>03/09/2004 09:34:45</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/08/2004 08:34:45</sessionEndTimeStart>
                <sessionEndTimeEnd>03/09/2004 10:34:45</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>AND</listMethod>
            </listControl>
            <order>
                <orderBy>ATTENDEENAME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>STARTTIME</orderBy>
                <orderAD>ASC</orderAD>
                <orderBy>CONFID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message></securityContext>

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

Figure 9-1 • Schema diagram for lsteventattendeeHistory

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:LsteventattendeeHistoryResponse"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <history:eventAttendeeHistory>
        <history:sessionKey>101316464</history:sessionKey>
        <history:attendeeName>1111 1111</history:attendeeName>
        <history:attendeeEmail>asdf@asdf.asdf</history:attendeeEmail>
        <history:startTime>03/09/2004 07:34:45</history:startTime>
        <history:endTime>03/09/2004 07:35:21</history:endTime>
        <history:duration>1</history:duration>
        <history:registered>N</history:registered>
        <history:invited>N</history:invited>
        <history:ipAddress>172.16.244.122</history:ipAddress>
        <history:participantType>ATTENDEE</history:participantType>
        <history:voipDuration>0</history:voipDuration>
        <history:clientAgent>Windows,IE</history:clientAgent>
        <history:confID>4686965</history:confID>
      </history:eventAttendeeHistory>
      <history:matchingRecords>
        <serv:total>15</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 lsteventattendeeHistoryResponse message.

Figure 9-2 • Schema diagram for lsteventattendeeHistoryResponse

Note The expanded diagram for history:reQandA and history:matchingRecords can be found in schema diagrams.

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

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

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.

LstmeetingattendeeHistory

Allows meeting hosts or site administrators to request detailed attendee information for any meeting session previously hosted on the site.

Note Host can only access the information of his or her own meeting attendees, but site administrator can access the attendee information of all the meetings previously hosted on his or her site.

Request

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

Figure 9-5 • Schema diagram for lstmeetingattendeeHistory

The sample XML document lists detailed attendee information of the meeting sessions hosted during 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.LstmeetingattendeeHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/28/2004 01:42:34
                </sessionStartTimeStart>
                <sessionStartTimeEnd>04/1/2004 02:42:34</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/28/2004 00:42:34</sessionEndTimeStart>
                <sessionEndTimeEnd>04/1/2004 02:42:34</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>10</serv:maximumNum>
                <serv:listMethod>OR</serv:listMethod>
            </listControl>
            <order>
                <orderBy>CONFID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
            <inclAudioOnly>TRUE</inclAudioOnly>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 9-6 • Schema diagram for lstmeetingattendeeHistoryResponse

Note The expanded diagram for history:matchingRecords can be found in schema diagrams.

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:LstmeetingattendeeHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:meetingAttendeeHistory>
                <history:meetingKey>94036066</history:meetingKey>
                <history:confName>java schedule for XML</history:confName>
                <history:ipAddress>172.16.244.151</history:ipAddress>
                <history:clientAgent>WINDOWS,IE</history:clientAgent>
                <history:name>java java</history:name>
                <history:email>java@sz.com</history:email>
                <history:joinTime>03/29/2004 02:42:34</history:joinTime>
                <history:leaveTime>03/29/2004 02:49:31</history:leaveTime>
                <history:duration>7</history:duration>
                <history:participantType>ATTENDEE</history:participantType>
                <history:voipDuration>0</history:voipDuration>
                <history:confID>4702323</history:confID>
            </history:meetingAttendeeHistory>
            <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 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”.

LstmeetingusageHistory

Allows meeting hosts or site administrators to request detailed usage data for previously hosted meeting sessions. This command enables external users and third-party systems to prepare flexible usage reports in formats other than Webex online reports.

Note A host can only access his or her own meeting history, but a site administrator can access the history of all the meetings hosted on his or her site. When a site administrator specifies a hostWebexID, the system will return the data of the specified host’s meetings; if a hostWebexID is not specified, all the meetings 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 shows an example of a request for all meetings the user hostid has previously hosted.

<?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.LstmeetingusageHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/29/2004 00:42:34
                </sessionStartTimeStart>
                <sessionStartTimeEnd>03/29/2004 04:42:34</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/29/2004 02:42:34</sessionEndTimeStart>
                <sessionEndTimeEnd>03/29/2004 05:42:34</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>10</serv:maximumNum>
                <serv:listMethod>OR</serv:listMethod>
            </listControl>
            <order>
                <orderBy>CONFNAME</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

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

Figure 9-7 • Schema diagram for lstmeetingusageHistory

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>
        LstmeetingusageHistory
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="history:LstmeetingusageHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:meetingUsageHistory>
                <history:sessionKey>94036066</history:sessionKey>
                <history:confName>java schedule for XML</history:confName>
                <history:meetingStartTime>03/29/2004 02:42:34
                </history:meetingStartTime>
                <history:meetingEndTime>03/29/2004 02:49:20
                </history:meetingEndTime>
                <history:duration>7</history:duration>
                <history:timezone>GMT-08:00, Pacific (San Jose)
                </history:timezone>
                <history:meetingType>PRO</history:meetingType>
                <history:hostWebexID>xml</history:hostWebexID>
                <history:hostName>xml</history:hostName>
                <history:hostEmail>xml@sz.webex.com</history:hostEmail>
                <history:totalCallInMinutes>0</history:totalCallInMinutes>
                <history:totalPeopleMinutes>7</history:totalPeopleMinutes>
                <history:totalCallInTollfreeMinutes>0
                </history:totalCallInTollfreeMinutes>
                <history:totalCallOutDomestic>0</history:totalCallOutDomestic>
                <history:totalCallOutInternational>0
                </history:totalCallOutInternational>
                <history:totalVoipMinutes>0</history:totalVoipMinutes>
                <history:userID>479422751</history:userID>
                <history:totalParticipants>1</history:totalParticipants>
                <history:totalParticipantsVoip>0</history:totalParticipantsVoip>
                <history:totalParticipantsCallIn>0
                </history:totalParticipantsCallIn>
                <history:totalParticipantsCallOut>0
                </history:totalParticipantsCallOut>
                <history:confID>4702323</history:confID>
                <history:peakAttendee>1</history:peakAttendee>
            </history:meetingUsageHistory>
            <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 lstmeetingusageHistoryResponse message.

Figure 9-8 • Schema diagram for lstmeetingusageHistoryResponse

Note You can see expanded diagrams for history:trackingCode and history:matchingRecords in schema diagrams.

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

LstrecordaccessDetailHistory

The lstrecordaccessDetailHistory API supports the recorded training access detail report.

Request

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

Figure 9-9 • Schema diagram for lstrecordaccessDetailHistory

Note The expanded diagram for history:listControlcan be found in schema diagrams.

The following XML example shows a typical lstrecordaccessDetailHistory request.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <siteID>20070951</siteID>
            <webExID>jasonc4</webExID>
            <password>pass</password>
            <partnerID>webexpartner</partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type=
            "java:com.webex.service.binding.history.lstrecordaccessDetailHistory">
            <recondID>5862</recondID>
            <timeZoneID>4</timeZoneID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 9-10 • Schema diagram for lstrecordaccessDetailHistoryResponse

Note The expanded diagram for hitosry:recordDetail can be found in Figure G-131 and history:matchingRecords can be found in schema diagrams.

The following XML example shows a typical lstrecordaccessDetailHistoryResponse.


<?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:lstrecordaccessDetailHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:recordDetail>
                <history:viewID>1307</history:viewID>
                <history:participantName>jason4 chencc</history:participantName>
                <history:participantEmail>jasonc@sz.webex.com
                </history:participantEmail>
                <history:accessTime>01/21/2008 17:16:03</history:accessTime>
                <history:registered>false</history:registered>
                <history:downloaded>false</history:downloaded>
                <history:viewed>true</history:viewed>
                <history:timeZoneID>4</history:timeZoneID>
            </history:recordDetail>
            <history:recordDetail>
                <history:viewID>1312</history:viewID>
                <history:participantName>jason4 chencc</history:participantName>
                <history:participantEmail>jasonc@sz.webex.com
                </history:participantEmail>
                <history:accessTime>01/22/2008 00:08:35</history:accessTime>
                <history:registered>false</history:registered>
                <history:downloaded>true</history:downloaded>
                <history:viewed>false</history:viewed>
                <history:timeZoneID>4</history:timeZoneID>
            </history:recordDetail>
            <history:matchingRecords>
                <serv:total>2</serv:total>
                <serv:returned>2</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </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”.

LstrecordaccessHistory

Provides the access details for a previously recorded training session.

Note Regular hosts can only retrieve the access information of their own recorded sessions, but site administrators can retrieve the access information of all the recorded sessions on their sites

Request

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

Figure 9-11 • Schema diagram for lstrecordaccessHistory

Note The expanded diagram for history:listControl can be found in schema diagrams.

The sample XML document queries for the access history for sessions that were recorded between October 16, 2003 and Oct. 19, 2003.


<?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.LstrecordaccessHistory">
            <creationTimeScope>
                <creationTimeStart>10/16/2003 08:16:56</creationTimeStart>
                <creationTimeEnd>10/19/2003 08:16:56</creationTimeEnd>
            </creationTimeScope>
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
            </listControl>
            <order>
                <orderBy>RECORDID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 9-12 • Schema diagram for lstrecordaccessHistoryResponse

Note The expanded diagram for history:matchingRecords can be found in schema diagrams.

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:lstrecordaccessHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:recordAccessHistory>
                <history:recordID>4134727</history:recordID>
                <history:recordName>TC recording</history:recordName>
                <history:creationTime>11/28/2008 05:51:24
                </history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>3</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>4137042</history:recordID>
                <history:recordName>TC siteadmin recording</history:recordName>
                <history:creationTime>12/09/2008 03:07:33</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:recordAccessHistory>
                <history:recordID>4137052</history:recordID>
                <history:recordName>TC recording2</history:recordName>
                <history:creationTime>12/09/2008 03:16:29</history:creationTime>
                <history:registered>0</history:registered>
                <history:downloaded>0</history:downloaded>
                <history:viewed>1</history:viewed>
                <history:timeZoneID>20</history:timeZoneID>
            </history:recordAccessHistory>
            <history:matchingRecords>
                <serv:total>3</serv:total>
                <serv:returned>3</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </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”.

LstsupportattendeeHistory

Allows support session hosts or site administrators to request detailed attendee information for any support session previously hosted on the site.

Note Site administrators can retrieve the attendee information of all the support sessions hosted on their sites, whereas regular hosts can only retrieve the attendee information of their own support sessions.

Request

The sample XML document queries for the attendee information of the support sessions hosted on the site during 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.LstsupportattendeeHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/28/2004 02:04:04
                </sessionStartTimeStart>
                <sessionStartTimeEnd>03/31/2004 02:04:04</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/28/2004 01:04:04</sessionEndTimeStart>
                <sessionEndTimeEnd>03/31/2004 04:04:04</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>5</serv:maximumNum>
                <serv:listMethod>AND</serv:listMethod>
            </listControl>
            <order>
                <orderBy>CONFID</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

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

Figure 9-17 • Schema diagram for lstsupportattendeeHistory

Response

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

Figure 9-18 • Schema diagram for lstsupportattendeeHistoryResponse

Note The expanded diagram for history:matchingRecords can be found in schema diagrams.

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:LstsupportattendeeHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:supportAttendeeHistory>
                <history:sessionKey>15375492</history:sessionKey>
                <history:attendeeName>java java</history:attendeeName>
                <history:attendeeEmail>java@sz.com</history:attendeeEmail>
                <history:startTime>03/29/2004 02:04:04</history:startTime>
                <history:endTime>03/29/2004 02:19:20</history:endTime>
                <history:duration>16</history:duration>
                <history:ipAddress>172.16.244.58</history:ipAddress>
                <history:participantType>HOST</history:participantType>
                <history:clientAgent>WINDOWS,IE</history:clientAgent>
                <history:confID>4702314</history:confID>
            </history:supportAttendeeHistory>
            <history:supportAttendeeHistory>
                <history:sessionKey>15375492</history:sessionKey>
                <history:attendeeName>ret</history:attendeeName>
                <history:attendeeEmail>robinl@sz.webex.com
                </history:attendeeEmail>
                <history:startTime>03/29/2004 02:17:09</history:startTime>
                <history:endTime>03/29/2004 02:19:20</history:endTime>
                <history:duration>3</history:duration>
                <history:ipAddress>172.16.244.34</history:ipAddress>
                <history:participantType>ATTENDEE</history:participantType>
                <history:clientAgent>WINDOWS,IE</history:clientAgent>
                <history:confID>4702314</history:confID>
            </history:supportAttendeeHistory>
            <history:matchingRecords>
                <serv:total>2</serv:total>
                <serv:returned>2</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </history:matchingRecords>
        </serv:bodyContent>
    </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”.

LstsupportsessionHistory

Allows support session hosts or site administrators to request detailed usage data for previously hosted support sessions.

Note A host can only access his or her own support session history, but a site administrator can access the history of all the support sessions hosted on his or her site. When a site administrator specifies a hostWebexID, the system will return the data of the specified host's support sessions; if a hostWebexID is not specified, all the support sessions on his or her site will be returned. If you are not a site administrator, the element hostWebexID will be ignored.

Request

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

Figure 9-19 • Schema diagram for lstsupportsessionHistory

The sample XML document queries for the support 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.LstsupportsessionHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/28/2004 03:04:03
                </sessionStartTimeStart>
                <sessionStartTimeEnd>03/31/2004 03:04:03</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/28/2004 03:04:03</sessionEndTimeStart>
                <sessionEndTimeEnd>03/31/2004 03:04:03</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>10</serv:maximumNum>
                <serv:listMethod>AND</serv:listMethod>
            </listControl>
            <order>
                <orderBy>CONFNAME</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

Response

Note The expanded diagram for history:matchingRecords{name="font" face="Georgia, Times New Roman, Times, serif"} can be found in Figure G-51.

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

Figure 9-20 • Schema diagram for lstsupportsessionHistoryResponse

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:LstsupportsessionHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:supportSessionHistory>
                <history:sessionKey>15375492</history:sessionKey>
                <history:confName>test join states 01</history:confName>
                <history:sessionStartTime>03/29/2004 02:04:03
                </history:sessionStartTime>
                <history:sessionEndTime>03/29/2004 02:19:09
                </history:sessionEndTime>
                <history:duration>16</history:duration>
                <history:timezone>4</history:timezone>
                <history:meetingType>SC3</history:meetingType>
                <history:hostWebexID>java</history:hostWebexID>
                <history:hostName>java</history:hostName>
                <history:hostEmail>java@sz.com</history:hostEmail>
                <history:totalPeopleMinutes>19</history:totalPeopleMinutes>
                <history:confID>4702314</history:confID>
                <history:peakAttendee>1</history:peakAttendee>
            </history:supportSessionHistory>
            <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 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”.

LsttrainingattendeeHistory

Allows training session hosts to request detailed attendee information for any training session previously hosted on the site.

Note Site administrators can retrieve the attendee information of all the training sessions hosted on their sites, but regular hosts can only retrieve the attendee information of their own training sessions.

Request

The sample XML document shows an example of a request to list the attendee information of the training sessions 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.LsttrainingattendeeHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/28/2004 02:31:24
                </sessionStartTimeStart>
                <sessionStartTimeEnd>03/31/2004 02:31:24</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/28/2004 00:31:24</sessionEndTimeStart>
                <sessionEndTimeEnd>04/1/2004 02:31:24</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>10</serv:maximumNum>
                <serv:listMethod>AND</serv:listMethod>
            </listControl>
            <order>
                <orderBy>NAME</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

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

Figure 9-21 • Schema diagram for lsttrainingattendeeHistory

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:LsttrainingattendeeHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:trainingAttendeeHistory>
                <history:sessionKey>87745560</history:sessionKey>
                <history:confName>java for XML schedule meeting
                </history:confName>
                <history:attendeeName>xml xml</history:attendeeName>
                <history:attendeeEmail>xml@sz.webex.com</history:attendeeEmail>
                <history:startTime>03/29/2004 01:31:25</history:startTime>
                <history:endTime>03/29/2004 01:41:35</history:endTime>
                <history:duration>11</history:duration>
                <history:ipAddress>172.16.244.151</history:ipAddress>
                <history:participantType>HOST</history:participantType>
                <history:voipDuration>0</history:voipDuration>
                <history:clientAgent>WINDOWS,IE</history:clientAgent>
                <history:confID>4702308</history:confID>
            </history:trainingAttendeeHistory>
            <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 lsttrainingattendeeHistoryResponse message.

Figure 9-22 • Schema diagram for lsttrainingattendeeHistoryResponse

Note For expanded diagrams of history:matchingRecords see schema diagrams.

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. See Global Response Elements Showing Results and Errors.

LsttrainingsessionHistory

Allows training session hosts or site administrators to request detailed usage data for previously hosted training sessions, such as the number of attendees, and the session duration. This command enables external users and third-party systems to prepare flexible usage reports in formats other than Webex online reports.

Note A host can only access his or her own training session history, but a site administrator can access the history of all the training sessions hosted on his or her site. When a site administrator specifies a hostWebexID, the system returns the data of the specified host's sessions; if a hostWebexID is not specified, all training sessions 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 shows an example of a request for a list of training sessions previously hosted on the site.

<?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.LsttrainingsessionHistory">
            <startTimeScope>
                <sessionStartTimeStart>03/28/2004 02:31:24
                </sessionStartTimeStart>
                <sessionStartTimeEnd>04/2/2004 02:31:24</sessionStartTimeEnd>
            </startTimeScope>
            <endTimeScope>
                <sessionEndTimeStart>03/28/2004 03:31:24</sessionEndTimeStart>
                <sessionEndTimeEnd>04/2/2004 03:31:24</sessionEndTimeEnd>
            </endTimeScope>
            <listControl>
                <serv:startFrom>1</serv:startFrom>
                <serv:maximumNum>12</serv:maximumNum>
                <serv:listMethod>AND</serv:listMethod>
            </listControl>
            <order>
                <orderBy>CONFNAME</orderBy>
                <orderAD>ASC</orderAD>
            </order>
        </bodyContent>
    </body>
</serv:message>

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

Figure 9-23 • Schema diagram for lsttrainingsessionHistory

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:LsttrainingsessionHistoryResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <history:trainingSessionHistory>
                <history:sessionKey>87745560</history:sessionKey>
                <history:confName>java for XML schedule meeting
                </history:confName>
                <history:sessionStartTime>03/29/2004 01:31:24
                </history:sessionStartTime>
                <history:sessionEndTime>03/29/2004 01:41:25
                </history:sessionEndTime>
                <history:duration>11</history:duration>
                <history:totalAttendee>1</history:totalAttendee>
                <history:totalRegistered>4</history:totalRegistered>
                <history:totalInvited>4</history:totalInvited>
                <history:timezone>4</history:timezone>
                <history:userID>479422751</history:userID>
                <history:hostWebexID>xml</history:hostWebexID>
                <history:hostEmail>xml@sz.webex.com</history:hostEmail>
                <history:totalPeopleMinutes>11</history:totalPeopleMinutes>
                <history:totalCallInMinutes>0</history:totalCallInMinutes>
                <history:totalCallInTolllfreeMinutes>0
                </history:totalCallInTolllfreeMinutes>
                <history:totalCallOutDomestic>0</history:totalCallOutDomestic>
                <history:totalCallOutInternational>0
                </history:totalCallOutInternational>
                <history:totalVoipMinutes>1</history:totalVoipMinutes>
                <history:totalParticipants>1</history:totalParticipants>
                <history:totalParticipantsVoip>0</history:totalParticipantsVoip>
                <history:totalParticipantsCallIn>0
                </history:totalParticipantsCallIn>
                <history:totalParticipantsCallOut>0
                </history:totalParticipantsCallOut>
                <history:confID>4702308</history:confID>
                <history:peakAttendee>1</history:peakAttendee>
            </history:trainingSessionHistory>
            <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 lsttrainingsessionHistoryResponse message.

Figure 9-24 • Schema diagram for lsttrainingsessionHistoryResponse

Note The expanded diagram for history:trackingCode can be found in schema diagrams and history:matchingRecords can be found in schema diagrams.

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”.

Elements in Webex XML Schema Definitions for the History Service

The following table describes all the elements that are used in the Webex XML API for the service for history.

*Element*	*Constraint(s)*	*Description*
`accessTime`	Optional. String.	Holds when the record was accessed.
`account`	Optional. String.	Filters by account.
`address1`	Optional. String.	Session participant's address line 1.
`address2`	Optional. String.	Session participant's address line 2.
`attendeeEmail`	Optional. String.	Session participant's email address.
`attendeeName`	Optional. String.	Session participant's name.
`attendeeStats`	Optional. Valid values are TRUE or FALSE.	Determines if the status of an attendee is displayed.
`attendeeType`	Optional. Enum {PROSPECT, SALESTEAM}	Holds the type of attendee.
`avgLeadScore`	Required. Float.	Average of the leading score.
`city`	Optional. String.	Session participant's city.
`clientAgent`	Optional. String.	Session participant's operating system and browser, such as “Windows, IE”.
`company`	Optional. String.	Session participant's company.
`confID`	Optional. Long.	The unique conference ID associated with a session, with which you take operations such as to query the session’s history data. Note: `confID takes priority over sessionKey and meetingType. Thus, if a wrong confID is specified, the system throws an exception and stops processing sessionKey and meetingType even if they are also specified.`
`confName`	Optional. Maximum of 512 characters.	Name of the meeting.
`count`	Required. Long.	Counter variable.
`country`	Optional. String.	Session participant's country.
`creationTime`	Optional. String.	Creation time of a recording. Formatted as MM/DD/YYYY HH:MM:SS. If specified, creationTimeEnd must also be specified.
`creationTimeEnd`	Optional. Required if creationTimeScope is specified. String.	Return all recordings that were created between creationTimeStart and this time. Formatted as MM/DD/YYYY HH:MM:SS If specified, creationTime must also be specified.
`creationTimeStart`	Optional. Required if creationTimeScope is specified. String.	Return all recordings that were created between creationTimeEnd and this time. Formatted as MM/DD/YYYY HH:MM:SS.
`downloaded`	Optional. Integer.	The number of times that a recorded session has been downloaded.
`duration`	Optional. Integer.	The number of minutes (rounded up) that the session lasted.
`email`	Optional. String.	Session participant's email address.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`endTime`	Optional. String.	Time when the participant left the session or the session ended, in GMT.
`fax`	Optional. String.	A participant’s fax number.
`firstName`	Optional. String.	A person’s given name.
`hostEmail`	Optional. String.	Email address for the session host.
`hostName`	Optional. String.	Full name of the session host.
`hostWebexID`	Optional. String.	Webex ID of the session host.
`inclAudioOnly`	Optional. Valid values are TRUE and FALSE.	Determines if attendee information will be returned for audio only sessions. Default: FALSE.
`invited`	Optional. String.	Number of participants who were invited to the session. This only includes participants who were invited from the CreateMeeting/TrainingSession, CreateMeetingAttendee requests or the schedule session site web pages. This number does not include participants who were invited from the session client window once the session has started.
`ipAddress`	Optional. String.	IP address for the participant's computer.
`joinTime`	Optional. String.	Time at which the participant joined the session.
`label`	Optional. String.	The name of a field.
`lastName`	Optional. String.	A participant’s family name.
`leadScore`	Optional. Float.	Holds the lead score.
`leadSourceID`	Optional. String.	Holds the ID of the lead source.
`leaveTime`	Optional. String.	Time when the participant left the session.
`listControl`	Optional. Container.	Controls the data result set.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in “Specifying Boolean Relationships for Searches” on page 55.
`matchingRecords`	Optional. Container.	Holds the date scope range.
`maximumNum`	Optional. Integer.	Limits the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`meetingEndTime`	Optional. String.	Time when the session ended, in GMT.
`meetingKey`	Optional. Integer.	Unique identifier for a meeting. A recurring or constant meeting will have one meetingKey but each individual session will have a unique confID.
`meetingStartTime`	Optional. String. Time when the session began, in GMT.
`meetingType`	Optional. String. Valid values are: ■ PRE, PRO and STD (Meeting Center) ■ OCS and SC3 (Support Center) ■ ONS (Event Center) ■ TRS (Training Center) ■ RAS (Access Anywhere)	An abbreviated code to designate the session type.
`name`	Optional. String.	Full name for session participant.
`opportunity`	Optional. String.	Filter by opportunity.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy whether to sort in ascending or descending order. Default: ASC.
`orderBy`	Optional.	Which elements to sort by in the sessions returned. ■ For LsttrainingsessionHistory, valid values are: CONFNAME, STARTTIME, TOTALINVITED, TOTALREGISTERED, TOTALATTENDEE, ASSISTREQUEST, and ASSISTCONFIRM. ■ For LstrecordaccessHistory, valid value is RECORDID. ■ For LsttrainingattendeeHistory, valid values are NAME, STARTTIME, COMPANY, COUNTRY, STATE, CITY and CONFID. ■ For LstmeetingusageHistory and LstsalesSessionHistory, valid values are CONFNAME, STARTTIME, TOTALATTENDEE and HOSTNAME, ASSISTREQUEST, ASSISTCONFIRM. ■ For LstmeetingattendeeHistory and LstsalesAttendeeHistory, valid values are CONFID, STARTTIME, COMPANY, COUNTRY, STATE and CITY. ■ For LsteventsessionHistory, valid values are CONFID, STARTTIME and CONFNAME, ASSISTREQUEST, ASSISTCONFIRM. ■ For LsteventattendeeHistory, valid values are STARTTIME, ATTENDEENAME, SESSIONKEY and CONFID. ■ For LstsupportsessionHistory, valid values are CONFID, SESSIONSTARTTIME and CONFNAME. ■ For LstsupportattendeeHistory, valid values are ATTENDEENAME, STARTTIME, SESSIONKEY and CONFID.
`participantEmail`	Optional. String.	Holds the email of a participant.
`participantName`	Optional. String.	Holds the name of a participant.
`participantType`	Optional. Enumeration.	Valid values are HOST, ATTENDEE, OTHER. Role of a participant in the meeting.
`partnerID`	Optional.	The Webex assigned unique identification number that is assigned to each partner. Its value is returned in Response commands.
`peakAttendee`	Long.	Holds the maximum number of simultaneous participants in a session.
`phone`	Optional. String.	Session participant's telephone number.
`phoneNumber`	Optional. String.	Session participant's telephone number.
`postalCode`	Optional. String.	A participant’s zip code.
`recordDetail`	Optional. Container.	Holds the NBR recordings.
`recordID`	Optional. Integer.	ID of the recording.
`recordName`	Optional. String.	Name of the recording.
`regA`	Required. String.	Holds an answer.
`registerDate`	Optional. String.	Holds the register date.
`registered`	Optional. String.	Quantity of registered attendees.
`regQ`	Required. String.	Holds a question.
`returned`	Required if matchingRecords is specified. Integer.	The number of records returned in the response.
`returnPSOFields`	Optional. Valid values are TRUE or FALSE.	Determines if the PSO Fields will be returned.
`returnRegFields`	Optional. Valid values are TRUE or FALSE.	Determines if the registration fields will be returned.
`sessionEndTime`	Optional. String.	Time when the session actually ended, in GMT.
`sessionEndTimeEnd`	Required if endTimeScope is specified. String.	Returns all sessions that ended between sessionEndTimeStart and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionEndTimeStart`	Required if endTimeScope is specified. String.	Returns all sessions that ended between sessionEndTimeEnd and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionKey`	Optional. Long.	Unique identification number for a Webex session.
`sessionStartTime`	Optional. String.	Time when the session actually started, in GMT.
`sessionStartTimeEnd`	Required if startTimeScope is specified. String.	Returns all sessions that started between sessionStartTimeStart and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
`sessionStartTimeStart`	Required if startTimeScope is specified. String.	Returns all sessions that started between sessionEndTimeEnd and this time, in GMT. Formatted as MM/DD/YYYY HH:MM:SS.
`startFrom`	Optional. Integer.	Works with maximumNum to limit the quantity of returned objects as described in “Choosing A Subset of Records” on page 54.
`startFrom` (in matchingRecords element)	Required. Integer.	Record index number that the returned set starts from.
`startTime`	Optional. String.	Time when the participant joined the session, in GMT.
`state`	Optional. String.	Session participant's state.
`timeZone`	Optional. String.	A string containing the GMT offset and timezone name and example city. See Appendix A, Time Zone, Language Encoding, and Country Codes.
`timeZoneID`	Optional. An integer ranges from 0 to 61.	An index into the table of time zones as shown in Appendix A, Time Zone, Language Encoding, and Country Codes. Default is 20.
`title`	Optional. String.	Session participant's title.
`total`	Required if matchingRecords is specified. Integer.	Total number of records matching the query request.
`totalAttendee`	Optional. Numeric.	Total number of attendees.
`totalCallInMinutes`	Optional. Integer.	Total number of minutes used in the session for dial in teleconferencing.
`totalCallInTollfreeMinutes`	Optional. Integer.	Total number of minutes used in the session for toll free dial in teleconferencing.
`totalCallOutDomestic`	Optional. Integer.	Total minutes used for dial out domestic teleconferencing.
`totalCallOutInternational`	Optional. Integer.	Total minutes used for dial out international teleconferencing.
`totalInvited`	Optional. Integer.	Total number of invited users.
`totalParticipants`	Optional. Integer.	Total number of participants including attendees and the host.
`totalParticipantsCallIn`	Optional. Integer.	Total number of participants who used standard and toll-free dial-in teleconferences.
`totalParticipantsCallOut`	Optional. Integer.	Total number of participants who used domestic and international dial-out teleconferences.
`totalParticipantsVoip`	Optional. Integer.	Total number of participants who used Voice over IP.
`totalPeopleMinutes`	Optional. Integer.	Total minutes used by all participants in the Webex session.
`totalRegistered`	Optional. Integer.	Total number of registered users.
`totalVoipMinutes`	Optional. Integer.	Total number of minutes used for Voice over IP.
`trackingCode1..10`	Optional.	Ten text elements that you can use for any information about a session, such as project names, departments, or anything else of your choice.
`userID`	Optional. Integer.	Unique identifier for the session host.
`value`	Optional. String.	Any user entered value.
`viewed`	Optional. Integer.	The number of times that this recording has been viewed.
`viewID`	Optional. Long.	Holds the ID of what is being viewed.
`viewTimeEnd`	Required. String.	View the end time.
`viewTimeScope`	Optional. viewTimeScopeType.	Views the time scope.
`viewTimeStart`	Required. String.	View the start time.
`voipDuration`	Optional. Integer.	Minutes for Voice over IP conference that an attendee has participated in during a meeting.
`zip`	Optional. String.	Postal code of the session participant.
`zipCode`	Optional. String.	Postal code of the session participant.

Site Service

This section provides descriptions of the Webex XML API's for the Site Services, which contains the GetSite and LstTimeZone operations. Samples are given for the outbound request messages and expected server response messages.

Table 10-1 • Webex Site Service XML Messages

*XML Request Message*	*Description*
`GetSite`	Returns information about the Webex site.
`LstTimeZone`	Returns list of Webex time zone values.
`SetSite`	Allows a MeetingPlace with Site Admin privileges to set several MeetingPlace URL links.

GetSite

Webex partners can use the GetSite command to get a list of features, options and privileges that are configured for their Webex service sites, including Meeting Center, Training Center, Event Center, Support Center, and Sales Center. Webex partners are able to use this information to customize menu items that appear in the left side and top navigation bars on their Webex site.

The first attendee becomes the presenter on MC. The <firstAttendeeAsPresenter> element is available in CreateMeeting, SetMeeting. The element <firstAttendeeAsPresenter> is part of the response for GetMeeting. The element <firstAttendeeAsPresenter> is part of the response for GetSite.

Element	Parent	Definition	Type	Default
`firstAttendeeAsPresenter`	`schedule`	Turns on/off "The first attendee to join will be the presenter"	boolean

The default value for TopBarIndex returned by getSite is defined in code. The default value is not stored in the database. If the TopBarIndex value has not been customized, then GetSite returns the default value of "WL;MC;EC;SaC;SC;TC;SA;PS;".

If the TopBarIndex value has been customized, then getSite returns the customized value from the database.

GetSite includes the following elements to determine whether the TelePresence integration is enabled for the site and meeting type"Do no display" flag:

Element	Parent	Definition	Type	Default
`enableTP`	`<tools>`	Returns "Enable One Touch TelePresence (MC only)" checkbox status	boolean 0..1	`FALSE`
`enableTPplus`	`<tools>`	Returns "Enable One Touch Telepresence Plus (MC only)" checkbox status from site admin	boolean 0..1	`FALSE`
`hideInScheduler`	`<metaData>:<meetingTypes>`	Returns "Do not display in scheduler (For Telepresence only)" checkbox status for meeting type	boolean 0..1	`FALSE`

Note: To enhance Personal Conference security, the XML API supports a user's telephone PIN that is used to add security to Personal Conference Number audio.

The following element is available in createUser, setUser, and getUser to support a user's telephone PIN:

Element	Parent	Definition	Type	Default
`PIN`	`<phones>`	Secondary level of authentication for PCN and when host is using the phone and inviting additional attendees	string 0..1

The following new element has been added to createUser, setUser, and getUser to support PCN Join Before Host:

The joinBeforeHost element is available in the createUser, setUser, and getUser operations to support the "PCN Join Before Host" setting:

Element	Parent	Definition	Type	Default
`joinBeforeHost`	`<personalTeleconf>`	Indicates if PCN-Join Before Host is enabled for the user	boolean 0..1	`FALSE`

Original in Creat/SetUser is ignored; this flag is not supported at the user level for versions T28 and higher.
If an XML API user who has never had a PIN launches a PCN meeting and calls Webex audio access number on T28, the Webex audio IVR will prompt user to enter their PIN. The user needs to create their PIN before attempting to launch a PCN meeting on T28. Otherwise, the user will not be able to launch meetings any more.
T28 requires the the host to set a PIN before a PCN account can be added or edited. So the XML API also has this restriction. Create/SetUser requires user has valid PIN to add or edit PCN account. If a valid PIN does not exist, the XML API throws an exception: "valid PIN is required".

Logic

1.The PIN can be set through the XML API by using Create/SetUser. GetUser can be used to retrieve host's PIN.

2.When using Create/SetUser to specify the PIN, the XML API will check to see if the value provided is a valid PIN. Single number values and simple sequences, like 1111 or 1234 are not allowed. If value is not a valid PIN, the XML API throws the exception: WBXValidationException (ID=999999, "Not a valid PIN! PIN must be 4-digit number and not allow PIN to be Single number values or simple sequences, like 1111 or 1234.") "Not a valid PIN".

3.Create/SetUser will only allow the siteadmin to specify for the host. This option can only be specified on the SiteAdmin page - so the host is not allowed to change the setting. If this rule is violated, the XML API will throw the exception: NoPrivilegeException(ID = 000001, "Access denied, additional privileges are required")

4.If the value is set through the XML API Create/SetUser request, this input value will now be ignored. Only the value of new element should be used.

5.The XML API GetUser response will still return , but the value will be identical to the value of the new element .

Note This API can be executed by both hosts and site administrators.

Request

The sample XML document shows an example of a request for information about the features enabled for the site.

<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.site.GetSite" />
        <returnSettings>
            <eventCenter>true</eventCenter>
        </returnSetting>
    </body>
</serv:message>

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

Figure 10-1 • Schema diagram for getSite

Response

The sample XML document shows an example of a possible response for the preceding query XML 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:ns1="http://www.webex.com/schemas/2002/06/service/site"
    xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ns1:getSiteResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns1:siteInstance>
                <ns1:metaData>
                    <ns1:isEnterprise>true</ns1:isEnterprise>
                    <ns1:serviceType>Meeting Center</ns1:serviceType>
                    <ns1:serviceType>Event Center</ns1:serviceType>
                    <ns1:serviceType>Training Center</ns1:serviceType>
                    <ns1:serviceType>Support Center</ns1:serviceType>
                    <ns1:serviceType>Sales Center</ns1:serviceType>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>1</ns1:meetingTypeID>
                        <ns1:meetingTypeName>FRE</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>2</ns1:meetingTypeID>
                        <ns1:meetingTypeName>STD</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>3</ns1:meetingTypeID>
                        <ns1:meetingTypeName>PRO</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>4</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SOS</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>5</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SOP</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>6</ns1:meetingTypeID>
                        <ns1:meetingTypeName>PPU</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>7</ns1:meetingTypeID>
                        <ns1:meetingTypeName>OCS</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>8</ns1:meetingTypeID>
                        <ns1:meetingTypeName>COB</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>9</ns1:meetingTypeID>
                        <ns1:meetingTypeName>ONS</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>10</ns1:meetingTypeID>
                        <ns1:meetingTypeName>RAS</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>11</ns1:meetingTypeID>
                        <ns1:meetingTypeName>TRS</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>13</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SC3</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>14</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SMT</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>15</ns1:meetingTypeID>
                        <ns1:meetingTypeName>SAC</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:meetingTypes>
                        <ns1:meetingTypeID>16</ns1:meetingTypeID>
                        <ns1:meetingTypeName>AUO</ns1:meetingTypeName>
                    </ns1:meetingTypes>
                    <ns1:siteName>rose22</ns1:siteName>
                    <ns1:brandName>rose22</ns1:brandName>
                    <ns1:region>U.S.</ns1:region>
                    <ns1:currency>US Dollars</ns1:currency>
                    <ns1:timeZoneID>4</ns1:timeZoneID>
                    <ns1:timeZone>GMT-08:00, Pacific (San Jose)</ns1:timeZone>
                    <ns1:parterID>webexpartner</ns1:parterID>
                    <ns1:webDomain>szqaxml_wd</ns1:webDomain>
                    <ns1:meetingDomain>szqaxml_md</ns1:meetingDomain>
                    <ns1:telephonyDomain>xml_dummy_tel</ns1:telephonyDomain>
                    <ns1:pageVersion>T27L</ns1:pageVersion>
                    <ns1:clientVersion>T27L</ns1:clientVersion>
                    <ns1:pageLanguage>ENGLISH</ns1:pageLanguage>
                    <ns1:activateStatus>true</ns1:activateStatus>
                    <ns1:webPageType>J2EE</ns1:webPageType>
                    <ns1:iCalendar>true</ns1:iCalendar>
                    <ns1:myWebexDefaultPage>My Meetings</ns1:myWebexDefaultPage>
                    <ns1:componentVersion>cmp0306l</ns1:componentVersion>
                    <ns1:displayMeetingActualTime>false
                    </ns1:displayMeetingActualTime>
                    <ns1:displayOffset>true</ns1:displayOffset>
                </ns1:metaData>
                <ns1:ucf>
                    <ns1:ucfConfiguration>UCF 2.1</ns1:ucfConfiguration>
                </ns1:ucf>
                <ns1:clientPlatforms>
                    <ns1:msWindows>true</ns1:msWindows>
                    <ns1:macOS9>true</ns1:macOS9>
                    <ns1:macOSX>true</ns1:macOSX>
                    <ns1:sunSolaris>true</ns1:sunSolaris>
                    <ns1:linux>true</ns1:linux>
                    <ns1:hpUnix>false</ns1:hpUnix>
                    <ns1:java>true</ns1:java>
                    <ns1:palm>false</ns1:palm>
                </ns1:clientPlatforms>
                <ns1:resourceRestrictions>
                    <ns1:isLicenseManager>false</ns1:isLicenseManager>
                    <ns1:concurrentLicense>0</ns1:concurrentLicense>
                    <ns1:fileFolderCapacity>1000</ns1:fileFolderCapacity>
                    <ns1:maxConcurrentEvents>0</ns1:maxConcurrentEvents>
                    <ns1:archiveStorageLimit>1000</ns1:archiveStorageLimit>
                </ns1:resourceRestrictions>
                <ns1:supportAPI>
                    <ns1:autoLogin>true</ns1:autoLogin>
                    <ns1:aspAndPHPAPI>true</ns1:aspAndPHPAPI>
                    <ns1:backwardAPI>false</ns1:backwardAPI>
                    <ns1:xmlAPI>true</ns1:xmlAPI>
                    <ns1:cAPI>false</ns1:cAPI>
                    <ns1:scorm>false</ns1:scorm>
                </ns1:supportAPI>
                <ns1:myWebexConfig>
                    <ns1:myContacts>true</ns1:myContacts>
                    <ns1:myProfile>true</ns1:myProfile>
                    <ns1:myMeetings>true</ns1:myMeetings>
                    <ns1:trainingRecordings>true</ns1:trainingRecordings>
                    <ns1:folders>true</ns1:folders>
                    <ns1:eventDocument>true</ns1:eventDocument>
                    <ns1:myReport>false</ns1:myReport>
                    <ns1:myComputer>false</ns1:myComputer>
                    <ns1:personalMeetingPage>false</ns1:personalMeetingPage>
                    <ns1:myFilesStorage>1000</ns1:myFilesStorage>
                    <ns1:myComputerNumbers>0</ns1:myComputerNumbers>
                    <ns1:enableMyWebexPro>true</ns1:enableMyWebexPro>
                    <ns1:myWebexProMaxHosts>999999</ns1:myWebexProMaxHosts>
                    <ns1:restrictAccessAnyApps>false</ns1:restrictAccessAnyApps>
                    <ns1:restrictAccessAnyAppsNum>0
                    </ns1:restrictAccessAnyAppsNum>
                    <ns1:addlAccessAnyComputersLimit>STRICT
                    </ns1:addlAccessAnyComputersLimit>
                    <ns1:addlAccessAnyComputers>0</ns1:addlAccessAnyComputers>
                    <ns1:addlStorageLimit>STRICT</ns1:addlStorageLimit>
                    <ns1:addlStorage>0</ns1:addlStorage>
                    <ns1:myContactsPro>true</ns1:myContactsPro>
                    <ns1:myProfilePro>true</ns1:myProfilePro>
                    <ns1:myMeetingsPro>true</ns1:myMeetingsPro>
                    <ns1:trainingRecordingsPro>true</ns1:trainingRecordingsPro>
                    <ns1:foldersPro>true</ns1:foldersPro>
                    <ns1:eventDocumentPro>true</ns1:eventDocumentPro>
                    <ns1:myReportPro>true</ns1:myReportPro>
                    <ns1:myComputerPro>true</ns1:myComputerPro>
                    <ns1:personalMeetingPagePro>true
                    </ns1:personalMeetingPagePro>
                    <ns1:myFilesStoragePro>1000</ns1:myFilesStoragePro>
                    <ns1:myComputerNumbersPro>3</ns1:myComputerNumbersPro>
                    <ns1:PMRheaderBranding>false</ns1:PMRheaderBranding>
                </ns1:myWebexConfig>
                <ns1:telephonyConfig>
                    <ns1:isTSPUsingTelephonyAPI>false</ns1:isTSPUsingTelephonyAPI>
                    <ns1:serviceName>Personal Conference No.</ns1:serviceName>
                    <ns1:participantAccessCodeLabel>Attendee access code
                    </ns1:participantAccessCodeLabel>
                    <ns1:subscriberAccessCodeLabel>Host access code
                    </ns1:subscriberAccessCodeLabel>
                    <ns1:attendeeIDLabel>Attendee ID</ns1:attendeeIDLabel>
                    <ns1:internetPhone>true</ns1:internetPhone>
                    <ns1:callInTeleconferencing>true</ns1:callInTeleconferencing>
                    <ns1:tollFreeCallinTeleconferencing>true
                    </ns1:tollFreeCallinTeleconferencing>
                    <ns1:callBackTeleconferencing>true
                    </ns1:callBackTeleconferencing>
                    <ns1:callInNumber>1</ns1:callInNumber>
                    <ns1:defaultTeleServerSubject>10.224.38.95
                    </ns1:defaultTeleServerSubject>
                    <ns1:subscribeName>QA</ns1:subscribeName>
                    <ns1:subscribePassword>pass</ns1:subscribePassword>
                    <ns1:defaultPhoneLines>10</ns1:defaultPhoneLines>
                    <ns1:defaultSpeakingLines>10</ns1:defaultSpeakingLines>
                    <ns1:majorCountryCode>1</ns1:majorCountryCode>
                    <ns1:majorAreaCode>408</ns1:majorAreaCode>
                    <ns1:publicName>Call-in User</ns1:publicName>
                    <ns1:hybridTeleconference>true</ns1:hybridTeleconference>
                    <ns1:instantHelp>false</ns1:instantHelp>
                    <ns1:customerManage>false</ns1:customerManage>
                    <ns1:maxCallersNumber>500</ns1:maxCallersNumber>
                    <ns1:isSpecified>false</ns1:isSpecified>
                    <ns1:isContinue>false</ns1:isContinue>
                    <ns1:personalTeleconf>
                        <ns1:primaryLargeServer>
                            <serv:tollNum>1-408197043</serv:tollNum>
                            <serv:tollFreeNum>1-408197041</serv:tollFreeNum>
                            <serv:intlLocalNum>010-111222</serv:intlLocalNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:primaryLargeServer>
                        <ns1:backup1LargeServer>
                            <serv:tollNum>222</serv:tollNum>
                            <serv:tollFreeNum>222</serv:tollFreeNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:backup1LargeServer>
                        <ns1:backup2LargeServer>
                            <serv:tollNum>333</serv:tollNum>
                            <serv:tollFreeNum>333</serv:tollFreeNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Backup call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>
                                Backup call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:backup2LargeServer>
                        <ns1:primarySmallServer>
                            <serv:tollNum>444</serv:tollNum>
                            <serv:tollFreeNum>444</serv:tollFreeNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:primarySmallServer>
                        <ns1:backup1SmallServer>
                            <serv:tollNum>555</serv:tollNum>
                            <serv:tollFreeNum>555</serv:tollFreeNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>Call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:backup1SmallServer>
                        <ns1:backup2SmallServer>
                            <serv:tollNum>10.224.38.95</serv:tollNum>
                            <serv:tollFreeNum>10.224.38.95</serv:tollFreeNum>
                            <serv:enableServer>true</serv:enableServer>
                            <serv:tollLabel>Backup call-in toll number (US/Canada)
                            </serv:tollLabel>
                            <serv:tollFreeLabel>
                                Backup call-in toll-free number (US/Canada)
                            </serv:tollFreeLabel>
                        </ns1:backup2SmallServer>
                    </ns1:personalTeleconf>
                    <ns1:multiMediaPlatform>false</ns1:multiMediaPlatform>
                    <ns1:broadcastAudioStream>false</ns1:broadcastAudioStream>
                    <ns1:tspAdaptorSettings>
                        <ns1:primaryLarge>
                            <ns1:enableAdaptor>true</ns1:enableAdaptor>
                            <ns1:serverIP>10.224.38.105</ns1:serverIP>
                            <ns1:mpAudio>
                                <ns1:label>Call-in number (tsp)</ns1:label>
                                <ns1:phoneNumber>14081971541</ns1:phoneNumber>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number (tsp)</ns1:label>
                                <ns1:phoneNumber>14081971542</ns1:phoneNumber>
                            </ns1:mpAudio>
                            <ns1:globalCallInNumURL>https://www.intercall.com/GlobalN
                                umService/TollNum=%TollNum%&amp;CC=%TollNumCC%&amp;TF
                                N=%TollFreeNum%&amp;TFNCC=%TollFreeNumCC%&amp;PC=%Par
                                ticipantCode%&amp;SC=%SubscriberCode%
                            </ns1:globalCallInNumURL>
                        </ns1:primaryLarge>
                        <ns1:backup1Large>
                            <ns1:enableAdaptor>false</ns1:enableAdaptor>
                            <ns1:serverIP />
                            <ns1:mpAudio>
                                <ns1:label>Call-in number</ns1:label>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number</ns1:label>
                            </ns1:mpAudio>
                        </ns1:backup1Large>
                        <ns1:backup2Large>
                            <ns1:enableAdaptor>false</ns1:enableAdaptor>
                            <ns1:serverIP />
                            <ns1:mpAudio>
                                <ns1:label>Call-in number</ns1:label>
                            </ns1:mpAudio>
                            <ns1:mpAudio>
                                <ns1:label>Call-in toll-free number</ns1:label>
                            </ns1:mpAudio>
                        </ns1:backup2Large>
                    </ns1:tspAdaptorSettings>
                    <ns1:meetingPlace>
                        <ns1:persistentTSP>false</ns1:persistentTSP>
                        <ns1:mpAudioConferencing>WithoutIntegration
                        </ns1:mpAudioConferencing>
                    </ns1:meetingPlace>
                    <ns1:otherTeleServiceName>Other teleconference service
                    </ns1:otherTeleServiceName>
                    <ns1:supportAdapterlessTSP>false</ns1:supportAdapterlessTSP>
                    <ns1:displayAttendeeID>false</ns1:displayAttendeeID>
                    <ns1:provisionTeleAccount>true</ns1:provisionTeleAccount>
                    <ns1:choosePCN>true</ns1:choosePCN>
                    <ns1:audioOnly>true</ns1:audioOnly>
                    <ns1:configTollAndTollFreeNum>false
                    </ns1:configTollAndTollFreeNum>
                    <ns1:configPrimaryTS>false</ns1:configPrimaryTS>
                </ns1:telephonyConfig>
                <ns1:commerceAndReporting>
                    <ns1:trackingCode>true</ns1:trackingCode>
                    <ns1:siteAdminReport>true</ns1:siteAdminReport>
                    <ns1:subScriptionService>false</ns1:subScriptionService>
                    <ns1:isECommmerce>false</ns1:isECommmerce>
                    <ns1:customereCommerce>false</ns1:customereCommerce>
                    <ns1:isLocalTax>false</ns1:isLocalTax>
                    <ns1:localTaxName>VAT</ns1:localTaxName>
                    <ns1:localTaxtRate>0.0</ns1:localTaxtRate>
                    <ns1:holReport>0</ns1:holReport>
                </ns1:commerceAndReporting>
                <ns1:tools>
                    <ns1:businessDirectory>false</ns1:businessDirectory>
                    <ns1:officeCalendar>false</ns1:officeCalendar>
                    <ns1:meetingCalendar>true</ns1:meetingCalendar>
                    <ns1:displayOnCallAssistLink>false
                    </ns1:displayOnCallAssistLink>
                    <ns1:displayProfileLink>true</ns1:displayProfileLink>
                    <ns1:recordingAndPlayback>true</ns1:recordingAndPlayback>
                    <ns1:recordingEditor>true</ns1:recordingEditor>
                    <ns1:publishRecordings>false</ns1:publishRecordings>
                    <ns1:instantMeeting>true</ns1:instantMeeting>
                    <ns1:emails>false</ns1:emails>
                    <ns1:outlookIntegration>true</ns1:outlookIntegration>
                    <ns1:wirelessAccess>true</ns1:wirelessAccess>
                    <ns1:allowPublicAccess>true</ns1:allowPublicAccess>
                    <ns1:ssl>true</ns1:ssl>
                    <ns1:handsOnLab>true</ns1:handsOnLab>
                    <ns1:holMaxLabs>999999</ns1:holMaxLabs>
                    <ns1:holMaxComputers>999999</ns1:holMaxComputers>
                    <ns1:userLockDown>false</ns1:userLockDown>
                    <ns1:meetingAssist>false</ns1:meetingAssist>
                    <ns1:sms>false</ns1:sms>
                    <ns1:encryption>NONE</ns1:encryption>
                    <ns1:internalMeeting>false</ns1:internalMeeting>
                </ns1:tools>
                <ns1:custCommunications>
                    <ns1:displayType>
                        <ns1:prodSvcAnnounce>false</ns1:prodSvcAnnounce>
                        <ns1:trainingInfo>false</ns1:trainingInfo>
                        <ns1:eNewsletters>false</ns1:eNewsletters>
                        <ns1:promotionsOffers>false</ns1:promotionsOffers>
                        <ns1:pressReleases>false</ns1:pressReleases>
                    </ns1:displayType>
                    <ns1:displayMethod>
                        <ns1:email>false</ns1:email>
                        <ns1:fax>false</ns1:fax>
                        <ns1:phone>false</ns1:phone>
                        <ns1:mail>false</ns1:mail>
                    </ns1:displayMethod>
                </ns1:custCommunications>
                <ns1:trackingCodes />
                <ns1:supportedServices>
                    <ns1:meetingCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>mc0805l</ns1:pageVersion>
                        <ns1:clientVersion>T27L</ns1:clientVersion>
                    </ns1:meetingCenter>
                    <ns1:trainingCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>tc0505l</ns1:pageVersion>
                        <ns1:clientVersion>T27L</ns1:clientVersion>
                    </ns1:trainingCenter>
                    <ns1:supportCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>sc0700l</ns1:pageVersion>
                        <ns1:clientVersion>T27L</ns1:clientVersion>
                        <ns1:webACD>true</ns1:webACD>
                    </ns1:supportCenter>
                    <ns1:eventCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>ec0605l</ns1:pageVersion>
                        <ns1:clientVersion>T27L</ns1:clientVersion>
                        <ns1:marketingAddOn>true</ns1:marketingAddOn>
                    </ns1:eventCenter>
                    <ns1:salesCenter>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:pageVersion>sac0405l</ns1:pageVersion>
                        <ns1:clientVersion>T27L</ns1:clientVersion>
                    </ns1:salesCenter>
                </ns1:supportedServices>
                <ns1:securityOptions>
                    <ns1:passwordExpires>false</ns1:passwordExpires>
                    <ns1:passwordLifetime>0</ns1:passwordLifetime>
                    <ns1:allMeetingsUnlisted>false</ns1:allMeetingsUnlisted>
                    <ns1:allMeetingsPassword>true</ns1:allMeetingsPassword>
                    <ns1:joinBeforeHost>true</ns1:joinBeforeHost>
                    <ns1:audioBeforeHost>true</ns1:audioBeforeHost>
                    <ns1:changePersonalURL>false</ns1:changePersonalURL>
                    <ns1:changeUserName>false</ns1:changeUserName>
                    <ns1:meetings>
                        <ns1:strictPasswords>true</ns1:strictPasswords>
                    </ns1:meetings>
                    <ns1:strictUserPassword>false</ns1:strictUserPassword>
                    <ns1:accountNotify>false</ns1:accountNotify>
                    <ns1:requireLoginBeforeSiteAccess>false
                    </ns1:requireLoginBeforeSiteAccess>
                    <ns1:changePWDWhenAutoLogin>false</ns1:changePWDWhenAutoLogin>
                    <ns1:enforceBaseline>false</ns1:enforceBaseline>
                    <ns1:passwordChangeIntervalOpt>true
                    </ns1:passwordChangeIntervalOpt>
                    <ns1:passwordChangeInterval>24</ns1:passwordChangeInterval>
                </ns1:securityOptions>
                <ns1:defaults>
                    <ns1:emailReminders>true</ns1:emailReminders>
                    <ns1:entryExitTone>BEEP</ns1:entryExitTone>
                    <ns1:voip>true</ns1:voip>
                    <ns1:teleconference>
                        <ns1:telephonySupport>CALLBACK</ns1:telephonySupport>
                        <ns1:tollFree>true</ns1:tollFree>
                        <ns1:intlLocalCallIn>true</ns1:intlLocalCallIn>
                    </ns1:teleconference>
                    <ns1:joinTeleconfNotPress1>false</ns1:joinTeleconfNotPress1>
                    <ns1:updateTSPAccount>false</ns1:updateTSPAccount>
                </ns1:defaults>
                <ns1:scheduleMeetingOptions>
                    <ns1:scheduleOnBehalf>true</ns1:scheduleOnBehalf>
                    <ns1:saveSessionTemplate>true</ns1:saveSessionTemplate>
                </ns1:scheduleMeetingOptions>
                <ns1:navBarTop>
                    <ns1:button>
                        <ns1:order>1</ns1:order>
                        <ns1:serviceName>Welcome</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>2</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Meeting Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>3</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Event Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>4</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Sales Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>5</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Support Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>6</ns1:order>
                        <ns1:enabled>true</ns1:enabled>
                        <ns1:serviceName>Training Center</ns1:serviceName>
                    </ns1:button>
                    <ns1:button>
                        <ns1:order>7</ns1:order>
                        <ns1:serviceName>Site Administration</ns1:serviceName>
                    </ns1:button>
                    <ns1:displayDisabledService>true</ns1:displayDisabledService>
                </ns1:navBarTop>
                <ns1:navMyWebex>
                    <ns1:customLinks>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                    </ns1:customLinks>
                    <ns1:partnerLinks>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                        <ns1:partnerLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:partnerLink>
                    </ns1:partnerLinks>
                    <ns1:partnerIntegration>true</ns1:partnerIntegration>
                    <ns1:support>
                        <ns1:target>NEW</ns1:target>
                    </ns1:support>
                    <ns1:training>
                        <ns1:target>NEW</ns1:target>
                    </ns1:training>
                </ns1:navMyWebex>
                <ns1:navAllServices>
                    <ns1:customLinks>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                        <ns1:customLink>
                            <ns1:target>NEW</ns1:target>
                        </ns1:customLink>
                    </ns1:customLinks>
                    <ns1:support>
                        <ns1:name>Support</ns1:name>
                        <ns1:target>NEW</ns1:target>
                    </ns1:support>
                    <ns1:training>
                        <ns1:name>Training</ns1:name>
                        <ns1:target>NEW</ns1:target>
                    </ns1:training>
                    <ns1:supportMenu>
                        <ns1:userGuides>
                            <ns1:target>NEW</ns1:target>
                        </ns1:userGuides>
                        <ns1:downloads>
                            <ns1:target>NEW</ns1:target>
                        </ns1:downloads>
                        <ns1:training>
                            <ns1:target>NEW</ns1:target>
                        </ns1:training>
                        <ns1:contactUs>
                            <ns1:target>NEW</ns1:target>
                        </ns1:contactUs>
                        <ns1:supportMyResources>true</ns1:supportMyResources>
                    </ns1:supportMenu>
                </ns1:navAllServices>
                <ns1:passwordCriteria>
                    <ns1:mixedCase>false</ns1:mixedCase>
                    <ns1:minLength>4</ns1:minLength>
                    <ns1:minAlpha>0</ns1:minAlpha>
                    <ns1:minNumeric>0</ns1:minNumeric>
                    <ns1:minSpecial>0</ns1:minSpecial>
                    <ns1:disallowWebTextSessions>true</ns1:disallowWebTextSessions>
                    <ns1:disallowWebTextAccounts>false
                    </ns1:disallowWebTextAccounts>
                    <ns1:disallowList>true</ns1:disallowList>
                    <ns1:disallowValue>password</ns1:disallowValue>
                    <ns1:disallowValue>passwd</ns1:disallowValue>
                    <ns1:disallowValue>pass</ns1:disallowValue>
                </ns1:passwordCriteria>
                <ns1:accountPasswordCriteria>
                    <ns1:mixedCase>false</ns1:mixedCase>
                    <ns1:minLength>4</ns1:minLength>
                    <ns1:minNumeric>0</ns1:minNumeric>
                    <ns1:minAlpha>0</ns1:minAlpha>
                    <ns1:minSpecial>0</ns1:minSpecial>
                    <ns1:disallow3XRepeatedChar>false</ns1:disallow3XRepeatedChar>
                    <ns1:disallowWebTextAccounts>false
                    </ns1:disallowWebTextAccounts>
                    <ns1:disallowList>false</ns1:disallowList>
                    <ns1:disallowValue>password</ns1:disallowValue>
                    <ns1:disallowValue>passwd</ns1:disallowValue>
                    <ns1:disallowValue>pass</ns1:disallowValue>
                    <ns1:disallowValue>webex</ns1:disallowValue>
                    <ns1:disallowValue>cisco</ns1:disallowValue>
                    <ns1:disallowValue>xebew</ns1:disallowValue>
                    <ns1:disallowValue>ocsic</ns1:disallowValue>
                </ns1:accountPasswordCriteria>
                <ns1:productivityTools>
                    <ns1:enable>true</ns1:enable>
                    <ns1:installOpts>
                        <ns1:autoUpdate>true</ns1:autoUpdate>
                    </ns1:installOpts>
                    <ns1:integrations>
                        <ns1:outlook>true</ns1:outlook>
                        <ns1:lotusNotes>false</ns1:lotusNotes>
                        <ns1:oneClick>false</ns1:oneClick>
                        <ns1:showSysTrayIcon>true</ns1:showSysTrayIcon>
                        <ns1:office>false</ns1:office>
                        <ns1:excel>true</ns1:excel>
                        <ns1:powerPoint>true</ns1:powerPoint>
                        <ns1:word>true</ns1:word>
                        <ns1:IE>true</ns1:IE>
                        <ns1:firefox>true</ns1:firefox>
                        <ns1:explorerRightClick>true</ns1:explorerRightClick>
                        <ns1:instantMessenger>false</ns1:instantMessenger>
                        <ns1:aolMessenger>false</ns1:aolMessenger>
                        <ns1:googleTalk>false</ns1:googleTalk>
                        <ns1:lotusSametime>false</ns1:lotusSametime>
                        <ns1:skype>false</ns1:skype>
                        <ns1:windowsMessenger>true</ns1:windowsMessenger>
                        <ns1:yahooMessenger>false</ns1:yahooMessenger>
                        <ns1:ciscoIPPhone>false</ns1:ciscoIPPhone>
                        <ns1:pcNow>true</ns1:pcNow>
                        <ns1:iGoogle>true</ns1:iGoogle>
                        <ns1:iPhoneDusting>true</ns1:iPhoneDusting>
                    </ns1:integrations>
                    <ns1:oneClick>
                        <ns1:allowJoinUnlistMeeting>true
                        </ns1:allowJoinUnlistMeeting>
                        <ns1:requireApproveJoin>false</ns1:requireApproveJoin>
                    </ns1:oneClick>
                    <ns1:templates>
                        <ns1:useTemplate>false</ns1:useTemplate>
                    </ns1:templates>
                    <ns1:lockDownPT>
                        <ns1:lockDown>false</ns1:lockDown>
                    </ns1:lockDownPT>
                    <ns1:imSettings>
                        <ns1:attendeeInviteOther>true</ns1:attendeeInviteOther>
                    </ns1:imSettings>
                </ns1:productivityTools>
                <ns1:meetingPlace>
                    <ns1:mpProfileURL>mpProfileURL</ns1:mpProfileURL>
                    <ns1:mpLogoutURL>mpLogoutURL</ns1:mpLogoutURL>
                    <ns1:mpInternalMeetingLink>mpInternalMeetingLink
                    </ns1:mpInternalMeetingLink>
                    <ns1:nbrProfileNumber>nbrProfileNumber</ns1:nbrProfileNumber>
                    <ns1:nbrProfilePassword>nbrProfilePassword
                    </ns1:nbrProfilePassword>
                </ns1:meetingPlace>
                <ns1:eventCenter>
                    <ns1:standardFields>
                        <event:phone>
                            <event:req>false</event:req>
                        </event:phone>
                        <event:company>
                            <event:req>false</event:req>
                        </event:company>
                        <event:title>
                            <event:req>false</event:req>
                        </event:title>
                        <event:numEmployees>
                            <event:req>false</event:req>
                        </event:numEmployees>
                        <event:futureInfo>
                            <event:req>false</event:req>
                        </event:futureInfo>
                        <event:address1>
                            <event:req>false</event:req>
                        </event:address1>
                        <event:address2>
                            <event:req>false</event:req>
                        </event:address2>
                        <event:city>
                            <event:req>false</event:req>
                        </event:city>
                        <event:state>
                            <event:req>false</event:req>
                        </event:state>
                        <event:postalCode>
                            <event:req>false</event:req>
                        </event:postalCode>
                        <event:country>
                            <event:req>false</event:req>
                        </event:country>
                        <ns1:firstName>
                            <event:req>true</event:req>
                        </ns1:firstName>
                        <ns1:lastName>
                            <event:req>true</event:req>
                        </ns1:lastName>
                        <ns1:emailAddress>
                            <event:req>true</event:req>
                        </ns1:emailAddress>
                    </ns1:standardFields>
                    <ns1:customFields />
                </ns1:eventCenter>
                <ns1:salesCenter>
                    <ns1:allowJoinWithoutLogin>true</ns1:allowJoinWithoutLogin>
                </ns1:salesCenter>
                <ns1:connectIntegration />
            </ns1:siteInstance>
        </serv:bodyContent>
    </serv:body>
</serv:message>

The following schema diagrams show the structure of the elements in the getSiteResponse message.

Figure 10-2 • Schema diagram for getSiteResponse

Figure 10-3 • Schema diagram for GetSiteResponse (Part 1)

Figure 10-4 • Schema diagram for GetSiteResponse (Part 2)

Figure 10-5 • Schema diagram for GetSiteResponse (Part 3)

Figure 10-6 • Schema diagram for GetSiteResponse (Part 4)

Figure 10-7 • Schema diagram for GetSiteResponse (Part 5)

Figure 10-8 • Schema diagram for GetSiteResponse (Part 6)

Figure 10-9 • Schema diagram for GetSiteResponse (Part 7

Figure 10-10 • Schema diagram for GetSiteResponse (Part 8)

Figure 10-11 • Schema diagram for GetSiteResponse (Part 9)

Figure 10-12 • Schema diagram for GetSiteResponse (Part 10)

Figure 10-13 • Schema diagram for GetSiteResponse (Part 11)

Note

Returns the password criteria set by the site admin so that user and session password definitions will be enforced.
GetSiteResponse returns the following options so WebOffice is able to control the My Profile display: PMRheaderBranding, PMRheaderBrandingLocation, changePersonalURL, changeUserName, displayDisabledService, scheduleOnBehalf, and saveSessionTemplate.
GetSiteResponse returns a “Marketing Add-on” option.
Integrations that build duplicate Webex scheduling pages are able to retrieve the default scheduling settings for a new session.
GetSiteResponse returns the TSP server information configured in the Super Admin web page.
GetSiteResponse returns a “Train base release name” for J2EE sites.
GetSiteResponse returns the Persistent TSP Adaptor for MeetingPlace configuration.
GetSiteResponse returns the Super Admin Multi-Media Platform options that define the Broadcast audio stream.
GetSiteResponse returns the display name for OTHER teleconferencing using the field.
Users are allowed to customize links and fields in the Left Navigation bar.
GetSiteResponse returns productivity tool and template options from Super admin and Site admin.
GetSiteResponse is able to return a default My Webex page along with it’s component version number.

Table 10-3 shows the variables that can be used when populating the TSP Adaptor Settings page with call-in numbers.

Table 10-3 • Global Call-In URL Variable Definitions

LstTimeZone

Webex partners can use the lstTimeZone command to request information about Webex time zones. The response provides the offset in minutes from GMT for the specified time zone. Specifying one or more <timeZoneID> values will return the description and GMT offsets for each time zone. Not specifying any <timeZoneID> value returns information for all 62 time zones.

The <date> element specifies the GMT date and time to use to calculate the GMT offsets which change during Daylight Savings Time periods. If <date> is unspecified then the current date and time are assumed.

Request

The sample XML shows an example of a request for the server to return the GMT offset from January 26, 2015, 9:00 PM in time zone 4 (U.S. Pacific 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="site.LstTimeZone">
            <timezoneID>4</timezoneID>
            <date>01/26/2015 21:00:00</date>
        </bodyContent>
    </body>
</serv:message>

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

Figure 10-15 • Schema diagram for lstTimeZone

For descriptions of the global elements in the security context of the header, see Ch.2, “Global Request Elements in Security Context”. For descriptions of the non-global elements, refer to “Elements in Webex XML Schema Definitions for the Site Service”.

Response

LstTimeZoneResponse returns information including any Daylight Saving Time offsets in emails and webpages.

The sample XML shows a possible response to the preceding request message (in this example, time zone information for the U.S. Pacific timezone).

<?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:ns1="http://www.webex.com/schemas/2002/06/service/site"
    xmlns:event="http://www.webex.com/schemas/2002/06/service/event">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ns1:lstTimeZoneResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns1:timeZone>
                <ns1:timeZoneID>4</ns1:timeZoneID>
                <ns1:gmtOffset>-480</ns1:gmtOffset>
                <ns1:description>GMT-08:00, Pacific (San Francisco)
                </ns1:description>
                <ns1:hideTimeZoneName>false</ns1:hideTimeZoneName>
                <ns1:fallInDST>false</ns1:fallInDST>
            </ns1:timeZone>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Figure 10-16 • Schema diagram for lstTimeZoneResponse

The result and exceptionID global elements allow you to confirm that an instantiation request was successful. These elements are described in Ch.2, “Global Response Elements Showing Results and Errors”.

SetSite

The SetSite API allows a MeetingPlace with Site Admin privileges to set several MeetingPlace URL links which can be used in MyWebex to redirect the user back to the MeetingPlace web page behind the firewall.

Request

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

Figure 10-17 • Schema diagram for setSite

Note The expanded diagram for site:meetingPlace can be found in schema diagrams.

The sample XML document illustrates a request to set up a site page.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <siteID>20060486</siteID>
            <webExID>wbxadmin</webExID>
            <password>pass</password>
            <partnerID>webexpartner</partnerID>
        </securityContext>
    </header>
    <body>
        <bodyContent xsi:type="java:com.webex.service.binding.site.SetSite">
            <meetingPlace>
                <mpProfileURL>mpProfileURL</mpProfileURL>
                <mpLogoutURL>mpLogoutURL</mpLogoutURL>
                <mpInternalMeetingLink>mpInternalMeetingLink
                </mpInternalMeetingLink>
                <nbrProfileNumber>nbrProfileNumber</nbrProfileNumber>
                <nbrProfilePassword>nbrProfilePassword</nbrProfilePassword>
            </meetingPlace>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 10-18 • Schema diagram for setSiteResponse

The sample XML document illustrates a response to the above request API.


<?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:ns1="http://www.webex.com/schemas/2002/06/service/site">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="ns1:setSiteResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

Elements in Webex XML Schema Definitions for the Site Service

The following table describes all the elements that are used in Webex XML API for the Site service.

*Element*	*Constraint(s)*	*Description*
`accountNotify`	Optional. Valid values are TRUE and FALSE.	Determines if all site administrators are notified when a new account is created.
`accountNumLimit`	Optional. Long.	Holds the maximum number of active accounts allowed.
`activateStatus`	Required. Valid values are TRUE and FALSE.	If TRUE, the site is an active site.
`active`	Required. Valid values are TRUE and FALSE.	Indicates whether an item in a tracking code group is active or not.
`addlAccessAnyComputers`	Optional. Long.	Specifies the number of additional remote computers that an account can set up. By default, 3 remote computers are allowed.
`addlAccessAnyComputersLimit`	Enumeration. Valid values are STRICT, WARN_EXCEED, and NONE.	Specifies the information for exceeding the limit of remote computers allowed on the site.
`addlStorage`	Optional. Long.	Specifies the additional file storage in MB.
`addlStorageLimit`	Optional. Enumeration. Valid values are STRICT, WARN_EXCEED, and NONE.	Specifies the information for exceeding the limit of file storage allocated on the site.
`allMeetingsPassword`	Required. Valid values are TRUE and FALSE.	Specifies that all meetings must have a password.
`allMeetingsUnlisted`	Required. Valid values are TRUE and FALSE.	Specifies that all meetings must be unlisted.
`allowJoinUnlistMeeting`	Optional. Valid values are TRUE and FALSE.	Allows the host to join unlisted meetings using the host email address.
`allowJoinWithoutLogin`	Optional. Valid values are TRUE and FALSE.	Allows sales team members to join a meeting without logging in.
`allowPublicAccess`	Required. Valid values are TRUE and FALSE.	Allows public access to the site.
`aolMessenger`	Optional. Valid values are TRUE and FALSE.	Sets AOL Messenger integration.
`archiveStorageLimit`	Optional. Integer.	Recorded event archive storage limit in MB for Event Center and OnStage.
`aspAndPHPAPI`	Optional. Valid values are TRUE and FALSE.	Enables URL API for the site.
`attendeeIDLabel`	Optional. String.	Display name for the attendee ID.
`attendeeInviteOther`	Optional. Valid values are TRUE and FALSE.	Determines if attendees are allowed to invite other people to a meeting.
`audioOnly`	Optional. Valid values are TRUE and FALSE.	Set audio-only sessions.
`audioBeforeHost`	Required. Valid values are TRUE and FALSE.	Allows attendees to join the teleconference before the host.
`autoLogin`	Optional. Valid values are TRUE and FALSE.	Enables all the URL API p.php commands for login/logout, creating new users, and so on.
`autoUpdate`	Optional. Valid values are TRUE and FALSE.	Automatically updates the Productivity Tools when new versions are available on siteadmin.
`backup1Large`	Required. tspServerType.	Holds the backup 1 large telephony server settings.
`backup2Large`	Required. tspServerType.	Holds the backup 2 large telephony server settings.
`backwardAPI`	Optional. Valid values are TRUE and FALSE.	Enables backward compatibility for s.php and s.asp commands.
`brandName`	Optional. String.	Domain name for the site, for example, acme.webex.com.
`broadcastAudioStream`	Optional. Valid values are TRUE and FALSE.	Determines whether or not the audio stream is enabled.
`businessDirectory`	Optional. Valid values are TRUE and FALSE.	Enables the Webex Business Directory functionality.
`callBackTeleconferencing`	Optional. Valid values are TRUE and FALSE.	Enables call back teleconferencing for sessions. Default: FALSE.
`callInNumber`	Optional. String.	Call-in teleconferencing number.
`callInPrice`	Optional. Double.	Per minute price for toll call-in teleconferencing.
`callInTeleconferencing`	Optional. Valid values are TRUE and FALSE.	Enables call in teleconferencing for sessions.
`callInTollFreePrice`	Optional. Double.	Per minute price for toll free call-In teleconferencing.
`callOutPrice`	Optional. Double.	Per minute price for call out teleconferencing.
`cAPI`	Optional. Valid values are TRUE and FALSE.	Enables Component API. Default: FALSE.
`changePersonalURL`	Optional. Valid values are TRUE and FALSE.	Determines if a user is allowed to change their personal URL. Default: FALSE.
`changeUserName`	Optional. Valid values are TRUE and FALSE.	Determines if a user is allowed to change their user name. Default: FALSE.
`choosePCN`	Optional. Valid values are TRUE and FALSE.	Allows the host to choose the Personal Conference Number.
`ciscoCUAEURL`	Optional. String.	Holds a semicolon delimited list of CUAE (Cisco Unified Application Environment) URLs.
`ciscoIPPhone`	Optional. Valid values are TRUE and FALSE.	Determines whether to enable or disable CISCO IP phone integration to PT.
`clientVersion`	Required. String.	The version of a session client.
`componentVersion`	Optional. String.	Stores the component version number.
`concurrentLicense`	Optional. Integer.	Number of concurrent users allowed.
`conferencePrice`	Optional. Double.	Per minute price for Pay-Per-User Meetings.
`configTollandTollFreeNum`	Optional. Valid values are TRUE and FALSE.	Determines where toll and tollfree numbers are saved.
`configPrimaryTS`	Optional. Valid values are TRUE and FALSE.	Toggles the option "Configurable Primary Telephony Server by Countries".
`connectNameSpaceID`	Optional. String.	Holds the organization ID code.
`connectOrganization`	Optional. String.	Holds the organization name.
`connectServerURL`	Optional. String.	Holds the connect server URL.
`contactUs`	Optional. Container.	Holds the Contact Us link fields.
`countryAlias`	Required. String.	Holds the country's alias.
`creditCardAuthorRetries`	Optional. Integer.	Number of attempts to try credit card authorization for Pay Per User.
`CUMAURL`	Optional. String.	The CUMA URL.
`currency`	Required. String. Valid values are US Dollars, Australian Dollars, Canadian Dollars, British Pounds, Euros, French Francs, Deutschmarks, Hong Kong Dollars, Italian Lira, Japanese Yen, New Zealand Dollars, Swiss Francs, Swedish Kroner, Korean Won, Mexico, Argentina, Chile, Colombia, and Venezuela.	Local currency.
`customereCommerce`	Optional. Valid values are TRUE and FALSE.	Available for Business Exchange Partner websites. Indicates that your organization uses its own service for billing users of your Webex service site.
`customerManage`	Optional. Valid values are TRUE and FALSE.	Determines if the customer manages their own TS Audio.
`customizedName`	Optional. String.	A customized name that overrides .
`customLink`	Optional. linkType.	Custom links.
`date`	Optional. String.	A GMT reference date and time for Daylight Savings time determination.
`daylightLabel`	Optional. String.	Defines the Daylight Saving Time label.
`description`	Required. String.	Time zone description, formatted at GMT-HH:MM, Region (City).
`defaultChoice`	Optional. Integer.	Default choice index of an option button group.
`defaultPhoneLines`	Optional. Integer.	Default number of lines to reserve for teleconference.
`defaultSpeakingLines`	Optional. Integer.	Defaults number of speaking lines for teleconference.
`defaultTeleServerSubject`	Optional. String.	Determines the default telephony server subject.
`disallow3XRepeatedChar`	Required. Valid values are TRUE and FALSE.	Determines if a character can be repeated more than 3 times in a password.
`disallowList`	Required. Valid values are TRUE and FALSE.	Specifies if passwords from a list are to be allowed.
`disallowValue`	Optional. String.	Sets password values that are not allowed.
`disallowWebTextAccounts`	Optional. Value values are TRUE and FALSE.	Determines if dynamic web page text is allowed for account passwords.
`disallowWebTextSessions`	Optional. Value values are TRUE and FALSE.	Determines if dynamic web page text is allowed for session passwords.
`displayAttendeeID`	Optional. Value values are TRUE and FALSE.	Determines if attendee IDs are displayed.
`displayDisabledService`	Optional. Value values are TRUE and FALSE.	Corresponds to the "Display services that are not enabled for this site" checkbox.
`displayMeetingActualTime`	Optional. Valid values are TRUE and FALSE.	Determines if "Display meetings at actual start time, not scheduled time (MC, $C)" checkbox is displayed on Site Admin.
`displayOffset`	Optional. Valid values are TRUE and FALSE.	Determines whether or not the GMT offset is displayed in emails and web pages.
`displayOnCallAssistLink`	Optional. Valid values are TRUE and FALSE.	Displays OnCall assist link for customer site.
`displayProfileLink`	Optional. Valid values are TRUE and FALSE.	Displays "My Profile" link to allow users to change their personal settings.
`downloads`	Optional. Container.	Holds the Downloads link fields.
`e2e`	Optional. Valid values are TRUE and FALSE.	Enables E2E.
`email`	Optional. Valid values are TRUE and FALSE.	Enable the Email method to interact with customers.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`emailReminders`	Required. Valid values are TRUE and FALSE.	Determines if email reminders are to be sent out.
`emails`	Optional. Valid values are TRUE and FALSE.	Enables Email templates.
`enable`	Optional. Valid values are TRUE and FALSE.	Determines if productivity tools are enabled on superadmin.
`enableAdaptor`	Required. Valid values are TRUE and FALSE.	Determines if the TSP Adaptor is enabled.
`enabled`	Required. Valid values are TRUE and FALSE.	Indicates whether one of the services (Meeting Center, Event Center, Training Center, Support Center, and Sales Center) is enabled on the site.
`enableMyWebexPro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro feature for the site.
`enableServer`	Optional. Valid values are TRUE and FALSE.	Determines if the Telephony server is enabled.
`encryption`	Optional. String.	Holds the encryption string.
`eNewsletters`	Optional. Valid values are TRUE and FALSE.	Enables the News Letters to interact with customers.
`enforceBaseline`	Required. Valid values are TRUE and FALSE.	Determines if "Enforce password security baseline" value on Super Admin is used.
`entryExitTone`	Required.	Determines if a sound is made when someone enters or exits.
`eventCenter`	Optional. Valid values are TRUE and FALSE.	Controls whether or not to return EC specific settings. Defaults to FALSE.
`eventCenter` (in GetSiteResponse)	Optional. Container.	Holds the event center registration fields.
`eventDocument`	Optional. Valid values are TRUE and FALSE.	Enables My Files - Recorded events for My Webex Standard.
`eventDocumentPro`	Optional. Valid values are TRUE and FALSE.	Enables My Files - Recorded events for My Webex Pro.
`excel`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft Excel integration.
`explorerRightClick`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft Windows explorer right click menu integration.
`fallInDST`	Optional. Valid values are TRUE and FALSE.	Enables "Automatically Set Time Ahead by 1 Hour for Daylight Saving Time" if the date falls within DST.
`fax`	Optional. Valid values are TRUE and FALSE.	Enable the Fax method to interact with customers.
`fileFolderCapacity`	Optional. Integer.	File folder capacity for the site in MB.
`firefox`	Optional. Valid values are TRUE and FALSE.	Sets Mozilla Firefox integration.
`folders`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Standard - Personal Folders.
`foldersPro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro - Personal Folders.
`globalCallInNumURL`	Optional. String.	Holds the global call-in numbers for TSP adapter servers.
`globalNum`	Optional. Container.	Corresponds to the Global Call-in Numbers in the telephony domain.
`gmtOffset`	Required. Integer.	The number of minutes to add or subtract from GMT to obtain local time for a time zone.
`googleTalk`	Optional. Valid values are TRUE and FALSE.	Sets Google talk messenger integration.
`groupLabel`	Required. String.	The label for a group.
`handsOnLab`	Optional. Valid values are TRUE and FALSE.	Enables Hands-on Lab functionality in Training Center.
`height`	Optional. Integer.	The height of the text box.
`hideTimeZoneName`	Optional. Valid values are TRUE and FALSE.	Determines if the time zone name is hidden.
`holMaxComputers`	Optional. Long.	Determines the maximum number of reserved computers for a training session.
`holMaxLabs`	Optional. Long.	Determines the maximum number of Hands-on Labs allowed for your website.
`holReport`	Optional. Long.	Determines if Hands-on Lab report is supported. 1 stands for TRUE, and 0 stands for FALSE.
`hostProfile`	Required. Enumeration.	Valid values are NOT_USED, OPTIONAL, REQUIRED, and ADMIN_SET.
`hpUnix`	Optional. Valid values are TRUE and FALSE.	Enables HP-Unix client.
`HQvideo`	Required. Valid values are TRUE and FALSE.	Indicates if high-quality video is enabled in both Super Admin and Site Admin.
`hybridTeleconference`	Optional. Valid values are TRUE and FALSE.	Holds if "Enable hybrid audio" is selected.
`iCalendar`	Optional. Valid values are TRUE and FALSE.	Specifies that an iCalendar file will be available for users to update calendars.
`iconURL`	Optional. String.	The URL of the icon for the link.
`IE`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft Internet Explorer integration.
`iGoogle`	Optional. Valid values are TRUE and FALSE.	Enables iGoogle integration.
`incl`	Optional. Valid values are TRUE and FALSE.	Indicates whether or not this field is included in the EC registration form.
`index`	Required. An integer ranging from 1 to 10.	The index of a tracking code group.
`index` (in textBox)	Optional. Integer.	The index of this option button group in all custom fields.
`inputMode`	Required. String.	The input method for a tracking code group.
`installOpts`	Optional. Container.	Holds the installation options section on siteadmin.
`instantHelp`	Optional. Valid values are TRUE and FALSE.	Determines if Instant Help is turned on.
`instantMeeting`	Optional. Valid values are TRUE and FALSE.	Enables starting instant meetings that don't require scheduled times, and so on.
`instantMessenger`	Optional. Valid values are TRUE and FALSE.	Sets instant messenger integration on superadmin and siteadmin.
`integrations`	Optional. Container.	Holds the integration settings for superadmin and siteadmin.
`internalMeeting`	Optional. Valid values are TRUE and FALSE.	Determines if a site supports internal meeting options.
`internetPhone`	Optional. Valid values are TRUE and FALSE.	Enables Voice Over IP functionality using the attendee computer's speakers and microphones.
`intlCallBackTeleconferencing`	Optional. Valid values are TRUE and FALSE.	Enables the international call-back teleconferencing.
`intLocalCallIn`	Optional.Valid values are TRUE and FALSE.	Specifies access to teleconference via global call-in numbers.
`intLocalNum`	Optional. String.	Holds a set of international local callin phone numbers. Each phone number and locale set is separated by "%". For example:"0800-032-2434 UK%0800-022-3703 Netherlands%0800-181-5365 Germany".
`iPhoneDusting`	Optional. Valid values are TRUE and FALSE.	Determines if the iPhone dusting option is enabled.
`isContinue`	Optional. Valid values are TRUE and FALSE.	If TRUE, keeps the teleconference going even if the network connection breaks.
`isECommmerce`	Optional. Valid values are TRUE and FALSE.	Enables credit card e-commerce capability.
`isEnterprise`	Required. Valid values are TRUE and FALSE.	If TRUE, specifies a Enterprise Edition site; if FALSE, not.
`isLicenseManager`	Required. Valid values are TRUE and FALSE.	Determines whether the meeting is controlled by License Manager.
`isLocalTax`	Optional. Valid values are TRUE and FALSE.	For e-commerce, determines whether or not local tax is collected.
`isSpecified`	Optional. Valid values are TRUE and FALSE.	If TRUE, always use the telephony server specified in the tele server name.
`isTSPUsingTelephonyAPI`	Optional. Valid values are TRUE and FALSE.	Enables TSP bridge adapter API.
`java`	Optional. Valid values are TRUE and FALSE.	Enables the Java client.
`joinBeforeHost`	Required. Valid values are TRUE and FALSE.	Allow attendees or panelists to join before the host.
`joinTeleconfNotPress1`	Required. Valid values are TRUE and FALSE.	Specifies whether or not Join Teleconference without pressing one is checked by default.
`label`	Required. String.	The label of an item.
`label` (in mpAudio)	Optional. String.	Holds the Cisco Unified MeetingPlace call-in number label.
`linux`	Optional. Valid values are TRUE and FALSE.	Enables the Linux client.
`localTaxName`	Optional. String.	The name of the local tax for ecommerce sites. For example, VAT.
`localTaxRate`	Optional. Integer.	The percentage rate of the local taxes for e-commerce enabled sites.
`lockDown`	Optional. Valid values are TRUE and FALSE.	Checkbox for "Lock down Productivity Tools for this site to".
`lotusNotes`	Optional. Valid values are TRUE and FALSE.	Sets IBM Lotus Notes integrations on superadmin and siteadmin.
`lotusSametime`	Optional. Valid values are TRUE and FALSE.	Sets Lotus Sametime Messenger integration.
`macOS9`	Optional. Valid values are TRUE and FALSE.	Enables the Mac OS 9 client.
`macOSX`	Optional. Valid values are TRUE and FALSE.	Enables the Mac OS X client.
`mail`	Optional. Valid values are TRUE and FALSE.	Enable the Mail method to interact with customers.
`majorAreaCode`	Optional. String.	Major area code for telephone. For example, 916.
`majorCountryCode`	Optional. String.	Major country code for telephone.
`marketingAddOn`	Optional. Valid values are TRUE and FALSE.	Defines whether or not the site supports EC program.
`maxBandwidth`	Optional. Enumeration. Valid values are LOW, MEDIUM, and HIGH.	Specifies the maximum HQ video bandwidth set in Site Admin.
`maxCallersNumber`	Optional. Integer.	Default maximum number of callers.
`maxConcurrentEvents`	Optional. Integer.	Maximum number of concurrent events.
`meetingAssist`	Optional. Valid values are TRUE and FALSE.	Enables Meeting Assist.
`meetingCalendar`	Optional. Valid values are TRUE and FALSE.	Enables Meeting Calender.
`meetingDomain`	Required. String.	Meeting domain name.
`meetingPlace`	Optional. Complex.	Contains the MeetingPlace elements.
`meetings`	Required. Container.	Holds the meeting security options.
`meetingTypeID`	Required. Integer.	Specifies the session type ID number.
`meetingTypeName`	Required. String. Valid values are: ■ PRE, PRO and STD (Meeting Center) ■ OCS and SC3 (Support Center) ■ ONS (Event Center) ■ TRS (Training Center) ■ RAS (Access Anywhere) ■ SAC (Sales Center) ■ SMT (SMARTtech)	Specifies the session type prefix code.
`minAlpha`	Required. Int.	Sets the minimum number of alphabetical characters in the password.
`minLength`	Required. Int.	Sets the minimum password length.
`minNumeric`	Required. Int.	Sets the minimum number of numeric characters in the password.
`minSpecial`	Required. Int.	Sets the minimum number of special characters in the password.
`mixedCase`	Required. Valid values are TRUE and FALSE.	Determines if a password requires mixed case.
`mpAudio`	Optional. Container.	Holds all Cisco Unified MeetingPlace audio conferencing labels and numbers. There are three groups and every group includes twelve pairs of labels and numbers.
`mpAudioConferencing`	Required. Valid values are WithoutIntegration and Integration.	Sets the Support Directory Service MeetingPlace audio conferencing settings. Defaults to WithoutIntegration.
`mpInternalMeetingLink`	Optional. String.	Holds the MP intranet meeting link.
`mpLogoutURL`	Optional. String.	Holds the MP logout URL.
`mpProfileURL`	Optional. String.	Holds the user profile URL.
`msWindows`	Optional. Valid values are TRUE and FALSE.	Enables native Microsoft Windows client.
`multiMediaHostName`	Optional. String.	the host name of the multi-media controller.
`multiMediaPlatform`	Optional. Valid values are TRUE and FALSE.	Determines whether or not the multimedia option is enabled.
`myComputer`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex Standard - Access Anywhere functionality. Default: FALSE.
`myComputerNumbers`	Optional. Integer.	Determines the number of computers allowed for My Webex Standard - Access Anywhere.
`myComputerNumbersPro`	Optional. Integer.	Determines the number of computers allowed for My Webex Pro - Access Anywhere.
`myComputerPro`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex Pro - Access Anywhere functionality. Default: FALSE.
`myContacts`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Standard - Personal Contacts list.
`myContactsPro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro - Personal Contacts list.
`myFilesStorage`	Optional. Long.	Storage limit in MB for My Webex Standard - My Files.
`myFilesStoragePro`	Optional. Long.	Storage limit in MB for My Webex Pro - My Files.
`myMeetings`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Standard - My Meetings feature.
`myMeetingsPro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro - My Meetings feature.
`myProfile`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Standard - My Profile feature.
`myProfilePro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro - My Profile feature.
`myReport`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Standard - My Reports feature.
`myReportPro`	Optional. Valid values are TRUE and FALSE.	Enables My Webex Pro - My Reports feature.
`myWebexDefaultPage`	Required. Enum { My Meetings, My Workspaces, My Computers, My Files:Folders, My Files:Training Recordings, My Files: Recorded Events, My Reports, My Profile, My Contacts }.	Determines the default page that My Webex points to.
`myWebexProHostLimit`	Enumeration. Valid values are STRICT, WARN_EXCEED, and NONE.	Specifies the host limit information for My Webex Pro.
`myWebexProMaxHosts`	Optional. Long.	Determines the maximum number of hosts for My Webex Pro.
`name`	Required. String.	The name of a tracking code group.
`name` (in linkType)	Optional. String.	The name of the link.
`nbrProfileNumber`	Optional. String.	Holds the NBR profile number.
`nbrProfilePassword`	Optional. String.	Holds the NBR profile password.
`office`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft Office integration on superadmin and siteadmin.
`officeCalendar`	Optional. Valid values are TRUE and FALSE.	Enables Office Calender feature.
`oneClick`	Optional. Valid values are TRUE and FALSE.	Enables One-click on superadmin and siteadmin.
`order`	Required. Integer.	Button for the display order.
`otherTeleServiceName`	Optional. String.	Displays the name of OTHER teleconferencing.
`outlook`	Optional. Valid values are TRUE and FALSE.	Enables Microsoft Outlook integration on superadmin and siteadmin.
`outlookIntegration`	Optional. Valid values are TRUE and FALSE.	Enables Outlook Integration for session scheduling.
`pageLanguage`	Required. String. Valid values are: ENGLISH, INTERNATIONAL ENGLISH, SIMPLIFIED CHINESE, TRADITIONAL CHINESE, JAPANESE, KOREAN, FRENCH, CANADIAN FRENCH, GERMAN, ITALIAN, CASTILIAN SPANISH, SPANISH, SWEDISH, DUTCH, and BRAZILIAN PORTUGUESE.	Sets the language for the site Web pages.
`pageVersion`	Required. String.	The Web page version of Webex service(s).
`palm`	Optional. Valid values are TRUE and FALSE.	Enables native PalmOS client.
`participantAccessCodeLabel`	Optional. String.	Display name for the participant access code.
`partnerID`	Required. String.	Partner ID for the site. Note: `This element displays a string of asterisks ("******") for regular hosts who call GetSite; the real partner ID will be returned only for users with the Site Admin or Site Admin - View Only privilege.`
`partnerIntegration`	Optional. Boolean.	Value of the checkbox.
`partnerLink`	Optional. linkType.	Partner links.
`passwordChangeInterval`	Required. Integer.	Holds the value for "Minimum password change interval X hours" on Site Admin.
`passwordChangeIntervalOpt`	Required. Valid values are TRUE and FALSE.	Determines if the value for "Minimum password change interval X hours" on Site Admin is used.
`passwordCriteria`	Required. Container.	Holds the strict password criteria.
`passwordExpires`	Required. Boolean.	Indicates whether the "Force users to change password every X days" option is enabled in the Site Administration tool.
`passwordLifetime`	Required. Integer.	Indicates the number of days left until the user password will expire if the "Force users to change password every X days" option is enabled in Site Administration.
`pcNow`	Optional. Valid values are TRUE and FALSE.	Enables PNCNow integration.
`persistentTSP`	Optional. Valid values are TRUE and FALSE.	Determines if a Persistent TSP adaptor is enabled. Defaults to FALSE.
`personalMeetingPage`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex Standard - Personal Meeting room page.
`personalMeetingPagePro`	Optional. Valid values are TRUE and FALSE.	Enables the My Webex Pro - Personal Meeting room page.
`phone`	Optional. Valid values are TRUE and FALSE.	Enable the Phone method to interact with customers.
`phoneNumber`	Required. String.	Holds the global phone number.
`phoneNumber` (in mpAudio)	Optional. String.	Holds the Cisco Unified MeetingPlace call in number.
`PMRheaderBranding`	Optional. Boolean.	Allows host to customize the personal meeting room branding.
`PMRheaderBrandingLocation`	Optional. Enum {Above, Replace, Below}.	Determines the location of the personal meeting room branding.
`powerPoint`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft PowerPoint integration.
`pressReleases`	Optional. Valid values are TRUE and FALSE.	Enables the Press Release to interact with customers.
`primaryAdaptorURL`	Optional. String.	URL for the Primary telephony adaptor.
`primaryLarge`	Required. tspServerType.	Holds the primary large telephony server settings.
`prodSvcAnnounce`	Optional. Valid values are TRUE and FALSE.	Enables the Product Service Announcement to interact with customers.
`productivityTools`	Optional. Container.	Holds the productivity tools setting on superadmin and siteadmin.
`promotionsOffers`	Optional. Valid values are TRUE and FALSE.	Enables the Promotion Offers to interact with customers.
`provisionTeleAccount`	Optional. Valid values are TRUE and FALSE.	Provision teleconference accounts.
`publicName`	Optional. String.	Generic name to display in session client attendee list for dial-in only users. For example, Call-In User.
`publishRecordings`	Optional. Valid values are TRUE and FALSE.	Enables publishing session recordings on the site.
`recordingAndPlayback`	Optional. Valid values are TRUE and FALSE.	Enables session recording.
`recordingEditor`	Optional. Valid values are TRUE and FALSE.	Enables users to access the session recording editor.
`region`	Required. String. Valid values are: U.S., Australia, Canada, French Canada, China, Germany, Hong Kong, Italy, Japan, Korea, New Zealand, Spain, Sweden, Switzerland, Taiwan, U.K., Mexico, Argentina, Chile, Colombia, Venezuela, and Brazil.	Geographic region for the site.
`req`	Optional. Valid values are TRUE and FALSE.	Indicates whether or not this field is required.
`requireApproveJoin`	Optional. Valid values are TRUE and FALSE.	Requires hosts to approve each user that users One-Click to join meetings without passwords.
`requireLoginBeforeSiteAccess`	Optional. Valid values are TRUE and FALSE.	Determines if a user must login before getting site access.
`restrictAccessAnyApps`	Optional. Valid values are TRUE and FALSE.	If TRUE, enables Restrict Access Anywhere applications; if FALSE, does not enable.
`restrictAccessAnyAppsNum`	Optional. Long.	Determines the number of Restrict Access Anywhere applications. Default value is 3.
`returnSettings`	Optional. Container.	Holds control over returning site specific settings.
`saveSessionTemplate`	Optional. Valid values are TRUE and FALSE.	Determines is a host can save the meeting template. Default: TRUE.
`scheduleOnBehalf`	Optional. Valid values are TRUE and FALSE.	Determines if a host can schedule on it's own behalf. Default: TRUE.
`scheduling`	Required. Enumeration. Valid values are NOT_USED, OPTIONAL, REQUIRED, and ADMIN_SET.	Indicates how a tracking code group is handled when scheduling a session or start an instant session of the type that is specified in the service element.
`score`	Optional. Integer.	The score of an item.
`scorm`	Optional. Valid values are TRUE and FALSE.	Enables the SCORM functionality for Training Center.
`secondaryAdaptorURL`	Optional. String.	URL for Secondary Telephony adaptor.
`serverIP`	Required. String.	Holds the TSP API server IP.
`service`	Required. String.	Indicates the service type for which a tracking code group will be handled.
`serviceName`	Optional. String.	Teleconferencing service name.
`serviceName` (in button type)	Optional. String.	Webex official service name {Welcome, Meeting Center, Event Center, Sales Center, etc.}.
`serviceType`	Required. Enumerated string. Valid values are Meeting Center, Event Center, Training Center, Support Center, and Sales Center.	The services (Meeting Center, Event Center, Training Center, Support Center, and Sales Center) that are supported for this site.
`shortName`	Optional. String.	The short name for the time zone.
`showSysTrayIcon`	Optional. Valid values are TRUE and FALSE.	Shows the system tray icon.
`siteAdminReport`	Optional. Valid values are TRUE and FALSE.	Enables Site Administration tool Reports section.
`siteName`	Required. String.	Full name for the site.
`skype`	Optional. Valid values are TRUE and FALSE.	Sets Skype integrations.
`sms`	Optional. Valid values are TRUE and FALSE.	Determines if site enables text messaging.
`ssl`	Optional. Valid values are TRUE and FALSE.	Enables SSL encryption for the site.
`standardLabel`	Optional. String.	Defines the Standard Time label.
`state`	Enum {CLEARED, SELECTED}	The state of an item.
`strictPasswords`	Optional. Valid values are TRUE and FALSE.	Determines if strict passwords are required for meetings.
`strictUserPassword`	Optional. Valid values are TRUE and FALSE.	Determines if strict passwords are required for user accounts.
`subscribeName`	Optional. String.	Telephony subscriber name.
`subscribePassword`	Optional. String.	Telephony subscriber password.
`subscriberAccessCodeLabel`	Optional. String.	Display name for the subscriber access code.
`subScriptionService`	Optional. Valid values are TRUE and FALSE.	Enables subscription service.
`sunSolaris`	Optional. Valid values are TRUE and FALSE.	Enables Sun Solaris native client.
`support`	Optional. linkType	Contains the details about the support link.
`supportAdapterlessTSP`	Optional. Valid values are TRUE and FALSE.	Determines if the option "Support TSP accounts without an adaptor" is given to Super Admin.
`supportMenu`	Optional. Container.	Holds links under the Support heading.
`supportMyResources`	Optional. Valid values are TRUE and FALSE.	Determines whether or not to show the MyResources link. Defaults to TRUE.
`target`	Optional. Enum {NEW, MAIN, PARENT, TOP}.	Target window. Default is NEW.
`telephonyDomain`	Required. String.	Telephony domain name.
`telephonySupport`	Required. Enumerated string. Valid values are NONE, CALLIN, CALLBACK, OTHER.	Specifies the type of teleconference support for meetings.
`teleServerName`	Optional. String.	Name of the telephony server.
`templates`	Optional. Container.	Holds templates on SiteAdmin.
`timeZone`	String. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.	Time zone for the site.
`timeZoneID`	Required. An integer ranging from 0 to 61. For details, see Appendix A, Time Zone, Language Encoding, and Country Codes.	Determines the time zone for the geographic location of the meeting.
`tollFree`	Optional. Valid values are TRUE and FALSE.	Specifies whether toll-free call-in is available.
`tollFreeCallinTeleconferencing`	Optional. Valid values are TRUE and FALSE.	Enables toll-free call-in teleconferencing.
`tollFreeLabel`	Optional. String.	Label name for the toll-free call-in number.
`tollFreeNum`	Optional. String.	Returns the toll free call-in number.
`tollLabel`	Optional. String.	Label name for the toll call-in number.
`tollNum`	Required. String.	Returns the toll call-in number.
`trackingCode`	Optional. Valid values are TRUE and FALSE.	Enables tracking codes.
`training`	Optional. linkType.	Contains the details about the training link.
`trainingInfo`	Optional. Valid values are TRUE and FALSE.	Enables the Training Information to interact with customers.
`trainingRecordings`	Optional. Valid values are TRUE and FALSE.	Enables My Files - Training Center recordings storage for My Webex Standard.
`trainingRecordingsPro`	Optional. Valid values are TRUE and FALSE.	Enables My Files - Training Center recordings storage for My Webex Pro.
`TSDelay`	Optional. Integer.	Roll over delay for Instant Help in seconds.
`tspAdaptorSettings`	Optional. Complex.	Holds all 3 sets of TSP adaptor settings.
`TSPrimaryCountryCode`	Optional. String.	The primary TS country code.
`TSPrimaryName`	Optional. String.	The primary TS name.
`TSPrimaryNumber`	Optional. String.	The primary TS phone number.
`TSRouting`	Optional. Container.	Holds the TS information.
`TSSecondCountryCode`	Optional. String.	The secondary TS country code.
`TSSecondName`	Optional. String.	The secondary TS name.
`TSSecondNumber`	Optional. String.	The secondary TS phone number.
`type`	Enum.	The type of an item.
`ucfConfiguration`	Required. String. Valid values are UCF 2.0, UCF 2.1, UCF Beta, and No UCF.	UCF Configuration.
`updateTSPAccount`	Optional. Valid values are TRUE and FALSE.	Determines if the TSP account is updated.
`url`	Optional. String.	The URL of the link.
`userGuides`	Optional. Container.	Holds the User Guide link fields.
`userLockDown`	Optional. Valid values are TRUE and FALSE.	Determines if a user is locked down.
`useTemplate`	Optional. Valid values are TRUE and FALSE.	Allows the host to use templates when scheduling meetings in productivity tools.
`value`	Required. String.	The string value of a list item in one tracking code group.
`version`	Optional. String.	Dropdown list for 'Lock down Productivity Tools for this site to'.
`video`	Required. Container.	Holds the site video options.
`voip`	Required. Valid values are TRUE and FALSE.	Denotes if voip protocols are being used.
`voIPPrice`	Optional. Double.	Per minute price for Voice over IP service.
`webDomain`	Required. String.	Name of the Web Domain.
`webPageType`	Required. Enumeration. Valid values are J2EE and PHP.	Indicates the Web page type of a Webex service site.
`width`	Optional. Integer.	The width of the text box.
`windowsMessenger`	Optional. Valid values are TRUE and FALSE.	Sets Windows Messenger integrations.
`wirelessAccess`	Optional. Valid values are TRUE and FALSE.	Enables Wireless Access.
`word`	Optional. Valid values are TRUE and FALSE.	Sets Microsoft Word integration.
`xmlAPI`	Optional. Valid values are TRUE and FALSE.	Enables the XML API.
`yahooMessenger`	Optional. Valid values are TRUE and FALSE.	Sets Yahoo Messenger integrations.

Meeting Attendee Service

This section describes the Webex XML API operations related to the Meeting Attendee service. These operations allow you to invite, register, delete and retrieve Attendees from a previously scheduled Webex session.

Table 11-1 • Webex Meeting Attendee Service XML Messages

*XML Request Message*	*Description*
`CreateMeetingAttendee`	Adds Attendee to previously scheduled session.
`DelMeetingAttendee`	Removes Attendee from scheduled session.
`GetEnrollmentInfo`	Returns information from the pre-session enrollment form.
`LstMeetingAttendee`	Returns list of Attendees from scheduled session.
`RegisterMeetingAttendee`	Registers a new attendee to a scheduled session, or accepts or rejects an invited attendee.

CreateMeetingAttendee

The CreateMeetingAttendee request adds one or more attendees to a scheduled session of one of the Webex session types, including Meeting Center, Training Center, Event Center, Sales Center, or Teleconference-only sessions.

If <attendeeOptions><registration> is enabled in the CreateTrainingSession or CreateMeeting request, then CreateMeetingAttendee returns a unique registerID for each attendee. This registerID value can be specified when each attendee joins the session using the Training Center URL API m.php?AT=JM&MK=meetingKey...&RID=registerID command.

Note In the XML API requests, registerID is bound with the attendee having actually participated in the meeting. Thus, using LstmeetingattendeeHistory and LsttrainingattendeeHistory, Webex partners will be able to query which attendees attended the meeting and how long they participated in the meeting and their detailed registration information.

Note You can choose to send invitation email messages to the attendees by setting the value of emailInvitations. This setting overrides the corresponding site and meeting configuration, but it is only effective for the current session. Currently there are four email templates that are available for usage. Information on the templates may be found in 'Email Information'. The XML API will not send a schedule confirmation email message to the session host even if emailInvitations is set to TRUE. Sales team members can be invited to a meeting without being invited if this option is enabled.

Note: Lower Case email address modification

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

Figure 11-1 • Schema diagram for createMeetingAttendee

Note The expanded diagram for att:attendeeType(extension)can be found in schema diagrams and att:attendees can be found in schema diagrams.

Note

We recommend that you use <attendees> to add the attendees of a session, and only add attendees for one session with each request.
Set <role>=HOST to add the user as an alternate host.
The meetingKey element has been deprecated. We keep this for backward compatibility. New users please use sessionKey instead.

The sample XML document creates a new meeting participant for the meeting with the identifier 82679427.


<?xml version="1.0"?>
<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.attendee.CreateMeetingAttendee">
            <person>
                <name>alterhost</name>
                <address>
                    <addressType>PERSONAL</addressType>
                </address>
                <email>host1@test.com</email>
                <type>MEMBER</type>
            </person>
            <role>HOST</role>
            <sessionKey>808961063</sessionKey>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 11-2 • Schema diagram for createMeetingAttendeeResponse

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: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="att:CreateMeetingAttendeeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:attendeeId>13118243</att:attendeeId>
            <att:attendeeId>13118248</att:attendeeId>
            <att:attendeeId>13118253</att:attendeeId>
        </serv:bodyContent>
    </serv:body>
</serv:message>

DelMeetingAttendee

Allows hosts to remove an attendee from a session of one of the Webex session types, including Meeting Center, Training Center, Event Center, Sales Center, or Teleconference-only sessions.

Request

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

Figure 11-3 • Schema diagram for delMeetingAttendee

Note If attendeeID and attendeeEmail are specified for the same attendee, an error occurs, indicating that the specified attendee is not found. We recommend not deleting meeting attendees using attendeeID and attendeeEmail at the same time.

The sample XML document requests the deletion of the meeting attendee with an attendeeID value of 13118243.


<?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.attendee.DelMeetingAttendee">
            <attendeeID>13118243</attendeeID>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 11-4 • Schema diagram for delMeetingAttendeeResponse

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: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="att:DelMeetingAttendeeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
    </serv:body>
</serv:message>

GetEnrollmentInfo

Gets information about the pre-session form that attendees fill in before they join a Webex session. This API works for Event Center and Support Center.

Note Attendee enrollment status, IP address, hostname for IP, and registration submit time are only returned in EC sessions.

Request

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

Figure 11-5 • Schema diagram for getEnrollmentInfo

Note One Webex session may have multiple sub-sessions (different confID) for the same session key.

The sample XML document gets enrollment information with a specified conference ID.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service">
    <header>
        <securityContext>
            <webExID>host</webExID>
            <password>123456</password>
            <siteName>testsite</siteName>
        </securityContext>
    </header>
    <body>
        <bodyContent
            xsi:type="java:com.webex.service.binding.attendee.GetEnrollmentInfo">
            <sessionKey>987566789</sessionKey>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non global elements, refer to “Elements in Webex XML Schema Definitions for the Meeting Attendee Service”.

Response

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

Figure 11-6 • Schema diagram for getEnrollmentInfoResponse

Figure 11-7 • Schema diagram for getEnrollmentInfoResponse

Note The expanded diagram for att:matchingRecords can be found in schema diagrams.

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: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="att:getEnrollmentInfoResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:session>
                <att:confID>62916711</att:confID>
                <att:attendee>
                    <att:attendeeID>1697762</att:attendeeID>
                        <att:enrollFields>
                            <att:defaultFields>
                                <att:firstName>test</att:firstName>
                                <att:lastName>test</att:lastName>
                                <att:email>test@webex.com</att:email>
                                <att:company>webex</att:company>
                                <att:phoneNum>1,,6565,,,</att:phoneNum>
                                <att:title>sales</att:title>
                                <att:numEmployees>1-99</att:numEmployees>
                                <att:receiveInfo>false</att:receiveInfo>
                                <att:address1>longshan load</att:address1>
                                <att:address2>district</att:address2>
                                <att:city>suzhou</att:city>
                                <att:state>Jiangsu</att:state>
                                <att:zipcode>215000</att:zipcode>
                                <att:country>United States of America</att:country>
                                <att:leadSourceID />
                                <att:leadScore>0.0</att:leadScore>
                            </att:defaultFields>
                            <att:customFields />
                        </att:enrollFields>
                        <att:domain>aggen.webex.com</att:domain>
                        <att:ipAddress>172.16.250.4</att:ipAddress>
                        <att:submitTime>10/10/2007 01:44:55</att:submitTime>
                        <att:status>APPROVED</att:status>
                    </att:attendee>
                    <att:attendee>
                        <att:attendeeID>63</att:attendeeID>
                        <att:enrollFields>
                            <att:defaultFields>
                                <att:firstName>fname</att:firstName>
                                <att:lastName>lname</att:lastName>
                                <att:email>honjozz@sz.webex.com</att:email>
                                <att:company>compay a</att:company>
                        </att:defaultFields>
                        <att:customFields>
                            <att:field>
                                <att:label>Phone2</att:label>
                                <att:value>12345678</att:value>
                            </att:field>
                            <att:field>
                                <att:label>JasonCheck</att:label>
                                <att:value/>
                            </att:field>
                            <att:field>
                                <att:label>JaSCDrop</att:label>
                                <att:value/>
                            </att:field>
                        </att:customFields>
                    </att:enrollFields>
                </att:attendee>
                <att:matchingRecords>
                    <serv:total>2</serv:total>
                    <serv:returned>2</serv:returned>
                    <serv:startFrom>1</serv:startFrom>
                </att:matchingRecords>
            </att:session>
        </serv:bodyContent>
    </serv:body>
</serv:message>

LstMeetingAttendee

Retrieves the attendees information of a session hosted on the site. The session can be one of all the Webex session types including Meeting Center, Training Center, Event Center, Sales Center, or Teleconference-only sessions.

Request

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

Figure 11-8 • Schema diagram for lstMeetingAttendee

Note The expanded diagram for att:listControl can be found in schema diagrams.

The sample XML document is a query for all meeting participant services for the meeting that received the Webex-generated meetingKey value of 82679427. Be sure to use a valid value for a meeting of one of the users on your website.

<?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.attendee.LstMeetingAttendee">
            <meetingKey>82679427</meetingKey>
        </bodyContent>
    </body>
</serv:message>

Response

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

Figure 11-9 • Schema diagram for lstMeetingAttendeeResponse

Note The expanded diagram for att:matchingRecords can be found in schema diagrams and att:person can be found in schema diagrams.

The sample XML document shows an example of a possible response for the preceding query XML 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: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="att:lstMeetingAttendeeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:matchingRecords>
                <serv:total>3</serv:total>
                <serv:returned>3</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </att:matchingRecords>
            <att:attendee>
                <att:person>
                    <com:name>James Kirk</com:name>
                    <com:firstName>James</com:firstName>
                    <com:lastName>Kirk</com:lastName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones />
                    <com:email>Jkirk@sz.webex.com</com:email>
                    <com:type>VISITOR</com:type>
                </att:person>
                <att:contactID>28410622</att:contactID>
                <att:joinStatus>INVITE</att:joinStatus>
                <att:meetingKey>803754412</att:meetingKey>
                <att:sessionKey>803754412</att:sessionKey>
                <att:language>ENGLISH</att:language>
                <att:role>ATTENDEE</att:role>
                <att:locale>U.S.</att:locale>
                <att:timeZoneID>4</att:timeZoneID>
                <att:languageID>1</att:languageID>
                <att:attendeeId>28410622</att:attendeeId>
                <att:confId>65102084</att:confId>
                <att:status>
                    <att:invited>true</att:invited>
                    <att:registered>false</att:registered>
                    <att:rejected>false</att:rejected>
                    <att:accepted>false</att:accepted>
                </att:status>
            </att:attendee>
            <att:attendee>
                <att:person>
                    <com:name>test2</com:name>
                    <com:firstName>test2</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones />
                    <com:email>test2@webex.com</com:email>
                    <com:type>VISITOR</com:type>
                </att:person>
                <att:contactID>28411092</att:contactID>
                <att:joinStatus>INVITE</att:joinStatus>
                <att:meetingKey>803754412</att:meetingKey>
                <att:sessionKey>803754412</att:sessionKey>
                <att:language>ENGLISH</att:language>
                <att:role>ATTENDEE</att:role>
                <att:locale>U.S.</att:locale>
                <att:timeZoneID>4</att:timeZoneID>
                <att:languageID>1</att:languageID>
                <att:attendeeId>28411092</att:attendeeId>
                <att:confId>65102084</att:confId>
                <att:status>
                    <att:invited>true</att:invited>
                    <att:registered>false</att:registered>
                    <att:rejected>false</att:rejected>
                    <att:accepted>false</att:accepted>
                </att:status>
            </att:attendee>
            <att:attendee>
                <att:person>
                    <com:name>test1</com:name>
                    <com:firstName>test1</com:firstName>
                    <com:address>
                        <com:addressType>PERSONAL</com:addressType>
                    </com:address>
                    <com:phones />
                    <com:email>test1@webex.com</com:email>
                    <com:type>VISITOR</com:type>
                </att:person>
                <att:contactID>28411097</att:contactID>
                <att:joinStatus>INVITE</att:joinStatus>
                <att:meetingKey>803754412</att:meetingKey>
                <att:sessionKey>803754412</att:sessionKey>
                <att:language>ENGLISH</att:language>
                <att:role>ATTENDEE</att:role>
                <att:locale>U.S.</att:locale>
                <att:timeZoneID>4</att:timeZoneID>
                <att:languageID>1</att:languageID>
                <att:attendeeId>28411097</att:attendeeId>
                <att:confId>65102084</att:confId>
                <att:status>
                    <att:invited>true</att:invited>
                    <att:registered>false</att:registered>
                    <att:rejected>false</att:rejected>
                    <att:accepted>false</att:accepted>
                </att:status>
            </att:attendee>
        </serv:bodyContent>
    </serv:body>
</serv:message>

RegisterMeetingAttendee

Registers a new attendee to a scheduled session, or accepts or rejects an invited attendee. When used in conjunction with CreateMeeting or CreateMeetingAttendee, it implements the entire registration process for Meeting Center, as follows:

Create a Meeting with registration options turned on, using CreateMeeting.
Set joinStatus in CreateMeeting or CreateMeetingAttendee to INVITE to invite attendees to register for the Meeting.
Call RegisterMeetingAttendee to update attendees’ registration status to REGISTER, ACCEPT, or REJECT.

Note: Lower Case email address modification

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

Figure 11-10 • Schema diagram for registerMeetingAttendee

Note The expanded diagram for att:person can be found in Figure G-6.

The sample XML document registers two attendees to a session whose session key is 13643274.


<?xml version="1.0" encoding="UTF-8"?>
<serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:serv="http://www.webex.com/schemas/2002/06/service"
    xsi:schemaLocation="http://www.webex.com/schemas/2002/06/service">
    <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.attendee.RegisterMeetingAttendee">
            <attendees>
                <person>
                    <name>Bill Gates</name>
                    <title>title</title>
                    <company>microsoft</company>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <city>sz</city>
                        <country>china</country>
                    </address>
                    <phones>0</phones>
                    <email>bill@aaa.com</email>
                    <notes>notes</notes>
                    <url>https://</url>
                    <type>VISITOR</type>
                </person>
                <joinStatus>REGISTER</joinStatus>
                <role>ATTENDEE</role>
                <emailInvitations>true</emailInvitations>
                <sessionKey>13643274</sessionKey>
            </attendees>
            <attendees>
                <person>
                    <name>Bill1 Gates</name>
                    <title>title</title>
                    <company>microsoft</company>
                    <address>
                        <addressType>PERSONAL</addressType>
                        <city>sz</city>
                        <country>china</country>
                    </address>
                    <phones>0</phones>
                    <email>billl@aaa.com</email>
                    <notes>notes</notes>
                    <url>https://</url>
                    <type>VISITOR</type>
                </person>
                <joinStatus>REGISTER</joinStatus>
                <role>ATTENDEE</role>
                <emailInvitations>true</emailInvitations>
                <sessionKey>13643274</sessionKey>
            </attendees>
        </bodyContent>
    </body>
</serv:message>

For descriptions of the global elements in the security context of the header, see Global Request Elements in Security Context. For descriptions of the non global elements, refer to “Elements in Webex XML Schema Definitions for the Meeting Attendee Service”.

Response

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

Figure 11-11 • Schema diagram for registerMeetingAttendeeResponse

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:att="http://www.webex.com/schemas/2002/06/service/attendee">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>BACKUP</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="att:registerMeetingAttendeeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <att:register>
                <att:attendeeID>143147</att:attendeeID>
                <att:registerID>189613</att:registerID>
            </att:register>
            <att:register>
                <att:attendeeID>143152</att:attendeeID>
                <att:registerID>315556</att:registerID>
            </att:register>
        </serv:bodyContent>
    </serv:body>
</serv:message>

Elements in Webex XML Schema Definitions for the Meeting Attendee Service

The following table describes all the elements that are used in Webex XML API for the Meeting Attendee service.

*Element*	*Constraint(s)*	*Description*
`accepted`	Required. Boolean.	If TRUE, indicates an attendee has the ACCEPT join status.
`address1`	Optional. Maximum of 128 characters.	The first line of the attendee's street address.
`address2`	Optional. Maximum of 128 characters.	The second line of the attendee's street address.
`addressType`	Optional. Must be set to either PERSONAL or GLOBAL when the meeting participant that this service represents is not a registered Webex user.	Determines whether the meeting participant is a personal contact of the meeting host or is a site-wide (global) contact. Default: PERSONAL.
`attendeeId`	Optional. Long.	A Webex-assigned unique identification number attached to a meeting participant.
`city`	Optional. Maximum of 64 characters.	The attendee's city.
`company`	Optional. Maximum of 128 characters.	The attendee's company name.
`confID`	Optional. Long.	The unique conference ID associated with a session, used to register an attendee to the session with RegisterMeetingAttendee, or to list the session attendees' information with LstMeetingAttendee.
`contactID`	Optional. Long.	If populated, A reference to another service. A Webex-maintained reference to the contact information for a meeting attendee.
`country`	Optional. Maximum of 64 characters.	The attendee's country.
`domain`	String.	Attendee's web domain, hostname for IP.
`email`	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`emailInvitations`	Optional. Valid values are TRUE and FALSE.	Whether to send invitation email messages to the session attendees. Default is FALSE.
`fax`	Optional. Maximum of 64 characters.	The attendee's fax number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`firstName`	Optional. String.	The first name of an attendee.
`inclHistory`	Optional. Boolean.	Determines whether or not to include the attendee's history.
`invited`	Required. Boolean.	If TRUE, indicates an attendee has the INVITE join status.
`ipAddress`	String.	Attendee's IP address.
`joinStatus`	Optional. Valid values are REGISTER, ACCEPT, REJECT, and INVITE.	An attendee's status for a registration if the registration is required for a meeting. Defaults to INVITE.
`label`	Required. String.	The label for a custom field in a session enrollment form.
`language`	Required. String. Valid values are: ENGLISH, INTERNATIONAL ENGLISH, SIMPLIFIED CHINESE, TRADITIONAL CHINESE, JAPANESE, KOREAN, FRENCH, CANADIAN FRENCH, GERMAN, ITALIAN, CASTILIAN SPANISH, SPANISH, SWEDISH, DUTCH, and BRAZILIAN PORTUGUESE.	Language setting for the session attendee.
`languageID`	Optional. Long.	The ID of a language in the database.
`lastName`	Optional. String.	The last name of an attendee.
`leadScore`	Optional. String.	The enrollment score.
`leadSourceID`	Optional. String.	The enrollment lead source ID.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in "Specifying Boolean Relationships for Searches" on page 55.
`locale`	Optional. String.	The locale of the attendee.
`maximumNum`	Optional. Integer.	Limits the quantity of returned objects as described in "Choosing A Subset of Records" on page 54.
`meetingKey`	Required. Must be non-null.	A Webex-assigned meeting-unique value that is needed to join the particular meeting. A meeting may also be accessible from the Today's Scheduled Meetings Web page. See also listToPublic. meetingKey coexists with sessionKey for backward compatibility. One of them must be specified in the request.
`mobilePhone`	Optional. Maximum of 64 characters.	The attendee's mobile phone number. Format is a series of comma-separated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`name`	Optional. Maximum of 64 characters.	The name of a meeting attendee.
`notes`	Optional. Maximum of 2,048 characters.	The host's notes about the meeting participant. Default is "".
`numEmployees`	Optional. String. The number of employees for a company.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy whether to order in ascending or descending order.
`orderBy`	Optional. Valid values are CONFID, ATTENDEEID, ATTENDEETYPE, ATTENDEENAME, ATTENDEEWEBEXID, JOINSTATUS, EMAIL, PHONE, MOBILE, FAX, COMPANY, TITLE, URL, ADDRESS1, ADDRESS2, CITY, STATE, ZIPCODE, COUNTRY, NOTES, and ADDRESSTYPE.	Which elements to order by in the meetings returned.
`phone`	Optional. Maximum of 64 characters.	The attendee's phone number. Format is a series of commaseparated values for country code, area or city code, and local number. Country code and area code are optional. For example, "11,444,5551212" or "5553234". Default is "".
`phoneNum`	Optional. String.	Telephone number.
`receiveInfo`	Optional. Boolean.	Indicates whether or not an enrollee will receive information about future seminars in Event Center.
`registered`	Required. Boolean. If TRUE, indicates an attendee has the REGISTER join status.
`registerID`	Required. Long.	A Webex-assigned unique identification number for a session attendee following the result of a session registration activity. It can be used in the Training Center URL API m.php?AT=JM&RID=registerID command to track session attendance.
`rejected`	Required. Boolean.	If TRUE, indicates an attendee has the REJECT join status.
`returned`	Integer.	Indicates the returned number of matched records.
`role`	Optional. Enumerated string. Valid values are ATTENDEE, PRESENTER, and HOST.	The role of a session participant. The default is ATTENDEE. Note: `You can specify a participant as an alternate host by setting role to HOST. However, note that currently this only works for Meeting Center. If the site does not enable alternate host functionality, an exception is thrown.`
`sendEmail`	Optional. Valid values are TRUE and FALSE.	Determines if an email is sent on update.
`sessionKey`	Required if you select the attendeeEmail option. Long.	Denotes the session to add or delete the attendee from.
`startFrom` (in listControl element)	Optional. Integer.	Works with maximumNum to limit the quantity of returned objects as described in "Choosing A Subset of Records" on page 54.
`startFrom` (in matchingRecords element)	Required. Integer.	The record index number from which the returned results set starts.
`state`	Optional. Maximum of 32 characters.	The attendee's state of residence.
`status`	Enum {PENDING, APPROVED, REJECTED}	The attendee enrollment request status.
`submitTime`	String.	Holds when the attendee submitted their enrollment request.
`timeZoneID`	Optional. String.	Preferred time zone ID of the attendee.
`title`	Optional. Maximum of 128 characters.	The attendee's title.
`total`	Integer.	Indicates the total number of matched records.
`type`	Optional. Valid values are MEMBER and VISITOR.	The Webex-maintained determination of whether the meeting participant represented by a service of this type is a member (registered on your Webex XML server as a user) or a visitor. Default: VISITOR.
`url`	Optional. Maximum of 128 characters.	The attendee's URL, such as the URL of the attendee's office. Default is "".
`value`	Optional. String.	The value for a custom field in a session enrollment form.
`webExID`	Optional. A reference to another service when AttendeeType is set to MEMBER. Maximum of 64 characters.	A reference to the Webex user account for the meeting participant. Empty if the attendee is a VISITOR.
`zipcode`	Optional. Maximum of 16 characters.	The attendee's ZIP/postal code.

Meeting Type Service

This section describes Webex XML operations related to the Meeting Type service. These operations allow you to list and get details about the Meeting/Session Types available on a Webex site.

Table 12-1 • Webex Meeting Type Service XML Messages

*XML Request Message*	*Description*
`GetMeetingType`	Returns meeting type details.
`LstMeetingType`	Returns a list of available meeting types for a Webex site.

GetMeetingType

Retrieves detailed information for the specified meeting type.

Element	Parent	Definition	Type	Default
`hideInScheduler`	`LstMeetingType:<meetingType>GetMeetingType:root`	Returns "Do not display in scheduler (For Telepresence only)" checkbox status for session type	boolean 0..1	`FALSE`

Request

The sample XML shows an example of a request to retrieve the meeting type information for meetings with meetingTypeID value of 1. Be sure to provide a valid value for a meeting type on your site.

<?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.meetingtype.GetMeetingType">
            <meetingTypeID>1</meetingTypeID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 12-3 • Schema diagram for getMeetingType

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:mtgtype="http://www.webex.com/schemas/2002/06/service/meetingtype">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="mtgtype:getMeetingTypeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <mtgtype:productCodePrefix>FRE</mtgtype:productCodePrefix>
            <mtgtype:active>ACTIVATED</mtgtype:active>
            <mtgtype:name>Free meeting</mtgtype:name>
            <mtgtype:displayName>Free meeting</mtgtype:displayName>
            <mtgtype:limits>
                <mtgtype:maxAppShareDuration>108</mtgtype:maxAppShareDuration>
                <mtgtype:maxAppShareUser>908</mtgtype:maxAppShareUser>
                <mtgtype:maxDesktopShareDuration>907
                </mtgtype:maxDesktopShareDuration>
                <mtgtype:maxDesktopShareUser>907</mtgtype:maxDesktopShareUser>
                <mtgtype:maxFileTransferUser>904</mtgtype:maxFileTransferUser>
                <mtgtype:maxMeetingDuration>60</mtgtype:maxMeetingDuration>
                <mtgtype:maxMeetingUser>60</mtgtype:maxMeetingUser>
                <mtgtype:maxRecordUser>902</mtgtype:maxRecordUser>
                <mtgtype:maxVideoDuration>103</mtgtype:maxVideoDuration>
                <mtgtype:maxVideoUser>903</mtgtype:maxVideoUser>
                <mtgtype:maxWebTourDuration>105</mtgtype:maxWebTourDuration>
                <mtgtype:maxWebTourUser>905</mtgtype:maxWebTourUser>
            </mtgtype:limits>
            <mtgtype:options>
                <mtgtype:supportAppShare>true</mtgtype:supportAppShare>
                <mtgtype:supportAppShareRemote>true
                </mtgtype:supportAppShareRemote>
                <mtgtype:supportAttendeeRegistration>true
                </mtgtype:supportAttendeeRegistration>
                <mtgtype:supportRemoteWebTour>true</mtgtype:supportRemoteWebTour>
                <mtgtype:supportWebTour>true</mtgtype:supportWebTour>
                <mtgtype:supportFileShare>false</mtgtype:supportFileShare>
                <mtgtype:supportChat>true</mtgtype:supportChat>
                <mtgtype:supportCobrowseSite>false</mtgtype:supportCobrowseSite>
                <mtgtype:supportCorporateOfficesSite>false
                </mtgtype:supportCorporateOfficesSite>
                <mtgtype:supportDesktopShare>true</mtgtype:supportDesktopShare>
                <mtgtype:supportDesktopShareRemote>true
                </mtgtype:supportDesktopShareRemote>
                <mtgtype:supportFileTransfer>true</mtgtype:supportFileTransfer>
                <mtgtype:supportInternationalCallOut>true
                </mtgtype:supportInternationalCallOut>
                <mtgtype:supportJavaClient>true</mtgtype:supportJavaClient>
                <mtgtype:supportMacClient>true</mtgtype:supportMacClient>
                <mtgtype:supportMeetingCenterSite>true
                </mtgtype:supportMeetingCenterSite>
                <mtgtype:supportMeetingRecord>true</mtgtype:supportMeetingRecord>
                <mtgtype:supportMultipleMeeting>true
                </mtgtype:supportMultipleMeeting>
                <mtgtype:supportOnCallSite>false</mtgtype:supportOnCallSite>
                <mtgtype:supportOnStageSite>false</mtgtype:supportOnStageSite>
                <mtgtype:supportPartnerOfficesSite>false
                </mtgtype:supportPartnerOfficesSite>
                <mtgtype:supportPoll>true</mtgtype:supportPoll>
                <mtgtype:supportPresentation>true</mtgtype:supportPresentation>
                <mtgtype:supportSolarisClient>true</mtgtype:supportSolarisClient>
                <mtgtype:supportSSL>true</mtgtype:supportSSL>
                <mtgtype:E2E>false</mtgtype:supportE2E>
                <mtgtype:PKI>false</mtgtype:supportPKI>
                <mtgtype:supportTeleconfCallIn>true
                </mtgtype:supportTeleconfCallIn>
                <mtgtype:supportTeleconfCallOut>true
                </mtgtype:supportTeleconfCallOut>
                <mtgtype:supportTollFreeCallIn>true
                </mtgtype:supportTollFreeCallIn>
                <mtgtype:supportVideo>true</mtgtype:supportVideo>
                <mtgtype:supportVoIP>true</mtgtype:supportVoIP>
                <mtgtype:supportWebexComSite>false</mtgtype:supportWebexComSite>
                <mtgtype:supportWindowsClient>true</mtgtype:supportWindowsClient>
                <mtgtype:supportQuickStartAttendees>false
                </mtgtype:supportQuickStartAttendees>
                <mtgtype:supportQuickStartHost>false
                </mtgtype:supportQuickStartHost>
            </mtgtype:options>
            <mtgtype:phoneNumbers>
                <mtgtype:primaryTollCallInNumber>1-408197043
                </mtgtype:primaryTollCallInNumber>
                <mtgtype:primaryTollFreeCallInNumber>1-408197041
                </mtgtype:primaryTollFreeCallInNumber>
            </mtgtype:phoneNumbers>
            <mtgtype:meetingTypeID>1</mtgtype:meetingTypeID>
            <mtgtype:serviceTypes>
                <mtgtype:serviceType>MeetingCenter</mtgtype:serviceType>
                <mtgtype:serviceType>EventCenter</mtgtype:serviceType>
            </mtgtype:serviceTypes>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 12-2 • Schema diagram for getMeetingTypeResponse

LstMeetingType

Lists detailed information of the meeting types on the current site.

Element	Parent	Definition	Type	Default
`hideInScheduler`	`LstMeetingType:<meetingType>GetMeetingType:root`	Returns "Do not display in scheduler (For Telepresence only)" checkbox status for session type	boolean 0..1	`FALSE`

Request

The sample XML is an example of a request for all meeting type service instances with a siteID value of 0000.

<?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.meetingtype.LstMeetingType">
            <listControl>
                <startFrom>1</startFrom>
                <maximumNum>10</maximumNum>
                <listMethod>OR</listMethod>
            </listControl>
            <meetingTypeID>1</meetingTypeID>
        </bodyContent>
    </body>
</serv:message>

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

Figure 12-3 • Schema diagram for lstMeetingType

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:mtgtype="http://www.webex.com/schemas/2002/06/service/meetingtype">
    <serv:header>
        <serv:response>
            <serv:result>SUCCESS</serv:result>
            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
        </serv:response>
    </serv:header>
    <serv:body>
        <serv:bodyContent xsi:type="mtgtype:lstMeetingTypeResponse"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <mtgtype:matchingRecords>
                <serv:total>1</serv:total>
                <serv:returned>1</serv:returned>
                <serv:startFrom>1</serv:startFrom>
            </mtgtype:matchingRecords>
            <mtgtype:meetingType>
                <mtgtype:productCodePrefix>FRE</mtgtype:productCodePrefix>
                <mtgtype:active>ACTIVATED</mtgtype:active>
                <mtgtype:name>Free meeting</mtgtype:name>
                <mtgtype:displayName>Free meeting</mtgtype:displayName>
                <mtgtype:limits>
                    <mtgtype:maxAppShareDuration>108</mtgtype:maxAppShareDuration>
                    <mtgtype:maxAppShareUser>908</mtgtype:maxAppShareUser>
                    <mtgtype:maxDesktopShareDuration>107
                    </mtgtype:maxDesktopShareDuration>
                    <mtgtype:maxDesktopShareUser>907</mtgtype:maxDesktopShareUser>
                    <mtgtype:maxFileTransferUser>904</mtgtype:maxFileTransferUser>
                    <mtgtype:maxMeetingDuration>60</mtgtype:maxMeetingDuration>
                    <mtgtype:maxMeetingUser>60</mtgtype:maxMeetingUser>
                    <mtgtype:maxRecordUser>902</mtgtype:maxRecordUser>
                    <mtgtype:maxVideoDuration>103</mtgtype:maxVideoDuration>
                    <mtgtype:maxVideoUser>903</mtgtype:maxVideoUser>
                    <mtgtype:maxWebTourDuration>105</mtgtype:maxWebTourDuration>
                    <mtgtype:maxWebTourUser>905</mtgtype:maxWebTourUser>
                </mtgtype:limits>
                <mtgtype:options>
                    <mtgtype:supportAppShare>true</mtgtype:supportAppShare>
                    <mtgtype:supportAppShareRemote>true
                    </mtgtype:supportAppShareRemote>
                    <mtgtype:supportAttendeeRegistration>true
                    </mtgtype:supportAttendeeRegistration>
                    <mtgtype:supportRemoteWebTour>true
                    </mtgtype:supportRemoteWebTour>
                    <mtgtype:supportWebTour>true</mtgtype:supportWebTour>
                    <mtgtype:supportFileShare>false</mtgtype:supportFileShare>
                    <mtgtype:supportChat>true</mtgtype:supportChat>
                    <mtgtype:supportCobrowseSite>false
                    </mtgtype:supportCobrowseSite>
                    <mtgtype:supportCorporateOfficesSite>false
                    </mtgtype:supportCorporateOfficesSite>
                    <mtgtype:supportDesktopShare>true
                    </mtgtype:supportDesktopShare>
                    <mtgtype:supportDesktopShareRemote>true
                    </mtgtype:supportDesktopShareRemote>
                    <mtgtype:supportFileTransfer>true
                    </mtgtype:supportFileTransfer>
                    <mtgtype:supportInternationalCallOut>true
                    </mtgtype:supportInternationalCallOut>
                    <mtgtype:supportJavaClient>true</mtgtype:supportJavaClient>
                    <mtgtype:supportMacClient>true</mtgtype:supportMacClient>
                    <mtgtype:supportMeetingCenterSite>true
                    </mtgtype:supportMeetingCenterSite>
                    <mtgtype:supportMeetingRecord>true
                    </mtgtype:supportMeetingRecord>
                    <mtgtype:supportMultipleMeeting>true
                    </mtgtype:supportMultipleMeeting>
                    <mtgtype:supportOnCallSite>false</mtgtype:supportOnCallSite>
                    <mtgtype:supportOnStageSite>false</mtgtype:supportOnStageSite>
                    <mtgtype:supportPartnerOfficesSite>false
                    </mtgtype:supportPartnerOfficesSite>
                    <mtgtype:supportPoll>true</mtgtype:supportPoll>
                    <mtgtype:supportPresentation>true
                    </mtgtype:supportPresentation>
                    <mtgtype:supportSolarisClient>true
                    </mtgtype:supportSolarisClient>
                    <mtgtype:supportSSL>true</mtgtype:supportSSL>
                    <mtgtype:E2E>false</mtgtype:supportE2E>
                    <mtgtype:PKI>false</mtgtype:supportPKI>
                    <mtgtype:supportTeleconfCallIn>true
                    </mtgtype:supportTeleconfCallIn>
                    <mtgtype:supportTeleconfCallOut>true
                    </mtgtype:supportTeleconfCallOut>
                    <mtgtype:supportTollFreeCallIn>true
                    </mtgtype:supportTollFreeCallIn>
                    <mtgtype:supportVideo>true</mtgtype:supportVideo>
                    <mtgtype:supportVoIP>true</mtgtype:supportVoIP>
                    <mtgtype:supportWebexComSite>false
                    </mtgtype:supportWebexComSite>
                    <mtgtype:supportWindowsClient>true
                    </mtgtype:supportWindowsClient>
                    <mtgtype:supportQuickStartAttendees>false
                    </mtgtype:supportQuickStartAttendees>
                    <mtgtype:supportQuickStartHost>false
                    </mtgtype:supportQuickStartHost>
                </mtgtype:options>
                <mtgtype:phoneNumbers>
                    <mtgtype:primaryTollCallInNumber>1-408197043
                    </mtgtype:primaryTollCallInNumber>
                    <mtgtype:primaryTollFreeCallInNumber>1-40897041
                    </mtgtype:primaryTollFreeCallInNumber>
                </mtgtype:phoneNumbers>
                <mtgtype:meetingTypeID>1</mtgtype:meetingTypeID>
                <mtgtype:serviceTypes>
                    <mtgtype:serviceType>MeetingCenter</mtgtype:serviceType>
                    <mtgtype:serviceType>EventCenter</mtgtype:serviceType>
                </mtgtype:serviceTypes>
            </mtgtype:meetingType>
        </serv:bodyContent>
    </serv:body>
</serv:message>

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

Figure 12-4 • Schema diagram for lstMeetingTypeResponse

Figure 12-5 • Schema diagram for meetingType

Elements in Webex XML Schema Definitions for the Meeting Type Service

The following table describes all the elements that are used in Webex XML API for the Meeting Type service.

*Element*	*Constraint(s)*	*Description*
`active`	Optional. Valid values are ACTIVATED or DEACTIVATED.	Indicates whether the type of meeting represented by an object of this type is enabled or disabled. Default: ACTIVATED.
`displayName`	Optional.	The display name for the meeting type.
`email` (in all requests)	Optional. String.	The email address as stored in the user profile used for authentication in the security header. Authentication is not case sensitive.
`listMethod`	Optional. Valid values are AND and OR.	Specifies whether to use AND or OR for multiple search values as described in "Specifying Boolean Relationships for Searches" on page 55.
`maxAppShareDuration`	Optional. Numeric.	The maximum length, in minutes, of an application sharing session for meetings of this type. Default: 999999.
`maxAppShareUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the application-sharing function for meetings of this type. Default: 999999.
`maxDesktopShareDuration`	Optional. Numeric.	The maximum length, in minutes, of a desktop sharing session for meetings of this type. Default: 999999.
`maxDesktopShareUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the sharedesktop function for meetings of this type. Default: 999999.
`maxFileTransferUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the file transfer function for meetings of this type. Default: 999999.
`maximumNum`	Optional. Integer.	Limits the quantity of returned objects as described in "Choosing A Subset of Records" on page 54.
`maxMeetingDuration`	Optional. Numeric.	The maximum length, in minutes, of a meeting for meetings of this type. Default: 999999.
`maxMeetingUser`	Optional. Numeric.	The maximum number of meeting attendees for meetings of this type. Default: 999999.
`maxRecordUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the meeting record function to record a meeting, session, or event. Default: 999999.
`maxVideoDuration`	Optional. Numeric.	The maximum length, in minutes, of a video-conferencing session for meetings of this type. Default: 999999.
`maxVideoUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the video sharing function for meetings of this type. Default: 999999.
`maxWebTourDuration`	Optional. Numeric.	The maximum length, in minutes, of a Web tour for meetings of this type. Default: 999999.
`maxWebTourUser`	Optional. Numeric.	The maximum number of meeting attendees that can use the Web tour function for meetings of this type. Default: 999999.
`meetingTypeID` (in GetMeetingType request)	Integer. Required.	Specifies a unique value that identifies a particular meeting type whose detailed information you want to get.
`meetingTypeID` (in LstMeetingType request)	Integer. Optional.	Specifies IDs for the meeting types whose detailed information you want to get. If unspecified, LstMeetingType returns all available meeting types on a site.
`name`	Optional.	The name of the meeting type.
`orderAD`	Optional. Valid values are ASC and DESC.	When using orderBy whether to order in ascending or descending order.
`orderBy`	Optional. Valid values are MEETINGTYPEID, PRODUCTCODEPREFIX, MEETINGTYPENAME, MEETINGTYPEDISPLAYNAME.	Which elements to order by in the meetings returned.
`primaryTollCallInNumber`	Optional.	The telephone number for a toll call-in teleconference. Default: "".
`primaryTollFreeCallInNumber`	Optional.	The telephone number for a tollfree call-in teleconference. Default: "".
`productCodePrefix`	Optional. Valid values are INITIAL, FRE, STD, PRO, STANDARD_SUB, PRO_SUB, PPU, ONCALL, ONTOUR, ONSTAGE, ACCESS_ANYWHERE, COB, OCS, ONS, RAS, SC3, SOP, SOS, TRS, and CUSTOM.	Indicates the product label for the type of meeting. Webex partner sites are configured to support one or more meeting types with contractually agreed upon features. Default: PRO.
`returned`	Required if matchingRecords is specified.	The number of records returned in the response.
`serviceType`	Optional.	The type of meeting being returned.
`startFrom`	Required if matchingRecords is specified. Integer.	Works with maximumNum to limit the quantity of returned objects as described in "Choosing A Subset of Records" on page 54.
`supportAppShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether application sharing is supported for meetings of this type. Default: FALSE.
`supportAppShareRemote`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote application sharing is supported for meetings of this type. Default: FALSE.
`supportAttendeeRegistration`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type allow the registration of attendees. Default: FALSE.
`supportChat`	Optional. Valid values are TRUE and FALSE.	Indicates whether chat is supported for meetings of this type. Default: FALSE.
`supportCobrowseSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type can be used on the Webex.com site. Default: FALSE.
`supportCorporateOfficesSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type support the Webex Business Exchange (Corporate) site. Default: FALSE.
`supportDesktopShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether desktop sharing is supported for meetings of this type. Default: FALSE.
`supportDesktopShareRemote`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote desktop sharing is supported for meetings of this type. Default: FALSE.
`supportFileShare`	Optional. Valid values are TRUE and FALSE.	Indicates whether file sharing is supported for meetings of this type. Default: FALSE.
`supportFileTransfer`	Optional. Valid values are TRUE and FALSE.	Indicates whether the distribution of files among meeting participants is supported for meetings of this type. Default: FALSE.
`supportInternationalCallOut`	Optional. Valid values are TRUE and FALSE.	Indicates whether conference calling out of the meeting to nondomestic numbers is supported for meetings of this type. Default: FALSE.
`supportJavaClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Java-based Webex Meeting Center client is supported for meetings of this type. Default: FALSE.
`supportMacClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Macintosh based Webex Meeting Center client is supported for meetings of this type. Default: FALSE.
`supportMeetingCenterSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type support Webex Meeting Center. Default: FALSE.
`supportMeetingRecord`	Optional. Valid values are TRUE and FALSE.	Indicates whether recording of meetings is supported for meetings of this type. Default: FALSE.
`supportMultipleMeeting`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type allow multiple simultaneous meetings for each host. Default: FALSE.
`supportOnCallSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type support Webex OnCall. Default: FALSE.
`supportOnStageSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type support Webex OnStage. Default: FALSE.
`supportPartnerOfficesSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type supports Webex Business Exchange (Partner). Default: FALSE.
`supportPoll`	Optional. Valid values are TRUE and FALSE.	Indicates whether survey polling is supported for meetings of this type. Default: FALSE.
`supportPresentation`	Optional. Valid values are TRUE and FALSE.	Indicates whether document review and presentations are supported for meetings of this type. Default: FALSE.
`supportQuickStartAttendees`	Optional. Valid values are TRUE and FALSE.	Determines if QuickStart is shown to attendees.
`supportQuickStartHost`	Optional.Valid values are TRUE and FALSE.	Determines whether QuickStart is to show the host and the presenter.
`supportRemoteWebTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether remote Web touring is supported for meetings of this type. Default: FALSE.
`supportSolarisClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Solaris based Webex Meeting Center client is supported for meetings of this type. Default: FALSE.
`supportSSL`	Optional. Valid values are TRUE and FALSE.	Indicates whether secured socket layer (SSL) is used for all meeting communications that take place between Webex Meeting Center clients for meetings of this type. Default: FALSE.
`supportTeleconfCallIn`	Optional. Valid values are TRUE and FALSE.	Indicates whether conference calling into meetings is supported for meetings of this type. Default: FALSE.
`supportTeleconfCallOut`	Optional. Valid values are TRUE and FALSE.	Indicates whether conference calling out of meetings is supported for meetings of this type. Default: FALSE.
`supportTollFreeCallIn`	Optional. Valid values are TRUE and FALSE.	Indicates whether toll-free conference calling is supported for meetings of this type. Default: FALSE.
`supportVideo`	Optional. Valid values are TRUE and FALSE.	Indicates whether video is supported for meetings of this type. Default: FALSE.
`supportVoIP`	Optional. Valid values are TRUE and FALSE.	Indicates whether voice communications over the Internet (VoIP) is supported for meetings of this type. Default: FALSE.
`supportWebexComSite`	Optional. Valid values are TRUE and FALSE.	Indicates whether meetings of this type can be used on the Webex.com site. Default: FALSE.
`supportWebTour`	Optional. Valid values are TRUE and FALSE.	Indicates whether Web touring is supported for meetings of this type. Default: FALSE.
`supportWindowsClient`	Optional. Valid values are TRUE and FALSE.	Indicates whether a Windows based Webex Meeting Center client is supported for meetings of this type. Default: FALSE.
`total`	Required if matchingRecords is specified.	Total number of records matchingthe query request.

Service Common Schema Diagrams

The following shows schema diagrams for elements found in the service schema files.

XSD Schema Diagram: bodyContent

XSD Schema Diagram:

XSD Schema Diagram:

Specifying the XML API Service To Be Called

The xsi:type is how you tell the XML API service which command you want to use.

Example

The following XML snippet is the part of request message that specifies the XML API service to call.

The following example shows how to call the GetSite operation in the Site service.

<bodyContent xsi:type="java:com.webex.service.binding.site.GetSite">

XML API Reference Guide

Audience

XML Request and Response Documents

Global Request Elements in Security Context

Global Request Elements for List Control

Global Response Elements Showing Results and Errors

User Service

User Service In General

Spark Meet with Webex

Default Meeting Types

Teleconference Call-Back

AuthenticateUser

Order Of Priority

Request (using a samlResponse)

Request (using a password on a CI-enabled site)

Schema Diagram

Response

Schema Diagram

CreateUser

Join Before Host

Auto-enable CMR for new users

Request

Response

DelUser

Request

Response

DelSessionTemplates

Request

Response

GetloginTicket

Request

Response

GetloginurlUser

Request

Response

GetlogouturlUser

Request

Response

GetUser

Request

Response

LstsummaryUser

Request

Response

LstUser (Deprecated)

Request

Response

SetUser

Request

Response

UploadPMRImage

Request

Response

Elements in Webex XML Schema Definitions for the User Service

Complex Types Used By The User Session Service

Schema diagram: privilegeType element

Schema diagram: address element

Schema diagram: user element of type delUserStatusType

General Session Service

CreateContacts

Request

Response

CreateDistList

Request

Response

DelRecording

Request

Response

DelSession

Request

Response

DetectSessionByCallback

APIs impacted

XML Request Schema

Request

XML Response Schema

XML Response

Changed Behavior

Design

GetAPIVersion

Request (using a `samlResponse`)

Request (using a `password` on a CI-enabled site)

Schema diagram: `privilegeType` element

Schema diagram: `address` element

Schema diagram: `user` element of type `delUserStatusType`

Schema diagram: `contact` element