Proposed - This functionality does not yet exist

Notify

HTTP Request: POST

Request a notification for an event in a match.

The notification can be set for a particular match, or all matches in a competition.


			POST /v1/{sport}/livestream/notify/match/{matchId}

			POST /v1/{sport}/livestream/notify/competition/{competitionId}

When the event occurs a HTTP GET request is made to the URL supplied. If the URL is unavailable then the call will not be retried. The following parameters are appended to the notification URL. matchId, competitionId & event.

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`ak`	`string`	The API key given to you
`event`	`string`	The type of event you wish a notification for: `connected` The publisher has connected to the system to publish the game. Due to connection drop outs this may happen multiple times. A connection does not indicate that the match has started. `starting` The publisher has indicated that the match is 10 minutes away from starting. `started` The publisher has indicated that the match has started. `finished` The publisher has indicated that the match has finished. `complete` The publisher has indicated that the match has been completed.
`url`	`url`	The url to call when the event happens. Note: This field must be URL encoded
Optional Parameters
`matchId`	`integer`	The unique matchId for the match
`competitionId`	`integer`	The unique competitionId for the competition
`format`	`string`	The format the data is to be received in. Options are `json` (Default) `xml`

Request Body

Do not supply a request body with this method.

Response

On success this method returns SUCCESS.

HTTP Request: DELETE

Remove a notification request from the system


			DELETE /v1/{sport}/livestream/notify/match/{matchId}

			DELETE /v1/{sport}/livestream/notify/competition/{competitionId}

An event can only be deleted the same way it was set. If an event was set for a competition, you cannot delete for a matchId in that competition, the whole competition must be deleted.

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`ak`	`string`	The API key given to you
`event`	`string`	The type of event you wish to delete the notification for: `connected` The publisher has connected to the system to publish the game. Due to connection drop outs this may happen multiple times. A connection does not indicate that the match has started. `starting` The publisher has indicated that the match is 10 minutes away from starting. `started` The publisher has indicated that the match has started. `finished` The publisher has indicated that the match has finished. `complete` The publisher has indicated that the match has been completed.
`url`	`url`	The url to call when the event happens. Note: This field must be URL encoded
Optional Parameters
`matchId`	`integer`	The unique matchId for the match
`competitionId`	`integer`	The unique competitionId for the competition
`format`	`string`	The format the data is to be received in. Options are `json` (Default) `xml`

Request Body

Do not supply a request body.

Response

On success this method returns SUCCESS.