Introduction

Welcome to the Turnie.re API documentation! This document will describe all available endpoints and possible responses.

Authentication

GET /PATH HTTP/1.1
access-token: →ozpq-AC9P3iXS_HfgsfyAg
client: qy4HyWhq-FCod5qtzaitqw
expiry: 1544795677
uid: mail@example.com

HTTP/1.1 200 OK
access-token: new-access-token
client: qy4HyWhq-FCod5qtzaitqw
expiry: 1544795676
uid: mail@example.com

The response of a successful sign in request will return an initial access-token and client header. Those and the uid header (set to the email of the logged in user) have to be included in every request to an authenticated path.

The access-token is valid until expiry (unix timestamp) or one request. Every request will contain a new access-token for the next request.

For implementation details and more examples check out devise-token-auth.

Users

POST /users/sign_in HTTP/1.1
Content-Type: application/json

{
  "email": "mail@example.com",
  "password": "p4ssw0rd"
}

HTTP/1.1 200 OK
Content-Type: application/json
access-token: →ozpq-AC9P3iXS_HfgsfyAg
client: qy4HyWhq-FCod5qtzaitqw
expiry: 1544795676
uid: mail@example.com

{
  "id": 1,
  "email": "mail@example.com",
  "provider": "email",
  "username": "user",
  "uid": "mail@example.com",
  "allow_password_change": true,
  "type": "user"
}

Sign a user in to obtain an access token.

Parameters

Parameter	Description
email	E-Mail of the user
password	Password of the user

Sign out

DELETE /users/sign_out HTTP/1.1
access-token: →ozpq-AC9P3iXS_HfgsfyAg
client: qy4HyWhq-FCod5qtzaitqw
uid: mail@example.com

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": true
}

Sign out a user and invalidate the access token.

Register

POST /users HTTP/1.1
Content-Type: application/json

{
  "email": "jonny3210@example.com",
  "username": "jonny3210",
  "password": "123456"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "email": "mail@example.com",
  "provider": "email",
  "username": "user",
  "uid": "mail@example.com",
  "allow_password_change": false,
  "type": "user"
}

Parameters

Parameter	Description
email	E-Mail of the new user
username	Username of the new user
password	Password of the new user

Update

PUT /users HTTP/1.1
Content-Type: application/json

{
  "email": "new@email.com",
  "username": "newusername"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "email": "new@email.com",
  "provider": "email",
  "username": "newusername",
  "uid": "new@email.com",
  "allow_password_change": false,
  "created_at": "2019-05-13T10:07:21.228Z",
  "updated_at": "2019-05-13T10:11:38.087Z"
}

Update user account.

Parameters can be omitted as needed.

Parameters

Parameter	Description
email	Updated mail address
username	Updated username

Change Password

PUT /users/password HTTP/1.1
Content-Type: application/json

{
  "current_password": "password"
  "password": "P@ssw0rd"
  "password_confirmation": "P@ssw0rd"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 23,
  "email": "john@gmail.com",
  "provider": "email",
  "username": "JohnTheBoy",
  "uid": "john@gmail.com",
  "allow_password_change": true,
  "created_at": "2019-06-04T10:08:28.838Z",
  "updated_at": "2019-06-04T10:10:39.027Z"
}

Parameters

Parameter	Description
current_password	current/old password
password	The new password
password_confirmation	The new password again to prevent typos

Tournaments

List tournaments

GET /tournaments HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "code": "184c4a",
    "id": 1,
    "name": "Shadow",
    "public": true
  }
]

List all existing tournaments.

Unauthenticated users can only list public tournaments.

URL Parameters

Parameter	Default	Description
type	public	Type of tournaments to include in the list (either `public` or `private`)

Show a tournament

GET /tournaments/1 HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 3,
  "name": "Erics Wonderland",
  "code": "e177f3",
  "public": true,
  "description": "Here we go: Erics third wonderland tournament.",
  "owner_username": "eric_kunze",
  "stages": [
    {
      "id": 7,
      "level": 1,
      "state": "playoff_stage",
      "matches": [
        {
          "id": 15,
          "state": "not_started",
          "position": 0,
          "winner": null,
          "match_scores": [
            {
              "id": 23,
              "points": 0,
              "team": {
                "id": 17,
                "name": "Barambo"
              }
            },
            {
              "id": 24,
              "points": 0,
              "team": {
                "id": 18,
                "name": "Kurumba"
              }
            }
          ]
        },
        {
          "id": 16,
          "state": "not_started",
          "position": 1,
          "winner": null,
          "match_scores": [
            {
              "id": 25,
              "points": 0,
              "team": {
                "id": 19,
                "name": "Gatego"
              }
            },
            {
              "id": 26,
              "points": 0,
              "team": {
                "id": 20,
                "name": "Tentiku"
              }
            }
          ]
        }
      ],
      "groups": []
    },
    {
      "id": 8,
      "level": 0,
      "state": "playoff_stage",
      "matches": [
        {
          "id": 17,
          "state": "not_ready",
          "position": 0,
          "winner": null,
          "match_scores": []
        }
      ],
      "groups": []
    }
  ],
  "teams": [
    {
      "id": 17,
      "name": "Barambo"
    },
    {
      "id": 18,
      "name": "Kurumba"
    },
    {
      "id": 19,
      "name": "Gatego"
    },
    {
      "id": 20,
      "name": "Tentiku"
    }
  ]
}

Request a detailed Tournament object. This will include all available attributes and relations. Public tournaments can be requested by anyone, private tournaments only by their owner.

Show tournament statistics

GET /tournaments/1/statistics HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

{
  "most_dominant_score": {
    "id": 1,
    "group_points": 1,
    "received_points": 0,
    "scored_points": 100,
    "team": {
      "id": 69,
      "name": "Zoe"
    }
  },
  "least_dominant_score": {
    "id": 2,
    "group_points": 0,
    "received_points": 100,
    "scored_points": 0,
    "team": {
      "id": 76,
      "name": "Jasper"
    }
  },
  "group_scores": [
    {
      "id": 1,
      "group_points": 1,
      "received_points": 0,
      "scored_points": 100,
      "team": {
        "id": 69,
        "name": "Zoe"
      }
    },
    {
      "id": 2,
      "group_points": 0,
      "received_points": 100,
      "scored_points": 0,
      "team": {
        "id": 76,
        "name": "Jasper"
      }
    }
  ]
}

Retrieve a list of group scores for tournaments with a group stage.
Additionally calculate a most (most scored_points) and least (most received_points) dominant team.

Create a tournament

POST /tournaments HTTP/1.1
Content-Type: application/json

{
  "name": "Tournament 01",
  "description": "An interesting description",
  "public": false,
  "group_stage": false,
  "playoff_teams_amount": 4,
  "teams": [
    {
      "id": 1
    },
    /* or */
    {
      "name": "Name 01"
    },

    /* for "group_stage": true */
    {
      "id": 1,
      "group": 1
    },   
    /* or */
    {
      "name": "Name 01",
      "group": 1
    }
  ]
}

HTTP/1.1 200 OK
Content-Type: application/json

TBD

Create a new tournament.

This will associate the given teams to a new tournament object or create them and generate a playoff stage.

You can either reuse teams from an existing tournament (first example) or create new teams (second example).

For tournaments with a group stage ("group_stage": true) an additional "group" parameter, specifying the group as an integer, is required for each team.

Parameters without default value are required!

Parameters

Parameter	Description	Default
name	Name of the tournament
teams	Teams to create/add to the tournament
description	Description of the tournament	`''`
public	Whether the tournament is public (`true` or `false`)	`true`
group_stage	Whether the tournament will start with a group stage (`true` or `false`)	`false`
playoff_teams_amount	(only required for tournaments with group stage) The amount of teams that advance to playoff stage after group stage (1 < playoff_teams_amount < amount of teams)

Update a tournament

PATCH /tournaments/3 HTTP/1.1
Content-Type: application/json

{
  "name": "Erics VERY NICE Wonderland",
  "description": "Here we go: Erics third wonderland tournament. Forgot this sentence..",
  "public": false
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 3,
  "name": "Erics VERY NICE Wonderland",
  "code": "e177f3",
  "public": false,
  "description": "Here we go: Erics third wonderland tournament. Forgot this sentence..",
  "owner_username": "eric_kunze",
  "stages": [
    {
      "id": 7,
      "level": 1,
      "state": "playoff_stage"
    },
    {
      "id": 8,
      "level": 0,
      "state": "playoff_stage"
    }
  ],
  "teams": [
    {
      "id": 17,
      "name": "Barambo"
    },
    {
      "id": 18,
      "name": "Kurumba"
    },
    {
      "id": 19,
      "name": "Gatego"
    },
    {
      "id": 20,
      "name": "Tentiku"
    }
  ]
}

Update tournament attributes.

Parameters

All parameters are optional, therefore one request can be used to update either all, some or no parameters.

Parameter	Description
name	Name of the tournament
description	Description of the tournament
public	Whether the tournament is public (`true` or `false`)

Delete a tournament

DELETE /tournaments/1 HTTP/1.1

HTTP/1.1 204 No Content

Teams

Show a team

GET /teams/1 HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "Gracie"
}

Update a team

PATCH /teams/1 HTTP/1.1
Content-Type: application/json

{
  "name": "New name"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "New name"
}

Parameters

Parameter	Description
name	Name of the team

Matches

Show a match

GET /matches/1 HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "match_scores": [
    {
      "id": 1,
      "points": 0,
      "team": {
        "id": 1,
        "name": "Bubba"
      }
    },
    {
      "id": 2,
      "points": 1,
      "team": {
        "id": 2,
        "name": "Misty"
      }
    }
  ],
  "position": 0,
  "state": "not_started"
}

Matches belonging to a private tournament can only be viewed by the owner of that tournament.

Start a Match

Starting a Match is only available when the matches current state is 'not_started'.

PATCH /matches/1 HTTP/1.1
Content-Type: application/json

{
  "state": "in_progress",
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "state": "in_progress",
  "position": 2,
  "match_scores": [
    {
      "id": 17,
      "points": 0
    },
    {
      "id": 18,
      "points": 0
    }
  ]
}

Parameters

Parameter	Value
state	'in_progress'

End a Match

Stopping a match is only available if the matches current state is 'in_progress'. Stopping a match will result in the match below being filled with the winning team / the group points being recalculated.

PATCH /matches/1 HTTP/1.1
Content-Type: application/json

{
  "state": "finished",
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "state": "finished",
  "position": 2,
  "match_scores": [
    {
      "id": 17,
      "points": 0
    },
    {
      "id": 18,
      "points": 0
    }
  ]
}

Parameters

Parameter	Value
state	'finished'

Match Scores

Show a match score

GET /match_scores/1 HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "points": 0,
    "team": {
        "id": 1,
        "name": "Bubba"
    }
}

Update a match score

PATCH /match_scores/1 HTTP/1.1
Content-Type: application/json

{
  "points": 100,
}

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "points": 100,
  "team": {
    "id": 1,
    "name": "Bubba"
  }
}

Parameters

Parameter	Description
points	Updated points

Stages

Errors

This error section is stored in a separate file in includes/_errors.md. Slate allows you to optionally separate out your docs into many files...just save them to the includes folder and add them to the top of your index.md's frontmatter. Files are included in the order listed.

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The kitten requested is hidden for administrators only.
404	Not Found -- The specified kitten could not be found.
405	Method Not Allowed -- You tried to access a kitten with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The kitten requested has been removed from our servers.
418	I'm a teapot.
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Introduction

Authentication

Users

Sign in

Parameters

Sign out

Register

Parameters

Update

Parameters

Change Password

Parameters

Tournaments

List tournaments

URL Parameters

Show a tournament

Show tournament statistics

Create a tournament

Parameters

Update a tournament

Parameters

Delete a tournament

Teams

Show a team

Update a team

Parameters

Matches

Show a match

Start a Match

Parameters

End a Match

Parameters

Match Scores

Show a match score

Update a match score

Parameters

Stages

Errors