Get the detail about a specific person's performance in a particular match
GET /v1/{sport}/statistics/personmatch/competitions/{competitionId}
GET /v1/{sport}/statistics/personmatch/competitions/{competitionId}/teams/{teamId}
GET /v1/{sport}/statistics/personmatch/competitions/{competitionId}/persons/{personId}
GET /v1/{sport}/statistics/personmatch/matches/{matchId}
GET /v1/{sport}/statistics/personmatch/matches/{matchId}/teams/{teamId}
GET /v1/{sport}/statistics/personmatch/matches/{matchId}/persons/{personId}
Parameter Name | Value | Description |
---|---|---|
Required Parameters | ||
sport |
string |
The sport for which you are making the request |
Optional Parameters | ||
competitionId |
integer |
The unique identifier for the competition |
isPlayer |
integer |
If the person was a player in the match |
isTeamOfficial |
integer |
If the person was a team official in the match |
matchId |
integer |
The unique identifier for the match |
teamId |
integer |
The unique identifier for the team |
personId |
integer |
The unique identifier for the person |
periodNumber |
integer |
Return statistics for only a given period. 0 = total game |
periodType |
string |
Return statistics for only a certain type of period
|
useExternalForLeague |
integer |
If this value is set to the leagueId, then the URL parameters teamId , matchId , personId and competitionId will instead refer to the externalId fields of the respective entities in that league. |
Do not supply a request body with this method.
If successful this method returns an array of Person Match Statistics resources.
Get the detail about a specific person's performance in a particular match
GET /v1/{sport}/statistics/personmatch/matches/{matchId}/teams/{teamId}/persons/{personId}/periods/{periodNumber}/{periodType}
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 |
teamId |
integer |
The unique identifier for the team |
personId |
integer |
The unique identifier for this person |
periodNumber |
integer |
Return statistics for only a given period |
periodType |
string |
The type of period.
|
useExternalForLeague |
integer |
If this value is set to the leagueId, then the URL parameters teamId , matchId and personId will instead refer to the externalId fields of the respective entities in that league. |
Do not supply a request body with this method.
If successful this method returns a Person Match Statistics resource.
Create detail about a specific person's performance in a particular match. Both the PUT and POST verbs are accepted as the system will handle any creation/editing logic.
In order to be included in the match, a person must have a Person Match Statistics record with periodNumber
of 0 and periodType
of REGULAR. They can have participated
of 0, but this base record must exist.
Note: Only the fields being sent for the resource will be returned. For a full list of fields, do a detail call as above.
POST /v1/{sport}/leagues/{leagueId}/statistics/personmatch
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, then the content of the request body is interpreted differently. See the Request Body section for more information. |
In the request body supply a Person Match Statistics 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.
personId
teamId
competitionId
matchId
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.
Delete an existing person's performance in a particular match
DELETE /v1/{sport}/statistics/personmatch/matches/{matchId}/teams/{teamId}/persons/{personId}/periods/{periodNumber}/{periodType}
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 |
teamId |
integer |
The unique identifier for this team |
personId |
integer |
The unique identifier for this person |
periodNumber |
integer |
Return statistics for only a given period |
periodType |
string |
The type of period.
|
Optional Parameters | ||
useExternalForLeague |
integer |
If this value is set to the leagueId, then the URL parameters teamId , matchId and personId will instead refer to the externalId fields of the respective entities in that league. |
Do not supply a request body with this method.
Successful this method returns SUCCESS.
Competition and Career statistics will need to be rebuilt