Clubs

Request: GET

Returns a list of clubs that the user has access to.

HTTP Request


			GET /v1/{sport}/clubs

			GET /v1/{sport}/leagues/{leagueId}/clubs

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
Optional Parameters
`leagueId`	`integer`	Unique identifier for the league the club belongs to.
`keywords`	`string`	Display only where the club has the given keyword
`countryCode`	`string`	Display only when the club is in the country. ISO 3166 two letter country code.
`status`	`string`	club status

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a list of Club resources.

Request: GET

Get the detail about a specific club

HTTP Request


			GET /v1/{sport}/clubs/{clubId}

Parameters

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

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a Club resource.

Request: POST

Create a new club

HTTP Request


			POST /v1/{sport}/leagues/{leagueId}/clubs

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`leagueId`	`integer`	Unique identifier for the league the club belongs to.
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.

Request Body

In the request body supply a Club resource.If the bulk parameter is specified a list of resources is expected.

Response

If successful this method returns a Club 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 club

HTTP Request


			PUT /v1/{sport}/clubs/{clubId}

Parameters

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

Request Body

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

Response

If successful this method returns a Club resource.

Request: DELETE

Delete an existing club

HTTP Request


               DELETE /v1/{sport}/clubs/{clubId}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`clubId`	`integer`	The unique identifier for this club
Optional Parameters
`confirm`	`integer`	0 = Default. FAILURE returned if cascade records found. 1 = override cascades Affected resources: Standings Person (Default club) Team
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the club, then the URL parameter `clubId` will instead refer to the `externalId` of the club in that league.

Request Body

Do not supply a request body with this method.

Response

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