TANDBERG Codec C90 D14128.02 - Manual (Page 49)

D14128.02—NOVEMBER 2008 49
Codec C90 System Integrator Guide
Contents Introduction Getting Started Interfaces About the API xConfiguration xCommand xStatus Cameras Appendices Contact us About the API
TANDBERG XML API service
TXAS is a service provided by TANDBERG units for transmitting and
receiving (transceiving) information encoded in XML format.
The API uses HTTP(S) as the transport mechanism and connects to
the normal web port (80). TXAS can be accessed by bare-bone HTTP
requests where URL’s uniquely identifies the request.
Bare-bone HTTP/HTTPS Access
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
/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 returned.
getxml
REQUEST:
/getxml
PARAM:
location = XPath expression
formputxml
This is most useful in a POST (to extend character limit of 255 of GET urls). It posts a Configuration 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>).
formputxml
REQUEST:
/formputxml
PARAM:
xmldoc = “an XML document of Configuration, Directory or Command”
putxml
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).
putxml
REQUEST:
/putxml
PARAM:
HTTP BODY as argument