SowinskiBraeden/school-management-api
1
0 Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update DOCUMENTATION.md

Browse Source
This commit is contained in:
SowinskiBraeden authored and GitHub committed 2022-06-10 12:29:29 -07:00
1 parent 596533753c
commit ca4020f0ee
1 file changed
+65 -49
Download Patch File Download Diff File Expand all files Collapse all files
DOCUMENTATION.md
+65 -49
View File
@@ -1,5 +1,3 @@
# School Management API Documentation # School Management API Documentation
The School Management API Documentation, defining all functions and their purpose. As well as how to use the API, how to properly call functions and provide the necessary fields. The School Management API Documentation, defining all functions and their purpose. As well as how to use the API, how to properly call functions and provide the necessary fields.
@@ -23,12 +21,12 @@ The School Management API Documentation, defining all functions and their purpos
* [Get Student Account](#get-student-account) * [Get Student Account](#get-student-account)
* [Updating Account information](#updating-accounts) - **(Not Documented)** * [Updating Account information](#updating-accounts) - **(Not Documented)**
* **Update Student...** * **Update Student...**
* [Name](#update-student-name) - **(Not Documented)** * [Name](#update-student-name)
* [Grade Level](#update-student-grade-level) - **(Not Documented)** * [Grade Level](#update-student-grade-level)
* [Homeroom](#update-student-homeroom) - **(Not Documented)** * [Homeroom](#update-student-homeroom)
* [Locker](#update-student-locker) - **(Not Documented)** * [Locker](#update-student-locker)
* [YOG](#update-student-year-of-graduation) - **(Not Documented)** * [YOG](#update-student-year-of-graduation)
* [Password](#update-student-password) - **(Not Documented)** * [Password](#update-student-password)
* [Email](#update-student-email) - **(Not Documented)** * [Email](#update-student-email) - **(Not Documented)**
* [Address](#update-student-address) - **(Not Documented)** * [Address](#update-student-address) - **(Not Documented)**
* [Photo](#update-student-photo) - **(Not Documented)** * [Photo](#update-student-photo) - **(Not Documented)**
@@ -55,7 +53,7 @@ The School Management API Documentation, defining all functions and their purpos
The API is an all in one package and is simple and easy to deploy. Eliminating any long unforgiving configurations you may face in other software. The API is an all in one package and is simple and easy to deploy. Eliminating any long unforgiving configurations you may face in other software.
1. Clone the repo 1. Clone the repo
``` ```bash
$ git clone https://github.com/SowinskiBraeden/school-management-api $ git clone https://github.com/SowinskiBraeden/school-management-api
$ cd school-management-api $ cd school-management-api
``` ```
@@ -63,7 +61,7 @@ The School Management API Documentation, defining all functions and their purpos
2. Rename `.env.example` to `.env` 2. Rename `.env.example` to `.env`
3. Enter desired values into `.env` 3. Enter desired values into `.env`
``` ```bash
mongoURI='your mongo URI' mongoURI='your mongo URI'
dbo='school' dbo='school'
secret='your 256 bit secret' secret='your 256 bit secret'
@@ -78,14 +76,14 @@ The School Management API Documentation, defining all functions and their purpos
``` ```
4. Run the system in your terminal 4. Run the system in your terminal
``` ```bash
$ go run main.go $ go run main.go
``` ```
Or... Or...
5. Build and compile the system into an executable 5. Build and compile the system into an executable
``` ```bash
$ go build $ go build
``` ```
@@ -113,7 +111,7 @@ The School Management API Documentation, defining all functions and their purpos
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "the API is active" "message": "the API is active"
@@ -139,7 +137,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
+ Logged into an existing Admin account + Logged into an existing Admin account
+ JSON: + JSON:
``` ```jsonc
{ {
"firstname": "John", "firstname": "John",
"lastname": "Doe", "lastname": "Doe",
@@ -151,7 +149,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
+ Status 200: `OK` + Status 200: `OK`
+ JSON: + JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully inserted admin" "message": "successfully inserted admin"
@@ -171,7 +169,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
+ Logged into an existing Admin account + Logged into an existing Admin account
+ JSON: + JSON:
``` ```jsonc
{ {
"firstname": "Homer", "firstname": "Homer",
"middlename": "Jay", "middlename": "Jay",
@@ -184,7 +182,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
+ Status 200: `OK` + Status 200: `OK`
+ JSON: + JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully inserted teacher" "message": "successfully inserted teacher"
@@ -202,7 +200,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
+ Logged into an existing Admin account + Logged into an existing Admin account
+ JSON: + JSON:
``` ```jsonc
{ {
"firstname": "Bart", "firstname": "Bart",
"middlename": "JoJo", "middlename": "JoJo",
@@ -220,7 +218,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
+ Status 200: `OK` + Status 200: `OK`
+ JSON: + JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"successfully inserted student" "successfully inserted student"
@@ -254,7 +252,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* JSON: * JSON:
``` ```jsonc
{ {
"tid": "123456", "tid": "123456",
"password": "myawesomepassword123" "password": "myawesomepassword123"
@@ -281,7 +279,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* JSON: * JSON:
``` ```jsonc
{ {
"tid": "123456", "tid": "123456",
"password": "myawesomepassword123" "password": "myawesomepassword123"
@@ -291,7 +289,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "correct password" "message": "correct password"
@@ -308,7 +306,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* JSON: * JSON:
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"password": "myawesomepassword123" "password": "myawesomepassword123"
@@ -318,7 +316,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "correct password" "message": "correct password"
@@ -341,7 +339,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully logged into admin", "message": "successfully logged into admin",
@@ -363,7 +361,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully logged into teacher", "message": "successfully logged into teacher",
@@ -385,7 +383,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully logged into teacher", "message": "successfully logged into teacher",
@@ -406,7 +404,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
* JSON: * JSON:
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"firstname": "Lisa", "firstname": "Lisa",
@@ -418,7 +416,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated student" "message": "successfully updated student"
@@ -436,7 +434,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
* JSON": * JSON":
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"gradelevel": 11 "gradelevel": 11
@@ -446,7 +444,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated student" "message": "successfully updated student"
@@ -464,7 +462,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
* JSON: * JSON:
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"homeroom": "A123" "homeroom": "A123"
@@ -474,7 +472,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated student" "message": "successfully updated student"
@@ -492,7 +490,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
* JSON: * JSON:
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"lockernumber": "B123" "lockernumber": "B123"
@@ -502,7 +500,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated student" "message": "successfully updated student"
@@ -520,7 +518,7 @@ There are several account that can be registered into the system. As you may gue
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
* JSON: * JSON:
``` ```jsonc
{ {
"sid": "123456", "sid": "123456",
"yog": 2020 "yog": 2020
@@ -530,7 +528,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated student" "message": "successfully updated student"
@@ -546,33 +544,51 @@ There are several account that can be registered into the system. As you may gue
``` ```
**Required:** **Required:**
* Logged into an admin account * Logged into students account
* JSON:
```jsonc
{
"password": "myOldPassword",
"newpassword1": "myNewPassword",
"newpassword2": "myNewPassword"
}
```
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated student password"
} }
``` ```
* Emails student an alert of password change
<br></br> <br></br>
+ ### Update Student Email + ### Update Student Email
**Method:** `POST` **Method:** `POST`
``` ```
<API_URL>/student/ <API_URL>/student/updateEmail
``` ```
**Required:** **Required:**
* Logged into an admin account * Logged into an admin account
__or__
* Logged into students account
* JSON:
```jsonc
{
"sid": "123456", // (Only required if signed in as admin)
"email": "BartSimpsonsCoolEmail@example.com"
}
```
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -593,7 +609,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -614,7 +630,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -635,7 +651,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -656,7 +672,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -677,7 +693,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -698,7 +714,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"
@@ -719,7 +735,7 @@ There are several account that can be registered into the system. As you may gue
**Returns:** **Returns:**
* Status 200: `OK` * Status 200: `OK`
* JSON: * JSON:
``` ```jsonc
{ {
"success": true, "success": true,
"message": "successfully updated" "message": "successfully updated"