PROTOCOL.md

Client/Server Protocol

General Protocol

The Client may asynchronously send requests to the Server. The Server is expected to return responses as outlined below.

The response must contain at least a [Minimal Response]. Depending on the request, it may provide additional responses as outlined in this section.

Minimal Response

Asynchronous request (read AJAX) initiated by the Client receive a JSON Response from the server containing at least:

{
	"status": "success"|"error",
	"message": "<message>"
}

status indicates whether or not the request has been fulfilled by the server ("success") or encountered an error ("error"). On "error" the Client must display "<message>" to the user. On "success", the Client may display "<message>" to the user.

Depending on the request, the server may provide additional information in the response, as outlined below.

Alert