COVERITLIVE API - SCOREBOARD/DELETE (V. 2.0)

The Request

This method allows for a scoreboard to be deleted. Deleted scoreboards will be removed from all consoles and viewer windows.

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

Parameter Description Required
event_code The event code for the event in which the scoreboard is being deleted. 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_id The id of the scoreboard to be deleted. Returned by the scoreboard/list and scoreboard/create API methods. yes

The Response

There is no extra data returned from a scoreboard/delete request, so the response has the same fields as a general response.


Example response to a successful scoreboard/delete request:


{
	"result":"success",
	"message":"true",
	"type":"scoreboard",
	"action":"delete",
	"version":2
}

scoreboard/delete Error Responses

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

result response message response solution
missing_scoreboard_id_param Required parameter empty: scoreboard_id. Ensure the scoreboard_id request parameter is present when making a scoreboard/delete request.
invalid_scoreboard_id_param The scoreboard_id request parameter did not contain a valid scoreboard id. When populating the scoreboard_id request parameter, ensure it contains a valid scoreboard id. Scoreboard ids are returned by scoreboard/list and scoreboard/create requests.
scoreboard_deleted The scoreboard specified by scoreboard_id has already been deleted. Scoreboards that have already been deleted cannot be deleted again.