Match Actions

Request: GET

Returns a list of match actions relating to a particular match.

HTTP Request


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

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
`scoring`	`integer`	If this value is set to `1` then only scoring actions (success and unsuccessful) are returned.
`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 Action resources.

Request: GET

Get the detail about a specific match action

HTTP Request


			GET /v1/{sport}/matches/{matchId}/actions/{actionNumber}

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
`actionNumber`	`integer`	The unique identifier for this particular action in the match
Optional Parameters
`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 a Match Action resource.

Request: POST

Create a new match action

HTTP Request


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

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
`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 Action 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.

matchId
teamId
personId

Response

If successful this method returns a Match Action resource. If the bulk parameter is specified it will return a list of resources. Any errors returned are against the specific resource.

Request: PUT

Update an existing matchaction

HTTP Request


			PUT /v1/{sport}/matches/{matchId}/actions/{actionNumber}

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
`actionNumber`	`integer`	The unique identifier for this particular action in the match
Optional Parameters
`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 Action 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.

matchId
teamId
personId

Response

If successful this method returns a Match Action resource.

Request: DELETE

Delete an existing matchaction

HTTP Request


			DELETE /v1/{sport}/matches/{matchId}/actions

			DELETE /v1/{sport}/matches/{matchId}/actions/{actionNumber}

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 matchaction
Optional Parameters
`acitonNumber`	`integer`	The unique identifier for this particular action in the match
`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

Successful this method returns SUCCESS.