Chat with Us!

XML API 10.0.0 SP12 Release Notes

Important: The XML API 10.0.0 SP12 release changes some schema definitions. For the latest schema definitions, see the release notes announcements page. The features in this release are backward compatibility with previous releases.
 

 

Overview

This release note describes the changes made in the release of WebEx XML API 10.0.0 SP12. These changes apply to your integration with WBS 31.
All features are backward compatible with existing integrations. There are changes to the latest schema definitions explained below.

 
 

View, recover, or delete recordings from the Recordings Trash Bin

Support for the Recording Trash Bin was added to the XML API. Deleted recordings are moved to the Trash Bin, and can be recovered for a period of 30 days (by default). Recordings in the Trash Bin can be listed and permanently deleted.


APIs impacted

API New/Existing Description
DelRecording Existing Deletes the recording (and moves it to trash bin).
RecoverRecordingFromRecycleBin New Restores/recovers recording from trash bin.
DelRecordingFromRecycleBin New Deletes recording permanently. Can also be used to empty trash bin.
LstRecordingInRecycleBin New Lists the recordings in trash bin. A user can get the list of recordings owned. No query for other user's recordings by site administrator.

Schema changes

DelRecording retains its original schema. Only its functionality is impacted.

Schemas are defined for the new API's below.

RecoverRecordingFromRecycleBin

 

Request:

<xsd:complexType name="recoverRecordingFromRecycleBin">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="recordingID" type="xsd:long" maxOccurs="20"/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

Response:

<xsd:complexType name="recoverRecordingFromRecycleBinResponse">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="successfulRecoverRecordings" minOccurs="0">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="recordingID" type="xsd:long" maxOccurs="20"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="failedRecoverRecordings" minOccurs="0">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="recordingDetails" maxOccurs="20">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="recordingID" type="xsd:long"/>

<xsd:element name="reasonForFailure" type="xsd:string"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

DelRecordingFromRecycleBin

 

Request:

<xsd:complexType name="delRecordingFromRecycleBin">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="recordingID" type="xsd:long" minOccurs="0" maxOccurs="20"/>

<xsd:element name="deleteAll" type="xsd:boolean" minOccurs="0" default="false"/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

Response:

<xsd:complexType name="delRecordingFromRecycleBinResponse">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="numberOfRecordingsSuccesfullyDeleted" type="xsd:int"/>

<xsd:element name="failedToDeleteRecordings" minOccurs="0">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="recordingID" type="xsd:long" maxOccurs="20"/>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

LstRecordingInRecycleBin

Note: Only the AND condition is supported. The OR condition is not supported in order to avoid latent performance issues.


Request:

<xsd:complexType name="lstRecordingInRecycleBin">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="listControl" type="ep:listControlType" minOccurs="0"/>

<xsd:element name="createTimeScope" type="ep:createTimeScopeType" minOccurs="0"/>

<xsd:element name="sessionKey" type="xsd:long" minOccurs="0"/>

<xsd:element name="recordName" type="xsd:string" minOccurs="0"/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

schema diagram of extra node lstRecordingRecycleBin

Response:

<xsd:complexType name="lstRecordingInRecycleBinResponse">

<xsd:complexContent>

<xsd:extension base="serv:bodyContentType">

<xsd:sequence>

<xsd:element name="matchingRecords" type="serv:matchingRecordsType" minOccurs="0"/>

<xsd:element name="recording" type="ep:recordingRecycleBinType" minOccurs="0" maxOccurs="unbounded"/>

</xsd:sequence>

</xsd:extension>

</xsd:complexContent>

</xsd:complexType>

 

schema diagram of extra node lstRecordingRecycleBinResponse

Behavior Changed

DelRecording no longer deletes the recording from WBXNBRRecordingConfig table. Instead, it deletes any RecoverRecordingFlag record and adds a NewDeleteRecordFlag record for the RecordID.

DB Design

The following items are changed in WBXNBRRecordingConfig table.

DB Item Name

DB Item Value

Description

RecoverRecordingFlag

Boolean (Design, so far only has value '1')

If the flag is set, it means that the recording has been recovered from the trash bin.

NewDeleteRecordFlag

Boolean (Design, so far only has value '1')

If the flag is set, it means that the recording has been moved to the trash bin.


Productivity Tools requests new node containing old site names

Productivity Tools can now handle meetings on sites that were renamed or upgraded. A new node oldSiteNames is returned by the getSite API.

APIs impacted

GetSite returns an extra node oldSiteNames

Schema changes

schema diagram of extra node oldSiteNames

Behavior Changed

None

Design

When the request header RETURNOLDSITENAMES is TRUE, the GetSite API checks if the target site has any old siteSiteName in the WebDB table WbxSiteRename via siteID. If it exists, it will concatenate all old site names with comma character in the response oldSiteNames node.

Because the getSite API is frequently used by lots of customers/users, to avoid a performance impact, it returns oldSiteNames only when the RETURNOLDSITENAMES header is TRUE.

Sample 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: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:siteName>hmpcncraig2</ns1:siteName>
                    <ns1:oldSiteNames>hmpcncraig1,hmpcncraig0,hmpcncraig</ns1:oldSiteNames>
                    <ns1:brandName>hmpcncraig2</ns1:brandName>
                    <ns1:region>U.S.</ns1:region>
...

Known Issues

None


Related Release Information

The XML API schemas and release notes are available at the Cisco WebEx Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/xml-api/reference/

The URL API release notes are available at the Cisco WebEx Developer Portal:
https://developer.cisco.com/site/collaboration/webex/webex-developer/develop-test/url-api/reference/