COVERITLIVE API - SCOREBOARD/CREATE (V. 2.0)

The Request

This method allows users to create scoreboards on the fly. The scoreboard id is returned by the method if the scoreboard is successfully created, allowing for further interactions through the API.

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

Parameter Description Required
event_code The event code for the event in which the scoreboard is being created. 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
scoreboard_type

Indicates the type of scoreboard that is being created. Depending of this value, the additional request parameters will differ. These are listed below. Possible values for scoreboard_type include:

baseball - a baseball specific scoreboard

basketball - a basketball specific scoreboard

collegebasketball - a college basketball specific scoreboard (halves instead of quarters)

football - a football specific scoreboard

hockey - a hockey specific scoreboard

soccer - a soccer specific scoreboard

standings - a scoreboard of the "Race/Standings" type

team - a scoreboard of the "Team vs Team" type. This type is deprecated, consider using one of the sport specific scoreboard types instead.

yes

Additional request parameters when scoreboard_type is set to "team"


Parameter Description Required
team_a The name of the first (away) team. May not be more than 25 characters in length. yes
team_a_nickname The nickname of the first (away) team, which will display under the team name. no
team_a_short_name The short name of the first (away) team. This is shown is the center scoring display, and should be no more than 3 or 4 characters in length. no
team_a_record The record (wins, losses) of the first (away) team. no
team_a_logo The URI of an image that will be used as the logo for the first (away) team. The image must be 64 x 44 pixels. If it is larger than that, only the top left 64 x 44 pixels will be displayed. no
score_a The score of the first (away) team. May not be more than 8 characters in length. yes
team_b The name of the second (home) team. May not be more than 25 characters in length. yes
team_b_nickname The nickname of the second (home) team, which will display under the team name. no
team_b_short_name The short name of the second (home) team. This is shown is the center scoring display, and should be no more than 3 or 4 characters in length. no
team_b_record The record (wins, losses) of the second (home) team. no
team_b_logo The URI of an image that will be used as the logo for the second (home) team. The image must be 64 x 44 pixels. If it is larger than that, only the top left 64 x 44 pixels will be displayed. no
score_b The score of the second (home) team. May not be more than 8 characters in length. yes
game_time The time at which the score was updated. May not be more than 10 characters in length no
game_section The current quarter/period/half of the game. May not be more than 60 characters in length. no

When the scoreboard_type is set to "baseball", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_runs The total number of runs for the first (away) team. no
team_a_hits The total number of hits for the first (away) team. no
team_a_errors The total number of errors for the first (away) team. no
team_b_runs The total number of runs for the second (home) team. no
team_b_hits The total number of hits for the second (home) team. no
team_b_errors The total number of errors for the second (home) team. no
runs_label The label for runs in the center scoring display. Defaults to "R". no
hits_label The label for hits in the center scoring display. Defaults to "H". no
errors_label The label for hits in the center scoring display. Defaults to "E". no
balls The total number of balls for the player currently at bat. Should be an integer between 0 and 3, inclusive. no
strikes The total number of strikes for the player currently at bat. Should be an integer between 0 and 2, inclusive. no
outs The total number of outs for the team currently at bat. Should be an integer between 0 and 2, inclusive. no
inning The current inning. no
hide_center_scoring Set to "y" to hide the center scoring display (runs, hits, and errors for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no
hide_balls_strikes Set to "y" to hide the display of balls, strikes, outs and inning. If this parameter is set to "y" the balls, strikes, outs and inning will not be shown, even if the corresponding request parameters are populated. no

When the scoreboard_type is set to "basketball", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_1_quarter_score The total score for the first (away) team in the first quarter. no
team_a_2_quarter_score The total score for the first (away) team in the second quarter. no
team_a_3_quarter_score The total score for the first (away) team in the third quarter. no
team_a_4_quarter_score The total score for the first (away) team in the fourth quarter. no
team_a_overtime_score The total score for the first (away) team in overtime. no
team_b_1_quarter_score The total score for the second (home) team in the first quarter. no
team_b_2_quarter_score The total score for the second (home) team in the second quarter. no
team_b_3_quarter_score The total score for the second (home) team in the third quarter. no
team_b_4_quarter_score The total score for the second (home) team in the fourth quarter. no
team_b_overtime_score The total score for the second (home) team in overtime. no
1_quarter_label The label for the first quarter in the center scoring display. Defaults to "1". no
2_quarter_label The label for the second quarter in the center scoring display. Defaults to "2". no
3_quarter_label The label for the third quarter in the center scoring display. Defaults to "3". no
4_quarter_label The label for the fourth quarter in the center scoring display. Defaults to "4". no
overtime_label The label for overtime in the center scoring display. Defaults to "-". no
hide_center_scoring Set to "y" to hide the center scoring display (scores broken down by quarter for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no

When the scoreboard_type is set to "collegebasketball", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_1_half_score The total score for the first (away) team in the first half. no
team_a_2_half_score The total score for the first (away) team in the second half. no
team_b_1_half_score The total score for the second (home) team in the first half. no
team_b_2_half_score The total score for the second (home) team in the second half. no
1_half_label The label for the first half in the center scoring display. Defaults to "1". no
2_half_label The label for the second half in the center scoring display. Defaults to "2". no
hide_center_scoring Set to "y" to hide the center scoring display (scores broken down by half for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no

When the scoreboard_type is set to "football", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_1_quarter_score The total score for the first (away) team in the first quarter. no
team_a_2_quarter_score The total score for the first (away) team in the second quarter. no
team_a_3_quarter_score The total score for the first (away) team in the third quarter. no
team_a_4_quarter_score The total score for the first (away) team in the fourth quarter. no
team_a_overtime_score The total score for the first (away) team in overtime. no
team_a_timeouts The total timeouts remaining for the first (away) team. Set to an integer between 0 and 3, inclusive. no
team_b_1_quarter_score The total score for the second (home) team in the first quarter. no
team_b_2_quarter_score The total score for the second (home) team in the second quarter. no
team_b_3_quarter_score The total score for the second (home) team in the third quarter. no
team_b_4_quarter_score The total score for the second (home) team in the fourth quarter. no
team_b_overtime_score The total score for the second (home) team in overtime. no
team_b_timeouts The total timeouts remaining for the second (home) team. Set to an integer between 0 and 3, inclusive. no
1_quarter_label The label for the first quarter in the center scoring display. Defaults to "1". no
2_quarter_label The label for the second quarter in the center scoring display. Defaults to "2". no
3_quarter_label The label for the third quarter in the center scoring display. Defaults to "3". no
4_quarter_label The label for the fourth quarter in the center scoring display. Defaults to "4". no
overtime_label The label for overtime in the center scoring display. Defaults to "-". no
hide_center_scoring Set to "y" to hide the center scoring display (scores broken down by quarter for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no

When the scoreboard_type is set to "hockey", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_1_period_score The total score for the first (away) team in the first period. no
team_a_2_period_score The total score for the first (away) team in the second period. no
team_a_3_period_score The total score for the first (away) team in the third period. no
team_a_overtime_score The total score for the first (away) team in overtime. no
team_b_1_period_score The total score for the second (home) team in the first period. no
team_b_2_period_score The total score for the second (home) team in the second period. no
team_b_3_period_score The total score for the second (home) team in the third period. no
team_b_overtime_score The total score for the second (home) team in overtime. no
1_period_label The label for the first period in the center scoring display. Defaults to "1". no
2_period_label The label for the second period in the center scoring display. Defaults to "2". no
3_period_label The label for the third period in the center scoring display. Defaults to "3". no
overtime_label The label for overtime in the center scoring display. Defaults to "-". no
hide_center_scoring Set to "y" to hide the center scoring display (scores broken down by period for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no

When the scoreboard_type is set to "soccer", the following request parameters can be populated (in addition to the extra "team" request parameters listed above)


Parameter Description Required
team_a_1_half_score The total score for the first (away) team in the first half. no
team_a_2_half_score The total score for the first (away) team in the second half. no
team_b_1_half_score The total score for the second (home) team in the first half. no
team_b_2_half_score The total score for the second (home) team in the second half. no
1_half_label The label for the first half in the center scoring display. Defaults to "1". no
2_half_label The label for the second half in the center scoring display. Defaults to "2". no
hide_center_scoring Set to "y" to hide the center scoring display (scores broken down by half for both teams). If this parameter is set to "y" the center display will not be shown, even if the corresponding request parameters are populated. no

Additional request parameters when scoreboard_type is set to "standings"


Parameter Description Required
headline The headline text of the scoreboard. May not be more than 120 characters in length. no
participants A pipe delimited list of names for the standings. There can be no more than 10 pipe delimited names, and each name may not be more than 20 characters in length. Each name must have a corresponding score entry in the scores request parameter (ex. if participants="name1|name2|name3" then scores ="score1|score2|score3"). yes
scores A pipe delimited list of scores for the standings. There can be no more than 10 pipe delimited scores, and each score may not be more than 8 characters in length. Each score must have a corresponding name entry in the participants request parameter (ex. if scores="score1|score2|score3" then participants ="name1|name2|name3"). yes
number_of_columns An integer, either 1 or 2. Dictates the number of columns that the standings scoreboard display will use. Defaults to 1 column if there are 5 or less entries, or 2 columns if there are more than 5 entries. no

The Response

The scoreboard id of a successfully created scoreboard is returned in the data field of a general response. This field will consist of a scoreboard_id field, which will contain the scoreboard id.


Example response to a successful scoreboard/create request:


{
	"result":"success",
	"message":"true",
	"type":"scoreboard",
	"action":"create",
	"version":2,
	"data":{
		"scoreboard_id" : "123456"
	}
}

scoreboard/create Error Responses

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

result response message response solution
missing_scoreboard_type_param Required parameter empty: scoreboard_type. Ensure the scoreboard_type request parameter is present.
invalid_scoreboard_type_param scoreboard_type request parameter contained an invalid value. Valid values include: team, standings, baseball, basketball, collegebasketball, football, hockey, soccer. Ensure the scoreboard_type request parameter contains one of the values: team, standings, baseball, basketball, collegebasketball, football, hockey, soccer.
live_scoreboards_in_use Live Scoreboard are being used for this Event. Manual Scoreboards cannot be created. If a live scoreboard has been created in the event using the EventStudio, then no further scoreboards can be created in the event using the API.
invalid_headline_param Exceeded maximum headline length of: 120. Ensure the headline request parameter does not exceed 120 characters in length.
missing_team_a_param Required parameter empty: team_a. Ensure the team_a request parameter is present when creating a "team" scoreboard.
invalid_team_a_param Exceeded maximum team_a length of: 25. Ensure the team_a request parameter does not exceed 25 characters in length.
missing_team_b_param Required parameter empty: team_b. Ensure the team_b request parameter is present when creating a "team" scoreboard.
invalid_team_b_param Exceeded maximum team_b length of: 25. Ensure the team_b request parameter does not exceed 25 characters in length.
missing_score_a_param Required parameter empty: score_a. Ensure the score_a request parameter is present when creating a "team" scoreboard.
invalid_score_a_param Exceeded maximum score_a length of: 8. Ensure the score_a request parameter does not exceed 8 characters in length.
missing_score_b_param Required parameter empty: score_b. Ensure the score_b request parameter is present when creating a "team" scoreboard.
invalid_score_b_param Exceeded maximum score_b length of: 8. Ensure the score_b request parameter does not exceed 8 characters in length.
invalid_game_time_param Exceeded maximum game_time length of: 10. Ensure the game_time request parameter does not exceed 10 characters in length.
invalid_game_section_param Exceeded maximum game_section length of: 60. Ensure the game_section request parameter does not exceed 60 characters in length.
missing_participants_param Required parameter empty: participants. Ensure the participants request parameter is present when creating a "standings" scoreboard.
invalid_participants_param participants request parameter contains more than 10 pipe separated values. Ensure the participants request parameter does not exceed 10 pipe delimited values.
invalid_participants_param One of the names included in the participants request parameter exceeded maximum length of: 20. Ensure the pipe delimited values are each no more than 20 characters in length
invalid_scores_param scores request parameter contains more than 10 pipe separated values. Ensure the scores request parameter does not exceed 10 pipe delimited values.
invalid_scores_param One of the names included in the scores request parameter exceeded maximum length of: 8. Ensure the pipe delimited values are each no more than 8 characters in length
invalid_scores_and_participants_params the scores and participants request params do not contain the same number of pipe separated values. Ensure the participants and scores request parameters contain the same number of pipe delimited values.(ex. if scores="score1|score2|score3" then participants ="name1|name2|name3").
invalid_number_of_columns_param number_of_columns must be set to 1 or 2 Ensure the number_of_columns request parameter is set to 1 or 2 if populated.