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

Each call made to the  Cisco TMSBA must include the following 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.

Do not set a number greater than the latest version of the API, as this may break compatibility when using 
later 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. 

Calls that require an API integration license must include a ClientSession ID that Cisco TMS will use to 
recognize the client. 

 

n

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.

 

n

Each ID expires after 47 minutes with a 17 minute added grace period.

 

n

Reusing an expired ClientSession ID will result in Cisco TMS throwing an exception containing a 
suggested 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.

You can enable logging for the ClientSession ID by setting the log level for log-web-external to DEBUG. The 
log will then flag:

 

n

Incoming session IDs

 

n

Number of active session IDs

 

n

Whether the incoming session ID is consuming a license key

 

n

When the number of available licenses is exceeded and the incoming session ID associated with this 
request

The context header contains multiple flags related to the conference and the client.

Two flags control whether an email confirmation of the request will be sent out, and whether the confirmation 
will include conference information such as routing, list of participating systems, and so on. These flags are 
not mandatory, and all are false by default.

Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide (14.6)     

Page 19 of 81

Using the APIs for remote setup and booking

The SOAP header