Overview
Retrieve a list of grades under a specified season.
Terms of use
PlayHQ API credentials
Season Grades uses API keys to authenticate requests. To request API credentials please submit a support request.
Important: API credential requests will be reviewed by PlayHQ and the administration body for the relevant sport or association.
Once you have received your credentials from PlayHQ you will be able to generate an authentication token. More information on how to do this can be found here.
Resources
Get Request
GET v1/seasons/:id/gradesInformation on Path and Header parameters can be found here.
Data included in a successful response
|
Field Name in File |
Field Description |
Sample Data (or picklist values, if appropriate) |
Database Field Type* |
|---|---|---|---|
|
id |
Grade's UUID |
88a5b302-f71f-11ea-adc1-0242ac120002 |
UUID |
|
name |
Grade name |
12 Boys - VJL2 (P2) |
String |
|
url |
URL of grade |
https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768 |
|
|
metadata |
Array of sub objects (defined below) |
|
Array |
|
metadata.hasMore |
|
true |
Boolean |
|
metadata.nextCursor |
|
dXNlcjpXMDdRQ1JQQTQ= |
|
Errors
|
Scenario |
|
|---|---|
|
Submit an invalid season ID |
400 - Bad Request |
|
Submit multiple season IDs |
400 - Bad Request |