User routes
Create a new user
Creates a new user.
POST /competitions/{id}/users
Request Body
| name |
type |
required |
requirements |
| username |
string |
yes |
none |
| password |
string |
yes |
length >= 8 |
| email |
string |
yes |
something@something.something
|
| eligible |
boolean |
yes |
none |
Responses
| code |
description |
content |
| 400 |
data validation failed |
{"message": "invalid_values"} |
| 409 |
username or email conflict |
{"message": "username_email_conflict"} |
| 201 |
successfully created |
none |
Get a list of users
Gets a list of users.
GET /competitions/{id}/users
Responses
| code |
description |
content |
| 200 |
a list of users |
list of users, includes emails if request by admin |
Get a user
Gets a single user.
GET /competitions/{id}/users/{id}
Responses
| code |
description |
content |
| 200 |
successfully found user |
a user
|
| 404 |
user not found |
{"message": "user_not_found"} |
Modify a user 
Modifies a user. Requires authentication.
PATCH /competitions/{id}/users/{id}
The user must be either an admin or the user they are trying to modify.
Request Body
| name |
type |
required |
requirements |
| username |
string |
no |
none |
| email |
string |
no |
something@something.something
|
| eligible |
boolean |
no |
none |
Responses
| code |
description |
content |
| 204 |
successfully modified |
none |
| 409 |
username or email conflict |
{"message": "username_email_conflict"} |
| 404 |
user not found |
{"message": "user_not_found"} |
| 403 |
user not permitted to modify |
{"message": "action_forbidden"} |
| 400 |
validation failed |
{"message": "invalid_values"} |
| 401 |
authentication failed |
none |