Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Synchronization pattern
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 8 of 33
Synchronization pattern
The APIs can be used in conjunction with external booking applications that have their own reservation
database. There are three main components:
database. There are three main components:
Importing: Importing resources from Cisco TMS into an external application. The API can automate
importing systems from Cisco TMS into the third party application, or this can be user-initiated via a
GUI.
importing systems from Cisco TMS into the third party application, or this can be user-initiated via a
GUI.
Synchronizing: Synchronizing resources booked in Cisco TMS with resources available in an
external booking system. An external system can keep track of booking transaction on the Cisco TMS
server, and synchronize itself with booking made using Cisco TMS. (Information exchange:
external booking system. An external system can keep track of booking transaction on the Cisco TMS
server, and synchronize itself with booking made using Cisco TMS. (Information exchange:
TMS ->
External Booking System
). This part is not applicable for external GUI front ends that do not have
their own reservation database.
Booking: Booking resource booked in an external booking system in Cisco TMS. This part of the API
allows you to forward booking requests from an external booking system to Cisco TMS, and reserve
the resources there. (Information exchange:
allows you to forward booking requests from an external booking system to Cisco TMS, and reserve
the resources there. (Information exchange:
External Booking System -> TMS
)
Availability: Reads bookings in Cisco TMS. The API allows you to display Cisco TMS reservations
from Cisco TMS internal reservation database.
from Cisco TMS internal reservation database.
Importing
Use the GetSystems or GetSystemsForUser function to get a list of available systems in Cisco TMS. This
function returns a list of TMSSystem objects, and information such as the ID of the system, for use by a
third party application. GetSystems will return all systems in Cisco TMS, while GetSystemsForUser will
only return the systems the user has booking privileges for. If the external application controls system
access, use GetSystems and filter the systems in the application.
function returns a list of TMSSystem objects, and information such as the ID of the system, for use by a
third party application. GetSystems will return all systems in Cisco TMS, while GetSystemsForUser will
only return the systems the user has booking privileges for. If the external application controls system
access, use GetSystems and filter the systems in the application.
Synchronizing
Use the GetTransactionsSince function to get a list of transactions by the transaction ID (all conferences
have a transaction ID property). The list of transaction contains the transaction type (New, Update, and
Delete) and an associated ConferenceId. Use GetConferenceById to get an updated Conference object –
and update the conference with the external source. The current transaction ID should then be updated to
the last conference’s TransactionId.
have a transaction ID property). The list of transaction contains the transaction type (New, Update, and
Delete) and an associated ConferenceId. Use GetConferenceById to get an updated Conference object –
and update the conference with the external source. The current transaction ID should then be updated to
the last conference’s TransactionId.
Booking
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 saved conferences.
retrieve saved conferences.
To save changes to a conference, edit the conference properties and use 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.
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.