Team Routes

These routes relate to retrieving and manipulating a team’s information, which, by default, includes the name of the team and their ID (used for the IPs of machines). They do not deal with team configuration or team checks, however.

Get All Teams

GET /teams

Gets information for all teams that have been created in the current scoring session.

Example request:

GET /teams HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
[
   {
       'id': '1',
       'name': 'Team A'
   },
   {
       'id': '2',
       'name': 'Team B'
   }
]

Requires Authentication: Yes

Allowed Roles: Administrator, Organizer

URL Parameters:

There are no URL parameters for this interface.

Required JSON Parameters:

No JSON parameters are required for this interface.

Optional JSON Parameters:

No optional JSON parameters are allowed for this interface.

Forbidden JSON Parameters:

No JSON parameters are forbidden for this interface.

Exceptions:

• IllegalParameter: You submitted parameters with your GET request. Parameters are not allowed on this interface.

Create Team

POST /teams

Creates a new team for use in the current scoring session.

Example request:

POST /teams HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Content-Type: application/json
{
   'name': 'Team C',
   'id': '3'
}

Example response:

HTTP/1.1 201 Created
Location: http://example.com/teams/3

Requires Authentication: Yes

Allowed Roles: Administrator

URL Parameters:

There are no URL parameters for this interface.

Required JSON Parameters:

• name: This is the name of the team.
• id: This is the ID of the team, which is what is placed in the relevant position in each machine’s ID.

Optional JSON Parameters:

No optional parameters are allowed for this interface.

Forbidden JSON Parameters:

No JSON parameters are forbidden for this interface.

Exceptions:

• Exists: A team with the specified ID already exists. You must specify a different ID for the team.
• IllegalParameter: Either a parameter submitted in the request is not allowed on this interface, or a parameter is missing from the request. See the reason in the exception for more information.

Get Specific Team

GET /teams/(team_id)

Gets information on a specific team with the ID team_id.

Example request:

GET /teams/1 HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
   'name': 'Team A'
}

Requires Authentication: Yes

Allowed Roles: Administrator, Organizer

URL Parameters:

• team_id: The ID for the team you are requesting information for.

Required JSON Parameters:

No JSON parameters are required for this interface.

Optional JSON Parameters:

No optional parameters are allowed for this interface.

Forbidden JSON Parameters:

No JSON parameters are forbidden for this interface.

Exceptions:

• IllegalParameter: You submitted parameters with your GET request. Parameters are not allowed on this interface.

Modify Team

PATCH /teams/(team_id)

Modifies the information for a team specified by team_id.

Example request:

PATCH /teams/1 HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Content-Type: application/json
{
   'name': 'A'
}

Example response:

HTTP/1.1 204 No Content

Requires Authentication: Yes

Allowed Roles: Administrator

URL Parameters:

• team_id: The ID for the team you are requesting information for.

Required JSON Parameters:

No JSON parameters are required for this interface.

Optional JSON Parameters:

• name: The name of the team.

Forbidden JSON Parameters:

No JSON parameters are forbidden for this interface.

Exceptions:

• IllegalParameter: Either a parameter submitted in the request is not allowed on this interface, or a parameter is missing from the request. See the reason in the exception for more information.

Delete Team

DELETE /teams/(team_id)

Deletes a team specified by team_id.

Example request:

DELETE /teams/1 HTTP/1.1
Host: example.com
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 No Content

Requires Authentication: Yes

Allowed Roles: Administrator

URL Parameters:

• team_id: The ID for the team you are requesting information for.

Required JSON Parameters:

No JSON parameters are required for this interface.

Optional JSON Parameters:

No optional parameters are allowed for this interface.

Forbidden JSON Parameters:

No JSON parameters are forbidden for this interface.

Exceptions:

• IllegalParameter: You submitted parameters with your DELETE request. Parameters are not allowed on this interface.