Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Introduction
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 4 of 33
Introduction
The Cisco TelePresence Management Suite Extension Booking API (Cisco TMSBA) gives developers
access to Cisco TelePresence Management Suite (Cisco TMS) booking functionality. This API is
employed by Cisco TelePresence in its Microsoft Exchange and IBM Lotus Domino integrations, and
provides the same feature set as the Cisco TMS Scheduler user interface.
access to Cisco TelePresence Management Suite (Cisco TMS) booking functionality. This API is
employed by Cisco TelePresence in its Microsoft Exchange and IBM Lotus Domino integrations, and
provides the same feature set as the Cisco TMS Scheduler user interface.
Document structure
This document includes the following parts:
Entities in Cisco TMS - describes the objects and entities utilized by the Cisco TMSBA.
Usage patterns - describes how an external GUI, booking database, or entire booking system can
interact with the Cisco TMS booking system. The Microsoft Exchange and IBM Lotus Domino
integrations work against the API in this manner.
interact with the Cisco TMS booking system. The Microsoft Exchange and IBM Lotus Domino
integrations work against the API in this manner.
API Reference – describes the functions and objects available in the Cisco TMSBA.
Intended audience
The target audience for this document is developers seeking to implement a data/audio/video
conferencing booking solution that is not supported by Cisco TMS directly, or where existing Cisco TMS
features do not provide the necessary functionality/interoperability. Such booking systems will be referred
to as external booking systems.
conferencing booking solution that is not supported by Cisco TMS directly, or where existing Cisco TMS
features do not provide the necessary functionality/interoperability. Such booking systems will be referred
to as external booking systems.
Functional overview
There are four main features of the API:
Importing: Importing and/or displaying Cisco TMS resources in an external application. See the
. This import process can be automated or initiated via a GUI.
Synchronizing: Synchronizing resources booked in Cisco TMS with resources managed by an
external booking system. (Information exchange:
external booking system. (Information exchange:
TMS -> External Booking System
).
Booking: Forwards booking requests made by an external booking system to TMS and reserve the
resources there. (Information exchange:
resources there. (Information exchange:
External Booking System -> TMS
)
Availability: Read and display bookings and reservations stored in the Cisco TMS reservation
database.
database.
It is not possible to forward booking requests made in Cisco TMS to an external booking system. The
Cisco TMS database must control resource bookings for the API to function.
Cisco TMS database must control resource bookings for the API to function.
Note: The API cannot be used for system management, call management or other features beyond
booking.
booking.
Booking principles
By using the Cisco TMSBA, users can book video resources from their own booking application.
Systems can be read from Cisco TMS using the remote service API of the Cisco TMSBA to import and/or
display them in the booking application.
display them in the booking application.
One type of API usage is to make a front-end GUI utilizing the booking capabilities of Cisco TMS. By
importing systems using the remote service API, the booking application can show availability information
importing systems using the remote service API, the booking application can show availability information