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

API overview

Cisco TMSBA Programming Reference Guide

Page 9 of 53

Cisco TMSBA versioning is designed to provide a backwards compatible API to clients. This means that 
applications written for an older version of the API will keep working when upgrading to Cisco TMS with a 
newer version of the API.

Each SOAP message sent to the API by the client must announce which version it complies with in a 
header. The API will filter what is returned to the client based on this announced version.

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>

</ExternalAPIVersionSoapHeader>

If no version number is set, version 0 is the default. 

Version 0 of the API corresponds to version 9 of Cisco TMS. Not all versions of Cisco TMS include changes 
to the API. Below is an overview of     Cisco TMS versions that included a new version of Cisco TMSBA.

9

13.2

8

13.1.2

7

13.1

6

13.0.1

5

12.6

4

11.9

3

11.0

2

1

0

9