Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
because of ClientSession ID or licensing problems, use this table to identify other clients or Client Session IDs that
inadvertently consume licenses.
inadvertently consume licenses.
Refer to your version of Cisco TelePresence Management Suite Administrator Guide for detailed description of the
Active Application Integration Clients table.
Active Application Integration Clients table.
You can enable logging for the ClientSession ID by setting the log level for log-web-external to DEBUG. The log will
then flag:
then flag:
■
Incoming session IDs
■
Number of active session IDs
■
Whether the incoming session ID is consuming a license key
■
When the number of available licenses is exceeded and the incoming session ID associated with this request
ContextHeader
The context header contains multiple flags related to the conference and the client.
Two flags control whether an email confirmation of the request will be sent out, and whether the confirmation will
include conference information such as routing, list of participating systems, and so on. These flags are not
mandatory, and all are false by default.
include conference information such as routing, list of participating systems, and so on. These flags are not
mandatory, and all are false by default.
The client language flag will request localized API error messages for the specified language. Cisco TMS will return
localized messages if available. If no language is specified, English will be returned.
localized messages if available. If no language is specified, English will be returned.
<ContextHeader
xmlns
="http://tandberg.net/2004/02/tms/external/booking/"
>
<SendConfirmationMail>
boolean
</SendConfirmationMail>
<ExcludeConferenceInformation>
boolean
</ExcludeConferenceInformation>
<ClientLanguage>
string
</ClientLanguage>
</ContextHeader>
GUI Pattern
Cisco TMSBA can supply data to the front-end GUI of an external booking application. There are three information
types.
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.
TMS.
Get a list of available systems in Cisco TMS by using either:
■
GetSystems
■
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.
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.
■
Get all Cisco TMS bookings for a specific user by using
GetConferencesForUser
.
■
Get free/busy information for systems by using
GetConferencesForSystems
.
■
Get a specific conference, including any exceptions if it is a series, by using
GetRecurrentConferenceById
.
13
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide