1 introduction, 1 http and https, 2 xml-rpc – TANDBERG 3.0 User Manual
Page 5: Introduction, Http and https
Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
1
1 Introduction
This document contains the specification of the TANDBERG Codian Remote Management API, by which it is
possible to control several Codian products. This is accomplished via messages sent using the XML-RPC
protocol.
XML-RPC is a simple protocol for remote procedure calling using HTTP as the transport and XML as the
encoding. It is designed to be as simple as possible, whilst allowing complex data structures to be transmitted,
processed and returned. XML-RPC has no platform or software dependence and was chosen over SOAP
because of its simplicity.
The interface is stateless. Currently, there is no mechanism for the Codian device to call back the controlling
application and therefore the controlling application must poll the device for status, as required. A future
enhancement may provide a mechanism for signaling device status changes to the controlling application.
The latest version of the Remote Management API is version 2.5, the following table shows which version of
Codian products support this version.
API Version
MCU 4200
MCU 4500
Media blades
IP VCR 2200
Recording blade
Codian ISDN
Gateway 3200,
3201, MSE 8320,
MSE 8321
IP Gateway 3500
Series
IP Gateway MSE
8350 blade
2.4 2.2 2.2 1.3
2.5
2.3, and later
2.3, and later
1.4
2.0
1.1 HTTP and HTTPS
Codian devices expect to receive HTTP communication over TCP/IP connections to port 80. The HTTP
messages should be “POST”s to the URL “/RPC2”.
HTTPS (a secure, encrypted version of HTTP) is supported on the following products:
• Codian MCU products, software version 2.3 and later
• Codian IP VCR products, software version 2.3 and later
• Codian ISDN GW products, software version 1.4 and later
• Codian IP GW products, software version 2.0 and later
By default, HTTPS is provided on TCP port 443, although Codian devices can be configured to receive HTTP
and HTTPS connections on non-standard TCP port numbers if required.
The Codian devices implements HTTP/1.1 as defined by RFC 2616 [2].
1.2 XML-RPC
For the background and details of XML-RPC, please refer to the
In this implementation, all parameters and return values are part of a <struct> and are all explicitly named.
For example, the “device.query” method returns the current time value as a structure member named
‘currentTime’ rather than as a single value of type <dateTime.iso8601>.