Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide

Page of 64
TMSSystemId
System ID as given in Cisco TMS.
Returned data:
 A TMSSystem object.
If the provided ID does not exist, this will cause an error. See the section 
.
GetSystems
This function returns all endpoints and rooms registered in Cisco TMS. Note that network systems, such as a Cisco 
TelePresence MCU, are not returned since they are normally not booked by the users, but are added to the 
conference by Cisco TMS if required. 
Typically used during setup of resources in the external booking system to connect resources in Cisco TMS with 
resources in the external booking system.
Supported parameters:
 None
Returned data:
 An array of TMSSystem objects.
GetSystemsForUser
This function returns all endpoints and rooms that can be booked by the current user, the account credentials are 
used to communicate with  Cisco TMSBA. 
Note that network systems, such as a Cisco TelePresence MCU, are not returned since they are normally not booked 
by the users, but are added to the conference by Cisco TMS if required. 
Typically used in the external booking system to list Cisco TMS resources in external booking system.
Supported parameters:
 None.
Returned data:
 An array of TMSSystem objects.
GetUsers
This function returns all users registered in Cisco TMS. 
This function is typically used in the front-end GUI to provide a list of Cisco TMS users, and can filter output from the  
Cisco TMSBA based on users from this output.
Supported parameters:
 None.
Returned data:
 An array of User objects.
IsAlive
This function checks the connection to the web services of Cisco TMS.
It is typically used during installation to check the URL to this web service.
Supported parameters:
 None
Returned data:
 A boolean value true/false, which is true if the connection works.
IsBookOnBehalfOfUser
Checks whether the specified user (not the current user) is a member of a Cisco TMS group that has permissions to 
book on behalf of other users. 
Supported parameters:
user
The Cisco TMS user ID of the user for whom to check permissions.
22
Cisco TelePresence Management Suite Extension Booking API  Programming Reference Guide