Seasons
Season is a grouping of matches. Generally the season will last a portion of a year (every year).
The competition can have many seasons, but the season can only belong to one competition.
Return a list of seasons in the 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
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 discipline for a match
BEACHBeachHOCKEY5SHockey5sINDOORIndoorOUTDOOROutdoorPARAHOCKEYPara hockey
INDOORPossible values: endDate on or before this date
2018-08-16Type of Fixtures
FIXTUREFixturePRACTICEPractice
FIXTUREPossible values: A 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)]The gender of the season or team
FEMALEFemaleMALEMaleMIXEDMixedUNKNOWNUnknown
MALEPossible values: 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.
10What level are the competitors representing
CLUBClubCOUNTRYCountryPERSONPerson
CLUBPossible values: The unique identifier of the season. Can specify multiple, delimited by comma.
009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005The type of matches added to this season
MULTI_YEAR_HISTORICALMulit-Year HistoricalONE_OFFOne off matchPRESEASONPre SeasonSEASONSeasonTOURNAMENTTournament
SEASONPossible values: Comma-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.
nameLocalPattern: ^(\-?nameLocal|\-?nameLatin|\-?year|,)*$The playing standard of the season or team
APPROVED_TEST_MATCHESApproved Test matchesCOMMONWEALTH_GAMESCommonwealth GamesCONTINENTAL_CHAMPIONSHIPContinental ChampionshipCONTINENTAL_CHAMPIONSHIP_DIV_2Continental Championship Div 2CONTINENTAL_CHAMPIONSHIP_DIV_3Continental Championship Div 3CONTINENTAL_CHAMPIONSHIP_DIV_4Continental Championship Div 4CONTINENTAL_QUALIFIERContinental QualifierELITEProfessional/elite organisationFIH_NATIONS_CUPFIH Nations CupFIH_OLYMPIC_QUALIFIERSFIH Olympic QualifiersFIH_PRO_LEAGUEFIH Pro LeagueFIH_WORLD_CUPFIH World CupFIH_WORLD_CUP_QUALIFIERSFIH World Cup QualifiersFRIENDLYInternational FriendlyGRASS_ROOTNormalHISTORICAL_BASELINEHistorical BaselineHOCKEY_SERIES_OPENHockey Series OpenINTERNATIONALInternationalINVITATIONAL_TOURNAMENTInvitational Tournament (3+ teams)NONCONTINENTAL_CHAMPIONSHIPNon-continental ChampionshipOLYMPICOlympicsOLYMPICSOlympic GamesREGIONRegionalTIER2lesser standard than eliteTIER3lesser standard than tier 2WORLD_CHAMPIONSHIPWorld ChampionshipWORLD_LEAGUEWorld LeagueZONE_CHAMPIONSHIPInternational Zone Championship
ELITEPossible values: startDate on or after this date
2018-08-16Status
ACTIVEActiveCOMPLETECompleteDRAFTDraftINACTIVEInactivePENDINGPending
ACTIVEPossible values: Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Data synchronization strategy with video production systems. Multiple allowed (comma-delimited).
AUTOMATEDAutomatedMANUALManualNONENone
NONE,AUTOMATEDPossible values: Successful operation
Error
Add a new season
- : 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 season
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the LeaderCriteria
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe international reference for this season given by the sport governing body
CA3243-3Primary Type of Matches
FIXTUREFixturePRACTICEPractice
FIXTUREExample: FIXTUREPossible values: The type of matches added to this season
MULTI_YEAR_HISTORICALMulit-Year HistoricalONE_OFFOne offPRESEASONPre SeasonSEASONSeasonTOURNAMENTTournament
SEASONPossible values: Year of the season
2019The playing grade of the matches in this season
AStatus
ACTIVEActiveCOMPLETECompleteDRAFTDraftINACTIVEInactivePENDINGPending
ACTIVEPossible values: Include this season in calculated statistics?
trueExample: trueIf no 'liveVideoAvailable' flag passed to a new match this value is used
trueIf no 'liveDataAvailable' flag passed to a new match this value is used
trueIf no 'durationFull' is passed to a new match this value is used
210Example: 180If no 'discipline' is passed to a new match this value is used
- None None
INDOORIndoorOUTDOOROutdoor
INDOORPossible values: The abbreviated name of the season in the local language
Test short localThe abbreviated name of the season in latin characters
Test short latinSeason start date
2016-09-08Season end date
2016-09-08The gender of the participants in the season
FEMALEFemaleMALEMaleMIXEDMixedUNKNOWNUnknown
MALEPossible values: The 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 playing standard of the season
ELITEProfessional/elite organisationFRIENDLYInternational FriendlyGRASS_ROOTNormalHISTORICAL_BASELINEHistorical BaselineINTERNATIONALInternationalNONCONTINENTAL_CHAMPIONSHIPNon-continental ChampionshipOLYMPICOlympicsREGIONRegionalTIER2lesser standard than eliteTIER3lesser standard than tier 2WORLD_CHAMPIONSHIPWorld ChampionshipZONE_CHAMPIONSHIPInternational Zone Championship
ELITEPossible values: What level are the competitors representing
CLUBClubCOUNTRYCountryPERSONPersonREGIONRegionSTATEState
CLUBPossible values: The unique identifier of the standingConfiguration
009e9276-5c80-11e8-9c2d-fa7ae01bbebcIs the standings generation locked ?
trueThe Id of the data as set by the provider of the data
A123Pattern: ^[0-9A-Za-z/_-]+$The profile that this season belongs to
009e9276-5c80-11e8-9c2d-fa7ae01bbebcData synchronization strategy with video production systems
AUTOMATEDAutomatedMANUALManualNONENone
NONEExample: AUTOMATEDPossible values: Successful operation
Error
Return a list of seasons in an organization.
- : 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
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe discipline for a match
BEACHBeachHOCKEY5SHockey5sINDOORIndoorOUTDOOROutdoorPARAHOCKEYPara hockey
INDOORPossible values: endDate on or before this date
2018-08-16Type of Fixtures
FIXTUREFixturePRACTICEPractice
FIXTUREPossible values: A 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)]The gender of the season or team
FEMALEFemaleMALEMaleMIXEDMixedUNKNOWNUnknown
MALEPossible values: 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.
10What level are the competitors representing
CLUBClubCOUNTRYCountryPERSONPerson
CLUBPossible values: The unique identifier of the season. Can specify multiple, delimited by comma.
009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005The type of matches added to this season
MULTI_YEAR_HISTORICALMulit-Year HistoricalONE_OFFOne off matchPRESEASONPre SeasonSEASONSeasonTOURNAMENTTournament
SEASONPossible values: Comma-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.
-nameLocalPattern: ^(\-?nameLocal|\-?nameLatin|\-?year|,)*$The playing standard of the season or team
APPROVED_TEST_MATCHESApproved Test matchesCOMMONWEALTH_GAMESCommonwealth GamesCONTINENTAL_CHAMPIONSHIPContinental ChampionshipCONTINENTAL_CHAMPIONSHIP_DIV_2Continental Championship Div 2CONTINENTAL_CHAMPIONSHIP_DIV_3Continental Championship Div 3CONTINENTAL_CHAMPIONSHIP_DIV_4Continental Championship Div 4CONTINENTAL_QUALIFIERContinental QualifierELITEProfessional/elite organisationFIH_NATIONS_CUPFIH Nations CupFIH_OLYMPIC_QUALIFIERSFIH Olympic QualifiersFIH_PRO_LEAGUEFIH Pro LeagueFIH_WORLD_CUPFIH World CupFIH_WORLD_CUP_QUALIFIERSFIH World Cup QualifiersFRIENDLYInternational FriendlyGRASS_ROOTNormalHISTORICAL_BASELINEHistorical BaselineHOCKEY_SERIES_OPENHockey Series OpenINTERNATIONALInternationalINVITATIONAL_TOURNAMENTInvitational Tournament (3+ teams)NONCONTINENTAL_CHAMPIONSHIPNon-continental ChampionshipOLYMPICOlympicsOLYMPICSOlympic GamesREGIONRegionalTIER2lesser standard than eliteTIER3lesser standard than tier 2WORLD_CHAMPIONSHIPWorld ChampionshipWORLD_LEAGUEWorld LeagueZONE_CHAMPIONSHIPInternational Zone Championship
ELITEPossible values: startDate on or after this date
2018-08-16Status
ACTIVEActiveCOMPLETECompleteDRAFTDraftINACTIVEInactivePENDINGPending
ACTIVEPossible values: Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Data synchronization strategy with video production systems. Multiple allowed (comma-delimited).
AUTOMATEDAutomatedMANUALManualNONENone
NONE,AUTOMATEDPossible values: Successful operation
Error
Return detailed information about a specific season
- : 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
b1a23The unique identifier of the season
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.
10Successful operation
Error
Change the information of a specific season
- : 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
b1a23The unique identifier of the season
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 unique identifier of the competition
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the LeaderCriteria
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe international reference for this season given by the sport governing body
CA3243-3Primary Type of Matches
FIXTUREFixturePRACTICEPractice
FIXTUREExample: FIXTUREPossible values: The type of matches added to this season
MULTI_YEAR_HISTORICALMulit-Year HistoricalONE_OFFOne offPRESEASONPre SeasonSEASONSeasonTOURNAMENTTournament
SEASONPossible values: Year of the season
2019The playing grade of the matches in this season
AStatus
ACTIVEActiveCOMPLETECompleteDRAFTDraftINACTIVEInactivePENDINGPending
ACTIVEPossible values: Include this season in calculated statistics?
trueExample: trueIf no 'liveVideoAvailable' flag passed to a new match this value is used
trueIf no 'liveDataAvailable' flag passed to a new match this value is used
trueIf no 'durationFull' is passed to a new match this value is used
210Example: 180If no 'discipline' is passed to a new match this value is used
- None None
INDOORIndoorOUTDOOROutdoor
INDOORPossible values: The abbreviated name of the season in the local language
Test short localThe abbreviated name of the season in latin characters
Test short latinSeason start date
2016-09-08Season end date
2016-09-08The gender of the participants in the season
FEMALEFemaleMALEMaleMIXEDMixedUNKNOWNUnknown
MALEPossible values: The 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 playing standard of the season
ELITEProfessional/elite organisationFRIENDLYInternational FriendlyGRASS_ROOTNormalHISTORICAL_BASELINEHistorical BaselineINTERNATIONALInternationalNONCONTINENTAL_CHAMPIONSHIPNon-continental ChampionshipOLYMPICOlympicsREGIONRegionalTIER2lesser standard than eliteTIER3lesser standard than tier 2WORLD_CHAMPIONSHIPWorld ChampionshipZONE_CHAMPIONSHIPInternational Zone Championship
ELITEPossible values: What level are the competitors representing
CLUBClubCOUNTRYCountryPERSONPersonREGIONRegionSTATEState
CLUBPossible values: The unique identifier of the standingConfiguration
009e9276-5c80-11e8-9c2d-fa7ae01bbebcIs the standings generation locked ?
trueThe Id of the data as set by the provider of the data
A123Pattern: ^[0-9A-Za-z/_-]+$The profile that this season belongs to
009e9276-5c80-11e8-9c2d-fa7ae01bbebcData synchronization strategy with video production systems
AUTOMATEDAutomatedMANUALManualNONENone
NONEExample: AUTOMATEDPossible values: Successful operation
Error
Delete a specific season
- : 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
b1a23The unique identifier of the season
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)]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
Last updated
Was this helpful?