Competitions
Competition is a grouping of seasons that generally involve the same competitors. Competitions can have a history of many years, or be a once off.
The competition is owned by the organization, but, many competitions can be grouped together to form a league.
Return a list of available competitions
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23Record was added after this date/time. In UTC.
2018-08-16T02:10:48The age group of the season
JUNIORJuniorMASTERSMastersSENIORSeniorUNDER_15Under 15UNDER_16Under 16UNDER_17Under 17UNDER_18Under 18UNDER_19Under 19UNDER_20Under 20UNDER_21Under 21UNDER_22Under 22UNDER_23Under 23YOUTHYouth
SENIORPossible values: The unique identifier of the competition. Can specify multiple, delimited by comma.
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLatin=David Johnson nameLatinContains=Dav will match nameLatinContains=John will match nameLatinContains=son will not match
Dav and nameLatin='David Johnson'Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLocal=David Johnson nameLocalContains=Dav will match nameLocalContains=John will match nameLocalContains=son will not match
Dav and nameLocal='David Johnson'The offset of the records. See Pagination for more information.
10Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.
-nameLocal,nameLatinPattern: ^(\-?nameLocal|\-?nameLatin|,)*$Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Successful operation
Error
Insert a new competition
- : Write/Update any data from below the organization
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the league
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe international reference for this competition given by the sport governing body
CA3243-3An abbreviation/short name in the local language
NFAThe name of the competition in the local language
Test name localPrimary Type of Matches
FIXTUREFixturePRACTICEPractice
FIXTUREExample: FIXTUREPossible values: An abbreviation/short name in latin characters
NFAThe name of the competition in latin characters
Test name latinThe Id of the data as set by the provider of the data
A123Pattern: ^[0-9A-Za-z/_-]+$The age group of the competition
- None None
JUNIORJuniorMASTERSMastersSENIORSeniorUNDER_15Under 15UNDER_16Under 16UNDER_17Under 17UNDER_18Under 18UNDER_19Under 19UNDER_20Under 20UNDER_21Under 21UNDER_22Under 22UNDER_23Under 23YOUTHYouth
SENIORPossible values: Successful operation
Error
Get a list of competitions that have active seasons
Return a list of available competitions that have active seasons
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23Record was added after this date/time. In UTC.
2018-08-16T02:10:48The age group of the season
JUNIORJuniorMASTERSMastersSENIORSeniorUNDER_15Under 15UNDER_16Under 16UNDER_17Under 17UNDER_18Under 18UNDER_19Under 19UNDER_20Under 20UNDER_21Under 21UNDER_22Under 22UNDER_23Under 23YOUTHYouth
SENIORPossible values: Record was modified after this date/time. In UTC.
2018-08-16T02:11:48The unique identifier of the competition. Can specify multiple, delimited by comma.
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Status
ACTIVEActiveCOMPLETECompleteDRAFTDraftINACTIVEInactivePENDINGPending
ACTIVEPossible values: Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Seasons data synchronization strategy with video production systems. Multiple allowed (comma-delimited).
AUTOMATEDAutomatedMANUALManualNONENone
NONE,AUTOMATEDPossible values: Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Successful operation
Error
Get a list of competitions by for a league
Return a list of available competitions for a specific league
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the league
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23Record was added after this date/time. In UTC.
2018-08-16T02:10:48The age group of the season
JUNIORJuniorMASTERSMastersSENIORSeniorUNDER_15Under 15UNDER_16Under 16UNDER_17Under 17UNDER_18Under 18UNDER_19Under 19UNDER_20Under 20UNDER_21Under 21UNDER_22Under 22UNDER_23Under 23YOUTHYouth
SENIORPossible values: The unique identifier of the competition. Can specify multiple, delimited by comma.
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Successful operation
Error
Return detailed information about a competition
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Successful operation
Error
Change the information of a specific competition
- : Write/Update any data from below the organization
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe unique identifier of the league
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe international reference for this competition given by the sport governing body
CA3243-3An abbreviation/short name in the local language
NFAThe name of the competition in the local language
Test name localPrimary Type of Matches
FIXTUREFixturePRACTICEPractice
FIXTUREExample: FIXTUREPossible values: An abbreviation/short name in latin characters
NFAThe name of the competition in latin characters
Test name latinThe Id of the data as set by the provider of the data
A123Pattern: ^[0-9A-Za-z/_-]+$The age group of the competition
- None None
JUNIORJuniorMASTERSMastersSENIORSeniorUNDER_15Under 15UNDER_16Under 16UNDER_17Under 17UNDER_18Under 18UNDER_19Under 19UNDER_20Under 20UNDER_21Under 21UNDER_22Under 22UNDER_23Under 23YOUTHYouth
SENIORPossible values: Successful operation
Error
Delete a specific competition
- : Write/Update any data from below the organization
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Force a delete command to run and delete child records as well if there are existing records depending on the record.
trueDon't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesSuccessful operation
Error
Get a list of competitions for the organization group
Return a list of competitions for the organization group
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization group
aubbRecord was added after this date/time. In UTC.
2018-08-16T02:10:48A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Successful operation
Error
Last updated
Was this helpful?