COVERITLIVE API - EVENT/END (V. 2.0)

The Request

This method allows users to end CoveritLive events automatically. When coupled with the event/create and event/start methods, the CiL event build process can be fully integrated into a 3rd party CMS.

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

Parameter Description Required
event_code The event code for the event which is to be 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 and event/create API methods. yes

The Response

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


Example response to a successful event/end request:


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

event/end Error Responses

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

result response message response solution
event_not_active The event specified by the event code is not in an active state. event/end requests can only be applied to events that have been created and started (ie. in an active state).
 

This website uses cookies to ensure that you receive the best experience. By clicking "Accept" or closing this window, you are agreeing to our cookies policy. You can change your cookie settings at any time and read about how we use them in our Cookie Policy