ChukwurahVictor / online-tutorial-app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Online-tutor-app

An online tutor app API Documentation

heroku: https://online-tutorial-app.herokuapp.com/

GENERAL (STUDENTS, TUTORS, ADMIN)

Endpoints

POST /signup - To signup a new student/tutor
POST /login - To login as a student/tutor
GET /subjects - To retrieve a subject in a category
GET /subjects/:subjectId - To retrieve a category and all its subjects
GET /category - To get all categories
GET /subjects/search - To search for subjects sorted alphabetically
GET /tutors/sort/first_name - To search for tutors by first name sorted alphabetically

STUDENTS

Endpoints

GET /subject/:subjectId - To see all tutors taking a subject
POST /lessons - To book a lesson

TUTORS

Endpoints

POST /registered-subjects - To register a subject as a tutor
GET /registered-subjects - To get all subjects registered
PATCH /registered-subjects - To update a registered subject
DELETE /registered-subjects - To delete a registered subject

ADMIN

Endpoints

POST /admin/subjects - create a new subject
PATCH /admin/subjects - update a subject
PATCH /admin/category - update a category
DELETE /admin/subjects/:subjectId - delete a subject
PATCH /admin/category - update a category
DELETE /admin/category/:categoryId - delete a category
GET /admin/tutors - retrieve all tutors
GET /admin/tutors/:tutorId - get a tutor
DELETE /admin/tutors/:tutorId - deactivate a tutor
POST /admin/lessons - book lesson
GET /admin/lessons - get all lessons
GET /admin/lessons/:lessonId - get a lesson
PATCH /admin/lessons/:lessonId - update a lesson
DELETE /admin/lessons/:lessonId - delete a lesson

About


Languages

Language:JavaScript 100.0%