Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
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
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.
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.
ClientSession
On calls that require an API integration license, Cisco TMS will return a ClientSession ID that Cisco TMS will
use to recognize the client.
use to recognize the client.
You must include this ID in the header of subsequent API calls, until the ClientSession ID is automatically
renewed after 45 minutes.
renewed after 45 minutes.
If you fail to include a session ID or provide the wrong ID, the session will expire, and the client will not be
able to connect to Cisco TMS. You can enable logging for the client session ID by setting the log level for log-
web-external to DEBUG. The log will then flag:
able to connect to Cisco TMS. You can enable logging for the client session 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
request
ContextHeader
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.
will include conference information such as routing, list of participating systems, and so on.
<ContextHeader
xmlns
="http://tandberg.net/2004/02/tms/external/booking/"
>
<SendConfirmationMail>
boolean
</SendConfirmationMail>
<ExcludeConferenceInformation>
boolean
</ExcludeConferenceInformation>
</ContextHeader>
The flags are not mandatory, and both are false by default.
Cisco TelePresence Management Suite Extension Booking API Programming Reference Guide (14.4)
Page 19 of 74
Using the APIs for remote setup and booking