Student Statuses API

[arafaysaleem]

Description

This epic is a goal of the larger epic of Students API and contains functionality for student status assignment in our project. This epic requires multiple endpoints to be setup and tested along with their detailed documentation.

Initiative / goal

We want to be able to manage student statuses so that students can choose from them while operating their account. These student statuses are also used to match similar students.

Hypothesis

The API must provide management of student statuses. This epic is considered complete when the following features are complete:

• Student Statuses Management
• Documentation
• Tests

Acceptance criteria and must have scope

We must have Authentication API setup prior to this. In the end we need to have a collection of following endpoints:

• GET All Student Statuses As a student, I should be able to get all possible student statuses, so that I can set one while using the app #53
• GET A Single Student Status As a student, I should be able to get details of a student status, so that I can understand what information it represents #54
• POST A New Student Status 🔒 As a admin, I should be able to create student statuses, so that students can select one while using the app #52
• PATCH A Student Status 🔒 As a admin, I should be able to update the details of a student status, so that I can fix old or inconsistent entries #56
• DELETE A Student Status 🔒 As a admin, I should be able to delete student statuses, so that I can remove old or inconsistent entries #55

Note: 🔒 symbol indicates the route is protected and accessible to admin only

Stakeholders

None

Timeline

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

[arafaysaleem]

The possible student statuses could be:

• looking for friends
• looking for transport
• looking for help
• looking for food

[arafaysaleem]

Completed