Team routes
Create and join a team
Creates and joins a team.
POST /competitions/{id}/teams
Request Body
name |
type |
required |
requirements |
name |
string |
yes |
none |
affiliation |
string |
no |
none |
passcode |
string |
yes |
none |
Responses
code |
description |
content |
400 |
data validation failed |
{"message": "invalid_values"} |
201 |
successfully created team |
none |
409 |
team name conflict |
{"message": "team_name_conflict"} |
403 |
user already on team |
{"message": "user_already_has_team"} |
401 |
authentication failed |
none |
400 |
invalid values |
{"message": "invalid_values"} |
Get a list of teams
Gets a list of teams.
GET /competitions/{id}/teams
Responses
Get a team
Gets a single team.
GET /competitions/{id}/teams/{id}
To retrieve scores as they were at the end of the competition, set the query parameter frozen
.
Responses
code |
description |
content |
200 |
the team |
a team
|
404 |
team not found |
{"message": "team_not_found"} |
Join a team
Joins a team.
PATCH /competitions/{id}/teams
Request body
name |
type |
required |
requirements |
name |
string |
yes |
none |
passcode |
string |
yes |
none |
Responses
code |
description |
content |
403 |
user already in team |
{"message": "already_in_team"} |
403 |
user already has another team and competition has started |
{"message": "user_already_has_team"} |
403 |
incorrect passcode |
{"message": "incorrect_passcode"} |
204 |
successfully joined team |
none |
401 |
authentication failed |
none |
400 |
invalid values |
{"message": "invalid_values"} |
Modify a team
Modifies a team. Requires authentication.
PATCH /competitions/{id}/teams/{id}
User must either be an admin or modifying their own team.
Request Body
name |
type |
required |
requirements |
name |
string |
no |
none |
affiliation |
string |
no |
none |
Responses
code |
description |
content |
204 |
successfully modified team |
none |
409 |
team name already in use |
{"message": "team_name_conflict"} |
404 |
team not found |
{"message": "team_not_found"} |
403 |
user not permitted to modify team |
{"message": "action_forbidden"} |
401 |
authentication failed |
none |
400 |
invalid values |
{"message": "invalid_values"} |