Standings

Request: GET

Get the detail about a specific competition's standings

HTTP Request


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

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
Optional Parameters
`competitorId`	`integer`	The unique identifier for this competitor. teamId if this competition is a Team based competition. personId if the competition is person based.
`roundNumber`	`integer`	Round number for the standing (0 = valid). Default = 0
`poolNumber`	`integer`	Pool number. Default = 0
`phaseName`	`string`	Phase/Stage name for pools
`latest`	`integer`	Get the latest standing for the competitionId. 1=Yes, 0=No.
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the URL parameters `competitorId`, `poolNumber` 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 Standings resources.

Request: GET

Get the detail about a specific standing record

HTTP Request


			GET /v1/{sport}/competitions/{competitionId}/standings/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 this competition
`competitorId`	`integer`	The unique identifier for this competitor. teamId if this competition is a Team based competition. personId if the competition is person based.
Optional Parameters
`roundNumber`	`integer`	Round number for the standing (0 = valid). Default = 0
`poolNumber`	`integer`	Pool number. Default = 0
`phaseName`	`string`	Phase/Stage name for pools
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the URL parameters `competitorId`, `poolNumber` 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 Standings resources.

Request: POST, Request: PUT

Create detail about a specific team's standing in the 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}/competitions/{competitionId}/standings

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 the standing is for.
Optional Parameters
`minimumResponse`	`integer`	If this value is set to 1 then the response resource will only contain contain minimal identifying fields.
`bulk`	`integer`	Create multiple records.
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the URL parameter `competitionId` will instead refer to the `externalId` of the competition in that league. The content of the request body is also interpreted differently. See the Request Body section for more information.

Request Body

In the request body supply a Standings 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.

competitionId
competitorId
poolNumber

Response

If successful this method returns a Standings 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 an existing standing

HTTP Request


               DELETE /v1/{sport}/competitions/{competitionId}/standings

               DELETE /v1/{sport}/competitions/{competitionId}/standings/competitors/{competitorId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`integer`	The competition the Standing is in
Optional Parameters
`competitorId`	`integer`	The competitor the Standing is in
`poolNumber`	`integer`	The poolNumber the Standing is in
`roundNumber`	`integer`	The roundNumber the Standing is in
`phaseName`	`string`	The phaseName the Standing is in
`useExternalForLeague`	`integer`	If this value is set to the leagueId, then the URL parameters `competitorId`, `poolNumber` and `competitionId` will instead refer to the `externalId` fields of the respective entities in that league.

Request Body

Do not supply a request body.

Response

If no override is flag passed in and the standings records are involved in any of the affected resources then the DELETE will fail (returns FAILURE). As this request may involve multiple standings records, this request will always return a successful HTTP status and a list of responses. On success this method returns a list of SUCCESS responses.