COVERITLIVE API - SCOREBOARD/LIST (V. 2.0)

The Request

This method provides a list of scoreboards for an event. Only Manual scoreboards are returned (data from Live scoreboards will not be returned). All relevant data for each scoreboard is returned.

URL:
https://api.coveritlive.com/remote/2/scoreboard/list
Response Format:
JSON
HTTP Method(s):
GET
API Rate Limited:
false
In addition to the parameters listed in the Request Parameters section, the scoreboard/list method also includes the following parameters:

Parameter Description Required
event_code The event code for the event for which scoreboard data is being retreived. Each CiL event that is created is assigned a unique event code that identifies it in the database - The event owner can find this value after creating a new event, by selecting the "altcast_code" which is found in their Viewer Window embed code (e.g. the event code is "46e6cd22b5" in "altcast_code=46e6cd22b5"). This value is also returned by the event/list API method. yes
status

A pipe (|) delimited list of scoreboard types to retrieve. Possible values include:

published - scoreboard has been created

deleted - scoreboard has been removed from display

yes
scoreboard_type

A pipe (|) delimited list of scoreboard types to retrieve. Possible values include:

team - scoreboards of the "Team vs Team" type (includes all team scoreboards, such as basketball, soccer, football, etc ...)

standings - scoreboards of the "Race/Standings" type

baseball - Baseball specific scoreboards (created in EventStudio)

basketball - Basketball specific scoreboards (created in EventStudio)

collegebasketball - College Basketball specific scoreboards (created in EventStudio)

football - Football specific scoreboards (created in EventStudio)

hockey - Hockey specific scoreboards (created in EventStudio)

soccer - Soccer specific scoreboards (created in EventStudio)

yes

The Response

The scoreboard listing data is returned in the data field of a general response. This field will consist of an array of scoreboard objects. There are two types of scoreboard objects corresponding to the two types of scoreboards: team and standings. Both types are enumerated below.

Team Scoreboard objects have the following fields:

Field Name Field Value(s) Explanation
scoreboard_id {string} The ID of the scoreboard. Can be used in further requests against a single scoreboard
scoreboard_type {string} One of: team, standings. For Team Scoreboards, this value will always be team.
status {string} One of: published, deleted. When a scoreboard is first created, it is in a published state. If it is subsequently deleted, the status field will reflect that.
headline {string} The headline of the scoreboard
team_a {string} The name of the first team entered by the user
team_b {string} The name of the second team entered by the user
score_a {string} The score of the first team entered by the user
score_b {string} The score of the second team entered by the user
game_time {string} The game time
game_section {string} Period / Half / Quarter
published_timestamp {integer} The time that the scoreboard was published, in seconds since the Unix Epoch. The timestamp is in GMT time.
modified_timestamp {integer} The last time that the scoreboard was modified, in seconds since the Unix Epoch. The timestamp is in GMT time.
editable {string}

Indicates whether the scoreboard can be updated through the API. This is a legacy field, as ALL scoreboard types can now be updated through the API.

Possible values:

y - scoreboard can be updated through the API

n - scoreboard cannot be updated through the API

sport {string} If the scoreboard was created in the EventStudio, it will be specific to a particular sport. Possible values include: baseball, basketball, collegebasketball, football, hockey, soccer.
detailed_data {object}

If the scoreboard was created in the EventStudio, there is additional data that is not present in scoreboards created using the Classic Console. The data contained in this field will differ depending on the sport the scoreboard is representing. See the example response below.

Standings Scoreboard objects have the following fields:

Field Name Field Value(s) Explanation
scoreboard_id {string} The ID of the scoreboard. Can be used in further requests against a single scoreboard
scoreboard_type {string} One of: team, standings. For Standings Scoreboards, this value will always be standings.
status {string} One of: published, deleted. When a scoreboard is first created, it is in a published state. If it is subsequently deleted, the status field will reflect that.
headline {string} The headline of the scoreboard
published_timestamp {integer} The time that the scoreboard was published, in seconds since the Unix Epoch. The timestamp is in GMT time.
modified_timestamp {integer} The last time that the scoreboard was modified, in seconds since the Unix Epoch. The timestamp is in GMT time.
standings {array} An array of individual standings objects
editable {string}

Indicates whether the scoreboard can be updated through the API. This is a legacy field, as ALL scoreboard types can now be updated through the API.

Possible values:

y - scoreboard can be updated through the API

n - scoreboard cannot be updated through the API

Individual Standings objects have the following fields:

Field Name Field Value(s) Explanation
name {string} The name of this participant
value {string} The score/time value assigned to this participant

Example response to a successful scoreboard/list request:


{
	"result":"success",
	"message":"true",
	"type":"scoreboard",
	"action":"list",
	"version":2,
	"data":[
		{
			"scoreboard_id":"13922452",
			"scoreboard_type":"team",
			"status":"deleted",
			"headline":"Team v Team Scoreboard Headline",
			"team_a":"Team a",
			"team_b":"Team b",
			"score_a":"20",
			"score_b":"15",
			"game_time":"2:34",
			"game_section":"2nd Half",
			"editable":"y",
			"published_timestamp":1319465814,
			"modified_timestamp":1319465814
		},
		{
			"scoreboard_id":"13922493",
			"scoreboard_type":"standings",
			"status":"published",
			"headline":"Race\/Standings Scoreboard Headline",
			"published_timestamp":1319465863,
			"modified_timestamp":1319465863,
			"editable":"y",
			"standings":[
				{
					"name":"Participant 1",
					"value":"20"
				},
				{
					"name":"Participant 2",
					"value":"15"
				},
				{
					"name":"Participant 3",
					"value":"10"
				},
				{
					"name":"Participant 2",
					"value":"5"
				}
			]
		},
		{		
			"scoreboard_id":"16547302",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Toronto Blue Jays at Boston Red Sox",
			"team_a":"Toronto Blue Jays ",
			"team_b":"Boston Red Sox",
			"score_a":"3",
			"score_b":"6",
			"game_time":"",
			"game_section":"",
			"editable":"y",
			"published_timestamp":1387224215,
			"modified_timestamp":1387224215,
			"sport":"baseball",
			"detailed_data":{
				"away_team":{
					"name":"Toronto",
					"nickname":"Blue Jays",
					"short_name":"TOR",
					"logo":"",
					"record":"(70-83)",
					"score":"3",
					"runs":"3",
					"hits":"10",
					"errors":"0"
				}, 
				"home_team":{
					"name":"Boston",
					"nickname":"Red Sox",
					"short_name":"BOS",
					"logo":"",
					"record":"(94-62)",
					"score":"6",
					"runs":"6",
					"hits":"12",
					"errors":"2"
				},
				"game_notes": "Here are the game notes",
				"runs_label":"R",
				"hits_label":"H",
				"errors_label":"E",
				"balls":"2",
				"strikes":"1",
				"outs":"1",
				"inning":"1st"
			}
		},
		{		
			"scoreboard_id":"16547304",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Toronto Raptors at Miami Heat",
			"team_a":"Toronto Raptors",
			"team_b":"Miami Heat",
			"score_a":"83",
			"score_b":"90",
			"game_time":"2:43",
			"game_section":"4th",
			"editable":"y",
			"published_timestamp":1387225421,
			"modified_timestamp":1387225421,
			"sport":"basketball",
			"detailed_data":{
				"away_team":{
					"name":"Toronto",
					"nickname":"Raptors",
					"short_name":"TOR",
					"logo":"",
					"record":"(6-9)",
					"score":"83",
					"1_quarter_score":"22",
					"2_quarter_score":"21",
					"3_quarter_score":"27",
					"4_quarter_score":"13",
					"overtime_score":"",
				}, 
				"home_team":{
					"name":"Miami",
					"nickname":"Heat",
					"short_name":"MIA",
					"logo":"",
					"record":"(13-3)",
					"score":"90",
					"1_quarter_score":"27",
					"2_quarter_score":"30",
					"3_quarter_score":"21",
					"4_quarter_score":"12",
					"overtime_score":""
				},
				"game_notes": "Here are the game notes",
				"game_time":"2:43",
				"game_section":"4th",
				"game_section_label":"Quarter",
				"1_quarter_label":"1",
				"2_quarter_label":"2",
				"3_quarter_label":"3",
				"4_quarter_label":"4",
				"overtime_label":""
			}
		},
		{		
			"scoreboard_id":"16547304",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Atlanta Falcons at Buffalo Bills",
			"team_a":"Atlanta Falcons",
			"team_b":"Buffalo Bills",
			"score_a":"34",
			"score_b":"31",
			"game_time":"3:42",
			"game_section":"4th",
			"editable":"y",
			"published_timestamp":1387221245,
			"modified_timestamp":1387221245,
			"sport":"football",
			"detailed_data":{
				"away_team":{
					"name":"Atlanta",
					"nickname":"Falcons",
					"short_name":"ATL",
					"logo":"",
					"record":"(3-9)",
					"score":"34",
					"timeouts_remaining":"3",
					"1_quarter_score":"7",
					"2_quarter_score":"10",
					"3_quarter_score":"7",
					"4_quarter_score":"7",
					"overtime_score":"3"
				}, 
				"home_team":{
					"name":"Buffalo",
					"nickname":"Bills",
					"short_name":"BUF",
					"logo":"",
					"record":"(4-8)",
					"score":"31",
					timeouts_remaining:"2",
					"1_quarter_score":"14",
					"2_quarter_score":"3",
					"3_quarter_score":"7",
					"4_quarter_score":"7",
					"overtime_score":"0"
				},
				"game_notes": "Here are the game notes",
				"game_time":"3:42",
				"game_section":"4th",
				"game_section_label":"Quarter",
				"1_quarter_label":"1",
				"2_quarter_label":"2",
				"3_quarter_label":"3",
				"4_quarter_label":"4",
				"overtime_label":"OT"
			}
		},
		{		
			"scoreboard_id":"16547306",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Syracuse Orange at St. John's Red Storm",
			"team_a":"Syracuse Orange",
			"team_b":"St. John's Red Storm",
			"score_a":"68",
			"score_b":"63",
			"game_time":"3:42",
			"game_section":"4th",
			"editable":"y",
			"published_timestamp":1387223962,
			"modified_timestamp":1387223962,
			"sport":"collegebasketball",
			"detailed_data":{
				"away_team":{
					"name":"Syracuse",
					"nickname":"Orange",
					"short_name":"SYR",
					"logo":"",
					"record":"(10-0)",
					"score":"68",
					"1_half_score":"39",
					"2_half_score":"29"
				}, 
				"home_team":{
					"name":"St. John's",
					"nickname":"Red Storm",
					"short_name":"STJ",
					"logo":"",
					"record":"(6-3)",
					"score":"63",
					"1_half_score":"27",
					"2_half_score":"36"
				},
				"game_notes": "Here are the game notes",
				"game_time":"3:42",
				"game_section":"2nd",
				"game_section_label":"Half",
				"1_half_label":"1",
				"2_half_label":"2"
			}
		},
		{		
			"scoreboard_id":"16547308",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Toronto Maple Leafs at Buffalo Sabres",
			"team_a":"Toronto Maple Leafs",
			"team_b":"Buffalo Sabres",
			"score_a":"2",
			"score_b":"3",
			"game_time":"1:49",
			"game_section":"3rd",
			"editable":"y",
			"published_timestamp":1387223296,
			"modified_timestamp":1387223296,
			"sport":"hockey",
			"detailed_data":{
				"away_team":{
					"name":"Toronto",
					"nickname":"Maple Leafs",
					"short_name":"TOR",
					"logo":"",
					"record":"(14-9)",
					"score":"2",
					"1_period_score":"1",
					"2_period_score":"1",
					"3_period_score":"0",
					"overtime_score":""
				}, 
				"home_team":{
					"name":"St. John's",
					"nickname":"Red Storm",
					"short_name":"BUF",
					"logo":"",
					"record":"(6-20)",
					"score":"3",
					"1_period_score":"0",
					"2_period_score":"2",
					"3_period_score":"0",
					"overtime_score"
				},
				"game_notes": "Here are the game notes",
				"game_time":"3:42",
				"game_section":"3rd",
				"game_section_label":"Period",
				"1_period_label":"1",	
				"2_period_label":"2",
				"3_period_label":"3",
				"overtime_label":""
			}
		},
		{		
			"scoreboard_id":"16547310",
			"scoreboard_type":"team",
			"status":"published",
			"headline":"Toronto FC at Montreal Impact,
			"team_a":"Toronto FC",
			"team_b":"Montreal Impact",
			"score_a":"1",
			"score_b":"0",
			"game_time":"0:59",
			"game_section":"2nd",
			"editable":"y",
			"published_timestamp":1387223179,
			"modified_timestamp":1387223179,
			"sport":"soccer",
			"detailed_data":{
				"away_team":{
					"name":"Toronto",
					"nickname":"FC",
					"short_name":"TOR",
					"logo":"",
					"record":"(10-0)",
					"score":"1",
					"1_half_score":"0",
					"2_half_score":"1"
				}, 
				"home_team":{
					"name":"Montreal",
					"nickname":"Impact",
					"short_name":"MON",
					"logo":"",
					"record":"(6-3)",
					"score":"0",
					"1_half_score":"0",
					"2_half_score":"0"
				},
				"game_notes": "Here are the game notes",
				"game_time":"0:59",
				"game_section":"2nd",
				"game_section_label":"Half",
				"1_half_label":"1",
				"2_half_label":"2"
			}
		}
	]
}

scoreboard/list Error Responses

A variety of error responses (in addition to the common error responses) to scoreboard/list requests, and instructions on how to rectify them:

result response message response solution
missing_status_param Required parameter empty: status. Ensure that the status parameter is present for scoreboard/list requests.
invalid_status_param status request parameter contains invalid values. Ensure that the status parameter only contains valid values (pipe delimited list, which can include 'published' and 'deleted').
missing_scoreboard_type_param Required parameter empty: scoreboard_type. Ensure that the scoreboard_type parameter is present for scoreboard/list requests.
invalid_scoreboard_type_param scoreboard_type request parameter contains invalid values. Ensure that the scoreboard_type parameter only contains valid values (pipe delimited list, which can include 'team', 'standings', 'baseball', 'basketball', 'collegebasketball', 'football', 'hockey' and 'soccer').