Pools

Request: GET

Returns a list of pools for a competition.

HTTP Request


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

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`string`	The competition for which you are making the request
Optional Parameters
`phaseName`	`string`	Phase/Stage name for this pool
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the pool, then the URL parameter `competitionId` will instead refer to the `externalId` 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 Pools resources.

Request: GET

Get the detail about a specific pool

HTTP Request


			GET /v1/{sport}/competitions/{competitionId}/pools/{poolNumber}

Parameters

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

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a Pools resource.

Request: POST

Create a new pool

HTTP Request


			POST /v1/{sport}/competitions/{competitionId}/pools

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 pool belongs to.
Optional Parameters
`minimumResponse`	`integer`	If this value is set to 1 then the response resource will only contain `personId` and `externalId`.
`bulk`	`integer`	Create multiple records.
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the pool, then the URL parameter `competitionId` will instead refer to the `externalId` of the competition in that league. 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 Pools 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

Response

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

Request: PUT

Update an existing pool

HTTP Request


			PUT /v1/{sport}/competitions/{competitionId}/pools/{poolNumber}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`poolNumber`	`integer`	The number of the pool in the competition
`competitionId`	`integer`	The unique identifier for this competition
Optional Parameters
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the pool, then the URL parameters `competitionId` and `poolNumber` will instead refer to the `externalId` of their respective entity. The content of the request body is interpreted differently. See the Request Body section for more information.

Request Body

A Pool resource should be supplied in the request body. Only the fields to be changed need to be specified.

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

Response

If successful this method returns a Pools resource.

Request: DELETE

Delete an existing pool

HTTP Request


               DELETE /v1/{sport}/competitions/{competitionId}/pools/{poolNumber}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`competitionId`	`number`	The unique identifier for the competition
`poolNumber`	`integer`	The number of the pool in the competition
Optional Parameters
`confirm`	`integer`	0 = Default. FAILURE returned if cascade records found. 1 = override cascades Affected resources: Match Person Match Statistics Team Match Statistics
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the pool, then the URL parameters `competitionId` and `poolNumber` will instead refer to the `externalId` of their respective entity.

Request Body

Do not supply a request body with this method.

Response

If no override is flag passed in and the poolNumber is involved in any of the affected resources then the DELETE will fail (returns FAILURE). Successful this method returns SUCCESS.