Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
cdrlog.enumerate
This call allows the calling application to download CDR log data without having to return the entire CDR log.
The call returns a subset of the CDR log based on the optional filterindex and numEvents
parameters.
Note: The
describes the CDR log in its XML form, as downloaded in cdr_log.xml
via the web interface. When the same events are enumerated with this call, the event type names use
camelCase for multiple words rather than using underscores. For example, conference_finished in
cdr_log.xml is the same event type as conferenceFinished in this response.
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
filter
array
An array of strings, which contain the names of event types
by which to filter the response. Omit filter to return all
event types or include a subset of the following:
scheduledConferenceStarted
ad-
hocConferenceStarted
conferenceFinished,
participantJoined
participantLeft
index (CDR log enumerate call)
integer
Index from which to get events. The device returns the
nextIndex
so the application can use it to retrieve the
next enumeration of CDR data.
If index is omitted, negative, or greater (by 2 or more) than
the highest index, then the device will enumerate events
from the beginning of the CDR log.
numEvents (per enumeration)
integer
Specifies maximum number of events to be returned per
enumeration. If omitted (or not between 1 - 20 inclusive), a
maximum of 20 events will be returned per enumeration.
Returned data
The response provides reference information such as time and log position, and an array of events that meet
the parameters provided in the call. If there are no events to enumerate, the events array is returned empty.
Each event in the array contains parameters that are common to all CDR log events and also contains any
infomation that is specific to that type of event. See the
for details of the MCU
event types.
Parameter name
Type
Short description
startIndex
integer
Either the index provided, or if that is lower than the index
of the first record the device has, it will be the first record it
does know about. In this case, comparing the startIndex
with the index provided gives the number of dropped
records.
nextIndex
integer
Revision number of the data being provided, reusable in a
subsequent call to the API.
Cisco TelePresence MCU API 2.10
Page 36 of 296
API commands
cdrlog.enumerate