Webex XML API

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