Person Competition Statistics

Request: GET

Returns a list of person competition statistics the user has access to.

HTTP Request

GET /v1/{sport}/statistics/personcompetition/competitions/{competitionId}
GET /v1/{sport}/statistics/personcompetition/competitions/{competitionId}/teams/{teamId}
GET /v1/{sport}/statistics/personcompetition/competitions/{competitionId}/teams/{teamId}/persons/{personId}
GET /v1/{sport}/statistics/personcompetition/competitions/{competitionId}/persons/{personId}
GET /v1/{sport}/statistics/personcompetition/persons/{personId}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
Optional Parameters
competitionId integer Unique identifier for the competition.
teamId integer Unique identifier for the team.
personId integer Unique identifier for the person.
periodNumber integer Display statistics for only this period.
periodType string The type of period.
  • REGULAR
  • OVERTIME
homeAway string Is this value for when the team is playing at home/away or either. If not provided, then 'ALL' is assumed.
  • HOME
  • AWAY
  • ALL
winLoss string Is this value for when the team has won or loss or either. If not provided, then 'ALL' is assumed.
  • WIN
  • LOSS
  • ALL
inConference string Is this value for when the team is in or out of it's own conference or either. If not provided, then 'ALL' is assumed.
  • IN
  • OUT
  • ALL
matchType string Is this value for what type of matches the team was in. If not provided, then 'ALL' is assumed.
  • PRESEASON
  • REGULAR
  • FINALS
  • ALL
useExternalForLeague integer If this value is set to the leagueId, then the URL parameters teamId, personId and competitionId 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 an array of Person Competition Statistics resources.

Request: GET

Get the detail about a specific person's performance in a particular competition

HTTP Request

GET /v1/{sport}/statistics/personcompetition/competitions/{competitionId}/teams/{teamId}/persons/{personId}/periods/{periodNumber}/{periodType}

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
competitionId integer The unique identifier for this competition
teamId integer Unique identifier for the team.
personId integer Unique identifier for the person.
periodNumber integer Display statistics for only this period.
periodType string The type of period.
  • REGULAR
  • OVERTIME
Optional Parameters
homeAway string Is this value for when the team is playing at home/away or either. If not provided, then 'ALL' is assumed.
  • HOME
  • AWAY
  • ALL
winLoss string Is this value for when the team has won or loss or either. If not provided, then 'ALL' is assumed.
  • WIN
  • LOSS
  • ALL
inConference string Is this value for when the team is in or out of it's own conference or either. If not provided, then 'ALL' is assumed.
  • IN
  • OUT
  • ALL
matchType string Is this value for what type of matches the team was in. If not provided, then 'ALL' is assumed.
  • PRESEASON
  • REGULAR
  • FINALS
  • ALL
useExternalForLeague integer If this value is set to the leagueId, then the URL parameters teamId, personId and competitionId 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 Person Competition Statistics resource.

Request: POST, Request: PUT

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

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}/statistics/personcompetition

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, 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 Competition 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.

Response

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