Competition Format

Request: GET

Get the detail about a specific competition's format

HTTP Request


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

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
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, then the URL parameters `competitionId` will instead refer to the `externalId` field of the competition in that league.

Request Body

Do not supply a request body with this method.

Response

If successful this method returns a Competition Format resource.

Request: POST, Request: PUT

Create detail about the format about a specific 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}/leagues/{leagueId}/competitions/format

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`leagueId`	`integer`	The unique identifier for this league
Optional Parameters
`bulk`	`integer`	Create multiple records.
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, 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 Competition Format 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 Competition Format 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 competition's format

HTTP Request


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

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
`useExternalForLeague`	`integer`	If this value is set to the leagueId for the competition, then the URL parameters `competitionId` will instead refer to the `externalId` field of the competition in that league.

Request Body

Do not supply a request body with this method.

Response

Successful this method returns SUCCESS.