Students API

[arafaysaleem]

Description

This epic is a sub goal of the epic for Complete REST API and provides functionality surrounding students. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

This API impacts all our modules as without students we can't create timetables, activities or any connections for our project and we can't proceed. We want to be able to manage activities. We want to build and search connections. We want to be able to post memories. We want to allow generating and sharing timetables. We should work on this immediately after setting up Preferences APIs.

Hypothesis

We must have Authentication, Hobbies, Interests, Universities, Campuses, Programs and User Statuses API setup prior to this. The following is true by the end of this API

• We can query/manage possible profile of a student
• We can query/manage possible organized activities of a student Activities API #14
• We can query/manage possible saved activities of a student Activities API #14
• We can query/manage possible attending activities of a student Activities API #14

Acceptance criteria and must have scope

In the end we need to have a collection of following endpoints:

• GET All Students As an admin, I should be able to get all possible students, so that I can review their profiles #67
• [GET] A Student's Organized Activities #105
• [GET] A Student's Attending Activities #106
• [GET] A Student's Saved Activities #107
• GET A Single Student As a student, I should be able to get details of another student, so that I can view their profile and interact with them #68
• PATCH A Student As a student, I should be able to update my account details, so that I can improve or change my profile #69
• DELETE A Student As a admin, I should be able to delete students, so that I can remove old or inconsistent entries #70
• Documentation For Each Endpoint
• Tests For Each Endpoint

Stakeholders

None

Timeline

5 weeks are needed to setup all the foundation, along with testing and documentation. No blockers expected.

[arafaysaleem]

This Epic has 3 stages:

1. First 7 starting days we will work on the base functionality of this API.
2. Sub epics will begin and continue till 3 days before the deadline.
3. Remaining 3 days, after sub epics are complete, will be used to check each of their functionalities in combination for this API's endpoints e.g. Get a student's activities after Activities API complete.

[arafaysaleem]

Merging of #222 completed this epic, after all related relevant APIs were finished and the combined functionality was tested.