Texecom Event Schemas

JSON Schema Documentation

battery presence test completed payload

Signals that a battery presence test has finished, reporting its outcome

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

Properties

NameType
hardwareIdString
serialString
powerSourceString
resultString
failReasonString

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

result

Description final result of the battery presence test
TypeString
Required Yes
Enum
  • pass
  • fail

failReason

Description if fail then this will carry reason for failure
TypeString
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/battery/presence_test/completed/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "battery presence test completed payload",
    "description": "Signals that a battery presence test has finished, reporting its outcome",
    "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"
        },
        "result": {
            "description": "final result of the battery presence test",
            "type": "string",
            "enum": [
                "pass",
                "fail"
            ]
        },
        "failReason": {
            "description": "if fail then this will carry reason for failure",
            "type": "string",
            "minLength": 0
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "powerSource",
        "result",
        "failReason"
    ],
    "additionalProperties": false
}