Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
GUI pattern
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 7 of 33
GUI pattern
The Cisco TMSBA can supply data to the front-end GUI of an external booking application. There are
three information types:
three information types:
System information: Information on Cisco TMS resources can be exported to an external
application. By using
application. By using
, data on systems in Cisco TMS can be exported to a front-
end GUI and used to display system entities available in Cisco TMS.
Availability information: Information on the availability Cisco TMS entities can be exported to an
external application. Reservations in the Cisco TMS internal reservation database can be displayed
and bookings filtering by users.
external application. Reservations in the Cisco TMS internal reservation database can be displayed
and bookings filtering by users.
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:
system to Cisco TMS, and reserve resources in Cisco TMS. (Information exchange:
External
Booking System -> TMS
)
System information
Use the GetSystems or GetSystemsForUser function to get a list of available systems in Cisco TMS. This
function returns a list of TMSSystem objects, which includes 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.
function returns a list of TMSSystem objects, which includes 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.
Availability information
Use the GetConferences to get all Cisco TMS reservations between two specified dates;
GetConferencesForSystem is used to get system availability information; GetRecurrentConferenceById is
used to get to get a conference, including any exceptions. This information can be used, For example, by
an external application to display an availability calendar.
GetConferencesForSystem is used to get system availability information; GetRecurrentConferenceById is
used to get to get a conference, including any exceptions. This information can be used, For example, by
an external application to display an availability calendar.
If filtering of availability information is required, use the Conference object. 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.
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.
Booking management
Use the GetDefaultConference functions to get Conference objects with Cisco TMS defined default values
for Conference properties.
for Conference properties.
Use GetConferenceById, GetConferenceIdByExternalId or GetRecurrentConferenceById functions to
retrieve already saved conferences.
retrieve already saved conferences.
To save changes to a conference, edit the properties on the Conference and use the function
SaveConference. This will save the conference to Cisco TMS if the validation of the properties is OK. If
not, an exception will be raised.
SaveConference. This will save the conference to Cisco TMS if the validation of the properties is OK. If
not, an exception will be raised.
To delete a conference use the DeleteConferenceById function. Conference participants will be
disconnected if the conference is deleted while it is active or connected.
disconnected if the conference is deleted while it is active or connected.
To add recording to a conference, use the GetRecordingAliases function to get information about a user's
recording aliases and use this information to add recording participant(s) to the conference.
recording aliases and use this information to add recording participant(s) to the conference.