JointSpace API Documentation

Getting Started

Using a REST API

A REST API is provided through a webserver. To use a REST API applications need to send standard HTTP requests to the webserver.

The JointSpace API is provided through a webserver in the TV. It accepts HTTP requests on port 1925. Two HTTP methods are supported.

• GET is used to retrieve data from the TV.
• POST is used to send data to the TV and make the TV execute certain operations.

The exact data to be retrieved or operation to be executed is specified in the path passed in the HTTP request. E.g. to read the current volume setting of the TV one has to send a GET request to http://ip-address-of-tv:1925/1/audio/volume. The TV will send the current volume setting in the HTTP response.

Parameters for operations are passed in the body of the POST request. E.g. to change the current volume setting of the TV one has to send a POST request to http://ip-address-of-tv:1925/1/audio/volume with the desired volume setting encoded in the body of the request.

See the API reference for an overview of all supported GET and POST requests.

Data representation

All data, both accepted by the TV in POST requests and returned by the TV in GET requests, is in JSON format.

Optionally JSONP can be enabled as response format for GET requests. To enable JSONP a callback function must be specified as a query parameter named callback. E.g. to retrieve the current volume setting of the TV in JSONP format one has to send a GET request to http://ip-address-of-tv:1925/1/audio/volume?callback=mycallbackfunc.

See the API reference for a detailed description of the data format for each supported request.

HTTP status codes

200

The request completed succesfully.

400

The data sent with a POST request was not in correct JSON format.

404

An incorrect path was specified in the GET or POST request.

405

A method other the GET or POST was used.

503

The request could not be executed due to unavailability of system resources.