Skip to content
Honeywick Consulting

Output stream

The output object is the primary response from Spiral, carrying scheduling updates and system status. Multiple output objects are separated by commas, forming a non-terminated JSON array.

{
  "update": [ scheduleObject ],
  "tag": 0,
  "info": [ "string" ],
  "optimised": true,
  "primed": true,
  "gear": 0
}

Components

Section titled “Components”
  • update — scheduleObject changes to apply to the host database. Multiple objects may be included and must be applied in a single transaction to maintain plan integrity.
  • tag — synchronises communication between Spiral and the host.
  • info — informational messages; the message types are controllable via debug settings.
  • optimised — whether the current schedule needs further optimisation (sent only when testMode is enabled).
  • primed — a one-time startup message sent when Spiral has built the initial schedule and the relationships across stops, projects, resources and response points.
  • gear — the current optimisation depth when Spiral adjusts complexity (sent only when testMode is enabled).
Section titled “Related”