Texecom Event Schemas

JSON Schema Documentation

Smart Panel Updated Payload

Payload emitted when an existing smart panel's details are modified.

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

Properties

NameType
hardwareIdString
serialString
primaryInterface[string, null]
secondaryInterface[string, null]
activePath[string, null]
ethernetIpAddress[string, null]
wifiIpAddress[string, null]
modelString
capabilitiesArray
previousVersion[string, null]
firmwareVersion[string, null]
updatedAtString
updatedByString
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

primaryInterface

Description Primary network interface currently in use, or null if not set.
Type[string, null]
Required Yes

secondaryInterface

Description Secondary network interface currently in use, or null if not set.
Type[string, null]
Required Yes

activePath

Description Communication path currently active for the smart panel, or null if not set.
Type[string, null]
Required Yes

ethernetIpAddress

Description Ethernet IP address of the smart panel, or null if not connected via ethernet.
Type[string, null]
Required Yes

wifiIpAddress

Description Wi-Fi IP address of the smart panel, or null if not connected via Wi-Fi.
Type[string, null]
Required Yes

model

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

capabilities

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

previousVersion

Description Firmware version the smart panel was running before this update, or null if unknown.
Type[string, null]
Required Yes

firmwareVersion

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

updatedAt

Description Timestamp the update was applied at.
TypeString
Required Yes
Format date-time

updatedBy

Description Identifier of the user who made the update, if attributed. Omitted when not provided.
TypeString
Required No

version

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

occurredAt

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

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/service/device/smartpanel/updated/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Smart Panel Updated Payload",
    "description": "Payload emitted when an existing smart panel's details are modified.",
    "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"
        },
        "primaryInterface": {
            "description": "Primary network interface currently in use, or null if not set.",
            "type": [
                "string",
                "null"
            ]
        },
        "secondaryInterface": {
            "description": "Secondary network interface currently in use, or null if not set.",
            "type": [
                "string",
                "null"
            ]
        },
        "activePath": {
            "description": "Communication path currently active for the smart panel, or null if not set.",
            "type": [
                "string",
                "null"
            ]
        },
        "ethernetIpAddress": {
            "description": "Ethernet IP address of the smart panel, or null if not connected via ethernet.",
            "type": [
                "string",
                "null"
            ]
        },
        "wifiIpAddress": {
            "description": "Wi-Fi IP address of the smart panel, or null if not connected via Wi-Fi.",
            "type": [
                "string",
                "null"
            ]
        },
        "model": {
            "description": "Device model identifier for the smart panel.",
            "type": "string"
        },
        "capabilities": {
            "description": "List of functional capabilities supported by the smart panel.",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "previousVersion": {
            "description": "Firmware version the smart panel was running before this update, or null if unknown.",
            "type": [
                "string",
                "null"
            ]
        },
        "firmwareVersion": {
            "description": "Firmware version currently running on the smart panel, or null if unknown.",
            "type": [
                "string",
                "null"
            ]
        },
        "updatedAt": {
            "description": "Timestamp the update was applied at.",
            "type": "string",
            "format": "date-time"
        },
        "updatedBy": {
            "description": "Identifier of the user who made the update, if attributed. Omitted when not provided.",
            "type": "string"
        },
        "version": {
            "description": "Wall-clock-ms tiebreaker used by projections for last-write-wins ordering.",
            "type": "number"
        },
        "occurredAt": {
            "description": "UTC timestamp when the update occurred, in ISO 8601 format.",
            "type": "string",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "primaryInterface",
        "secondaryInterface",
        "activePath",
        "ethernetIpAddress",
        "wifiIpAddress",
        "model",
        "capabilities",
        "previousVersion",
        "firmwareVersion",
        "updatedAt",
        "version",
        "occurredAt"
    ],
    "additionalProperties": false
}