Volleyball Match State V1
- Martin Kuks
- Dimitar Atanasov
- Alexandru Iftimiciuc
The rules of volleyball can be found here: http://www.fivb.org/en/volleyball/Forms.asp
Example Ably LiveAccess URL: https://platform.matchstate.api.geniussports.com/api/v1/sources/GeniusSportsItaly/sports/91189/fixtures/10431860/liveaccess
This document describes the V1 Volleyball match state contract.
Match Details Message
The Details message provides details of every action that has taken place in a match.
{
"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: |
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 datetime at which coverage was cancelled. |
Match
The Match object describes the current score and provides a complete match history.
{
"Sets":{},
"ScoreInSets":{},
"Kills":{},
"Blocks":{},
"Outs":{},
"Aces":{},
"Errors":{},
"ServiceErrors":{},
"Penalties":{},
"Expulsions":{},
"Disqualifications":{},
"MatchWinner":"TeamA",
"StartedAtUtc":"2015-10-01T15:15:44.95Z",
"FinishedAtUtc":"2015-10-01T16:25:34.05Z",
"IsConfirmedComplete":true
}
|
Element | Type | Description |
|---|---|---|
Sets | Set | An array of Set objects |
ScoreInSets | Score | The current score in sets |
Kills | Score | The number of kills by each team |
Blocks | Score | The number of blocks by each team |
Outs | Score | The number of outs by each team |
Aces | Score | The number of aces by each team |
Errors | Score | The number of errors by each team |
ServiceErrors | Score | The number of points won due to opponent's service errors for each team |
Penalties | Score | The number of penalties by each team |
Explusions | Explusion | An array of objects describing explusions |
Disqualifications | Disqualification | An object that describes disqualification events |
MatchWinner | TeamIdentifier, optional | The team that won the match if the match has ended |
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 |
IsConfirmedComplete | Boolean | True if match is complete, False otherwise |
Set
A collection of objects detailing actions in a set.
{
"SetNumber":1,
"Points":{},
"ScoreInPoints":{},
"RequestedTimeOuts":{},
"SetWinner":"TeamA",
"IsGoldenSet":False
"StartedAtUtc":"2015-10-01T15:15:44.95Z",
"FinishedAtUtc":"2015-10-01T16:25:34.05Z",
"IsConfirmedComplete":True
} |
Element | Type | Description |
|---|---|---|
SetNumber | Integer | The set described this this Set object |
Points | Point | An array of point objects detailing the points played so far in this set |
ScoreInPoints | Score | An object that describes the score of the current set in points |
RequestedTimeOuts | Score | An object that describes the number of timeouts requested by each team |
SetWinner | TeamIdentifier, optional | Indicates which team won the set if the set is complete, Null otherwise |
IsGoldenSet | Boolean | True if this set is a golden set, False otherwise (Not currently covered, always sent false) |
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 |
IsConfirmedComplete | Boolean | Indicates which team served the first point |
Point
A collection of objects describing a point.
Element | Type | Description |
|---|---|---|
PointNumber | Integer | The number of the point being described |
Server | TeamIdentifier | The team that is currently serving |
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 |
WonAt | 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: |
Expulsion
An object that describes an expulsion within a Volleyball match.
Element | Type | Description |
|---|---|---|
SetNumber | Integer | The set within which the expulsion occurred. |
OccurredAt | TimeSpan | The match time at which the expulsion occurred. |
Team | TeamIdentifier, optional | The team for which the expulsion was given. |
Disqualification
An object that describes a disqualification within a Volleyball match.
Element | Type | Description |
|---|---|---|
SetNumber | Integer | The set within which the disqualification occurred. |
OccurredAt | TimeSpan | The match time at which the disqualification occurred. |
Team | TeamIdentifier, optional | The team that was disqualified. |