Texecom Event Schemas

JSON Schema Documentation

Hardware Unlinked Payload

Canonical hardware-generic payload emitted when a hardware item is unlinked (e.g. decommissioned). Carries hardwareType so subtype detail isn't lost.

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

Properties

NameType
hardwareIdString
serialString
hardwareTypeString
versionNumber
occurredAtString

hardwareId

Description Identifier of the hardware record.
TypeString
Required Yes

serial

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

hardwareType

Description Type of hardware that was unlinked.
TypeString
Required Yes
Enum
  • SMARTPANEL

version

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

occurredAt

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

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/service/device/hardware/unlinked/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Hardware Unlinked Payload",
    "description": "Canonical hardware-generic payload emitted when a hardware item is unlinked (e.g. decommissioned). Carries hardwareType so subtype detail isn't lost.",
    "type": "object",
    "properties": {
        "hardwareId": {
            "description": "Identifier of the hardware record.",
            "type": "string"
        },
        "serial": {
            "description": "Hardware serial number as printed on the unit.",
            "type": "string"
        },
        "hardwareType": {
            "description": "Type of hardware that was unlinked.",
            "type": "string",
            "enum": [
                "SMARTPANEL"
            ]
        },
        "version": {
            "description": "Wall-clock-ms tiebreaker used by projections for last-write-wins ordering.",
            "type": "number"
        },
        "occurredAt": {
            "description": "UTC timestamp when the unlink occurred, in ISO 8601 format.",
            "type": "string",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "hardwareType",
        "version",
        "occurredAt"
    ],
    "additionalProperties": false
}