Light

ssentinull / teman-tutor Goto Github PK

View Code? Open in Web Editor NEW

2.0 0.0 1.0 326 KB

An meeting point for Tutors and College Students in need of assistance in their studies

PHP 100.00%

teman-tutor's Introduction

API Documentation:

Add User

POST: '/users'
Header: -
Body: email, password, name, gender(string), birth_date(date), address
Return Format: json
Data returned: email, name, gender, birth_date, address, created_at, updated_at
Controller Used: UsersController
Method Called: add(Request $request)

View a Single User

GET: '/users/{id}'
Header: -
Body: -
Return Format: json
Data returned: id, email, name, gender, birth_date, address, created_at, updated_at
Controller Used: UsersController
Method Called: view($id)

View the Groups that a User is enrolled in

GET: '/users/{id}/groups'
Header: remember_token
Body: -
Return Format: json-array
Data returned: id, name, desc, course_id, created_at, updated_at
Controller Used: UsersController
Method Called: groups($id)

Edit a Single User

PUT: '/users/{id}'
Header: remember_token
Body: email, password, name, gender(string), birth_date(date), address
Return Format: json
Data returned: id, email, name, gender, birth_date, address, created_at, updated_at
Controller Used: UsersController
Method Called: edit(Request $request, $id)

Delete a Single User

DELETE: '/users/{id}'
Header: remember_token
Body: -
Return Format: json
Data returned: 'Removed Succesfully'
Controller Used: UsersController
Method Called: delete($id)

View All Users

GET: '/users'
Header: -
Body: -
Return Format: json-array
Data returned: id, email, name, gender, birth_date, address, created_at, updated_at
Controller Used: UsersController
Method Called: allUsers()

Add a Group

POST: '/groups'
Header: remember_token
Body: name, desc, course_id, user_id
Return Format: json
Data returned:
- from Groups Table; id, name, desc, course_id, created_at, updated_at
- from Group_User Table; id, user_id, is_admin, is_accepted, created_at, updated_at
Controller Used: GroupsController
Method Called: add(Request $request) (the request should also include the $id of the User who created the Group)

View a Single Group

GET: '/groups/{id}'
Header: -
Body: -
Return Format: json
Data returned: id, name, desc, course_id, created_at, updated_at
Controller Used: GroupsController
Method Called: view($id)

View all the Users that belong to a Single Group

GET: '/groups/{id}/users'
Header: -
Body: -
Return Format: json-array
Data returned: id, email, name, gender, birth_date, address, remember_token, created_at, updated_at
Controller Used: GroupsController
Method Called: users($id)

Edit a Single Group

PUT: '/groups/{id}'
Header: remember_token
Body: name, desc, course_id
Return Format: json
Data returned: id, name, desc, course_id, created_at, updated_at
Controller Used: GroupsController
Method Called: edit(Request $request, $id)

Delete a Single Group

DELETE: '/groups/{id}'
Header: remember_token
Body: -
Return Format: json
Data returned: "Removed Successfully"
Controller Used: GroupsController
Method Called: delete($id)

View All Groups

GET: '/groups'
Header: -
Body: -
Return Format: json-array
Data returned: id, name, desc, course_id, created_at, updated_at
Controller Used: GroupsController
Method Called: allGroups()

A User wants to Join a Group

POST: '/groups/{group_id}/{user_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: group_id, user_id, is_admin = 0, is_accepted = 0 (data is fetched from Group_User Table)
Controller Used: Group_UserController
Method Called: addUser($group_id, $user_id)

A User is Accepted to a Group

PUT: '/groups/{group_id}/{user_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: group_id, user_id, is_admin = 0, is_accepted = 1 (data is fetched from Group_User Table)
Controller Used: Group_UserController
Method Called: accept($group_id, $user_id)

A User is Set to be an Admin of a Group

PUT: '/admin/{group_id}/{user_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: group_id, user_id, is_admin = 1, is_accepted = 1 (data is fetched from Group_User Table)
Controller Used: Group_UserController
Method Called: setAdmin($group_id, $user_id)

Remove a User from a Group

DELETE: '/groups/{group_id}/{user_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: "Remove \ Cancel \ Decline Successfully"
Controller Used: Group_UserController
Method Called: removeUser($group_id, $user_id)

A User wants to Login to his/her Account

POST: '/login'
Header: -
Body: email, password
Return Format: json
Data returned: id, email, name, gender, birth_date, address, remember_token, created_at, updated_at
Controller Used: AuthentificationsController
Method Called: login(Request $request)

A User wants to Logout to his/her Account

POST: '/logout'
Header: remember_token
Body: email
Return Format: json
Data returned: "Logout Successful"
Controller Used: AuthentificationsController
Method Called: logout(Request $request)

Add a Course

POST: '/courses'
Header: -
Body: name, desc
Return Format: json
Data returned: id, name, desc, created_at, updated_at
Controller Used: CoursesController
Method Called: add(Request $request)
Additional Info: This method is done directly to the DB through phpmyadmin

View a Course

GET: '/courses/{id}'
Header: -
Body: -
Return Format: json
Data returned: id, name, desc, created_at, updated_at
Controller Used: CoursesController
Method Called: view($id)

View the Groups that studies a particular Course

GET: '/courses/{id}/groups'
Header: -
Body: -
Return Format: json-array
Data returned: id, name, desc, course_id, created_at, updated_at (data is fetched from Groups Table)
Controller Used: CoursesController
Method Called: groups($course_id)

View the Tutors that teaches a particular Course

GET: '/courses/{id}/tutors'
Header: -
Body: -
Return Format: json-array
Data returned: id, name, desc, course_id, created_at, updated_at (data is fetched from Groups Table)
Controller Used: CoursesController
Method Called: tutors($course_id)

Edit a Course

PUT: '/courses/{id}'
Header: -
Body: name, desc
Return Format: json
Data returned: id, name, desc, created_at, updated_at
Controller Used: CoursesController
Method Called: edit(Request $request, $id)
Additional Info: This method is done directly to the DB through phpmyadmin

Delete a Course

DELETE: '/courses/{id}'
Header: -
Body: -
Return Format: json
Data returned: "Removed Successfully"
Controller Used: CoursesController
Method Called: delete($id)
Additional Info: This method is done directly to the DB through phpmyadmin

View all of the Courses

GET: '/courses'
Header: -
Body: -
Return Format: json-array
Data returned: id, name, desc, created_at, updated_at
Controller Used: CoursesController
Method Called: allCourses()

Add Tutor

POST: '/tutors'
Header: -
Body: email, password, name, gender(string), birth_date(date), address, price_rate, ipk, course_id
Return Format: json
Data returned: email, name, gender, birth_date, address, price_rate, ipk, course_id created_at, updated_at
Controller Used: TutorsController
Method Called: add(Request $request)

View a Single Tutor

GET: '/tutors/{id}'
Header: -
Body: -
Return Format: json
Data returned: id, email, name, gender, birth_date, address, price_rate, ipk, course_id created_at, updated_at
Controller Used: TutorsController
Method Called: view($id)

Edit a Single Tutor

PUT: '/tutors/{id}'
Header: remember_token
Body: email, password, name, gender(string), birth_date(date), address, price_rate, ipk, course_id
Return Format: json
Data returned: id, email, name, gender, birth_date, address, created_at, updated_at
Controller Used: TutorsController
Method Called: edit(Request $request, $id)

Delete a Single Tutor

DELETE: '/tutors/{id}'
Header: remember_token
Body: -
Return Format: json
Data returned: 'Removed Succesfully'
Controller Used: TutorsController
Method Called: delete($id)

View All Tutors

GET: '/tutors'
Header: -
Body: -
Return Format: json-array
Data returned: id, email, name, gender, birth_date, address, price_rate, ipk, course_id created_at, updated_at
Controller Used: TutorsController
Method Called: allTutors()

Create a new Appointment

POST: '/apps/{group_id}/{tutor_id}'
Header: remember_token
Body: date, place, subject
Return Format: json
Data returned: date, place, subject, is_accepted = 0, created_at, updated_at
Controller Used: Group_TutorController
Method Called: create(Request $request, $group_id, $tutor_id)

View a User's Appointments

GET: '/apps/{tutor_id}'
Header: remember_token
Body: -
Return Format: json-array
Data returned: id, group_id, tutor_id, date, place, subject, is_accepted, created_at, updated_at
Controller Used: Group_TutorController
Method Called: userApps($tutor_id)

Edit a Single Appointment

PUT: '/apps/{group_id}/{user_id}'
Header: remember_token
Body: date, place, subject
Return Format: json
Data returned: id, date, place, subject, is_accepted = 0, created_at, updated_at
Controller Used: Group_TutorController
Method Called: edit(Request $request, $group_id, $user_id)

Accept an Appointment

PUT: '/accept/{group_id}/{tutor_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: id, date, place, subject, is_accepted = 1, created_at, updated_at
Controller Used: Group_TutorController
Method Called: accept($group_id, $tutor_id)

Decline an Appointment

DELETE: '/decline/{group_id}/{tutor_id}'
Header: remember_token
Body: -
Return Format: json
Data returned: 'Removed Succesfully'
Controller Used: Group_TutorController
Method Called: delete($group_id, $tutor_id)

Create a New Message

POST: '/messages'
Header: remember_token
Body: group_id, user_id, message
Return Format: json
Data returned: group_id, user_id, message, created_at, updated_at
Controller Used: MessagesController
Method Called: add(Request $request)

View Messages of a Group

GET: '/messages/{group_id}'
Header: remember_token
Body: -
Return Format: json-array
Data returned: group_id, user_id, message, created_at, updated_at
Controller Used: MessagesController
Method Called: view($group_id)

Delete a Single Message from a Group

DELETE: '/messages/{id}'
Header: remember_token
Body: -
Return Format: json
Data returned: 'Removed Succesfully'
Controller Used: MessagesController
Method Called: delete($id)

teman-tutor's People

Contributors

Stargazers

Forkers

fahmifan

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.