Cisco Cisco TelePresence MCU 4510 Developer's Guide
conference.enumerate
Returns some or all conferences scheduled, running or completed on the MCU.
Input parameters
Optional or conditional inputs
Parameter name
Type
Short description
enumerateID
string
The device returns this index if the requested data is too
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
lastRevision
integer
This number identifies an earlier set of enumeration data to
compare against your current call. If you supply this
parameter using the currentRevision value returned by
a previous enumeration, the current enumerate call will
return only the differences since that previous call. If you
don't supply this parameter, the device assumes that you
want a full enumeration.
compare against your current call. If you supply this
parameter using the currentRevision value returned by
a previous enumeration, the current enumerate call will
return only the differences since that previous call. If you
don't supply this parameter, the device assumes that you
want a full enumeration.
moreThanFour
boolean
Enables the call to return more than four conferences (up to
24).
24).
enumerateFilter
string
A filter expression. The enumeration results depend on the
supplied expression.
supplied expression.
enumerateFilter
filters on:
Parameter name
Type
Short description
active
boolean
true
to request only active conferences.
completed
boolean
True if the conference has finished.
scheduled
boolean
true
if the conference is a scheduled conference
(regardless of whether or not it is completed).
Returned data
Conditionally returned
If there are entries to return, the method returns them in an array. If there are more entries than can be
returned in one response, you'll get the next enumerateID up from the one you provided.
returned in one response, you'll get the next enumerateID up from the one you provided.
Parameter name
Type
Short description
enumerateID
string
The device returns this index if the requested data is too
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
currentRevision
integer
A number that indicates the current revision of this
enumeration. You can use this as a lastRevision input to
a future enumerate call to retrieve only the changes
between the two enumerations.
enumeration. You can use this as a lastRevision input to
a future enumerate call to retrieve only the changes
between the two enumerations.
Cisco TelePresence MCU API 2.10
Page 46 of 296
API commands
conference.enumerate