Currently, the Bliep! Framework is the most worked on. The plan is to complete the framework first to enhance the teachers' experience.
After the website for teachers is done, we will update the app's front-
The Bliep! product will be worked on after the app is finished (or atleast releaseable.).
The Bliep! product's pcb and electrical components are already desgined and practically finished.
Here are a few progress bar's (Note: the progress might move back if new features are required and/or requested.):
Framework voor Bliep! docenten website
General Information
The Bliep! Framework has a format for every functions outputs, when calling a function make sure you follow these formats.
The format makes sure that no matter the function you will always have a predictable outcome.
Every function in the Bliep! Framework returns an assosciative array containing the value
successanddata. Thesuccessvalues is a boolean, this means at success the this value will always betrueand thedatavalue will contain the following:
When using a Get() function the
datawill contain an array of the requested data.
When using an Update() function thedatawill contain the amount of affected entries
In every other scenariodatawill probably contain a string containing some info in regards to the completed operation.When
successisfalsedatawill contain the error message.extractResponseData
This is a function you can use to easilly extract
successanddatafrom the function used.
For exampleif (extractResponseData(Auth::CheckLoggedIn(), 'success')) { };can be used to quickly check if the user is logged in, it also returns some data as an array$user = $result->fetch_assoc();but we dont need that data in this case.
But we can also take only thatdataif we want, by changing the'success'to'data'
Students
Get
Returns the requested information from the database about a student.
When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Request Parameters Type Description RequestIdbooleandefault = false RequestNamebooleandefault = false RequestNumberbooleandefault = false RequestEmailbooleandefault = false RequestEducationIdbooleandefault = false RequestSerialNumbIdbooleandefault = false RequestCohortbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Where Parameters Type Description WhereIdstringdefault = null WhereNamestringdefault = null WhereNumberstringdefault = null WhereEmailstringdefault = null WhereEducationIdstringdefault = null WhereSerialNumbIdstringdefault = null WhereCohortstringdefault = null The "RequestedOrder" parameter has 7 values from 0-6 below is a table of there meaning
Additional Parameters Type Description RequestedOrderstringdefault = 0
Requested Order Description 0No order 1order by name ASC 2order by name DESC 3order by email ASC 4order by email DESC 5order by number ASC 6order by number DESC Notes:
- The
Getfunction will always return results in an array for example: [{"StudentName":"John Doe","StudentNumber":"000000","StudentEmail":"000000@vistacollege.nl"}].- The
Getfunction will NEVER return the StudentPassword.
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedNamestringdefault = null RequestedNumberstringdefault = null RequestedEmailstringdefault = null RequestedEducationIdstringdefault = null RequestedSerialNumbIdstringdefault = null The "Where Parameters" are the parameters that select wich student to update. Note: Atleast one "Where Parameter" Should be set.
Where Parameters Type Description WhereIdstringdefault = null WhereNamestringdefault = null WhereNumberstringdefault = null WhereEmailstringdefault = null WhereEducationIdstringdefault = null WhereSerialNumbIdstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one student and if any records exist with the given where statements.- The
Updatefunction can only update ONE student at a time, if you want to update multiple students useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The "Requested Parameters" are the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedNamestringdefault = null RequestedNumberstringdefault = null RequestedEmailstringdefault = null RequestedEducationIdstringdefault = null RequestedSerialNumbIdstringdefault = null The "Where Parameters" are the parameters that select wich student's to update. Note: Atleast one "Where Parameter" Should be set.
Where Parameters Type Description WhereIdstringdefault = null WhereNamestringdefault = null WhereNumberstringdefault = null WhereEmailstringdefault = null WhereEducationIdstringdefault = null WhereSerialNumbIdstringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all student's it can find within the "Where Parameters" so be carefull.
Add
Adds a student to the student database
Insert Parameters Type Description InsertNamestringdefault = null InsertNumberstringdefault = null InsertEmailstringdefault = null InsertEducationIdstringdefault = null InsertSerialNumbIdstringdefault = null InsertCohortstringdefault = null Notes:
- All parameters need to be filled except InsertSerialNumbId wich can stay empty.
Add()uses the functionRandString()once to generate a random password.Add()sends an email to the email set inInsertEmailtelling the user their new password and that they now have an account.
RandString
Generates a random string with desired length.
Parameter Type Description lengthnumberdefault = 16 Notes:
RandString()uses the following characters:
0123456789
abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ
ResetPass
Resets the user's password to a randomly generated 8 character string and sends an email to that user including their new password.
Parameter Type Description WhereIdstringdefault = null Notes:
ResetPass()usesRandString()to generate a new password.ResetPassonly accepts the student's id to update the password to reduce confusion and accidental wrongfull password reset.
Delete
Delete does not actually remove the user from the database but sets its visible value to false, this is incase an accidental removal happens.
Parameter Type Description WhereIdstringdefault = null Notes:
Delete()uses theGet()function to check if a user is found.Delete()also checks if there is more than one user found, if more than one student is found it stops and error's.
Attendance
Get
The
Get()Function returns a list of all students that are checked in, theirCheckInTime,CheckOutTimeand theirSerialNumbIdare returnedThe date Parameter should be in YYYY-MM-DD format.
Parameter Type Description WhereCohortstringdefault = null WhereEducationIdstringdefault = null WhereSerialNumbIdstringdefault = null Datestringdefault = null The "RequestedOrder" parameter has 7 values from 0-6 below is a table of there meaning
Additional Parameters Type Description RequestedOrderstringdefault = 0
Requested Order Description 0No order 1order by name ASC 2order by name DESC 3order by email ASC 4order by email DESC 5order by number ASC 6order by number DESC Notes:
- The
Get()function also queries the Students table to retrieve all SerialNumbId's of all students in the selected cohort and education.
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONERequested Parametershould be set to a value when using this function
Requested Parameters Type Description RequestedSerialNumbIdstringdefault = null RequestedCheckInTimestringdefault = null RequestedCheckOutTimestringdefault = null The
Where Parametersare the parameters that select wich student to update. Note: Atleast oneWhere ParameterShould be set.
Where Parameters Type Description WhereSerialNumbIdstringdefault = null WhereDatestringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one entry and if any records exist with the given where statements.- The
Updatefunction can only update ONE entry at a time, if you want to update multiple entries useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedSerialNumbIdstringdefault = null RequestedCheckInTimestringdefault = null RequestedCheckOutTimestringdefault = null The
Where Parametersare the parameters that select wich student's to update. Note: Atleast oneWhere ParameterShould be set.
Where Parameters Type Description WhereSerialNumbIdstringdefault = null WhereDatestringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all entries it can find within theWhere Parametersso be carefull.
Add
Adds an entry to the checkinout database
Insert Parameters Type Description InsertSerialNumbIdstringdefault = null InsertCheckInTimestringdefault = null InsertCheckOutTimestringdefault = null InsertLicenseIdstringdefault = null Notes:
InsertSerialNumbIdcan NOT be empty.InsertLicenseIdcan NOT be empty.- If
InsertCheckOutTimeis not empty thanInsertCheckInTimecan NOT be empty
Delete
Delete()permanently deletes the found entry from the database
Parameter Type Description WhereCohortstringdefault = null WhereSerialNumbIdstringdefault = null Datestringdefault = null Notes:
Delete()uses theGet()function to check if an entry is found.Delete()also checks if there is more than one entry found, if more than one entry is found it stops and error's.
Education
Get
The
Get()Function returns an array with the requested data from the Educations Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestedIdbooleandefault = false RequestedCohortsbooleandefault = false RequestedStartingTimebooleandefault = false RequestedSchoolIdbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereIdstringdefault = null WhereCohortstringdefault = null WhereStartingTimestringdefault = null WhereSchoolIdstringdefault = null
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedCohortsstringdefault = null RequestedStartingTimestringdefault = null RequestedSchoolIdstringdefault = null The "Where Parameters" are the parameters that select wich student to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null WhereCohortstringdefault = null WhereStartingTimestringdefault = null WhereSchoolIdstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one education and if any records exist with the given where statements.- The
Updatefunction can only update ONE education at a time, if you want to update multiple educations useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The "Requested Parameters" are the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedCohortsstringdefault = null RequestedStartingTimestringdefault = null RequestedSchoolIdstringdefault = null The "Where Parameters" are the parameters that select wich entries to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null WhereCohortstringdefault = null WhereStartingTimestringdefault = null WhereSchoolIdstringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all entries it can find within the "Where Parameters" so be carefull.
Auth
CheckCredentials
CheckCredentials()is used to technically Login the user.CheckCredentials()Onsuccessreturns the$useras an associative array. If it failed to login, it always returnsfalse.
Parameter Type Description namestringdefault = null stringdefault = null passwordstringDoes not have default value (can not be empty.). Notes:
- If the
nameparameter is used it will search the user with the name, and NOT the- Only ONE of
namecan be used at a time.- Atleast ONE of
nameneeds to be used.CheckCredentials()starts a Session and sets a Session variableuser_idto theTeacher_Id.- Sets a session variable
user_idandtimestampto their value's
LogOut
Ends the session then restarts the session to verify correct loging out then finally ends the session once more and returns true if success.
CheckTimer
- Checks if the Session
timestampis not more than 900 seconds ago.- If
timestampis less than 900 seconds ago it uses theRefreshTimer()function.
RefreshTimer
Sets
timestampsession variable to the current time().
StartSession
Checks if Session is already running and if not it starts a Session.
EndSession
Stops Session.
CheckLoggedIn
- Checks if
user_idvalue in Session is set.- Checks if there is a real user logged in, returns
truewhen found andfalseif not or if something went wrong.CheckLoggedInalso queries the database to check if the user is real.
FastCheckLoggedIn
- Checks if
user_idvalue in Session is set.- Does not query the database.
- Returns
trueif found andfalseif something went wrong or the value isnt found.
AbsenceRequest
Get
The
Get()Function returns an array with the requested data from the absencerequest Table from the database.The
Get()Function everytime checks if the returned AbsenceRequest is sent more than 14 days ago and is approved or declined. If those criteria are met the entry will be deleted and not returned among the array of other returned entries.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestIdbooleandefault = false RequestReasonbooleandefault = false RequestStartDatebooleandefault = false RequestStartTimebooleandefault = false RequestEndDatebooleandefault = false RequestEndTimebooleandefault = false RequestDateSentbooleandefault = false RequestStudentIdbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereEducationIdstringdefault = null WhereApprovedstringdefault = null WhereStudentIdstringdefault = null
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedApprovedstringdefault = null The "Where Parameters" are the parameters that select wich entry to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereAbsenceRequestIdstringdefault = null WhereEducationIdstringdefault = null WhereApprovedstringdefault = null WhereStudentIdstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one entry and if any records exist with the given where statements.- The
Updatefunction can only update ONE entry at a time, if you want to update multiple educations useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The "Requested Parameters" are the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedApprovedstringdefault = null The "Where Parameters" are the parameters that select wich entries to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereAbsenceRequestIdstringdefault = null WhereEducationIdstringdefault = null WhereApprovedstringdefault = null WhereStudentIdstringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all entries it can find within the "Where Parameters" so be carefull.
Teacher
Get
The
Get()Function returns an array with the requested data from the teachers Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestIdbooleandefault = false RequestNamebooleandefault = false RequestEmailbooleandefault = false RequestDarkModebooleandefault = false RequestPinnedFormbooleandefault = false RequestSchoolIdbooleandefault = false RequestEducationIdbooleandefault = false RequestLicenseKeybooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereTeacherIdstringdefault = null WhereNamestringdefault = null WhereEmailstringdefault = null WhereSchoolIdstringdefault = null WhereEducationIdstringdefault = null
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedNamestringdefault = null RequestedEmailstringdefault = null RequestedDarkModestringdefault = null RequestedPinnedFormstringdefault = null RequestedSchoolIdstringdefault = null RequestedEducationIdstringdefault = null The "Where Parameters" are the parameters that select wich entry to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereTeacherIdstringdefault = null WhereNamestringdefault = null WhereEmailstringdefault = null WhereSchoolIdstringdefault = null WhereEducationIdstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one entry and if any records exist with the given where statements.- The
Updatefunction can only update ONE entry at a time, if you want to update multiple educations useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The "Requested Parameters" are the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedNamestringdefault = null RequestedEmailstringdefault = null RequestedDarkModestringdefault = null RequestedPinnedFormstringdefault = null RequestedSchoolIdstringdefault = null RequestedEducationIdstringdefault = null The "Where Parameters" are the parameters that select wich entries to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereTeacherIdstringdefault = null WhereNamestringdefault = null WhereEmailstringdefault = null WhereSchoolIdstringdefault = null WhereEducationIdstringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all entries it can find within the "Where Parameters" so be carefull.
Delete
Delete does not actually remove the teacher from the database but sets its visible value to false, this is incase an accidental removal happens.
Parameter Type Description WhereIdstringdefault = null Notes:
Delete()uses theGet()function to check if a user is found.Delete()also checks if there is more than one user found, if more than one student is found it stops and error's.
School
Get
The
Get()Function returns an array with the requested data from the schools Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestNamebooleandefault = false RequestLocationbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereIdstringdefault = null
LoggedHours
Get
The
Get()Function returns an array with the requested data from the schools Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestIdbooleandefault = false RequestStudentIdbooleandefault = false RequestSerialNumbbooleandefault = false RequestPresentbooleandefault = false RequestAbsentbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereIdstringdefault = null WhereStudentIdstringdefault = null WhereSerialNumbIdstringdefault = null WhereAbsentBiggerThanstringdefault = null
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedPresentstringdefault = null RequestedAbsentstringdefault = null The "Where Parameters" are the parameters that select wich entry to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null WhereStudentIdstringdefault = null WhereSerialNumbIdstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one entry and if any records exist with the given where statements.- The
Updatefunction can only update ONE entry at a time, if you want to update multiple educations useMultiUpdate.
MultiUpdate
MultiUpdate updates more than just one database entry.
The "Requested Parameters" are the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function.
Requested Parameters Type Description RequestedPresentstringdefault = null RequestedAbsentstringdefault = null The "Where Parameters" are the parameters that select wich entries to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null WhereStudentIdstringdefault = null WhereSerialNumbIdstringdefault = null Notes:
MultiUpdatedoes not perform aGetfunction to check if a record exists.MultiUpdateupdates all entries it can find within the "Where Parameters" so be carefull.
SerialNumber
Get
The
Get()Function returns an array with the requested data from the serialnumber Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestIdbooleandefault = false RequestSerialNumberbooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereIdstringdefault = null WhereSerialNumberstringdefault = null
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedSerialNumberbooleandefault = null The "Where Parameters" are the parameters that select wich entry to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null WhereSerialNumberstringdefault = null Notes:
Updateperforms aGetfunction to check if it encounters more than one entry and if any records exist with the given where statements.- The
Updatefunction can only update ONE entry at a time.
Delete
Delete()Only accepts ONE parameter and NEEDS that parameter for safety and to prevent accidental removal from the database.
Parameter Type Description WhereIdstringdefault = null Notes:
- Be carefull when using this function.
- Delete returns
affectedRowswhen succes andfalsewhen fail.
PinnedPage
Get
The
Get()Function returns an array with the requested data from the pinnedpage Table from the database.When a "Request Parameter" is set to
trueall other parameters are not selected and only the parameters that are set totruewill be selected.
Parameter Type Description RequestIdbooleandefault = false RequestPagebooleandefault = false The "Where Parameters" can be left empty but once set it will only return the selected data where that value is found.
Parameter Type Description WhereIdstringdefault = null WherePagestringdefault = null
Add
Adds an entry to the pinnedpage database
Insert Parameters Type PinnedPagestringNotes:
PinnedPagecan NOT be empty.
Delete
Delete()Only accepts ONE parameter and NEEDS that parameter for safety and to prevent accidental removal from the database.
Parameter Type Description WhereIdstringdefault = null Notes:
- Be carefull when using this function.
- Delete returns
truewhen succes andfalsewhen fail.
Update
The
Update()function updates one entry at a time.The
Requested Parametersare the value the variable will be set to. Note: Atleast ONE parameter should be set to a value when using this function
Requested Parameters Type Description RequestedPinnedPagebooleandefault = null The "Where Parameters" are the parameters that select wich entry to update. Note: Atleast one "Where Parameter" Should be set.
Parameter Type Description WhereIdstringdefault = null Notes:
- The
Updatefunction can only update ONE entry at a time.
This is currently the end of the Bliep! Framework
Alle API's die de frontend kan gebruiken voor de docenten website.
Login.php
The identifier can be both an email or a username, the API will automatically check this and use the correct functions.
Parameter Type Description identifierstringdefault = null passwordstringdefault = null Notes:
- At success the Api redirects to Home page automatically.
- At fail the Api returns success:false and message:*
GetPinnedPages.php
Returns success:true when executing succesfully and data:* as an array of all the pages the teacher has pinned.
Returns success:false and data:"No pinned pages found" if no pages are found.
Notes:
- Also checks if user is logged in and actual user.
- Checks if the request is made internally on the server.
GetAbsenceRequests.php
Returns success:true when executing succesfully and data:* as an array of all the absence requests.
Returns success:false and data:"No absence requests found" if no pages are found.
Notes:
- Also checks if user is logged in and actual user.
- Checks if the request is made internally on the server.
GetStudentAttendance.php
Returns an assosciative array with the needed data in the following format:
- 'student_name' => $student['StudentName'], - 'checked in' => false, - 'check in time' => "", - 'checked out' => false, - 'check out time' => ""Where the values will ofcourse change depending on the student.
Here is an example of the returned json:
{ "success": true, "data": [ { "student_name": "Alice Smith", "checked in": true, "check in time": "2025-02-10 08:00:00", "checked out": true, "check out time": "2025-02-10 16:00:00" }, { "student_name": "Bob Johnson", "checked in": false, "check in time": "", "checked out": false, "check out time": "" }, { "student_name": "Charlie Brown", "checked in": true, "check in time": "2025-02-10 09:00:00", "checked out": false, "check out time": "" } ] }
This function accepts the following input parameters:
orderbychecked_in_afternot_checked_indateeducation_idcohort
The following parameters are actually required:dateeducation_idcohort
The value:education_id
Must be hidden from the user and is connected to the teacher making the request.
EditStudentAttendance.php
Returns a assosciative array's within an array data that shows what action was taken and if any errors occured in the following format:
{ "success": true, "data": [ { "Student_id": "123", "SerialNumbId": "SN12345", "attendance_action": "updated", "attendance_success": true, "logged_hours_updated": true }, { "Student_id": "456", "SerialNumbId": "SN67890", "attendance_action": "added", "attendance_success": true, "logged_hours_updated": true }, { "Student_id": "789", "SerialNumbId": "SN24680", "attendance_action": "updated", "attendance_success": false, "logged_hours_updated": true } ] }
The input parameters are as follows:
studentsthis should be an array including assosciative array's including theStudent_idand theSerialNumbIdof said student.datecheck_in_timecheck_out_time
This function also updates the student's LoggedHours accordingly.
EditStudent.php
Returns the following at success, at failure it will return
success = falseanddatais the error message.The following are the input parameters:
Student_IdNew_NameNew_EmailNew_NumberNewSerialNumbIdI recommend
Student_Idbe hidden from the actual user on the front-end.
BulkStudentAdd.php
Uses a uploaded csv to bulk add students.
The following are the input parameters:
educationidcohortcsvfileReturns a json of the response of every Students::Add(), for every student there will be a
successvalue and adatavalue.
AddStudent.php
The following are the input parameters:
educationidrequiredcohortrequiredstudentnamerequiredstudentemailrequiredstudentnumberrequiredstudentserialReturns
success=trueif it added the student successfully otherwisesuccess=false.
RemoveStudent.php
The following are the input parameters:
educationidrequiredcohortrequiredstudentnamerequiredstudentemailrequiredstudentnumberrequiredReturns
success=trueif the student was removed successfully otherwisesuccess=false.
GetStudents.php
The following are the input parameters:
educationidrequiredcohortrequiredstudentnamestudentemailstudentnumberReturns
success=trueif the students were fetched successfully otherwisesuccess=false.
dataincludes the json of all the students that were fetched.