Complete REST API

[arafaysaleem]

Description

This epic is a large component of the overall project and is used to communicate between our server and our apps. This epic needs to prepare a working, fully functional REST API with multiple endpoints for use cases.

Initiative / goal

It is high impact since it used to communicate between our server and our apps so without this the project can not work.

Hypothesis

A documented API is received in the end containing all functionalities for the project. These are the endpoint collections it must have:

• Students API #9
• Activities API #14
• Activity Statuses API #12
• Activity Types API #13
• Student Statuses API #5
• Programs API #8
• Campuses API #7
• Campus Spots API #11
• Hobbies API #3
• Interests API #4
• Student Connections API #15
• Friends API #16
• Hangout Requests API #17
• Reaction Types API #19
• Posts API #18
• Teachers API #21
• Subjects API #22
• Teacher Reviews API #23
• Timeslots API #20
• Classrooms API #24
• Classes API #25
• Timetables API #26
• Timetable Share Rooms API #27
• Health Check

Acceptance criteria and must have scope

We need documentation, tested API endpoint URLs, Postman collection for each endpoints and a backup of the database schema and data.

Stakeholders

@diablo-shotgun @sfurqan2 are members of the engineering team who will verify the completion.

Timeline

3 months is the approximate timeline, a working deployable server is needed for the API as well as the DB instance. Currently, there are no identified blockers.