Match Players

Request: GET

Returns a list of players in the match without needing to pass periodNumber & periodType as the statistics calls require.

HTTP Request

GET /v1/{sport}/matches/{matchId}/players
GET /v1/{sport}/matches/{matchId}/teams/{teamId}/players

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
teamId integer show if team is a competitor in this match
useExternalForLeague integer If this value is set to the leagueId for the match, then the URL parameters matchId and teamId will instead refer to the externalId fields of the respective entities in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a list of Person Match Statistics resources.

Request: POST, Request: PUT

Create detail about a specific person's inclusion in a particular match. Both the PUT and POST verbs are accepted as the system will handle any creation/editing logic.

This Request works exactly the same as the Person Match Statistics POST/PUT call but without the statistics in the URL to stop confusion. It also doesn't require the periodNumber and periodType.

Note: Only the fields being sent for the resource will be returned. For a full list of fields, do a detail call as above.

HTTP Request

POST /v1/{sport}/leagues/{leagueId}/matches/players

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
leagueId integer The unique identifier for this leagueId
Optional Parameters
minimumResponse integer If this value is set to 1 then the response resource will only contain minimal identifying fields.
bulk integer Create multiple records.
useExternalForLeague integer If this value is set to the leagueId of the league, then 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 Person Match Statistics resource. If the bulk parameter is specified a list of resources is expected.

Example
        [
            {
                "matchId" : 10,
                "competitionId" : "23",
                "teamId" : "17",
                "personId" : "473",
                "shirtNumber" : "55",
                "isPlayer" : 1
            },
            {
                "matchId" : 10,
                "competitionId" : "23",
                "teamId" : "17",
                "personId" : "11",
                "shirtNumber" : "34",
                "isPlayer" : 1
            },
            {
                "matchId" : 10,
                "competitionId" : "23",
                "teamId" : "17",
                "personId" : "77",
                "shirtNumber" : "23",
                "isPlayer" : 1
            }
        ]
        

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 Person Match Statistics resource. If the bulk parameter is specified it will return a list of resources. Any errors returned are against the specific resource.