Organizations
An "Organization" within the K12NET system refers to an educational institution, such as a school district, individual school, or any other educational entity that manages and operates its educational and administrative functions using K12NET. Organizations are the primary entities that your application will interact with when using our APIs. They own and control access to their data, manage user roles such as students, teachers, staff, and parents, and are responsible for granting permissions to Partners to access their information within the scope of their services. The term 'Organization' is thus central to the structure of K12NET, signifying the institutions that form the backbone of our educational network.
Organization related apis provides access to endpoints that allow Partners to retrieve information about educational institutions within the K12NET system. Here are the available endpoints:
1. Retrieve All Organizations
To obtain a list of all Organizations:
GET https://api.k12net.com/INTCore.Web/api/partner/organizations
This endpoint returns the Organizations that have granted your Partner account access, each with its ID, Name and LocalId:
[
{ "ID": "f740df95-f6ee-df11-815a-002219a888e2", "Name": "Example Schools", "LocalId": "1" }
]
To retrieve a single Organization, or any campus or school below it, by its identifier:
GET https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}
2. Retrieve Schools for a Specific Organization
To get information about schools within a specific Organization:
GET https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/schools
Replace {organization_id} with the actual ID of the Organization you're querying about. This request returns the open schools that are part of the specified Organization. Each school carries its place in the Organization's hierarchy in LEA, which can itself have a Parent:
[
{
"ID": "64d249ec-4b35-4f30-a316-d045e105f827",
"Name": "Example Middle School",
"LocalId": "2",
"LEA": { "ID": "f740df95-f6ee-df11-815a-002219a888e2", "Name": "Example Schools", "LocalId": "1" }
}
]
The school ID is the {school_id} used by the Sections, Parents and Assessments endpoints.
3. Check Whether a Person Is Active
To check whether a person is active in an Organization, post one of UserName, NationalID or Email:
POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/IsPersonActive
{
"NationalID": "12345678901"
}
The response is true when an active person with that user name, national ID or e-mail address exists in the Organization, and false otherwise. When more than one field is sent, UserName is used first, then NationalID, then Email. The endpoint is available when the Organization shares student data with your Partner account.
Remember to authenticate your requests by including an Authorization header with the Bearer token:
curl -X GET https://api.k12net.com/INTCore.Web/api/partner/organizations
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
For the second endpoint, your request would look like this:
curl -X GET https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/schools
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Ensure to replace YOUR_ACCESS_TOKEN with the valid access token and {organization_id} with the actual ID of the organization.
Use these endpoints to access and manage organization-related data, enabling your application to provide organization-specific functionalities.