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

Remote Setup API Functions

This reference section describes all the available functions of the remote setup API.

DisableConferenceAPIUser

This function is used to disable a ConferenceAPI user. E-mail notifications for the user are disabled, and the user is 
removed from all groups in Cisco TMS except the Users group. This is done to keep references valid.  Executing this 
function requires Cisco TMS Site Administrator privileges.

This function is typically used during uninstall procedures.

The full username of the user to delete in NT4 style (domain\username).

  None.

GenerateConferenceAPIUser

This function generates a Cisco TMS Booking API account in the default user container on the Cisco TMS server, 
including registering the user in Cisco TMS. It is typically used during installation/setup procedures.

The user will be:

 

■

Hidden from normal user lists.

 

■

Added to the Site Administrator Group.

In order for the function to complete, the current user must be:

 

■

A Cisco TMS Site Administrator

 

■

A local computer administrator 

The base portion of the user name. If a user with the name already exists a numeric postfix is 
added (for example tms-admin ==> tms-admin1).

A base64 encoded password that is to be used for the newly created user.

The email address of the user.

Whether the user should receive scheduling notifications.

 The username of the created user (NT4 domain/username style).

GetConferenceLanguages

Returns an array of Language objects.

 None

 

  An array of supported conference languages in TMS. The CultureInfo field specifies the exact variety 

of a language and can be used to set the ConferenceLanguage on the Conference object when scheduling 
conferences.

GetSystemById

This function returns information about a specific system. If the system is not found, 

21

Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide