XML API 7.4.0 Release Notes
Overview
This release note describes the feature enhancements and improvements introduced in Webex® XML API 7.4.0. All features are backward compatible with existing integrations.
Important: Please note that this release includes changes to some of the XML API 7.x schema. For more information, see the updated schema definitions below.
Enable Support For Exception Meetings
In order to use the new features associated with exceptions to recurring meetings, you must enable the site-level flag in the Super Admin console. To do so, make a request to Cisco Support Services to change your site through the Super Admin console.
To enable exception meetings and XML API 7.4.0:
- Contact Cisco Support Service to change your site by using the following steps.
- In the Super Admin console, select Edit site page.
- Mark the checkbox Support Exception Meeting (shown in Figure 1) to enable exception meeting features.
- In the Super Admin console, select Edit site page.
- Under Enable XML Interface, select XML 7.4.0
Figure 1. Super Admin Console
The above changes make available to your site the features described in this release note.
Enhancements to recurring meetings
Description:
Meeting Center has been enhanced to better support meeting series (recurring meetings) and meeting series exceptions. Both the XML API and the URL API support these enhancements. We encourage integrators to use these enhancements for meeting management. The XML API supports all functionality matching the support from web schedulers. Note that the URL API also supports recurring meeting enhancements but it will not support management of meeting series exceptions.
Affected APIs:
CreateMeeting, SetMeeting, CreateMeetingAttendee, RegisterMeetingAttendee, DelSession, DelMeeting, DelMeetingAttendee, lstSummarySession, lstCalendarSession, GetMeeting, GetSessionInfo
lstsummarySession response
The lstsummarySession request has the option to set a recurrence to true in order to see all recurring meetings. The following diagram shows the new elements of a lstsummarySessionResponse.
Table 1: Elements affected by recurrence set to true
The following table shows the new child elements of the session element that are returned as part of a lstsummarySessionResponse. These elements are returned when the value of the recurrence element in the lstsummarySession request is set to true.
| Element | Type | Description |
|---|---|---|
isException |
boolean |
true if the occurrence is an exception meeting, otherwise false |
isNextUpcomingInstance |
boolean |
true if the occurrence is the next upcoming occurrence of a meeting series (including no repeat meeting), otherwise false |
seriesMeetingKey |
long |
if the occurrence is an exception meeting, the series meeting key is set as its value; otherwise is 0 |
recurrenceId |
long |
the long value of the time stamp of the occurrence's start date (in GMT) |
lstCalendarSession response
The lstCalendarSessionsResponse element now includes elements isException, isNextUpcomingInstance, seriesMeetingKey, and recurrenceId as part of the session element.
GetSessionInfo Request
The GetSessionInfo request now includes the element recurrenceKey as shown in the following diagram.
GetSessionInfo Response
The getSessionInfoResponse object now includes the elements isException, seriesMeetingKey, and hasException as part of the metadata element.
SetMeeting Request
SetMeeting Response
CreateMeeting Request
The CreateMeeting request causes:- an update email to be sent to all users who are still included in the meeting series exception
- a cancel email to be sent to all users removed from the meeting series exception
- an invitation email to be sent to newly-added users of the meeting series exception
DelMeeting Request
The DelMeeting request:- can be applied to a meeting series
- will cause an update email to be sent to users associated with the occurrence
Further Details
On pages that organize the lists as Daily, Weekly, and Monthly, the following apply:
- Lists show all
instances (regular meetings and meeting series exceptions) within the specified date range.
- The list filters
out expired occurrences.
- The list filters
out removed occurrences.
- If there is a
meeting series exception, the list shows the meeting series exception.
- The list includes
a hyperlink for each series occurrence. The link contains the confid
and start time of the specific
occurrence. Clicking on the link directs the user to the detail page of the specific occurrence.
- The list includes hyperlinks for each meeting series exception. The link contains the confid (but not the start time) of the meeting series exception.
On the All meeting page the response shows a list of meeting series(including both regular occurrences and meeting series exceptions). A meeting series is listed as one item.
The
list includes a hyperlink for a meeting series. The link contains the confid
and start time of next upcoming meeting. Clicking on the link redirects the user to the next upcoming occurrence of this series meeting.