This REST API uses the HTTP protocol to access JSON formatted data.

JSON

The JavaScript Object Notation (JSON) is a format intended for data exchange. It is supported by many programming languages, that's why JSON is suitable for data exchange between different languages and devices.

A JSON file contains one or multiple objects. Objects have one or more pairs consisting of a name and a value. The value can be an array, number, string, true, false, null, or another object.

Structure of a JSON-file

Notice: More detailed informations are available at www.json.org

HTTP

Conventionally, the HTTP methods GET, PUT, POST and DELETE can be used to read, edit, add or delete data. Since there is no data to add or delete, this REST API only uses the GET and PUT methods. The server only reports after a request from the client. This means, that the client needs to request data regulary, to stay up to date. As the figure shows, the selected frequency of the requests is of importance, so that no events are missed, but also unnecessary traffic is avoided. For an event based communication see MQTT

Communication between client and server