Competition Competitors

Request: GET

Returns a list of competitors for a competition.

HTTP Request


			GET /v1/{sport}/competitions/{competitionId}/competitors

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`integer`	The unique identifier for the competition
Optional Parameters
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, then the URL parameter `competitionId` will instead refer to the `externalId` fields of the competition in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a list of Competition Competitor resources.

Request: GET

Get the detail about a specific competitor in a competition

HTTP Request


			GET /v1/{sport}/competitions/{competitionId}/competitors/{competitorId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`integer`	The unique identifier for the competition
`competitorId`	`integer`	The unique identifier for the competitor in this competition. If the competition is team based, then this is the teamId, if person based, then this should be the personId.
Optional Parameters
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, then the URL parameters `competitionId` and `competitorId` 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 Competition Competitor resource.

Request: PUT

Update an existing competitor in a competition

Competitors are automatically added to a competition by virtue of being in a match in the competition. This update functionality allows you to change some detail about the competitior in the competition without affecting the match. This may be for example to mark the competitor as no longer being in the competition but keep their matches.

HTTP Request


			PUT /v1/{sport}/competitions/{competitionId}/competitors/{competitorId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`integer`	The unique identifier for the competition
`competitorId`	`integer`	The unique identifier for the competitor in this match. If the competition is team based, then this is the teamId, if person based, then this should be the personId.
Optional Parameters
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, then the URL parameters `competitionId` and `competitorId` will instead refer to the `externalId` of the resepective entities in that league.

Request Body

In the request body supply a Competition Competitors resource.

Response

If successful this method returns a Competition Competitors resource.