1 of 28

Response Model

Packets

Fields

All packets have at least the following fields, and may have additional fields depending on the value of eventElementType:

Field name

JSON type

Description

number

The unique match identifier

eventElementType

string

A discriminator field that can be used to identify the type of packet. Possible values:

PointScored
PointStarted
Correction
Injury
MatchStatusUpdate
PointScored
Sanction
Undo

seqNum

number

Sequence number of the packet. The first packet will use the number zero.

timestamp

string

The ISO 8601 UTC timestamp for when the packet occurred

Sample

{
  "eventElementType": "MatchStatusUpdate",
  "id": 2345,
  "seqNum": 19,
  "timestamp": "2020-09-30T18:43:21Z",
}

Correction packets

Correction objects

Undo

Fields

In addition to the basic packet fields undo packets have the following additional fields:

Field Name

JSON type

Description

game

int

The game in which the point was scored

scores

array (scores)

An array of the game scores up until this point

matchScore

array (match score)

An array of the current match score after correction

undoneEventSeqNums

array (number)

An array of the seqNums of packets undone by this correction

{
    "eventElementType": "Undo",
    "id": 0,
    "seqNum": 27,
    "matchScore": {
        "pointsA": 0,
        "pointsB": 0
    },
    "scores": [
        {
            "pointsA": 0,
            "pointsB": 11
        },
        {
            "pointsA": 5,
            "pointsB": 4
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        }
    ],
    "game": 2,
    "timestamp": "1970-01-01T00:00:00.000Z",
     "undoneEventSeqNums": [
    26
    ]
}

Correction (Score Edit)

Fields

In addition to the basic packet fields undo packets have the following additional fields:

Field Name

JSON type

Description

game

int

The game in which the point was scored

scores

array (scores)

An array of the game correct scores

matchScore

array (match score)

An array of the current match score after correction

{
    "eventElementType": "Correction",
    "id": 0,
    "seqNum": 27,
    "scores": [
        {
            "pointsA": 0,
            "pointsB": 11
        },
        {
            "pointsA": 5,
            "pointsB": 4
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        }
    ],
    "matchScore": {
        "pointsA": 0,
        "pointsB": 1
    },
    "game": 2,
    "timestamp": "1970-01-01T00:00:00.000Z",
}

Scoring packets

PointStarted packets

Fields

In addition to the basic packet fields point started packets have the following additional fields:

Field name

JSON type

Description

eventElementType

string

A discriminator field that can be used to identify the type of packet.

Possible values:

SwapServe
SwapSides
Undo
Correction
Expedited
Sanction

game

number

The game in which the point was scored

number

Unique match identifier

seqNum

number

Sequence number of the packet. The first packet will use the number zero.

server

string

Name of serving player or team

nextServer

string

The team who will serve next

timestamp

The ISO 8601 UTC timestamp for when the packet occurred

Sample

{
    "eventElementType": "PointStarted",
    "game": 1,
    "id": 99991,
    "seqNum": 6,
    "server": "TeamA",
    "nextServer: "TeamA",
    "timestamp": "2021-07-13T13:42:24.867Z"
}

PointScored packets

Fields

In addition to the basic packet fields point scored packets have the following additional fields:

Field Name

JSON type

Description

server

string

The server for the point

scoredBy

sttring

The team that scored the point

game

int

The game in which the point was scored

scores

array (scores)

An array of the game scores up until this point

matchScore

array (match score)

An array of the match score up until this point

nextServer

string

The team who will serve next

{
    "eventElementType": "PointScored",
    "game": 1,
    "id": 99991,
    "matchScore": {
        "pointsA": 0,
        "pointsB": 0
    },
    "scoredBy": "TeamB",
    "scores": [
        {
            "pointsA": 0,
            "pointsB": 1
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        }
    ],
    "seqNum": 7,
    "server": "TeamA",
    "nextServer": "TeamA",
    "timestamp": "2021-07-13T13:42:28.808Z"
}

Sanctions packets

Sanction packets

Fields

In addition to the basic packet fields, sanction packets have the following additional fields:

Field name

JSON type

Description

team

string

The team to which the sanctions are being applied

game

int

The current game

sanctionType

string

A discriminator field that can be used to identify the type of sanction assigned to the party.

Possible values:

PlayerYellowCard
PlayerYellowRedOne
PlayerYellowRedTwo

Sample

{
    "eventElementType": "Sanction",
    "id": 0,
    "seqNum": 51,
    "sanctionType": "PlayerYellowCard",
    "team": "TeamA",
    "game": 2,
    "timestamp": "1970-01-01T00:00:00.000Z"
}

PenaltyPoints packets

Fields

In addition to the basic packet fields, penalty points packets have the following additional fields:

Sample

{
    "eventElementType": "PenaltyPoint",
    "id": 0,
    "seqNum": 26,
    "team": "TeamA",
    "matchScore": {
        "pointsA": 0,
        "pointsB": 0
    },
    "scores": [
        {
            "pointsA": 0,
            "pointsB": 11
        },
        {
            "pointsA": 5,
            "pointsB": 5
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        },
        {
            "pointsA": 0,
            "pointsB": 0
        }
    ],
    "game": 2,
    "timestamp": "1970-01-01T00:00:00.000Z"
}

Swap packets

SwapServe packets

Fields

In addition to the basic packet fields swap serve packets have the following additional fields:

Field Name

JSON type

Description

game

int

The game in which the point was scored

scores

array (scores)

An array of the game scores up until this point

matchScore

array (match score)

An array of the match score up until this point

{
    "eventElementType": "SwapServe",
    "game": 1,
    "id": 99991,
    "matchScore": {
        "pointsA": 0,
        "pointsB": 0
    },
    "scores": [],
    "seqNum": 2,
    "timestamp": "2021-07-13T13:41:29.944Z"
}

SwapSides packets

Fields

In addition to the basic packet fields swap sides packets have the following additional fields:

Field Name

JSON type

Description

game

int

The game in which the point was scored

scores

array (scores)

An array of the game scores up until this point

matchScore

array (match score)

An array of the match score up until this point

{
    "eventElementType": "SwapSides",
    "game": 1,
    "id": 99991,
    "matchScore": {
        "pointsA": 0,
        "pointsB": 0
    },
    "scores": [],
    "seqNum": 3,
    "timestamp": "2021-07-13T13:41:31.405Z"
}

MatchStatusUpdate packets

Fields

In addition to the basic packet fields match status update packets have the following additional fields:

Field name

JSON type

Description

matchStatus

object (MatchStatus)

An object describing the current status of the match

Sample

{
  "eventElementType": "MatchStatusUpdate",
  "id": 2345,
  "matchStatus": {},
  "seqNum": 19,
  "timestamp": "2020-09-30T18:43:21Z",
}

Match Status objects

Fields

This object type contains at least the following fields, and may have additional fields depending on the value of matchState.

Field name

JSON type

Description

matchState

string

A discriminator field that can be used to identify the type of match status. Possible values:

PlayersConfirmed
InProgress
Timeout

PlayersConfirmed

Status update once the players have been confirmed.

Fields

This matchSate object type has the following fields:

Field name

JSON type

Description

state

string

The current status of the game

isExpedited

Boolean

Indicates whether the game has expedited (true or false)

Sample

"matchState": {
                "state": "PlayersConfirmed",
                "isExpedited": false
              }

InProgress

Status update once the game is started.

Fields

This matchSate object type has the following fields:

Field name

JSON type

Description

state

string

The current status of the game

isExpedited

Boolean

Indicates whether the game has expedited (true or false)

Sample

"matchState": {
                "state": "InProgress",
                "isExpedited": false
              }

Timeout

Fields

This matchSate object type has the following fields:

Field name

JSON type

Description

state

string

The current status of the game

isExpedited

Boolean

Indicates whether the game has expedited (true or false)

team

string

The team that requesed the timeout

game

int

The current game

timeoutType

string

A simplified descriptor for why the timeout was called

"matchState": {
                "state": "Timeout",
                "isExpedited": false,
                "team": "TeamA",
                "game": 1,
                "timeoutType": "PlayerTimeout"
              }

MatchFinished packets

This packet indicates the reason a match was finished.

Fields

In addition to the basic packet fields match status update packets have the following additional fields:

Field name

JSON type

Description

reason

object (reason)

An object describing the reason of why the match was finished

Sample

{
    "eventElementType": "MatchFinished",
    "id": 999991,
    "seqNum": 101,
    "reason": {},
    "won": "TeamA",
    "timestamp": "2021-07-13T13:47:17.793Z"
}

MatchFinished objects

Fields

This object type contains at least the following fields, and may have additional fields depending on the value of matchFinished.

Sample

{
  "reason": "Normally"
}

Normally

Fields

This object type has no additional fields beyond those included with all match finished objects.

Sample

{
  "reason": "Normally"
}

Injury

Fields

This object type has no additional fields beyond those included with all match finished objects.

Sample

{
  "reason": "Injury"
}

Disqualification

Fields

This object type has no additional fields beyond those included with all .

Sample

{
  "reason": "Disqualification"
}

Walkover

Fields

This object type has no additional fields beyond those included with all .

Sample

{
  "reason": "Walkover"
}

Retired

Fields

This object type has no additional fields beyond those included with all .

Sample

{
  "reason": "Retired"
}

Unknown Reason

Fields

This object type has no additional fields beyond those included with all match finished objects.

Sample

{
  "reason": "UnknownFinishedReason"
}