API Docs

API Docs

WARNING: hackEDU's backend API is not stable yet and backwards-incompatible changes will be made. This is not ready to be built upon yet.

Users

Apply

POST: /users/apply

Parameters

• firstName - first name of user
• lastName - last name of user
• email - user's email
• password - user's password
• application - application object.
  • highSchool - user's high school
  • interestingProject - an interesting project that the user worked on
  • systemHacked - a non-computer system that user hacked
  • passion - what user is passionate about
  • story - user's story, how they got interested in programming, that sort of thing
  • why - why the user wants to start a hack club

Get a single user

GET: /users/:id

Response

{
  "id": 1,
  "createdAt": "2014-04-17T00:00:00Z",
  "firstName": "Zaphod",
  "lastName": "Beeblebrox",
  "email": "zaphod@beeblebrox.com",
  "github": "zaphod",
  "twitter": "zaphod"
}

Schools

Get a single school

GET: /schools/:id

Response

{
  "id": 1,
  "createdAt": "2014-04-17T00:00:00Z",
  "name": "Beeblebrox High School",
  "latitude": 45.4278674,
  "longitude": -75.6939446
}

Get all schools

GET: /schools

Response

[
  {
    "id": 1,
    "createdAt": "2014-04-17T00:00:00Z",
    "name": "Beeblebrox High School",
    "latitude": 45.4278674,
    "longitude": -75.6939446
  },
  {
    "id": 2,
    "createdAt": "2014-04-17T00:00:00Z",
    "name": "Prefect High School",
    "latitude": 43.17518,
    "longitude": -79.2662
  }
]