Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
In a network load balancing scenario, use the virtual IP address or DNS name of the cluster for this task to allow
failover for the API.
failover for the API.
Security
We strongly recommend using SOAP for all requests. For security reasons, HTTP GET and POST are only accessible
from localhost. To change this, modify the Cisco TMS web.config file.
from localhost. To change this, modify the Cisco TMS web.config file.
Optional Elements
Optional elements are indicated in different ways in the WSDL:
■
minOccurs = 0
means the element can be omitted from the request XML altogether.
■
nillable="true"
means the element can hold an empty value.
The combination of these two is an element that can be skipped and be set to null (not a value).
Boolean Values
The boolean lexical forms "1" and "true" are interchangeable in SOAP.
The SOAP Header
ExternalAPIVersionSoapHeader
Each call made to the Cisco TMSBA must include the following header specifying the version of the API. The value
specified in
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.
Do not set a number greater than the latest version of the API, as this may break compatibility when using later
revisions.
revisions.
<ExternalAPIVersionSoapHeader
xmlns
="http://tandberg.net/2004/02/tms/external/booking/"
>
<ClientVersionIn>
int
</ClientVersionIn>
<ClientIdentifierIn>
string
</ClientIdentifierIn>
<ClientLatestNamespaceIn>
string
</ClientLatestNamespaceIn>
<NewServiceURL>
string
</NewServiceURL>
<ClientSession>
string
</ClientSession>
</ExternalAPIVersionSoapHeader>
If no version number is set, version 0 is the default.
ClientSession
Calls that require an API integration license must include a ClientSession ID that Cisco TMS will use to recognize the
client.
client.
■
If the ClientSession ID is null or blank, Cisco TMS will throw an exception containing a suggested
ClientSession ID string, and the API call will fail.
ClientSession ID string, and the API call will fail.
■
Each ID expires after 47 minutes with a 17 minute added grace period.
■
Reusing an expired ClientSession ID will result in Cisco TMS throwing an exception containing a suggested
new ID, and the API call will fail.
new ID, and the API call will fail.
The client must therefore regularly renew these IDs. We recommend using the suggested ClientSession ID strings
from the exceptions thrown by Cisco TMS.
from the exceptions thrown by Cisco TMS.
In Cisco TMS the Active Application Integration Clients table under Administrative Tools > Configuration > General
Settings > Licenses and Option Keys lists the network addresses and the ClientSession IDs used by Cisco TMSBA
clients that consume Application Integration Licenses. If your Cisco TMSBA client is unable to save conferences
Settings > Licenses and Option Keys lists the network addresses and the ClientSession IDs used by Cisco TMSBA
clients that consume Application Integration Licenses. If your Cisco TMSBA client is unable to save conferences
12
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide