Match Broadcasts

Request: GET

Returns a list of broadcasts relating to a particular match.

HTTP Request

GET /v1/{sport}/matches/{matchId}/broadcasts

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
matchId integer Unique identifier for the match.
Optional Parameters
broadcastType string Optional filter of broadcastType.
useExternalForLeague integer If this value is set to the leagueId for the match, then the URL parameter matchId will instead refer to the externalId field of the match.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of Match Broadcast resources.

Request: GET

Get the detail about a specific match broadcast

HTTP Request

GET /v1/{sport}/broadcasts/{broadcastId}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
broadcastId integer The unique identifier for this broadcast
Optional Parameters
useExternalForLeague integer If this value is set to the leagueId for the broadcast, then the URL parameter broadastId will instead refer to the externalId field of the broadcast.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a Match Broadcast resource.

Request: POST

Create a new match broadcast

HTTP Request

POST /v1/{sport}/matches/{matchId}/broadcasts

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
matchId integer Unique identifier for the match.
Optional Parameters
minimumResponse integer If this value is set to 1 then the response resource will only contain personId and externalId.
bulk integer Create multiple records.
useExternalForLeague integer If this value is set to the leagueId for the match, then the URL parameter matchId will instead refer to the externalId field of the match. The content of the request body is interpreted differently. See the Request Body section for more information.

Request Body

In the request body supply a Match Broadcast resource. If the bulk parameter is specified a list of resources is expected.

If the useExternalForLeague parameter is specified, then the following fields in the resource will be interpreted as the externalId of the specific entity instead of the unique identifier.

Response

If successful this method returns a Match Broadcast resource.

Request: PUT

Update an existing match broadcast

HTTP Request

PUT /v1/{sport}/broadcasts/{broadcastId}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
broadcastId integer The unique identifier for this broadcast
Optional Parameters
useExternalForLeague integer If this value is set to the leagueId for the match, then the URL parameter broadcastId will instead refer to the externalId field of the broadcast. The content of the request body is interpreted differently. See the Request Body section for more information.

Request Body

In the request body supply a Match Broadcast resource.

If the useExternalForLeague parameter is specified, then the following fields in the resource will be interpreted as the externalId of the specific entity instead of the unique identifier.

Response

If successful this method returns a Match Broadcaster resource.

Request: DELETE

Delete an existing match broadcast

HTTP Request

DELETE /v1/{sport}/matches/{matchId}/broadcasts
DELETE /v1/{sport}/broadcasts/{broadcastId}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
matchId integer The unique identifier for this match
Optional Parameters
broadcastId inetger The unique identifier for this match
useExternalForLeague integer If this value is set to the leagueId for the broadcast, then the URL parameters matchId & broadcastId will instead refer to the externalId fields of the respective entities.

Request Body

Do not supply a request body with this method.

Response

Successful this method returns SUCCESS.