Hackathon API

Backend API to manage hackathons, courses, reviews, users and authentication

Use https://api.demo.schauff.tech as the {{URL}} for all endpoints

Authentication 8

Routes for user authentication including register, login, reset password, etc

raw

Register User | POST {{URL}}/api/v1/auth/register

Description

Add user to database with encrypted password

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "name": "John Doe", "email": "john@gmail.com", "password": "123456", "role": "publisher" }

raw

Login User | POST {{URL}}/api/v1/auth/login

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "email": "john@gmail.com", "password": "123456" }

Get Logged In User via Token | GET {{URL}}/api/v1/auth/me

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

raw

Forgot Password | POST {{URL}}/api/v1/auth/forgotpassword

Description

Generate password token and send email

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "email": "john@gmail.com" }

raw

Reset Password | PUT {{URL}}/api/v1/auth/resetpassword/cd4739d9ae2f1b04299c99e1d4c2bfa0046caf77

Description

Reset user password using token

Headers

Key	Value	Description
Content-Type	application/json	JSON Type

Body

{ "password": "1234567" }

raw

Update User Details | PUT {{URL}}/api/v1/auth/updatedetails

Description

Update logged in user name and email

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "email": "john@gmail.com", "name": "John Doe" }

raw

Update Password | PUT {{URL}}/api/v1/auth/updatepassword

Description

Update logged in user password, send in the body currentPassword and newPassword

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "currentPassword": "1234567", "newPassword": "123456" }

Logout User | GET {{URL}}/api/v1/auth/logout

Description

Clear token cookie

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Hackathons 7

Hackathons CRUD functionality

Get All Hackathons | GET {{URL}}/api/v1/hackathons

Description

Fetch all hackathons from database. Includes pagination, filtering, etc

Get Single Hackathon | GET {{URL}}/api/v1/hackathons/5d90afc3a5c9f7592c0712e4

Description

Get single hackathon by ID

raw

Create New Hackathon | POST {{URL}}/api/v1/hackathons

Description

Add new hackathon to database. Must be authenticated and must be publisher or admin. Only 1 hackathon allowed per publisher

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "name": "ModernTech Hackathon", "description": "ModernTech has one goal, and that is to make you a rockstar developer and/or designer with a six figure salary. We teach both development and UI/UX", "website": "https://moderntech.com", "phone": "(222) 222-2222", "email": "enroll@moderntech.com", "address": "220 Pawtucket St, Lowell, MA 01854", "careers": ["Web Development", "UI/UX", "Mobile Development"], "housing": false, "jobAssistance": true, "jobGuarantee": false, "acceptGi": true }

raw

Update Hackathon | PUT {{URL}}/api/v1/hackathons/5d713a66ec8f2b88b8f830b8

Description

Update single hackathon in database

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "careers": ["Web Development", "UI/UX"] }

Delete Hackathon | DELETE {{URL}}/api/v1/hackathons/5d713a66ec8f2b88b8f830b8

Description

Delete hackathon from database

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Get Hackathons By Distance | GET {{URL}}/api/v1/hackathons/radius/02118/10

Description

Get hackathons within a radius of a specific zipcode

formdata

Upload Photo | PUT {{URL}}/api/v1/hackathons/5d725a1b7b292f5f8ceff788/photo

Description

Route to upload a hackathon photo

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

Key	Value	Description
file
Autho

Courses 6

Create, read, update and delete courses

Get All Courses | GET {{URL}}/api/v1/courses

Description

Get all courses in database

Get Courses For Hackathon | GET {{URL}}/api/v1/hackathons/5d713995b721c3bb38c1f5d0/courses

Description

Get the specific courses for a hackathon

Get Single Course | GET {{URL}}/api/v1/courses/5d725c84c4ded7bcb480eaa0

Description

Get a single course by its ID

raw

Create Course | POST {{URL}}/api/v1/hackathons/5d725a1b7b292f5f8ceff788/courses

Description

Create a course for a specific hackathon

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "title": "Full Stack Web Development", "description": "In this course you will learn full stack web development, first learning all about the frontend with HTML/CSS/JS/Vue and then the backend with Node.js/Express/MongoDB", "weeks": 12, "tuition": 10000, "minimumSkill": "intermediate", "scholarhipsAvailable": true }

raw

Update Course | PUT {{URL}}/api/v1/courses/5d725c84c4ded7bcb480eaa0

Description

Update course in database

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "tuition": 13000, "minimumSkill": "advanced" }

Delete Course | DELETE {{URL}}/api/v1/courses/5d725c84c4ded7bcb480eaa0

Description

Remove course from database

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Reviews 6

Manage course reviews

Get All Reviews | GET {{URL}}/api/v1/reviews

Description

Get all reviews from database and populate with hackathon name and description

Get Reviews For Hackathon | GET {{URL}}/api/v1/hackathons/5d725a1b7b292f5f8ceff788/reviews

Description

Fetch the reviews for a specific hackathon

Get Single Review | GET {{URL}}/api/v1/reviews/5d7a514b5d2c12c7449be027

Description

Fetch a review from database by id and populate Hackathon name and description

raw

Add Review For Hackathon | POST {{URL}}/api/v1/hackathons/5d725a1b7b292f5f8ceff788/reviews

Description

Insert review for a specific hackathon

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "title": "Nice Hackathon", "text": "I learned a lot", "rating": 8 }

raw

Update Review | PUT {{URL}}/api/v1/reviews/5da0942ee0b3f01c6d89f053

Description

Update review in database

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "title": "Had Fun" }

Delete Review | DELETE {{URL}}/api/v1/reviews/5da0942ee0b3f01c6d89f053

Description

Remove review from database

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Query

Key	Value	Description
Autho

Users 5

CRUD functionality for users only available to admin users

Get All Users | GET {{URL}}/api/v1/users

Description

Get all users (admin)

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Get Single User | GET {{URL}}/api/v1/users/5c8a1d5b0190b214360dc038

Description

get single user by id (admin)

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

raw

Create User | POST {{URL}}/api/v1/users/

Description

Add user to database (admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "name": "Nate Smith", "email": "nate@gmail.com", "password": "123456" }

raw

Update User | PUT {{URL}}/api/v1/users/5d98b144deacc60761649c61

Description

Update user in database (admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON Type
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Body

{ "name": "Nate Johnson" }

Delete User | DELETE {{URL}}/api/v1/users/5d98b144deacc60761649c61

Description

Delete user from database (admin)

Headers

Key	Value	Description
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkN2E1MTRiNWQyYzEyYzc0NDliZTA0NSIsImlhdCI6MTU3MTA1NzkzMywiZXhwIjoxNTczNjQ5OTMzfQ.rTumDmWSKzoiGrarbCRqpVBVVfHo5su4TNagQM6c2Ts

Query

Key	Value	Description
Author