Texecom Event Schemas

JSON Schema Documentation

Smart Panel Registered Payload

Payload emitted when a smart panel is registered against a site.

$idhttps://schemas.texecom-prod.com/v2/events/payload/service/device/smartpanel/registered/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
hardwareIdString
serialString
modelString
firmwareVersion[string, null]
capabilitiesArray
versionNumber
occurredAtString

hardwareId

Description Identifier of the hardware record for this smart panel.
TypeString
Required Yes

serial

Description Hardware serial number of the smart panel as printed on the unit.
TypeString
Required Yes

model

Description Device model identifier for the smart panel.
TypeString
Required Yes

firmwareVersion

Description Firmware version currently running on the smart panel, or null if unknown.
Type[string, null]
Required Yes

capabilities

Description List of functional capabilities supported by the smart panel.
TypeArray
Required Yes

version

Description Wall-clock-ms tiebreaker used by projections for last-write-wins ordering.
TypeNumber
Required Yes

occurredAt

Description UTC timestamp when the registration occurred, in ISO 8601 format.
TypeString
Required Yes
Format date-time

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/service/device/smartpanel/registered/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Smart Panel Registered Payload",
    "description": "Payload emitted when a smart panel is registered against a site.",
    "type": "object",
    "properties": {
        "hardwareId": {
            "description": "Identifier of the hardware record for this smart panel.",
            "type": "string"
        },
        "serial": {
            "description": "Hardware serial number of the smart panel as printed on the unit.",
            "type": "string"
        },
        "model": {
            "description": "Device model identifier for the smart panel.",
            "type": "string"
        },
        "firmwareVersion": {
            "description": "Firmware version currently running on the smart panel, or null if unknown.",
            "type": [
                "string",
                "null"
            ]
        },
        "capabilities": {
            "description": "List of functional capabilities supported by the smart panel.",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "version": {
            "description": "Wall-clock-ms tiebreaker used by projections for last-write-wins ordering.",
            "type": "number"
        },
        "occurredAt": {
            "description": "UTC timestamp when the registration occurred, in ISO 8601 format.",
            "type": "string",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "model",
        "firmwareVersion",
        "capabilities",
        "version",
        "occurredAt"
    ],
    "additionalProperties": false
}