Versions Compared

Key

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

...

Example Ably LiveAccess URL: https://platform.matchstate.api.geniussports.com/api/v1/sources/GeniusSportsItaly/sports/91189/fixtures/10431860/liveaccess
This document describes the V2 V1 Volleyball match state contract.

Match

...

Details Message

...

The Summary message summarises the major match events into a single, easily digested messageDetails message provides details of every action that has taken place in a match.

Code Block
{
"FixtureId":"3421547",
"CustomerId":6444,
"StartedAtUtc":"2015-10-01T15:15:44.95Z",
"FinishedAtUtc"
:null
:"2015-10-01T16:25:34.05Z",
"TeamA":{},
"TeamB":{},
"CurrentServer":"TeamA",
"
MatchScore
Match":{},
"MatchStatus":"BetweenPoints",
"SanctionStatus":"Safe",
"IsReliable":true,
"MessageTimestampUtc":"2015-10-01T15:15:44.9551641Z",
"IsCoverageCancelled":true,
"CoverageCancelledAtUtc":"2015-10-01T15:15:42.9551641Z"
} 

Element

Type

Description

FixtureId

Integer

An immutable identifier for the event

CustomerId

Integer

An immutable identifier for the customer

StartedAtUtc

DateTime, optional

The time that the match started if the match has started, Null otherwise

FinishedAtUtc

DateTime, optional

The time that the match finished

,

if the match has finished, Null otherwise

TeamA

Team

An object describing TeamA

TeamB

Team

An object describing TeamB

CurrentServer

TeamIdentifier, optional

An enum that describes the team that is currently serving. Possible values are:
TeamA
TeamB

MatchScore

Match

MatchScore

Match

An object that describes events within the

current

match

score

MatchStatus

MatchStatus

An enum that describes the current state of the match.

Possible values are:

NotStarted
WalkoverTeamA
WalkoverTeamB
OnCourt
WarmingUp
BetweenPoints
BetweenSets
TimeOut
PointInProgress
Challenge
PlaySuspended
ShortDelay
MedicalTimeoutTeamA
MedicalTimeoutTeamB
WinnerTeamAByRetirementOrDefault
WinnerTeamBByRetirementOrDefault
WinnerTeamA
WinnerTeamB
MatchAbandoned

SanctionStatus

SanctionStatus

An enum describing the current sanction status.

Possible values:
Safe
TeamAPenaltyCommitted
TeamBPenaltyCommitted
TeamAExpulsion
TeamBExpulsion
PossibleDisqualification

TeamADisqualification
TeamBDisqualification

IsReliable

Boolean

True if the data values are reliable, False otherwise

MessageTimestampUtc

DateTime

The time

that

in UTC at which the message was generated

Team

An object that describes a team. The Id and Name will match the information provided in Fixture; Jersey is provided only here.

...

Code Block
{
"Id":"184374",
"Name":"Windsor Wildcats",
"Jersey":{}
} 

...

Element

...

Type

...

Description

...

Id

...

String

...

The team's identifier

...

Name

...

String

...

The name of the team

...

Jersey

...

Jersey

...

An object that describes the team's jersey

Jersey

An object that describes a team's jersey.

...

Code Block
{
"Color1":{},
"Color2":{},
"PantsColor":{},
"SocksColor":{},
"JerseyDesign":{},
} 

...

Element

...

Type

...

Description

...

Color1

...

Color

...

An object describing the primary colour of the team's jersey

...

Color2

...

Color

...

An object describing the secondary colour of the team's jersey

...

PantsColor

...

Color

...

An object describing the colour of the team's pants

...

SocksColor

...

Color

...

An object describing the colour of the team's socks

...

JerseyDesign

...

JerseyDesign

...

An enum describing the design of the team's jersey. Possible values include:
Unknown
Plain
StripedHorizontal
StripedVertical
BarHorizontal
BarVertical

MatchScore

An object that describes the current match score.

...

Code Block
{
"ScoreInSets":{},
"ScoreInPoints":{}
} 

...

Element

...

Type

...

Description

...

ScoreInSets

...

Score

...

An object that describes the current score in sets

...

ScoreInPoints

...

Score

...

An object that describes the score of the current set in points

Score

An object that describes a score.

...

Code Block
{
"TeamA":6,
"TeamB":3
} 

...

Element

...

Type

...

Description

...

TeamA

...

Integer

...

TeamA's score

...

TeamB

...

Integer

...

TeamA's score

Match Details Message

...

The Details message provides details of every action that has taken place in a match.

Code Block
{
"FixtureId":"3421547",
"CustomerId":6444,
"StartedAtUtc":"2015-10-01T15:15:44.95Z",
"FinishedAtUtc":"2015-10-01T16:25:34.05Z",
"TeamA":{},
"TeamB":{},
"CurrentServer":"TeamA",
"Match":{},
"MatchStatus":"BetweenPoints",
"SanctionStatus":"Safe",
"IsReliable":true,
"MessageTimestampUtc":"2015-10-01T15:15:44.9551641Z",
"IsCoverageCancelled":true,
"CoverageCancelledAtUtc":"2015-10-01T15:15:42.9551641Z"
} 

Element

Type

Description

FixtureId

Integer

An immutable identifier for the event

CustomerId

Integer

An immutable identifier for the customer

StartedAtUtc

DateTime, optional

The time that the match started if the match has started, Null otherwise

FinishedAtUtc

DateTime, optional

The time that the match finished if the match has finished, Null otherwise

TeamA

Team

An object describing TeamA

TeamB

Team

An object describing TeamB

CurrentServer

TeamIdentifier, optional

An enum that describes the team that is currently serving. Possible values are:
TeamA
TeamB

Match

Match

An object that describes events within the match

MatchStatus

MatchStatus

An enum that describes the current state of the match.

SanctionStatus

SanctionStatus

An enum describing the current sanction status.

IsReliable

Boolean

True if the data values are reliable, False otherwise

MessageTimestampUtc

DateTime

The time in UTC at which the message was generated

IsCoverageCancelled

Boolean

True if coverage has been cancelled, false otherwise

CoverageCancelledAtUtc

DateTime, optional

The

IsCoverageCancelled

Boolean

True if coverage has been cancelled, false otherwise

CoverageCancelledAtUtc

DateTime, optional

The datetime at which coverage was cancelled.

...

Code Block
{
"PointNumber":1,
"PointTypeServer":Ace
"IsInSequenceTeamOne":true,
"IsConfirmedComplete":true,
"ServerWinner":"TeamOne",
"StartedAtUtcstartedAt": "2015-10-01T15:14:44.9551641Z00:00:00",
"WinnerwonAt": "TeamOne00:00:21",
"WonAtUtcStartedAtUtc":"2015-10-01T15:14:4644.3875293Z9551641Z",
"ScoreWhenPointStarted":{}
} 

Element

Type

Description

PointNumber

Integer

The number of the point being described

IsInSequence

Boolean

True if the point is in sequence, false otherwise

PointType

PointType

An enum that describes the point type. Possible values are:
Unknown
Block
Kill
Out
BlockOut
Ace
Error
ServeError
Penalty

IsConfirmedComplete

Boolean

True if the point has been confirmed, false otherwise
,
"IsConfirmedComplete":true,
"PointType":Ace
} 

Element

Type

Description

PointNumber

Integer

The number of the point being described

Server

TeamIdentifier

The team that is currently serving

StartedAtUtcWinner

DateTimeTeamIdentifier, optional

The time at which team that won the point started. Null if this information is not available.

Winner

TeamIdentifier, optional

The team that won the point if the point is complete, Null otherwise

StartedAt

DateTime, optional

Timer at which the point was started if the point is complete and the information is available, Null otherwise

WonAtUtcWonAt

DateTime, optional

The time at which the point was won if the point is complete and the information is available, Null otherwise

ScoreWhenPointStarted

MatchScore

The match score at the time that the point began

StartedAtUtc

DateTime, optional

The time at which the point started. Null if this information is not available.

IsConfirmedComplete

Boolean

True if the point has been confirmed, false otherwise

PointType

PointType

An enum that describes the point type. Possible values are:
Unknown
Block
Kill
Out
BlockOut
Ace
Error
ServeError
Penalty

Expulsion

An object that describes an expulsion within a Volleyball match.

...