Texecom Event Schemas

JSON Schema Documentation

walk test terminal payload

Signals that the start phase has reached a terminal state — all expected zones triggered, or the start window closed.

$idhttps://schemas.texecom-prod.com/v2/events/payload/walk_test/start/terminal/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
panelIdString
walkTestIdString
outcomeString

panelId

Description UUID that will give would be identification for panel
TypeString
Required Yes
Format uuid

walkTestId

Description walk test UUID for particular walk test
TypeString
Required Yes
Format uuid

outcome

Description final result of the session — discriminates completion from timeout
TypeString
Required Yes
Enum
  • completed
  • timed_out

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/walk_test/start/terminal/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "walk test terminal payload",
    "description": "Signals that the start phase has reached a terminal state — all expected zones triggered, or the start window closed.",
    "type": "object",
    "properties": {
        "panelId": {
            "description": "UUID that will give would be identification for panel",
            "type": "string",
            "format": "uuid"
        },
        "walkTestId": {
            "description": "walk test UUID for particular walk test",
            "type": "string",
            "format": "uuid"
        },
        "outcome": {
            "description": "final result of the session — discriminates completion from timeout",
            "type": "string",
            "enum": [
                "completed",
                "timed_out"
            ]
        }
    },
    "required": [
        "panelId",
        "walkTestId",
        "outcome"
    ],
    "additionalProperties": false
}