Field reference

Every field in the message schema and the probe reply schema, generated from the schemas' own descriptions. Message is the envelope every message carries; the sections after it say what each kind adds, then each definition they refer to. Every value is a display string, and a field with no value is left out. A field the format does not define is ignored by every receiver and never fails a message, so it is not listed.

Message

One Open Meet Display message: a complete snapshot of what one display target should show. It checks every 1.x message. Receivers must ignore fields they do not recognise, so every object allows additional properties, and a kind this schema does not list is checked against the envelope only. Every value is a display string; a field with no value is left out, and a receiver treats a missing field and a null one alike.

Every message carries these, whatever its kind.

Field	Type	Required	Meaning
`omd`	object	yes	What this message is and who wrote it.
`omd.version`	string (matches `^1\.\d+$`)	yes	MAJOR.MINOR. A receiver reads any 1.x message.
`omd.kind`	string	yes	start_list, results, team_scores, announcement, or clear. Open: accept and ignore a kind you do not show.
`omd.generator`	generator	yes
`omd.sent_at`	string (date-time)	yes	When the producer built the message, ISO 8601 UTC.
`meet`	object	yes
`meet.id`	text		The meet’s stable identity.
`meet.name`	string	yes
`meet.start_date`	date	yes
`meet.end_date`	date	yes
`meet.sport`	string	yes	OMX’s sports: xc, tf-indoor, tf-outdoor, run. Open.
`display`	object	yes
`display.target`	string (not empty)	yes
`display.mode`	string	yes	replace in 1.x.
`display.connection_id`	text		The producer connection that sent the message. A label, not a credential.

start_list messages

What start_list messages carry beside the envelope.

Field	Type	Required	Meaning
`event`	event	yes
`start_list`	eventRows	yes

results messages

What results messages carry beside the envelope.

Field	Type	Required	Meaning
`event`	event	yes
`results`	eventRows	yes

team_scores messages

What team_scores messages carry beside the envelope.

Field	Type	Required	Meaning
`event`	event
`team_scores`	teamScores	yes

announcement messages

What announcement messages carry beside the envelope.

Field	Type	Required	Meaning
`announcement`	announcement	yes

date

string (matches ^\d{4}-\d{2}-\d{2}$)

text

string | null

eventRows

Field	Type	Required	Meaning
`rows`	array of eventRow	yes

generator

The product that wrote this JSON, in the same shape as OMX’s generator.

Field	Type	Required	Meaning
`id`	string (not empty)	yes	A short name the product picks for itself, once, and never changes.
`name`	string (not empty)	yes	The product’s name.
`version`	text		The product’s version.

team

Field	Type	Required	Meaning
`name`	string	yes
`short_name`	text		What fits on a narrow board, such as the team’s code.

event

Field	Type	Required	Meaning
`id`	text
`number`	text
`name`	string	yes
`code`	text		OMX’s event code, such as 100, 4X400, or LJ. Left out when OMX has none.
`round`	text
`round_label`	text
`section_name`	text
`gender`	text		M, F, X (non-binary), or C (everyone: mixed, combined, or co-ed), as in OMX. Open: show an unknown value as text.
`entry_type`	text
`wind`	text

eventRow

Field	Type	Required	Meaning
`entry_id`	text
`start_assignment`	text
`participant_name`	string	yes
`bib`	text
`team`	team
`relay_legs`	array \| null
`seed`	text
`result`	text
`status`	text		dnf, dns, dq, fs, scr, or nr; exh is reserved. A row with a place has none. Open.
`place`	text
`wind`	text
`points`	text
`scoring_role`	text
`multi_points`	text

teamScores

Field	Type	Required	Meaning
`scope`	string	yes	meet or event. Open.
`division_name`	text
`gender`	text	yes	Whose standings these are, always present: M, F, or X for one gender, C for standings that count every gender together. Open.
`rows`	array of objects	yes
`rows[].place`	string	yes
`rows[].team`	team	yes
`rows[].points`	string	yes

announcement

Field	Type	Required
`title`	text
`message`	string (not empty)	yes
`priority`	text
`expires_at`	string \| null (date-time)

Probe reply

What a receiver answers, with 200, to a GET on the URL it takes messages on: the versions it reads and who it is. The same reply an Open Meet Exchange Publisher may give, plus optional display targets. Every object allows additional properties; a later minor version only adds fields.

Field	Type	Required	Meaning
`accepts`	array of string (matches `^\d+\.\d+$`) (at least 1)	yes	MAJOR.MINOR versions the receiver reads. 1.0 reads 1.0 and every later 1.x.
`generator`	object	yes	The product that wrote this reply.
`generator.id`	string (not empty)	yes	A short name the product picks for itself, once, and never changes.
`generator.name`	string (not empty)	yes	The product’s name.
`generator.version`	string \| null		The product’s version.
`targets`	array of string (not empty)		display.target names the receiver understands. It may take others.