Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
API reference
Cisco TMS Extension Booking API Programming Reference Guide (13.0.1)
Page 9 of 33
API reference
The Cisco TMSBA provides a Web Services API that interface with the Cisco TMS booking engine. Web
Services allows for simple integration into most common language and programming environments. See
your development tool reference for information on how to build implementation stubs to help speed the
development of applications that use Web Services.
Services allows for simple integration into most common language and programming environments. See
your development tool reference for information on how to build implementation stubs to help speed the
development of applications that use Web Services.
The WSDL file for the Cisco TMS Remote setup API is located at:
http://127.0.0.1/tms/external/booking/remotesetup/remotesetupservice.asmx
The WDSL file for the Cisco TMSBA is located at:
http://127.0.0.1/tms/external/Booking/BookingService.asmx
Note: Exchange 127.0.0.1 with the name of the web-server Cisco TMS is installed on.
Microsoft Visual Studio .NET users can reference the API by selecting
Project -> Add Web Reference
, or
enter the URLs above. For network load balancing, using the clusters virtual IP-address or DNS-name for
this task is recommended. This also allows fail over for the API.
this task is recommended. This also allows fail over for the API.
To use the Cisco TMSBA you will need one Application Integration License for each server using the API.
Please contact your Cisco reseller/partner for more information.
Please contact your Cisco reseller/partner for more information.
To import from Cisco TMS or book meetings through the API, requires authentication with the API. To be
able to book meetings using the API requires at least Misc Booking rights.
able to book meetings using the API requires at least Misc Booking rights.
Note: On a default Cisco TMS installation, any API requires the use of Windows Challenge Response or
NTLM authentication. Not all environments support this authentication mechanism (non-Windows based
environments), so you may need to allow for Basic Authentication on the /TMS/external/booking virtual
directory (this can be done using the Internet Information Services manager). Anonymous authentication
is not recommended. If you choose to do so, the IUSR_<machinename> needs to be given Book on
behalf of permissions in Cisco TMS.
NTLM authentication. Not all environments support this authentication mechanism (non-Windows based
environments), so you may need to allow for Basic Authentication on the /TMS/external/booking virtual
directory (this can be done using the Internet Information Services manager). Anonymous authentication
is not recommended. If you choose to do so, the IUSR_<machinename> needs to be given Book on
behalf of permissions in Cisco TMS.
API version
The Cisco TMSBA has gone through several versions, and backwards compatibility was design priority.
To utilize the full potential of the API, the API version needs to be specified in the headers when the
functions of the API are called.
To utilize the full potential of the API, the API version needs to be specified in the headers when the
functions of the API are called.
Note: Setting a number greater than the latest API version will break compatibilities when using revisions
of the API.
of the API.
ExternalAPIVersionSoapHeader
Each call made to the Cisco TMSBA should include a header specifying the version of the API. The value
specified in ClientVersionIn is used by the API to determine the output from the function. The XML below
describes the ExternalAPIVersionSoapHeader object that is common for all calls to the API.
specified in ClientVersionIn is used by the API to determine the output from the function. The XML below
describes the ExternalAPIVersionSoapHeader object that is common for all calls to the API.
<ExternalAPIVersionSoapHeader
xmlns=”http://tandberg.net/2004/02/tms/external/booking/”>
xmlns=”http://tandberg.net/2004/02/tms/external/booking/”>
<ClientVersionIn>
int
</ClientVersionIn>
<ClientIdentifierIn>
string
</ClientIdentifierIn>
<ClientLatestNamespaceIn>
string
</ClientLatestNamespaceIn>
<NewServiceURL>
string
</NewServiceURL>
</ExternalAPIVersionSoapHeader>