scoreboard

For: READ, PUBLISH

The scoreboard message type contains information about that status of the official scoreboard. The data can be generated by a physical integration to the scoreboard, OCR from a camera, computer program/App or some other means.

This message should be sent at a minimum every 10 seconds, but more often if data is changing more rapidly e.g., a clock (or shotclock) is running. This may mean the data is sent every 10th of second if the clock supports that resolution.

As scoreboard functionality varies widely, the information available in this message can also vary depending on what is available.

        {
            "type": "scoreboard",
            "venueId": "b25692de-ac17-11e8-98d0-529269fb1459",
            "fixtureId": "b98392de-ac17-11e8-98d0-529269fb1459",
            "clientType": "AppName:Version",
            "data": {
                "status": "DISCONNECTED",
                "state": "PRE",
                "periodId": 3,
                "possessionArrow": 2,
                "clock": {
                    "value": "PT8M23S",
                    "running": false
                },
                "shotClock": {
                    "value": "PT12.3S",
                    "running": false,
                    "inUse": true
                },
                "countdown": null,
                "team1": {
                    "name": "",
                    "shortName": "",
                    "score": 0,
                    "fouls": 0,
                    "timeOuts": 2,
                    "inBonus": false,
                    "inDoubleBonus": false,
                    "players": {
                        "1": {
                            "number": "00",
                            "name": "John Smith",
                            "score": 12,
                            "fouls": 2
                        },
                        "2": {
                            "number": "99",
                            "name": "Fred Jones",
                            "score": 34,
                            "fouls": 3
                        }
                    }
                },
                "team2": {
                    "name": "",
                    "shortName": "",
                    "score": 0,
                    "fouls": 0,
                    "timeOuts": 2,
                    "timeLeft": 1,
                    "inBonus": false,
                    "inDoubleBonus": false,
                    "players": {
                        "1": {
                            "number": "04",
                            "name": "Thomas Brown",
                            "score": 77,
                            "fouls": 3
                        }
                    }
                },
                "timestamp": "2018-08-14T16:45:34.34",
            }
        }
    

Bold fields are required

Field	Type	Description
status	string	The status of the connection of the sending device's connection to the scoreboard. Options are CONNECTED (actively receiving data) or DISCONNECTED (no data being received)
state	string	The state of the fixture/match. Options are PRE = Hasn't yet begun, RUNNING=Currently running FINAL=Finished and complete. A blank value is NOT valid. If unknown then do not send the key.
periodId	integer	The unique identifier of the period. Overtime periods start at 11. 1 = 1 OT1 = 11
possessionArrow	integer	If a posession arrow is in use, then this value indicates which team is next to receive possession. Options are 1 or 2.
clock.value	string	The current game clock time. Format ISO-8601 Duration.
clock.running	boolean	Whether the clock is currently running. Options are boolean true/false.
shotClock.value	string	The current shot clock time. Format ISO-8601 Duration.
shotClock.running	boolean	Whether the shot clock is currently running. Options are boolean true/false.
shotClock.inUse	boolean	Whether the shot clock is in use/available. Options are boolean true/false.
countdown	string	The value of any pre-match or period break count-down to the start/resumption of play. Format ISO-8601 Duration.
team1/team2	object	These team structures hold information about specific teams. team1 is normally the 'home' team and team2 the 'away'.
name	string	The name of the team
score	integer	The score of the team
fouls	integer	The number of fouls for the team
timeOuts	integer	The number of time outs for the team
inBonus	boolean	Is this team 'in bonus?'
inDoubleBonus	boolean	Is this team 'in double bonus?'
players	object	These player structures hold information about specific players on the team. The object 'key' is a sequential number (but a 'string' key) of the player on the scoreboard (this is NOT their jersey number).
team.players.X.number	string	The player's jersey'/shirt number
team.players.X.score	integer	The player's score
team.players.X.fouls	integer	The player's foul count
timestamp	datetime	An ISO-8601 datetime giving the time this message was sent.
clientType	string	The type of client that is sending this event. Generally this is given as ApplicationName:ApplicationVersion.
venueId	string	The UUID (v1) of the venueId where this device is located.
fixtureId	string	The UUID (v1) of the fixture for this data.

If a field has no value or the scoreboard model does not support it, then the key/value should not be sent as part of the message. If the field is required but the value is unknown the JSON value of null should be used. "" or 0 are valid values and should only be used when the value is known to be these values.