Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Type

Description

id

uuid

name

string

Description of the sanction rule

positions

enum[]

Optional - Applicable to players or coaches

order

number

Rule precedence order

sanctionId

uuid

Resulting sanction

parentId

id

officeId

id

Accumulation

order

number

Accumulation precedence order

exclusive

boolean

If an infraction matches this sanction it doesn’t count towards other sanctions

min

number

Minimum number of infractions (>=)

max

number

Maximum number of infractions (<=)

resets

boolean

Accumulation count resets to 0 after reaching last accumulation

...

Property

Type

Description

id

uuid

seasonId

string

Season

name

string

With i18n

code

string

Usually the rule number or an accumulation code

durationType

enum

Definite or Indefinite

officeId

numberid

parentId

id

externalId

uuid

For syncing with Spordle ID

...

Property

Type

Description

id

uuid

gameId

id

Game the suspension originated in

participantId

id

Participant that was suspended

teamId

id

Team that the participant is suspended in

positionGroup

enum

Position that this participant was suspended in. Player, Staff

sanctionId

id

Sanction that was determined by the rulebook sanction rules

penaltyId

id

Penalty that resulted in the suspension

durationType

enum

Definite or Indefinite. This is required to be the same as the sanction duration

minimumGames

number

Minimum number of games required for this suspension

Optional when indefinite. Set by system.

requiredGames

number

Number of games required to complete the suspension.

Optional when Indefinite. Required to be >= minimumGames

expiry

date

Optional - Date when the suspension will expire if the games requirement isn’t met

status

enum

Pending, Appealed, Active, Completed, Cancelled, Expired

externalId

uuid

For syncing with Spordle ID

Legacy suspension options (deprecated)

code

enum

Deprecated, replaced by sanctionId

SanctionBreak

Required to define breaks when calculating the suspension expiry date for the season

...