Parents
Parents
In K12NET, parents and other people responsible for a student are recorded as the student's contacts. The endpoints below return contacts of students who are actively enrolled in the active school year. The fields returned are controlled by the Organization's student contact data sharing settings; fields that are not shared are returned as null or are left out of the response.
1. Parents of a Signed-In Parent or of a Student
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/ContactStudents/{contact_id_or_student_id}
Pass the ID of a parent who signed in with K12NET (see Single Sign-On) to get that parent and the parent's students. Pass the ID of a student to get all contacts of that student, each with their students.
[
{
"ID": "6a64c9d0-011e-e411-93fd-6eae8b38b1b9",
"FullName": "Ayşe Yılmaz",
"FullNameParts": { "First": "Ayşe", "Middle": null, "Last": "Yılmaz", "Suffix": null },
"NationalID": "12345678901",
"BirthDate": "1984-03-02T00:00:00",
"Gender": false,
"PhoneNumbers": [ "+90 555 000 00 00" ],
"Emails": [ "[email protected]" ],
"CurrentStudentID": "365ffb89-8c91-f111-8fbf-98f2b32a1389",
"Students": [
{
"ID": "365ffb89-8c91-f111-8fbf-98f2b32a1389",
"FullName": "Elif Yılmaz",
"FullNameParts": { "First": "Elif", "Middle": null, "Last": "Yılmaz", "Suffix": null },
"NationalID": "10987654321",
"BirthDate": "2015-04-21T00:00:00",
"Gender": false
}
]
}
]
Studentslists only the contact's students who are actively enrolled in a school your Partner account can access. A contact with no such student is left out of the response.CurrentStudentIDis the student the parent is currently viewing on K12NET. It is00000000-0000-0000-0000-000000000000when not known.- The student fields follow the Organization's student data sharing settings; the contact fields follow its student contact settings.
2. Parents of an Organization
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Contacts
Returns the contacts of the students actively enrolled in the Organization's schools. Like the Students endpoint it is paged with $skip, $take (at most 100) and $includeTotalCount, and accepts $where and $orderby on it.ID and it.FullName:
{
"$skip": 0,
"$take": 100,
"$includeTotalCount": true,
"$orderby": "it.FullName"
}
[
{
"ID": "6a64c9d0-011e-e411-93fd-6eae8b38b1b9",
"FullName": "Ayşe Yılmaz",
"FullNameParts": { "First": "Ayşe", "Middle": null, "Last": "Yılmaz", "Suffix": null },
"OtherName": null,
"NationalID": "12345678901",
"BirthDate": "1984-03-02T00:00:00",
"Gender": false,
"PhoneNumbers": [ "+90 555 000 00 00" ],
"Emails": [ "[email protected]" ],
"UserName": "ayse.yilmaz",
"Relations": [
{ "StudentPersonalID": "365ffb89-8c91-f111-8fbf-98f2b32a1389", "Type": "Anne" }
]
}
]
Relations lists the contact's active students in the Organization and the contact's relationship to each student. Type is the relationship name as recorded in K12NET (for example Anne, mother in Turkish); it is empty when no relationship is recorded.
3. Parent Demographics of a School
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Parents/Demographics
Returns the birth date and gender of every contact of the school's actively enrolled students, ordered by ID. The endpoint is available when the Organization shares the birth date or gender of student contacts with your Partner account.
[
{ "ID": "08ccc7c5-6e14-f011-8fbe-98f2b32a1389", "BirthDate": "1984-03-02T00:00:00", "Gender": false },
{ "ID": "1c9487ca-8c91-f111-8fbf-98f2b32a1389", "BirthDate": null, "Gender": null }
]
Gender of Parents
In all parent endpoints Gender is true for male, false for female and null when unknown. When a parent's gender is not recorded, it is derived from the parent's relationship to the students: a contact recorded as a student's father is returned as male, and a contact recorded as a mother as female. A contact recorded as father of one student and mother of another stays null.
Responses may also contain the serializer properties $id and $type, which you can ignore.