Endpoint List
This section of the API Documentation lists every endpoint available to K12NET Partners. All INTCore endpoints are called with an access token obtained through the client_credentials grant (see Authentication). The user token obtained during Single Sign-On is only used for the userinfo endpoint.
Every endpoint returns only the data the Organization has allowed for your Partner account. When the Organization has not granted the related permission, the endpoint returns an empty response.
Authentication
-
Token Endpoint: Obtain access tokens for authenticating API requests.
POST https://api.k12net.com/GWCore.Web/connect/token
-
User Information Endpoint: Retrieve the identity of the user who signed in with K12NET.
GET https://api.k12net.com/GWCore.Web/connect/userinfo
Single Sign-On (SSO)
Use the ID returned by the userinfo endpoint as {user_id}. See Single Sign-On.
- Student information, including the current enrollment:
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/Students/{user_id} - Student enrollments in the active school year:
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/Students/{user_id}/Enrollments - Teacher information, including teaching assignments:
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/Teachers/{user_id} - Parent information and the parent's students:
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/ContactStudents/{contact_id_or_student_id}
Organizations
See Organizations.
- List the Organizations your Partner account has access to:
GET https://api.k12net.com/INTCore.Web/api/Partner/Organizations - Get a single Organization:
GET https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id} - List the schools of an Organization:
GET https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Schools - Check whether a person is active in an Organization:
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/IsPersonActive
Students and Teachers
See Students, Teachers and Filtering And Sorting.
- List the students of an Organization (paged):
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Students - List the teachers of an Organization (paged):
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Teachers - Sections of a student in the current term:
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Students/{student_id}/Sections - Sections of a teacher in the current term:
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Teachers/{teacher_id}/Sections
Parents
See Parents.
- List the parents of an Organization's students (paged):
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Contacts - Birth date and gender of a school's parents:
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Parents/Demographics
Assessments
See Assessments.
- Published exams of a school:
POST https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Administrations - Results of all students for an exam:
POST https://api.k12net.com/INTCore.Web/api/Partner/Administrations/{administration_id}/StudentResults - Exams a student took:
POST https://api.k12net.com/INTCore.Web/api/Partner/Schools/{school_id}/Students/{student_id}/Registrations - Result of a single exam registration:
GET https://api.k12net.com/INTCore.Web/api/Partner/Administrations/StudentResult/{registration_id}
Replace the values in braces with actual identifiers. A {school_id} is the ID of a school returned by the Schools endpoint or found in a student's enrollment.
For request parameters, response objects and the scope of each endpoint, refer to the documentation page dedicated to each endpoint.