API reference
Please refer to the below API methods, which contain responses, for examples of the JSON returned by the plugin.
Get Students
GET {baseUrl}/ws/schema/query/mk.ManageBac_Stu
Query Parameters
{
"records": [
{
"tables": {
"u_student_additionals": {
"nickname": "string | null",
"enrollmentdate": "YYYY-MM-DD"
},
"students": {
"dateofbirth": "YYYY-MM-DD",
"middle_name": "string",
"gender": "F", // one character or null
"first_name": "string",
"email": "string",
"yeargroup": "string",
"grade_program": "string",
"student_number": "string", // "123456"
"last_name": "string",
"grade": "string"
},
"u_country_codes": {
"nat": "AB"
}
}
}
],
"extensions": ""
}
Get Teachers
GET {baseUrl}/ws/schema/query/mk.ManageBac_Tea
Query Parameters
{
"records": [
{
"tables": {
"teachers": {
"middle_name": "string or null",
"id": "string",
"first_name": "string",
"last_name": "string"
}
}
}
],
"extensions": ""
}
Get Parents
GET {baseUrl}/ws/schema/query/mk.ManageBac_Par
Query Parameters
{
"records": [
{
"tables": {
"u_student_additionals": {
"father_private_email": "string",
"mother_school_email": "string",
"father_school_email": "string",
"mother_private_email": "string"
},
"students": {
"student_web_id": "string",
"first_name": "string",
"mother_first_name": "string",
"mother_last_name": "string",
"grade_level": "string", // -2, 1, 0, 1, 2, 3
"student_number": "12345",
"father_first_name": "string",
"father_last_name": "string",
"last_name": "string"
}
}
}
],
"extensions": ""
}
Get Student Enrollments in Classes
GET {baseUrl}/ws/schema/query/mk.ManageBac_Stu_Class
Query Parameters
{
"record": [
{
"tables": {
"students": {
"student_number": "123456"
},
"sections": {
"class_id": "string, including exp",
"section_number": "1"
}
}
}
]
}