Txas - tandberg xml api service, Bare-bone http(s) access – TANDBERG 6000MXP User Manual

Page 63

Advertising
background image

63

D 13887.08
MAY 2008

TANDBERG 3000

MXP

&

6000

MXP

REFERENCE GUIDE FOR SYSTEM INTEGRATORS

TXAS is a service provided by TANDBERG units for transmit-
ting and receiving (transceiving) information encoded in XML
format.
The API uses HTTP(S) as the transport mechanism and con-
nects to the normal web port (80). TXAS can be accessed
in two ways; bare-bone HTTP requests where URL’s uniquely
identifies the request, and SOAP where a single URI is used
but the request itself is encoded with XML.

TXAS - TANDBERG XML API Service

About the TANDBERG API

The bare-bone HTTP mode uses a unique URL to identify the specific request. The contents of
the HTTP body will be a XML document (or part of it).
Bare-bone HTTP(S) access is accomplished by passing arguments in the query string (after

?

’ in URL) in a GET request, or using the “application/x-www-form-urlencoded” content-type

method of POSTing form data (Each argument starts with a name ‘

=

’ and a value, and every

parameter separated with ‘

&

’ (and opt NL).)

getxml

REQUEST:

/getxml

PARAM:

location = XPath expression

/getxml

request returns an XML document based on the location parameter passed to the

request. The elements (or complete document) matching the expression will be returned.
On Incorrect XPath expression, a <Fault> element with a <XPathError> element will be re-
turned.
formputxml

REQUEST:

/formputxml

PARAM:

xmldoc = “an XML document of Configuration, Directory or Command”

This is most useful in a POST (to extend character limit of 255 of GET urls). It posts a Configu-
ration or Command document to set the configurations or issue a command.
Like getxml, it has the data URL form-data encoded with one single parameter. The Content-
Type of the document must be of type “application/x-www-form-urlencoded” and the body must
be encoded accordingly (e.g. first line will be xmldoc=<then the document>).
putxml

REQUEST:

/putxml

PARAM:

HTTP BODY as argument

Putxml is like

formputxml

+, put uses the complete BODY as argument (i.e. the content of

the xmldoc parameter). The Content-type should be “

text/xml

” or “

application/xml

” (

or “

text/plain

”), though no check at the moment. (Except for application/x-www-form-url

encoded which will cause a failure).

About TANDBERG XML API Service

Bare-bone HTTP(S) Access

Advertising
This manual is related to the following products: