API

Creates a player or organiser and returns a token. A welcome email is sent. The response status is 201.

name, email, password, password_confirmation
role is optional: player or organiser. Left off, the account is a player.
password is at least 8 characters.

{ "user": { "id", "name", "email", "role" }, "token": "...", "token_type": "Bearer" }

Checks the email and password. A wrong password returns 422 with "Invalid credentials."

email, password

{ "user", "token", "token_type": "Bearer" }

Returns the account that owns the token. Switching to a child does not change this. The password is not included.

{ "id", "name", "email", "role", "guardian_id" }

Deletes the token used for this call.

{ "message": "Logged out." }

The account and each linked child. active_id is the profile later calls will use. Until you switch, that is the account.

{ "active_id", "profiles": [{ "id", "name", "photo_url", "kind": "account or child" }] }

Chooses the account or one of its linked children. Any other id returns 403. Switching back uses the account id.

{ "user_id": 48 }

{ "active_id", "profile": { "id", "name", "photo_url", "kind" } }

The active profile. This is the account until you switch, then the chosen child.

{ "user", "profile", "tournaments", "friends" }

Updates the profile. Send only the fields that changed. interests is a list of up to 20 labels, each up to 40 characters. Repeated labels are kept once.

first_name, middle_name, last_name, email
gender, cell and home and work phones
date_of_birth, show_full_birthday, timezone, display_language
address lines, city, postal_code, country, state_province, region, district
membership_number, is_coach, is_official
south_african_citizen, identification_number, ethnic_group
tournament_player, coach, nationality, handedness
summary, nicknames, occupation, sporting_idols, website
birthplace, children_count, dietary_considerations
playing_time_preferences, interests

The same shape as GET /profile.

Sets the profile photo. The field name is photo. Maximum size is 2 MB.

photo

The profile, with profile.photo_url filled in.

Removes the profile photo.

The profile, with profile.photo_url set to null.

Sets the cover photo. The field name is cover. Maximum size is 4 MB.

cover

The profile, with profile.cover_url filled in.

Removes the cover photo.

The profile, with profile.cover_url set to null.

All published tournaments, newest start date first. Leave a filter off to ignore it. q matches the tournament name or the club name, city, or province. province must be one of the provinces in the response. club is a club id from clubs. from and to are dates, YYYY-MM-DD. from keeps tournaments that have not ended before that day. to keeps tournaments that start on or before that day. status is entries_open, in_progress, or completed. page starts at 1. per_page defaults to 15 and cannot be more than 50.

q, province, club, from, to, status
page, per_page

{ "tournaments": [{ "id", "name", "status", "status_label", "starts_on", "ends_on", "entry_fee_cents", "entry_fee", "club": { "id", "name", "city", "province" }, "draws": [{ "id", "name", "format", "format_label", "gender", "age", "locked", "limit", "entered_count", "open" }] }],
"provinces": [],
"clubs": [{ "id", "name" }],
"meta": { "current_page", "last_page", "per_page", "total" } }

One tournament and each draw, for the active profile. entered is true when that profile is already in the draw. blocked is why that profile cannot enter, or null when they can. open is false when the draw is locked, full, or the tournament is not taking entries. A draft returns 404.

{ "tournament": { the search tournament, plus "description", and each draw also has "entered", "registration_id", "blocked" } }

Signs the active profile up for that draw. A free entry returns 201 and the registration. An entry fee returns 200 with entered false and a payment; nobody is in the draw until that payment is finished. A locked draw, a closed tournament, a full draw, a second entry, or a profile that does not match the draw returns 422 with message.

{ "entered": true, "message", "registration" }
or
{ "entered": false, "message", "payment": { "id", "status", "amount", "amount_cents", "currency": "ZAR", "confirm_locally", "payfast": { "url", "fields" } } }

Finishes a pending entry when confirm_locally is true. Otherwise this returns 403. The payment must belong to this tournament and the active profile.

{ "entered", "message", "registration" }

Withdraws the active profile from that draw. Another profile’s entry returns 403. A locked draw returns 422 and the entry stays.

{ "message": "Registration withdrawn." }

Tournaments the active profile is already signed up for. The same list is included on GET /profile. This is not the full catalogue. Use search for that.

{ "tournaments": [{ "registration_id", "seed", "draw": { "id", "name" }, "tournament": { "id", "name", "starts_on", "ends_on", "status", "club" } }] }

Every tournament that is not a draft, whether or not a score sheet exists. A draw with locked false is not ready for scores yet.

{ "tournaments": [{ "id", "name", "status", "starts_on", "ends_on", "club", "draws": [{ "id", "name", "format", "format_label", "locked" }] }] }

The live board. as_of is the latest match change. A draw with layout bracket fills brackets and leaves tables empty. A draw with layout tables fills tables and playoffs.

{ "tournament", "as_of", "draws": [{ "id", "name", "format", "layout", "scoring", "locked", "brackets", "tables", "playoffs" }] }

Saves a result and returns that draw so the screen can replace it. home is player_one’s games, away is player_two’s games. A 7-6 set needs tiebreak, the loser’s tie-break points. Walkover, default, and retirement name the player. The score sheet must already be generated.

outcome: score, walkover, default, retirement, or no_result
sets: [{ "home": 6, "away": 4 }, { "home": 7, "away": 6, "tiebreak": 5 }]
winner_id for a walkover
retired_id for a retirement
defaulted_id for a default
court and scheduled_at are optional

{ "draw": { the same draw object as on the board } }

Finds other players by name. q needs at least 2 letters. A shorter search returns an empty list. Email addresses are not included. At most 10 players are returned.

{ "players": [{ "id", "name", "photo_url" }] }

Accepted friends, plus requests waiting on you and requests you have sent.

{ "friends": [], "incoming": [], "outgoing": [] }

Sends a friend request. A new request returns 201. You cannot add yourself. If that player already asked you, the response is 422 and tells you to accept their request.

{ "user_id": 12 }

{ "friendship": { "id", "status": "pending", "user": { "id", "name", "photo_url" } } }

Accepts a request sent to you. Only the player who received it can accept.

{ "friendship": { "id", "status": "accepted", "user" } }

Cancels a request you sent, declines one you received, or removes an accepted friend.

{ "message": "Friend removed." }