Using Http - Cisco Codec C20 Reference Manual

Cisco TelePresence System Codec C20
Contents Introduction

Using HTTP

The codec supports sending commands and configurations over HTTP and HTTPS. It is also possible to retrieve
configurations and statuses this way. This interface exposes the same API as the command line, but in XML format.
URL cheat sheet
The following table contains the main URLs used when accessing the API over HTTP.
Method URL
GET http://<ip-address>/status.xml
GET http://<ip-address>/configuration.xml
GET http://<ip-address>/command.xml
GET http://<ip-address>/valuespace.xml
GET http://<ip-address>/getxml?location=<path>
POST http://<ip-address>/putxml
GET, POST http://<ip-address>/formputxml?xmldoc=<xml>
Getting status and configurations
example 1: Get all status entries on the codec.
http://<ip-address>/getxml?location=/Status
example 2: Get just the audio statuses of the codec.
http://<ip-address>/getxml?location=/Status/Audio
example 3: Get all configurations of the codec.
http://<ip-address>/getxml?location=/Configuration
example 4: Get all video configurations of the codec.
http://<ip-address>/getxml?location=/
Configuration/Video
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API About the API xConfiguration
Description
Complete status document
Complete configuration document
Complete command document
Complete valuespace document
Retrieve document based on a path
Configurations and commands in HTTP body
Configurations and commands www-urlencoded
Sending commands and configurations
Using HTTP GeT
It is possible to use HTTP GET when sending commands or
configurations to the codec. This makes it easy to test commands
using your browser.
example 1: Setting the camera position.
http://<ip-address>/formputxml?xmldoc=
<Command><Camera><PositionSet command="True">
<CameraId>1</CameraId><Pan>200</Pan>
<Tilt>200</Tilt></PositionSet></Camera></Command>
example 2: Changing the system name.
http://<ip-address>/formputxml?xmldoc=
<Configuration><SystemUnit>
<Name>newName</Name></SystemUnit></Configuration>
example 3: Changing multiple configurations in one go.
http://<ip-address>/formputxml?xmldoc=
<Configuration><Audio><Volume>80</Volume>
</Audio><Video><OSD><TodaysBookings>On
</TodaysBookings></OSD></video><Configuration>
21
xCommand xStatus
Using HTTP POST
When sending configurations and commands to the codec,
it is important that the HTTP header Content-Type is set to
text/xml, i.e. Content-Type:
should contain the XML content.
example 1: Changing the system name.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
Connection: close
<Configuration>
<SystemUnit>
<Name>newName</Name>
</SystemUnit>
</Configuration>
example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
Connection: close
<Command>
<Camera>
<PositionSet command="True">
<CameraId>1</CameraId>
<Pan>200</Pan>
<Tilt>200</Tilt>
</PositionSet>
</Camera>
</Command>
Response
HTTP/1.1 200 OK
Date: <date>
Server: WSGIServer/0.1 Python/2.5.4
Cache-Control: no-cache
Content-Type: text/xml
Content-Length: 91
Connection: close
<?xml version="1.0"?>
<Command>
<CameraPositionSetResult item="1" status="OK"/>
</Command>
Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices
text/xml. The body of the POST