XML API 8.0.0 SP 8 Release Notes



Email templates now support Plain Text and HTML

Description:

Meeting Center now uses HTML email templates by default. A new site level option allows Super Admin to control the format (HTML or Text).

When "Support HTML format emails" is checked, the system will use HTML email templates instead of plain text for emails.

Support HTML Emails

The email templates for the XML API do NOT support localization.

Affected API's:

CreateMeeting, SetMeeting, CreateMeetingAttendee, RegisterMeetingAttendee, DelSession, DelMeetingAttendee


GetSessionInfo now returns more information for mobile clients

Description:

GetSessionInfo now returns Is Registration ID RequiredRegistration ID, Registration Status, Registration URL, and panelist-related information for mobile users.

1. Is Registration ID Required:

The GetSessionInfo response now includes the new element isRegisterIDRequired. See figure below.

Figure 1

2. Registration ID:

This information is returned only if the user is an attendee, the event is set to registration required, and the attendee registration is approved.

3. Registration Status:

The definition of the original schema is pictured below. The registration status is actually returned as joinStatus.

Figure 3

The conditions are detailed in the table below, and apply to MC/TC, as well.

Invited Registered Rejected Approved GetSessionInfo Response
Y Y N Y ACCEPT
Y Y Y N REJECT
Y Y N N REGISTER
Y N N N INVITE
N Y N Y ACCEPT
N Y Y N REJECT
N Y N N REGISTER
N N N N No Return

4. Registration URL:

Originally GetSessionInfo already returned registrationURL, but not for EC mobile support. EC on mobile requires a new registration URL for display on the mobile device. The URL format is like this:


	http://<siteURL>.webex.com/${tc appname}/eventcenter/enroll/mobileRegister.do?
	formId=0&formType=0&loadFlag=1&siteurl=&confID=

If the user calls GetSessionInfo with login info, then it will return registrationURLForMobile. If the session ticket exists, then the API will return a login with session ticket URL such as:


	https://<siteURL>.webex.com/<siteurl>/p.php?
	AT=LI&WID=<username>&SK=<sessionticket>&MU=[registrationURL for mobile];
	</sessionticket></username></siteurl>

If the session ticket does not exist, then the return URL will be [registrationURL for mobile];

5. Panelist Information:

For an EC meeting, the attendee can join the EC meeting directly as an Attendee or as a Panelist. The Host can set the Panelist password.

Now GetSessionInfo returns the following information regarding panelists:

  1. attendeeRole, which indicates if the attendee is a panelist
  2. isPanelistPasswordRequired, which lets you know if the panelist needs a password
  3. panelistPassword, the password for the panelist

The isPanelistPasswordRequired and panelistPassword elements are added as seen below:

Figure 5

Element Parent Definition Type Default
panelistPassword getSessionInfoResponse Panelist password for Event Center String null
isPanelistPasswordRequired getSessionInfoResponse If an EC meeting requires a panelist password Boolean False

Affected API's:

GetSessionInfo


Remove $C related APIs from XML API

Description:

SP8 removes all Sales Center APIs from the XML API schema. Here are the APIs that are removed:

  • AddProducts
  • CreateAccount
  • CreateOpportunity
  • CreateSalesSession
  • DelSalesSession
  • GetSalesSession
  • LstAccounts
  • LstOpportunities
  • LstProducts
  • LsySummarySalesSession
  • SetAccount
  • SetOpportunity
  • SetProduct
  • SetSalesSession

Plus two API from history service are removed:

  • LstsalesAttendeeHistory
  • LstsalesSessionhistory

Affected API's:

All of the above APIs that have been removed.


Personal Meeting Room elements added for mobile users

Description:

GetSite adds the element enablePersonalMeetingRoom:

GetSessionInfo adds the element isPersonalMeetingRoom:

GetUser adds the element isEnablePMR and pilotNumber:


Affected API's:

GetSite, GetUser, GetSessionInfo


GethosturlMeeting should work for alternate hosts as well (XML API)

Description:

Alternate hosts for a meeting will now be able to get the "Host URL" for the meeting by calling "GethostURLMeeting" API. This was not previously supported.


Affected API's:

CreateTrainingSession, GetTrainingSession, SetTrainingSession


Support HD video in Training Center (XML API)

Description:

For Training Center, if a site supports HD Video, then the scheduling APIs will allow enabling of HD Video if specified either through a flag in request or through the use of a session template. If a site is set up for HD video by default, then all sessions will be set up for HD Video. If a site is not set up for HD Video, but API specifies that, an error will be returned.


Affected API's:

CreateTrainingSession, GetTrainingSession, SetTrainingSession


Identify Site/User default global access number if set (XML API)

Description:

For Meeting Center and Training Center, enhancements have been made to identify the default Global access number. The default global access number can be configured at site level and user level. The APIs will identify site level or user level defaults in the list of Global Access number returned by a new element "default" added to the globalNum element.


Affected API's:

GetMeeting, GetTrainingSession, GetSite, GetSessionInfo


Change in course material URL returned for Training Center and Event Center (XML API)

Description:

For Training Center and Event Center, as part of on-going security enhancements, the link being returned for course material download is going to be secured through new encryption. Old links will continue to work.


Affected Versions:

8.0.0, 7.3.0, 6.0.0, 5.9.0, 5.8.0, 5.6.0, 5.4.0


Affected API's:

GetSessionInfo


Bug Fixes and Other:
  • CSCuo53390 - XMLAPI scheduled CMR meeting can't be joined from TelePresence
  • CSCuo74800 - Miss security check when attendee join unlisted meeting from Productivity Tools 1-click
  • CSCup01449 - Change Event Center Materials URL link to short link