Era.Common.NetworkMessage.ConsoleApi.Scheduler.RpcValidateTimeEventRequest

Description

Verifies, whether the [timeEvent] is correct or not.
If the event is not defined correctly or it defines no executions (e.g. it is in the past), exception is returned, with localized message about the problem.

Properties

Name JsonSchemaType Description
isValidatedByAgent boolean Flag used to differentiate between validation of server and client time events. Unset flag imply validation of server time event (equivalent to flag set to false).
timeEvent reference to Era.Common.DataDefinition.Scheduler.TimeEvent The time event to be verified.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Scheduler.RpcValidateTimeEventResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Scheduler.RpcValidateTimeEventRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Scheduler.RpcValidateTimeEventRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Scheduler.RpcValidateTimeEventRequest": {
            "$ref": "#/definitions/RpcValidateTimeEventRequest"
        }
    },
    "definitions": {
        "RpcValidateTimeEventRequest": {
            "additionalProperties": false,
            "required": [
                "timeEvent"
            ],
            "type": "object",
            "properties": {
                "isValidatedByAgent": {
                    "type": "boolean"
                },
                "timeEvent": {
                    "$ref": "Era.Common.DataDefinition.Scheduler.TimeEvent#/definitions/TimeEvent"
                }
            }
        }
    }
}