XML API 7.3.0 SP1 Release Notes


New Features


GetSite returns SSO more information

Description:

  1. GetSite API returns whether the site has enabled "SAML SSO" in element <enableSSO>, this value needs to be checked against SuperAdmin to verify if "SAML SSO" is enabled. If SuperAdmin supports SAML SSO , then return <enableSSO> as true, else return false.
  2. GetSite API returns whether the site has enabled "auto create account" in element <autoAccountCreation>, this value needs to be checked against SuperAdmin to verify if "SAML SSO" and "Allow Auto Account Creation" are both enabled. If SuperAdmin supports both of them, then return < autoAccountCreation> as true, else return false.

Affected API's:

GetSite


XSD Design:

The following new elements were added:

Element Parent Definition Type Default
samISSO siteType For saml SSO configuration on SuperAdmin Element, 1..1  
enableSSO samlSSO Indicate whether this site support saml SSO boolean, 1..1 false
autoAccountCreation samlSSO Indicate whether this site support auto create user account boolean, 1..1 false

Backward Compatibility:

No backward compatibility issue



GetSesssionInfo returns login URL with Session Ticket

Description:

Due to security restrictions, GetSessionInfo will not return login URL with "username" and "Password". This information will need to be retrieved form the "Session Ticket" provided by AS Client.

Note: Getting the Session Ticket from aSClient.createSessionTicket will have an affect on performace during the login process.

Affected API's:

GetSessionInfo


XSD Design:

No change


Backward compatibility:

In the previous release, "user name" and "password" requests do not have an expiration limit. However, the "Session Ticket" request will enforce an expired time. Once expired, a partner will need to request a new 'Session Ticket'.



First attendee becomes the presenter on MC

Description:

  • Enabled a new option to turn on/off "first attendee as presenter" when CreateMeeting, SetMeeting.
  • The value of "first attendee as presenter" will be returned on GetMeeting.
  • There is an option on the Site Admin page, allowing GetSite to return the option values.

Affected API's:

CreateMeeting, SetMeeting , GetMeeting, GetSite


XSD Design:

Added the element <firstAttendeeAsPresenter> on request for CreateMeeting, SetMeeting.
Added the element <firstAttendeeAsPresenter> on response for GetMeeting.
Added the element <firstAttendeeAsPresenter> on response for GetSite.

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

Backward Compatibility:

No backward compatibility issue.



For TC Single Recurrence Meeting, XMLAPI should return the meeting end status

Description:

On XMLAPI 7.3.0, the status of TC Single Recurrence just has "IN PROGRESS" AND "NOT_INPROGRESS". A new status "END" for TC Single Recurrence Meeting has been added.


Affected API's:

GetSessionInfo, LstSummarySession


XSD Design:

No change


Backward compatibility:

This status change is only for TC Single Recurrence Meeting, other meeting types will not be effected. lstSummarySession call is just supported for TC Single Recurrence meeting with XMLAPI 7.3.0. Therefore, there are no backward compatibility issue.



Bug Fixes


CSCue32413: SZ(XML7.3.0) getSessionInfo didn't return exceptionID

Affected API's:

GetSessionInfo


Problem:

When AES encrypting failes the JDK security, XMLAPI will throw the wrong exceptions (""Unable to encrypt").


Root Cause:

XMLAPI does not catch this type of exception.


Solution:

Catch and encapsulate the exception used by AES encrypting with the following XMLAPI exception (exception: 000044 Can not encrypt with AES HMAC).


Backward compatibility:

No backward compatibility issue.



CSCub38755: VoIP meeting audio type display None on MC

Affected API's:

GetSessionInfo


Problem:

No VoIP element on MC is found when meeting selected VOIP.


Root Cause:

The VOIP values had already been used and opened for TC on XMLAPI 7.3.


Solution:

Modify and open it for MC.


Backward compatibility:

No backward compatibility issue.



CSCub59510: XML API should return the Toll Free Flag and also TSP flag on MC

Affected API's:

GetSessionInfo


Problem:

The Toll Free Flag and TSP Flag were not found on MC when opening the meeting.


Root Cause:

The Toll Free Flag and TSP Flag values had already been used and opened for TC on XMLAPI 7.3.


Solution:

Modify and open it for MC.


Backward compatibility:

No backward compatibility issue.



CSCue05185: Reject person still can see session password and telephony

Affected API's:

GetSessionInfo


Problem:

For the meeting require registration, GetSessionInfo still returns meeting information such as 'meeting password' when a login user is not accepted by owner (Such as INVITE, PENDING and REJECT status for registration meeting).


Root Cause:

Due to new security hooks, there is no add permission control for INVITE, PENDING and REJECT users.


Solution:

Add a permission control for INVITE, PENDING and REJECT users. If the inputted meeting password is empty or login user is presenter, then the request will return all.

Note: If the attendee is PRESENTER, ALTERNATE HOST or SCHEDULE FOR, then it will return full meeting information.

Backward compatibility:

For meeting requires registration (MC, TC and EC):
INVITE, PENDING and REJECT user call GetSessionInfo without meeting password will return base meeting information.



CSCue22266: One of attendee/presenter can receive two reminder emails

Affected API's:

createTraingSession


Problem:

  1. CreateTrainingSession with 2 presenters and send reminder email.
  2. SetTrainingSession with the same 2 presenters and send reminder email.
  3. The 2nd presenter will receive duplicated reminder emails.

Root Cause:

Reminder email is sent by reminder engine. XMLAPI will insert data to related task table: WbxReminder. When SetTrainingSession with <attendee> or <presenter>, the old attendees and presenters for schedule meeting will be removed with the corresponding reminder data to avoid sending for wrong mail. The newly attendee and presenter reminder data will be saved based on attendees and presenters' reminder setting. The code logic has miss-caught some scenarios hence causing the problem.


Solution:

Changed the code logic to address this issue


Backward compatibility:

No backward compatibility issue.



CSCue22949: XMLAPI returned the URL are not same as web page

Affected API's:

GetSessionInfo


Problem:

The TollNum and TollFreeNum are different, XMLAPI result without the area code.


Root Cause:

The web page has been changed but without informs XMLAPI side, so XMLAPI doesn't add AREA code on TollNum and TollFreeNum.


Solution:

Add the AREA code for TollNum and TollFreeNum


Backward compatibility:

XMLAPI follow web page side to fix it.



CSCue29725: Add invitee/Delete meeting pops 31050 error if end meeting at PC first

Affected API's:

DelSession


Problem:

System error exception thrown when call delSession API.


Root Cause:

Actually this is dirty data from DB when synchronous operations for DROP meeting and GET meeting both on PC and Android pad. The DB returns the right CONFID which is a session key, but did not return the other meeting data, so XMLAPI throws a NullPointerException.


Solution:

Add a check NULL code when get whole meeting data from DB.


Backward compatibility:

No backward compatibility issue.



Appendices


GetSessionInfo response enhanced to return the following new elements:
Element Parent Definition Type Restrictions: PW=Return only w/meeting password or if caller is session host, invited attendee, panelist, or presenter. X=Never return Blank=Always return
        MC $C TC EC AO
registerID accessControl   string, 0..1 X X PW X X
joinStatus accessControl   Enum, 0..1 X X PW X X
registrationURLForMobile accessControl   String, 0..1 X X X X
registrationStatus accessControl   Enum, 0..1 X X X X
sessionFee metaData   long, 0..1 X X X X
hostKey root   String, 0..1 X X X X
agendaFormat metaData   Enum X PW
descriptionFormat metaData   Enum X X X X
voip telephony   PW X PW X X
isTSP telephony   PW X PW X X
tollFreeCallInData callInNum   X X PW X X
tollCallInData callInNum   X X PW X X
supportE2E root   PW X X X X
userRole root   X X PW X X