Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
GUI pattern
Cisco TMSBA can supply data to the front-end GUI of an external booking application. There are three
information types.
information types.
System information
Information on Cisco TMS resources can be exported to an external application. By using
the remote setup
API
, data on systems in Cisco TMS can be exported to a front-end GUI and used to display system entities
available in Cisco TMS.
Get a list of available systems in Cisco TMS by using either:
n
GetSystems
n
GetSystemsForUser
These functions return lists of TMSSystem objects, that include information such as the ID of the system, to
show in the front-end GUI. GetSystems will return all systems in Cisco TMS, while GetSystemsForUser
will only return the systems the user has booking privileges for. If the external GUI application controls
system access, use GetSystems and filter the systems in the application.
show in the front-end GUI. GetSystems will return all systems in Cisco TMS, while GetSystemsForUser
will only return the systems the user has booking privileges for. If the external GUI application controls
system access, use GetSystems and filter the systems in the application.
Free/busy information
Free/busy information on systems in Cisco TMS can be exported to an external application using Cisco
TMSBA.
TMSBA.
n
Get all Cisco TMS bookings for a specific user by using GetConferencesForUser.
n
Get free/busy information for systems by using GetConferencesForSystems.
n
Get a specific conference, including any exceptions if it is a series, by using
GetRecurrentConferenceById
GetRecurrentConferenceById
.
n
The Remote Setup API function GetUsers returns all users registered in Cisco TMS. The output of this
function can be used to display a drop-down list of all users in Cisco TMS, or show conferences booked by
a specific person.
function can be used to display a drop-down list of all users in Cisco TMS, or show conferences booked by
a specific person.
Booking management
The API allows you to forward booking requests from an external booking system to Cisco TMS, and reserve
resources in Cisco TMS. (Information exchange:
resources in Cisco TMS. (Information exchange:
External Booking System > TMS
).
n
Get Conference objects with default values for Conference properties defined in Cisco TMS by using the
GetDefaultConference
GetDefaultConference
function.
n
Retrieve existing conferences by using GetConferenceById, GetConferenceIdByExternalId or
GetRecurrentConferenceById
GetRecurrentConferenceById
.
n
Save changes to a conference by editing the conference properties and using the function
SaveConference
SaveConference
. This will save the conference to Cisco TMS if the properties validate. If not, an
exception will be raised.
n
Delete a conference or series by using DeleteConferenceById. Beware that ongoing conferences will
be ended rather than deleted, and that conference participants will be disconnected, if the conference is
ended while it is active or connected.
be ended rather than deleted, and that conference participants will be disconnected, if the conference is
ended while it is active or connected.
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide (14.6)
Page 21 of 81
Using the APIs for remote setup and booking
GUI pattern