Era.ServerApi.SimpleResponse

Description

SimpleResponse is used as a response to configuration request, start request, stop request, rpc requests(only to indicate error), or to indicate general error in ServerApi.

Properties

Name JsonSchemaType Description
error string If error occurred, this is set to error message.
result boolean OK - true, error - false.

Dual message (request/response)

No dual message.

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.ServerApi.SimpleResponse",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.ServerApi.SimpleResponse"
    ],
    "properties": {
        "Era.ServerApi.SimpleResponse": {
            "$ref": "#/definitions/SimpleResponse"
        }
    },
    "definitions": {
        "SimpleResponse": {
            "additionalProperties": false,
            "required": [
                "result"
            ],
            "type": "object",
            "properties": {
                "error": {
                    "type": "string"
                },
                "result": {
                    "type": "boolean"
                }
            }
        }
    }
}