Texecom Event Schemas

JSON Schema Documentation

Hardware Linked Payload

Canonical hardware-generic payload emitted when a hardware item is linked to a site.

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

Properties

NameType
hardwareIdString
serialString
site_idString
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

site_id

Description Identifier of the site the hardware is linked to.
TypeString
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 link occurred, in ISO 8601 format.
TypeString
Required Yes
Format date-time

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/service/device/hardware/linked/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Hardware Linked Payload",
    "description": "Canonical hardware-generic payload emitted when a hardware item is linked to a site.",
    "type": "object",
    "properties": {
        "hardwareId": {
            "description": "Identifier of the hardware record.",
            "type": "string"
        },
        "serial": {
            "description": "Hardware serial number as printed on the unit.",
            "type": "string"
        },
        "site_id": {
            "description": "Identifier of the site the hardware is linked to.",
            "type": "string"
        },
        "version": {
            "description": "Wall-clock-ms tiebreaker used by projections for last-write-wins ordering.",
            "type": "number"
        },
        "occurredAt": {
            "description": "UTC timestamp when the link occurred, in ISO 8601 format.",
            "type": "string",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "site_id",
        "version",
        "occurredAt"
    ],
    "additionalProperties": false
}