User Manual

ADAM-6000 Series User Manual 286

Appendix D REST for ADAM-6000

D.1 REST Introduction

REpresentational State Transfer (REST) is a software architecture for

Web applications behavior and services including image indication,

resource requests and responses and message delivery. It can be devel-

oped to be compatible with popular protocols or standards like HTTP,

URI, XML, HTML. With the advantage of scalability, simplicity and per-

formance, it has already been adopted in Web services by Amazon and

Yahoo.

The Web service of ADAM-6000 is developed based on HTML5, if users

need to integrate this into other Web services, the following information/

command list should be referred to for implementation.

D.2 REST Resources for ADAM

D.2.1 Configuration

D.2.1.1 GET/Configuration/Information

Request The content-type will be ‘application/x-www-form-urlencoded’.

Examples:

Use the following URI to get the module information.

http://10.0.0.1/configuration/information

Response The content-type will be ‘text/xml’

If result is OK, the content will look like below

<?xml version="1.0" ?>

<ADAM-6017 status=”OK”>

<DESC>5th floor SW001 module</DESC>

</CONFIG>

</ADAM-6017>

If result is failed , the content will look like below

<?xml version="1.0" ?>

<ADAM-6017 status=”{error}”>

</ADAM-6017>

{error} : The error message.

Remarks