Sign up

/users/sign_up post

post

Create a new user account.

Request
Response

Body

Media type: application/json

Type: object

Properties

user: required(object)
- email: required(string)
- password: required(string)
- password_confirmation: required(string)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

user: required(object)
- email: required(string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Authentication

/oauth/token post

post

Create an access token that allows user to authenticate.

Request
Response

Query Parameters

email: required(string)
password: required(string)
grant_type: required(password)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

access_token: required(string)
created_at: required(integer)
expires_in: required(integer)
refresh_token: required(string)
token_type: required(string)

Example:

{
  "access_token": "fdf22ac62f7007c2a63291485446650e01637a986db59364e33761838e109ee4",
  "created_at": 1515571806,
  "expires_in": 7200,
  "refresh_token": "8a737a12ea6a3182aa9924b277d67d55c92f67fa3d03f5016aa50c787ea513b0",
  "token_type": "bearer"
}

HTTP status code 401

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

Example:

{
  "error": "invalid_grant",
  "error_description": "The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client."
}

/oauth/token/info get

get

Retrieve details about the token used for authentication.

Secured by oauth

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

application: required(object)
- uid: required(nil)
created_at: required(integer)
expires_in: required(integer)
resource_owner_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
scope: required(array of string)

Example:

{
  "application": {
    "uid": null
  },
  "created_at": 1515572788,
  "expires_in": 100,
  "resource_owner_id": "6a15b02f-0712-56dc-a290-915475d29abb",
  "scope": [
    "public"
  ]
}

HTTP status code 401

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

Example:

{
  "error": "invalid_request",
  "error_description": "The request is missing a required parameter, includes an unsupported parameter value, or is otherwise malformed."
}

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/oauth/revoke post

post

Revoke the given token.

Secured by oauth

Response
Security

HTTP status code 200

Always returns 200 OK, even if token doesn't exist or has already been revoked.

Body

Media type: application/json

Type: any

Example:

{}

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

User

/user get patch

get

Retrieve account details for currently authenticated user.

patch

Update account details for currently authenticated user.

Retrieve account details for currently authenticated user.

Secured by oauth

Response
Security

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

user: required(object)
- email: required(string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Update account details for currently authenticated user.

Secured by oauth

Body

Media type: application/json

Type: object

Properties

user: required(object)
- email: (string)
- password: (string)
- password_confirmation: (string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

user: required(object)
- email: required(string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Tournaments

/tournaments get post

get

Retrieve tournaments. Authentication is optional - when authenticated, retrieve only tournaments created by authenticated user. Tournaments are sorted by 'starts_at' (ascending).

post

Create a new tournament.

Retrieve tournaments. Authentication is optional - when authenticated, retrieve only tournaments created by authenticated user. Tournaments are sorted by 'starts_at' (ascending).

Secured by oauth

Query Parameters

filters: (object)
- starts_at_after: (datetime)
  Specify datetime after which tournaments you want to retrieve should start.
- with_name: (string)
  Specify tournament name you want to search for (case insensitive).
page: (integer - default: 1)
Specify the page that you want to retrieve, 12 results are returned per page.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournaments: required(array of object)
Items: Tournament
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)
meta: required(object)
- total_count: required(integer)

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Create a new tournament.

Secured by oauth

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: required(string)
- name: required(string)
- starts_at: required(datetime)
- result_names: required(array of string)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/tournaments/enlisted get

get

Retrieve tournaments that currently authenticated user has enlisted in. Tournaments are sorted by 'starts_at' (ascending).

Secured by oauth

Query Parameters

filters: (object)
- starts_at_after: (datetime)
  Specify datetime after which tournaments you want to retrieve should start.
- with_name: (string)
  Specify tournament name you want to search for (case insensitive).
page: (integer - default: 1)
Specify the page that you want to retrieve, 12 results are returned per page.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournaments: required(array of object)
Items: Tournament
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)
meta: required(object)
- total_count: required(integer)

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/tournaments/{id} get patch delete

get

Retrieve a tournament with relations.

patch

Update tournament details. User can update only tournaments he created.

delete

Remove a tournament. User can remove only tournaments he created.

Retrieve a tournament with relations.

Request
Response

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors: required(array of Competitor)
  Items: Competitor
  - created_at: required(datetime)
  - id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
  - name: required(string)
  - status: required(one of enlisted, confirmed)
  - user_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- rounds: required(array of RoundWithRelations)
  Items: Round
  - players: required(array of Player)
    Items: Player
    competitor_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    
    id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
    
    result_values: required(array of integer)
    
    table_number: required(integer)
  - competitors_limit: required(integer)
  - created_at: required(datetime)
  - id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
  - tables_count: required(integer)
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)

HTTP status code 404

Returned when resource was not found. Response is always empty.

Update tournament details. User can update only tournaments he created.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: required(string)
- name: required(string)
- starts_at: required(datetime)
- result_names: required(array of string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Remove a tournament. User can remove only tournaments he created.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 204

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/tournaments/{id}/start post

post

Mark tournament as 'in progress'. User can start only tournaments he created and their 'starts_at' date is in the past.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/tournaments/{id}/end post

post

Mark tournament as 'ended'. User can start only tournaments he created and were previously started.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

tournament: required(object)
- competitors_limit: required(integer)
- description: (string)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- organiser_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_names: required(array of string)
- starts_at: required(datetime)
- status: required(one of created, in_progress, ended)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Results

/results get

get

Retrieve total results for each competitor in a tournament, sorted from highest to lowest.

Request
Response

Query Parameters

tournament_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

results: required(array of object)
Items: Result
- competitor_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- total: required(array of integer)

HTTP status code 404

Returned when resource was not found. Response is always empty.

Competitor

/competitor post delete

post

Enlist in a tournament. User can enlist only in tournaments that didn't start.

delete

Resign from a tournament. User can resign only from tournaments that didn't start.

Enlist in a tournament. User can enlist only in tournaments that didn't start.

Secured by oauth

Query Parameters

tournament_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- name: required(string)
  Name under which user wants to participate in a tournament. Must be unique within that tournament.

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- status: required(one of enlisted, confirmed)
- user_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Resign from a tournament. User can resign only from tournaments that didn't start.

Secured by oauth

Query Parameters

tournament_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

HTTP status code 204

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/competitor/add post

post

Create a competitor for user without an account. User can create competitors only in tournaments he created.

Secured by oauth

Query Parameters

tournament_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- name: required(string)
  Name under which user wants to participate in a tournament. Must be unique within that tournament.

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- status: required(one of enlisted, confirmed)
- user_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Competitors

/competitors/{id}/remove delete

delete

Remove competitor from a tournament. User can remove only competitors he created.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the competitor

HTTP status code 204

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/competitors/{id}/confirm post

post

Confirm user participation in a tournament. User can confirm competitors only in tournaments he created.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the competitor

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- status: required(one of enlisted, confirmed)
- user_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/competitors/{id}/reject post

post

Reject user participation in a tournament. User can reject competitors only in tournaments he created.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the competitor

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

competitor: required(object)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- name: required(string)
- status: required(one of enlisted, confirmed)
- user_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Rounds

/rounds post

post

Create a new tournament round. User can create rounds only in tournaments he created and didn't end.

Secured by oauth

Query Parameters

tournament_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the tournament

Body

Media type: application/json

Type: object

Properties

round: required(object)
- competitors_limit: required(integer)
- tables_count: required(integer)

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

round: required(object)
- competitors_limit: required(integer)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- tables_count: required(integer)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/rounds/{id} patch delete

patch

Update tournament round. User can update rounds only in tournaments he created and didn't end.

delete

Remove tournament round. User can remove rounds only in tournaments he created and didn't end.

Update tournament round. User can update rounds only in tournaments he created and didn't end.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the round

Body

Media type: application/json

Type: object

Properties

round: required(object)
- competitors_limit: required(integer)
- tables_count: required(integer)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

round: required(object)
- competitors_limit: required(integer)
- created_at: required(datetime)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- tables_count: required(integer)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Remove tournament round. User can remove rounds only in tournaments he created and didn't end.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the round

HTTP status code 204

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Players

Assign players to tables in a tournament round. For the first round assignment is random. If consecutive rounds have the same competitors limit and tables count, algorithm tries to pair up competitors who haven't met yet. Otherwise it's based on score. User can assign players only in tournaments he created.

Secured by oauth

Query Parameters

round_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the round

HTTP status code 201

Body

Media type: application/json

Type: object

Properties

players: required(array of object)
Items: Player
- competitor_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_values: required(array of integer)
- table_number: required(integer)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

/players/{id} patch

patch

Update player with the round results.

Secured by oauth

URI Parameters

id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
The id of the player

Body

Media type: application/json

Type: object

Properties

player: required(object)
- result_values: required(array of integer)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties

player: required(object)
- competitor_id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- id: required(string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)
- result_values: required(array of integer)
- table_number: required(integer)

HTTP status code 401

Returned when request was not authenticated properly. Response is always empty.

HTTP status code 403

Returned when action is not allowed, e.g. required conditions are not met.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, e.g. "forbidden".
error_description: required(string)
Human-readable error message.

HTTP status code 404

Returned when resource was not found. Response is always empty.

HTTP status code 422

Returned when sent parameters are not valid.

Body

Media type: application/json

Type: object

Properties

error: required(string)
Error code, for validation error it is always "invalid_params".
error_description: required(string)
Human-readable error message.
fields: required(object)
An object containing all errors. Object keys are field names, values are error messages (arrays of string).

Secured by oauth

Headers

Authorization: required(string)

Example:

Bearer iDbsaZHplNEL1thqvGsfYFyb_4P4Fv6uCCAGcENK_ho

Tournaments API documentation

Sign up

post /users/sign_up

Body

HTTP status code 201

Body

HTTP status code 422

Body

Authentication

post /oauth/token

Query Parameters

HTTP status code 200

Body

HTTP status code 401

Body

get /oauth/token/info

HTTP status code 200

Body

HTTP status code 401

Body

Secured by oauth

Headers

post /oauth/revoke

HTTP status code 200

Body

Secured by oauth

Headers

User

get /user

HTTP status code 200

Body

HTTP status code 401

Secured by oauth

Headers

patch /user

Body

HTTP status code 200

Body

HTTP status code 401

HTTP status code 422

Body

Secured by oauth

Headers

Tournaments

get /tournaments

Query Parameters

HTTP status code 200

Body

Secured by oauth

Headers

post /tournaments

Body

HTTP status code 201

Body

HTTP status code 401

HTTP status code 422

Body

Secured by oauth

Headers

get /tournaments/enlisted

Query Parameters

HTTP status code 200

Body

Secured by oauth

Headers

get /tournaments/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

patch /tournaments/{id}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 401

HTTP status code 403

Body

HTTP status code 404

HTTP status code 422