diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index e997e2f..89e6d79 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -37,9 +37,9 @@ The School Management API Documentation, defining all functions and their purpos * [Name](#update-teacher-name) - **(Not Documented)** * [Homeroom](#update-teacher-homeroom) - **(Not Documented)** * [Password](#update-teacher-password) - **(Not Documented)** + * [Email](#update-teacher-email) - **(Not Documented)** * [Address](#update-teacher-address) - **(Not Documented)** * [Photo](#update-teacher-photo) - **(Not Documented)** - * [Email](#update-teacher-email) - **(Not Documented)**

* **Update Admin...** * [Name](#update-admin-name) - **(Coming Soon)** @@ -367,7 +367,7 @@ There are several account that can be registered into the system. As you may gue { "success": true, "message": "successfully logged into teacher", - "admin:" + "teacher:" } ``` @@ -389,9 +389,366 @@ There are several account that can be registered into the system. As you may gue { "success": true, "message": "successfully logged into teacher", - "admin:" + "student:" } ```
+## Updating Account Information + ++ ### Update Student Name + **Method:** `POST` + ``` + /student/updateName + ``` + + **Required:** + * Logged into an admin account + * JSON: + ``` + { + "sid": "123456", + "firstname": "Lisa", + "middlename": "Marie", // (OPTIONAL) + "lastname": "Simpson" + } + ``` + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated student" + } + ``` + +

+ ++ ### Update Student Grade Level + **Method:** `POST` + ``` + /student/updateGradeLevel + ``` + + **Required:** + * Logged into an admin account + * JSON": + ``` + { + "sid": "123456", + "gradelevel": 11 + } + ``` + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated student" + } + ``` + +

+ ++ ### Update Student Homeroom + **Method:** `POST` + ``` + /student/updateHomeroom + ``` + + **Required:** + * Logged into an admin account + * JSON: + ``` + { + "sid": "123456", + "homeroom": "A123" + } + ``` + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated student" + } + ``` + +

+ ++ ### Update Student Locker + **Method:** `POST` + ``` + /student/updateLocker + ``` + + **Required:** + * Logged into an admin account + * JSON: + ``` + { + "sid": "123456", + "lockernumber": "B123" + } + ``` + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated student" + } + ``` + +

+ ++ ### Update Student Year of Graduation + **Method:** `POST` + ``` + /student/updateYOG + ``` + + **Required:** + * Logged into an admin account + * JSON: + ``` + { + "sid": "123456", + "yog": 2020 + } + ``` + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated student" + } + ``` + +

+ ++ ### Update Student Password + **Method:** `POST` + ``` + /student/updatePassword + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Student Email + **Method:** `POST` + ``` + /student/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Student Address + **Method:** `POST` + ``` + /student/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Student Photo + **Method:** `POST` + ``` + /student/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Name + **Method:** `POST` + ``` + /teacher/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Homeroom + **Method:** `POST` + ``` + /teacher/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Password + **Method:** `POST` + ``` + /teacher/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Email + **Method:** `POST` + ``` + /teacher/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Address + **Method:** `POST` + ``` + /teacher/ + ``` + + **Required:** + * Logged into an admin account + + **Returns:** + * Status 200: `OK` + * JSON: + ``` + { + "success": true, + "message": "successfully updated" + } + ``` + +

+ ++ ### Update Teacher Photo + **Coming Soon...** + +

+ ++ ### Update Admin Name + **Coming Soon...** + +

+ ++ ### Update Admin Password + **Coming Soon...** + +

+ ++ ### Update Admin Email + **Coming Soon...** + +

+ ++ ### Update Admin Photo + **Coming Soon...** + +