Texecom Event Schemas

JSON Schema Documentation

battery presence test initiated payload

Signals that a battery presence test has started

$idhttps://schemas.texecom-prod.com/v2/events/payload/battery/presence_test/initiated/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
hardwareIdString
serialString
powerSourceString
initiatedByString

hardwareId

Description Unique identifier of the hardware component.
TypeString
Required Yes
Format uuid

serial

Description Serial of the Veritas Pro panel.
TypeString
Required Yes

powerSource

Description power source under test (e.g. battery)
TypeString
Required Yes

initiatedBy

Description the actor that initiated the battery presence test (e.g. app)
TypeString
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/battery/presence_test/initiated/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "battery presence test initiated payload",
    "description": "Signals that a battery presence test has started",
    "type": "object",
    "properties": {
        "hardwareId": {
            "type": "string",
            "description": "Unique identifier of the hardware component.",
            "format": "uuid"
        },
        "serial": {
            "type": "string",
            "description": "Serial of the Veritas Pro panel."
        },
        "powerSource": {
            "description": "power source under test (e.g. battery)",
            "type": "string"
        },
        "initiatedBy": {
            "description": "the actor that initiated the battery presence test (e.g. app)",
            "type": "string"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "powerSource",
        "initiatedBy"
    ],
    "additionalProperties": false
}