Release Notes 11.0.0 SP3

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

Overview

This release note describes the changes made in the release of Webex XML API 11.0.0 SP3. These changes apply to your integration with WBS 32. All features are backward compatible with existing integrations. The changes to the latest schema definitions are explained below.

What is New in this Release

New lstRecording sorting support and new recording format filter

New lstRecording sorting support and new recording format filter

There are two new additions to the functionality of the lstRecording API:

The lstRecording API now supports returned recordings lists sorted by creation date, or by a specified sort order in the XML request.
The lstRecording API now supports queries that can return a list of recordings filtered by format. This is in support of mobile platform requirements, with mobile devices that can only play back MP4 recordings.

Affected APIs

lstRecording

Schema changes

Behavior Changed

Elements	Description
`formatTypes`	This is a new filter for query recording, end user can set it with "MP4", "ARF", "WRF" and "WMV" (maximum of 3 types). The API `LstRecording` will return recordings for the format types in the types list. If none of these elements are in the list, all types are returned.
`order`	Sorting on the recording is the result based on `<orderby>` and `<orderAD>`. For `<orderBy>` it supports `"HOSTID"`, `"RECORDID"`, `"RECORDNAME"` and `"CREATETIME"` (maximum 3 fields). For `<orderAD>` it supports `"ASC"` or `"DESC"`.

Design

The sample request for sorting elements are as follows:

Note: The element only supports "HOSTID", "RECORDID", "RECORDNAME" and "CREATETIME" (the number of elements must be 3 or fewer).

The sample request for new query condition FormatTypes as follows:

Note: The element only supports "MP4", "ARF", "WRF", and "WMV" (the number of elements must be 3 or fewer).

DB Design

The SQL for List Service Recordings

SELECT
  w.RecordID,w.SiteID,w.OWNERID,w.confID,w.NBRRECORDID,w.AUTHOR,w.RecordName,w.Description,w.Agenda,w.fileSize,w.LOCALTIME,
  decode(w.serviceID,'6',W.STARTTIME,'7',TO_DATE(w.LOCALTIME, 'mm/dd/yyyy hh24:mi:ss'), w.CREATETIME ) as CREATETIME,W.STARTTIME,
  w.MetaType,w.RefOption1,w.UnlistFlag ,w.DURATION ,w.filetype, w.REGISTEROPTION, w.KEYVERSION, W.ACCESSPWD as ACCESSPWD,
  W.AGENDA,W.REFNUM1,u.userName ,w.serviceID, N.STATUS
FROM WBXSERVICERECORDING W , WBXNBRRECORDING N, coruser u 
WHERE
  w.siteid= ? and w.siteid = u.siteid and w.ownerID = u.uid_ and w.siteid=N.siteid(+)
  and w.NBRRECORDID=N.RECORDID(+) and OWNERID = ?
  and w.createTime >= ? and w.createTime <= ?
  and ( (w.NBRRECORDID > 0 AND n.STATUS = 11)
    OR upper(w.MetaType) = 'MP4' 
    OR w.MetaType is NULL
    OR w.MetaType = ''
    OR upper(w.MetaType) = 'ARF' 
    OR upper(w.MetaType) = 'WRF' ) 
  and ( SERVICEID = 1 or SERVICEID = 6 or SERVICEID = 7 ) 
  ORDER BY OWNERID ASC,upper(RECORDNAME) ASC,CREATETIME ASC

The SQL for NBR Recording:

SELECT c.*, u.username FROM (
SELECT A.CONFID, A.RECORDID, A.SITEID, A.RECORDNAME, A.ACCESSPASSWORD as ACCESSPASSWORD, A.HOSTID, A.FILEURL, A.CONVERSIONTIME,
  A.createTime, A.DESCRIPTION, A.EXPIRATIONDATE, A.RECORDSIZE, A.RECLOCPATH, A.KEYVERSION, A.DOWNLOADCOUNT, A.CONFTYPE, A.STATUS,
  A.PLAYBACKCOUNT, A.METADATA, A.SHARABLE, A.RECORDNUM, A.ACTIVE, A.LASTMODIFIEDTIME, A.rawDataSize, A.REFNUM1 AS ServiceType, 
  A.SECVERSION , A.REFSTR1 AS FileType, A.REFNUM2 AS DURATION 
FROM WBXNBRRECORDING A
WHERE (A.STATUS=0 OR A.STATUS=2 OR A.STATUS=11) AND A.SITEID=?) c ,
  coruser u 
WHERE
c.siteid=u.siteid and c.hostid=u.uid_ AND c.siteid=?
and c.hostID = ? and c.createTime >= ? and c.createTime <= ?
and ( (c.FileType is NULL AND c.STATUS = 11)
  OR upper(c.FileType) = 'MP4' 
  OR (c.FileType is NULL AND c.STATUS != 11)
  OR upper(c.FileType) = 'ARF' 
  OR upper(c.FileType) = 'WMV' ) 
ORDER BY CREATETIME DESC,HOSTID ASC,upper(RECORDNAME) ASC

Known Issues

There are no known compatibility issues. If there are no <order> or <formatTypes>, the returned list is not changed.

The XML API schemas and release notes are available at the Cisco Webex Developer Portal:

XML API Reference

The URL API release notes are available at the Cisco Webex Developer Portal:

URL API Reference