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

 

■

The Remote Setup API function 

 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.

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: External Booking System > TMS).

 

■

Get Conference objects with default values for Conference properties defined in Cisco TMS by using the 

 function. 

 

■

Retrieve existing conferences by using 

, 

 or 

.

 

■

Save changes to a conference by editing the conference properties and using the function 

. This will save the conference to Cisco TMS if the properties validate. If not, an 

exception will be raised. When saving, you must provide the same version value as you got when retrieving the 
conference, or the save will be declined. If the save is declined because of your version value is out of date, 
retrieve the conference again prior to attempting another save operation.

 

■

Delete a conference or series by using 

. Beware that the 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.

 

■

Delete an occurrence of a series by using 

.

 

■

Add recording to a conference by using 

 to get information about a user's recording 

aliases and use this information to add recording participant(s) to the conference.

Replication Pattern

The APIs can be used in conjunction with external booking applications that have their own reservation database. 
There are three main components.

Import

The API can automate importing systems from Cisco TMS into a third-party application, or this can be initiated by the 
user via a GUI.

Get a list of available systems in Cisco TMS by using either of the following from the remote setup API:

 

■

 

■

These functions return lists of TMSSystem objects, and information such as the ID of the system, for use by a third 
party application. 

 will return all systems in Cisco TMS, while 

 will return only the 

systems the user has booking privileges for. If the external application controls system access, use 

 and 

filter the systems in the application. 

Replication

External booking systems can keep track of booking transactions on the Cisco TMS server, and replicate bookings 
made using Cisco TMS. This part does not apply to external GUI front ends that do not have their own reservation 
database.

Get a list of transactions listed by transaction ID by using the GetTransactionsSince function. All conferences have a 
transaction ID property

The list of transactions contains:

14

Cisco TelePresence Management Suite Extension Booking API  Programming Reference Guide