REST API

remotestick-server is a REST web service. All communication between the service and its clients is done via HTTP. Authentication is done via HTTP basic. Errors are return both as HTTP response codes as well as descriptive information in the response data.

Authentication

If a username and password is passed to remotestick-server when started all requests require authentication, which is done via HTTP basic. remotestick-server may be started without passing credentials, in such case clients may issue any requests without any authentication being made. This is strongly discouraged though.

Formatting

You must always specify in which format the result should be returned. Currently the only supported format is xml. For example:

GET /devices.xml

Will return all devices in xml.

Success And Failure Messages

• If a request completes successfully, but it has nothing to return (e.g. a DELETE operation), the HTTP response code will be 200 OK but no data will be returned.
• If a request fails to complete, the server will respond with a 4xx Client Error and a failure message. This is an example message in XML:
  <?xml version="1.0" encoding="UTF-8"?> <hash> <request>GET /devices.xml</request> <error>Authentication failed</error> </hash>

API Overview

• Device resources
• Device methods