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

Update documentation

Browse Source
This commit is contained in:
SowinskiBraeden committed 2022-08-15 20:42:38 -07:00
1 parent 06e0eea782
commit 1bd0da305d
1 file changed
+17 -11
Download Patch File Download Diff File Expand all files Collapse all files
DOCUMENTATION.md
+17 -11
View File
@@ -158,7 +158,9 @@ There are several account that can be registered into the system. As you may gue
"firstname": "John", "firstname": "John",
"lastname": "Doe", "lastname": "Doe",
"dob": "01-01-1999", "dob": "01-01-1999",
"email": "john_doe@example.com" "email": "john_doe@example.com",
"password1": "mySuperSecurePassword",
"password2": "mySuperSecurePassword"
} }
``` ```
@@ -191,7 +193,9 @@ There are several account that can be registered into the system. As you may gue
"middlename": "Jay", "middlename": "Jay",
"lastname": "Simson", "lastname": "Simson",
"dob": "12-05-1956", "dob": "12-05-1956",
"email": "homerdog_simpson@example.com" "email": "homer_simpson@example.com",
"password1": "homerLovesDuffBeer123",
"password2": "homerLovesDuffBeer123"
} }
``` ```
@@ -227,7 +231,9 @@ There are several account that can be registered into the system. As you may gue
"province": "...", "province": "...",
"city": "Springfield", "city": "Springfield",
"address": "742 Evergreen Terrace", "address": "742 Evergreen Terrace",
"postal": "..." "postal": "...",
"password1": "I_am_el_barto_5",
"password2": "I_am_el_barto_5"
} }
``` ```
@@ -237,7 +243,7 @@ There are several account that can be registered into the system. As you may gue
```jsonc ```jsonc
{ {
"success": true, "success": true,
"successfully inserted student" "message": "successfully inserted student"
} }
``` ```
@@ -278,7 +284,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"
@@ -709,7 +715,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
{ {
"tid": "123456", "tid": "123456",
"homeroom": "A123" "homeroom": "A123"
@@ -884,7 +890,7 @@ There are several account that can be registered into the system. As you may gue
* JSON: * JSON:
```jsonc ```jsonc
{ {
"firstname": "seymour_skinner@example.com" "email": "seymour_skinner@example.com"
} }
``` ```
@@ -926,7 +932,7 @@ There are several account that can be registered into the system. As you may gue
"message": "successfully updated admin password" "message": "successfully updated admin password"
} }
``` ```
* Emails admin ab alert of password change * Emails admin an alert of password change
<br></br> <br></br>
@@ -949,7 +955,7 @@ In the case of an emergency for a specified student, a contact is required to be
"middlename": "Jacqueline", // (optional) "middlename": "Jacqueline", // (optional)
"lastname": "Simpson", "lastname": "Simpson",
"homephone": "123-456-7890", "homephone": "123-456-7890",
"workphone": "098-765-4321" "workphone": "098-765-4321",
"email": "therealmarge@example.com", "email": "therealmarge@example.com",
"priority": 1, // 1 is highest priority, 10 is least priority "priority": 1, // 1 is highest priority, 10 is least priority
"relation": "mother", "relation": "mother",
@@ -969,7 +975,7 @@ In the case of an emergency for a specified student, a contact is required to be
"message": "successfully inserted contact to student" "message": "successfully inserted contact to student"
} }
``` ```
* Emails admin ab alert of password change * Emails admin an alert of password change
<br></br> <br></br>
@@ -986,7 +992,7 @@ In the case of an emergency for a specified student, a contact is required to be
{ {
"_id": "<contact object id>", "_id": "<contact object id>",
"firstname": "Marge", "firstname": "Marge",
"middlename": "" // (optional) "middlename": "", // (optional)
"lastname": "Simpson" "lastname": "Simpson"
} }
``` ```