Statistical Leaders - Qualifications

Request: GET

Returns a list of qualifications for statistical leaders in a competition.

HTTP Request

GET /v1/{sport}/competitions/{competitionId}/leaders/{statisticCode}/qualification

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
competitionId integer Unique identifier for the competition.
statisticCode text Unique identifier for the statistic.
The codes depend upon the sport:
Optional Parameters
matchType string 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 parameter competitionId will instead refer to the externalId field of the competition entity in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns an array of Leader Qualification resources.

Request: POST

Add new qualifications needed for this statistic to be an official leader. Multiple qualificatiosns for the same parameters are applied as an 'AND' for qualification purposes.

HTTP Request

POST /v1/{sport}/leagues/{leagueId}/leaders/qualification

Parameters

Parameter Name Value Description
Required Parameters
sport string The sport for which you are making the request
Optional Parameters
minimumResponse integer If this value is set to 1 then the response resource will only contain clubId and externalId.
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 Leader Qualification resource. if the bulk parameter is specified then an array 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 Leader Qualification resource. If the bulk parameter is specified it will return a list of resources. Any errors returned are against the specific resource.

Request: DELETE

Delete a qualification for a statistic. This will delete all qualifications for the statistic in the competition specified.

HTTP Request

DELETE /v1/{sport}/competitions/{competitionId}/leaders/{statisticCode}/qualification

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.
statisticCode text Unique identifier for the statistic.
The codes depend upon the sport:
matchType string 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 parameter competitionId will instead refer to the externalId fields of the competition entity in that league.

Request Body

Do not supply a request body with this method.

Response

Successful this method returns SUCCESS.