API.md

Table of Contents

• Users
  • Create a new user
  • Login as a user
  • View authenticated user
• Teams
  • List teams, ranked by score
  • View a team
  • Create a team
  • Invite another user to your team
  • List teams you're invited to
  • Join a team
  • Leave team
• Challenges
  • View Challenges

Users

Create a new user

POST /api/users/

{
  "username": "tyler_durden",
  "password": "dQw4w9WgXcQ"
}

Response

{
  "key": "9bZkp7q19f0.KmtzQCSh6xk"
}

Login as a user

POST /api/sessions/

{
  "username": "tyler_durden",
  "password": "dQw4w9WgXcQ"
}

Response

{
  "key": "KmtzQCSh6xk.9bZkp7q19f0"
}

View authenticated user

GET /api/user

Response

{
  "username": "tyler_durden",
  "team": {
    "id": 1,
    "name": "Fight Club"
  }
}

Teams

List teams, ranked by score

GET /api/teams/

Response

{
  "teams": [
    {
      "id": 1,
      "name": "Fight Club",
      "points": 1024
    },
    {
      "id": 2,
      "name": "Police Department",
      "points": 0
    }
  ]
}

View a team

GET /api/teams/1
GET /api/team

Response

{
  "id": 1,
  "name": "Fight Club"
}

Create a team

POST /api/teams/

{
  "name": "Fight Club"
}

Response

{
  "id": 1,
  "name": "Fight Club"
}

Invite another user to your team

POST /api/team/members/

{
  "username": "robert_paulson"
}

Response

HTTP/2.0 204 No Content

List teams you're invited to

POST /api/teams/invited

{
  "teams": [
    {
      "id": 2,
      "name": "Police Department"
    }
  ]
}

Response

HTTP/2.0 204 No Content

Join a team

PATCH /api/user

{
  "team": 1
}

Response

HTTP/2.0 204 No Content

Leave team

DELETE /api/team

Response

HTTP/2.0 204 No Content

Challenges

View Challenges

GET /api/challenges

Response

{
  "challenges": [
    {
      "category": "example",
      "description": "This is a test of the web problems",
      "id": 2,
      "points": 10,
      "title": "Test Web"
    }
  ]
}