Endpoint List
This section of the API Documentation provides a comprehensive list of available endpoints for the K12NET platform. These endpoints enable our Partners to integrate their applications seamlessly with K12NET, facilitating access to a wide range of functionalities from user authentication to detailed information about students, teachers, and organizations.
Authentication
-
Token Endpoint: Obtain access tokens for authenticating API requests.
-
POST https://api.k12net.com/GWCore.Web/connect/token
-
-
User Information Endpoint: Retrieve information about the authenticated user.
-
GET https://api.k12net.com/GWCore.Web/connect/userinfo
-
Single Sign-On (SSO)
-
Student Information:
-
Retrieve student basic information:
-
GET https://api.k12net.com/INTCore.Web/api/partner/sso/students/{user_id}
-
-
Access student enrollments:
-
GET https://api.k12net.com/INTCore.Web/api/partner/sso/students/{user_id}/enrollments
-
-
Get student section information:
-
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{{organization_id}}/Students/{{student_id}}/Sections
-
-
Retrieve student basic information:
-
Teacher Information:
-
Retrieve teacher basic information:
-
GET https://api.k12net.com/INTCore.Web/api/partner/sso/teachers/{user_id}
-
-
Get teacher section information:
-
GET https://api.k12net.com/INTCore.Web/api/Partner/Schools/{{organization_id}}/Teachers/{{teacher_id}}/Sections
-
-
Retrieve teacher basic information:
Organizations
-
List All Organizations: Retrieve a list of all organizations.
-
GET https://api.k12net.com/INTCore.Web/api/partner/organizations
-
-
Organization's Schools: Get a list of schools within a specific organization.
-
GET https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/schools
-
-
Organization's Students: Access information about students within a specific organization.
-
POST https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/students
-
-
Organization's Teachers: Retrieve information about teachers within a specific organization.
-
POST https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/teachers
-
Student Contact
-
Student Contact Information: Get student contact information (Parent information).
-
GET https://api.k12net.com/INTCore.Web/api/Partner/SSO/Students/{{student_contact_id}}
-
Please note that {user_id}
and {organization_id}
in the above endpoints should be replaced with actual user and organization identifiers respectively.
For detailed information on request parameters, response objects, and to understand the scope and limitations of each endpoint, refer to the specific documentation pages dedicated to each endpoint.