diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index e358480..93987ec 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -44,6 +44,15 @@ The School Management API Documentation, defining all functions and their purpos * [Password](#update-admin-password) - **(Coming Soon)** * [Email](#update-admin-email) - **(Coming Soon)** * [Photo](#update-admin-photo) - **(Coming Soon)** +* [Managing Contacts](#managing-contacts) - **(Not Documented)** + * [Create Contact](#create-contact) - **(Not Documented)** + * [Update Contact Name](#update-contact-name) - **(Not Documented)** + * [Update Contact Address](#update-contact-address) - **(Not Documented)** + * [Update Contact Home Phone](#update-contact-home-phone) - **(Not Documented)** + * [Update Contact Work Phone](#update-contact-work-phone) - **(Not Documented)** + * [Update Contact Email](#update-contact-email) - **(Not Documented)** + * [Update Contact Priority](#update-contact-priority) - **(Not Documented)** + * [Delete Contact](#delete-contact) - **(Not Documented)**
@@ -131,7 +140,7 @@ There are several account that can be registered into the system. As you may gue **Method:** `POST` ``` - /admin/create + /api/v1/admin/create ``` **Required:** @@ -163,7 +172,7 @@ There are several account that can be registered into the system. As you may gue **Method:** `POST` ``` - /teacher/register + /api/v1/teacher/register ``` **Required:** @@ -194,7 +203,7 @@ There are several account that can be registered into the system. As you may gue **Method:** `POST` ``` - /student/enroll + /api/v1/student/enroll ``` **Required:** @@ -247,7 +256,7 @@ There are several account that can be registered into the system. As you may gue + ### Logging into Admin **Method:** `POST` ``` - /admin/login + /api/v1/admin/login ``` **Required:** @@ -274,7 +283,7 @@ There are several account that can be registered into the system. As you may gue + ### Logging into Teacher **Method:** `POST` ``` - /teacher/login + /api/v1/teacher/login ``` **Required:** @@ -301,7 +310,7 @@ There are several account that can be registered into the system. As you may gue + ### Logging into Student **Method:** `POST` ``` - /student/login + /api/v1/student/login ``` **Required:** @@ -330,7 +339,7 @@ There are several account that can be registered into the system. As you may gue + ### Get Admin Account **Method:** `GET` ``` - /admin + /api/v1/admin ``` **Required:** @@ -352,7 +361,7 @@ There are several account that can be registered into the system. As you may gue + ### Get Teacher Account **Method:** `GET` ``` - /teacher + /api/v1/teacher ``` **Required:** @@ -374,7 +383,7 @@ There are several account that can be registered into the system. As you may gue + ### Get Student Account **Method:** `GET` ``` - /student + /api/v1/student ``` **Required:** @@ -398,7 +407,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Name **Method:** `POST` ``` - /student/updateName + /api/v1/student/updateName ``` **Required:** @@ -428,7 +437,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Grade Level **Method:** `POST` ``` - /student/updateGradeLevel + /api/v1/student/updateGradeLevel ``` **Required:** @@ -456,7 +465,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Homeroom **Method:** `POST` ``` - /student/updateHomeroom + /api/v1/student/updateHomeroom ``` **Required:** @@ -484,7 +493,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Locker **Method:** `POST` ``` - /student/updateLocker + /api/v1/student/updateLocker ``` **Required:** @@ -512,7 +521,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Year of Graduation **Method:** `POST` ``` - /student/updateYOG + /api/v1/student/updateYOG ``` **Required:** @@ -540,7 +549,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Password **Method:** `POST` ``` - /student/updatePassword + /api/v1/student/updatePassword ``` **Required:** @@ -570,7 +579,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Email **Method:** `POST` ``` - /student/updateEmail + /api/v1/student/updateEmail ``` **Required:** @@ -600,7 +609,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Address **Method:** `POST` ``` - /student/updateAddress + /api/v1/student/updateAddress ``` **Required:** @@ -631,7 +640,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Student Photo **Method:** `POST` ``` - /student/updatePhoto + /api/v1/student/updatePhoto ``` **Required:** @@ -657,7 +666,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Name **Method:** `POST` ``` - /teacher/updateName + /api/v1/teacher/updateName ``` **Required:** @@ -687,7 +696,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Homeroom **Method:** `POST` ``` - /teacher/updateHomeroom + /api/v1/teacher/updateHomeroom ``` **Required:** @@ -715,7 +724,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Password **Method:** `POST` ``` - /teacher/updatePassword + /api/v1/teacher/updatePassword ``` **Required:** @@ -745,7 +754,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Email **Method:** `POST` ``` - /teacher/updateEmail + /api/v1/teacher/updateEmail ``` **Required:** @@ -775,7 +784,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Address **Method:** `POST` ``` - /teacher/updateAddress + /api/v1/teacher/updateAddress ``` **Required:** @@ -806,7 +815,7 @@ There are several account that can be registered into the system. As you may gue + ### Update Teacher Photo **Method:** `POST` ``` - /teacher/updatePhoto + /api/v1/teacher/updatePhoto ``` **Required:** @@ -848,3 +857,84 @@ There are several account that can be registered into the system. As you may gue **Coming Soon...**

+ +## Managing Conacts +**To be Documented...** + ++ ### Creating Contact + **To be Documented...** + +

+ ++ ### Update Contact Name + **To be Documented...** + +

+ ++ ### Update Contact Address + **To be Documented...** + +

+ ++ ### Update Contact Home Phone + **To be Documented...** + +

+ ++ ### Update Contact Work Phone + **To be Documented...** + +

+ ++ ### Update Contact Email + **To be Documented...** + +

+ ++ ### Update Contact Priority + **To be Documented...** + +

+ ++ ### Delete Conotact + **To be Documented...** + +

+ +## Remove Users +**To be Documented...** + ++ ### Remove Admin + **To be Documented...** + +

+ ++ ### Remove Teacher + **To be Documented...** + +

+ ++ ### Remove Student + **To be Documented...** + +

+ +### Admin Commands +Administrators play a very important role in managing a school, they do much work behind the scenes to make sure that everything is correctly organized and working. + ++ ### Update Locker Combination + **To be Documented...** + +

+ ++ ### Enable Student Account + In the case a students acount has been disabled, an admin would require to enable the account. + + **To be Documented...** +

+ ++ ### Enable Teacher Account + In the case a teachers acount has been disabled, an admin would require to enable the account. + + **To be Documented...** +