COVERITLIVE API - POLL/END (V. 2.0)

The Request

This method allows for a poll to be ended. Ended polls will be removed from viewer window rotation, voting on ended polls will be closed and the final poll results will be added as a new event entry.

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

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

The Response

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


Example response to a successful poll/end request:


{
	"result":"success",
	"message":"true",
	"type":"poll",
	"action":"end",
	"version":2
}

poll/end Error Responses

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

result response message response solution
missing_poll_id_param Required parameter empty: poll_id. Ensure the poll_id request parameter is present when making a poll/end request.
invalid_poll_id_param The poll_id request parameter did not contain a valid poll id. When populating the poll_id request parameter, ensure it contains a valid poll id. Poll ids are returned by poll/list and poll/create requests.
poll_ended The poll specified by poll_id has already been ended. Polls that have already been ended cannot be ended again.