Teachers

The K12NET API provides a dedicated endpoint for Partners to access teacher information within a specific organization. Utilize the following endpoint to query teacher data:


POST https://api.k12net.com/INTCore.Web/api/partner/organizations/{organization_id}/teachers

Ensure to replace {organization_id} with the actual identifier of the organization whose teacher data you are interested in retrieving.

Capabilities of the Teachers Endpoint:

Paging: The teachers endpoint is equipped with paging functionality to efficiently handle large datasets. A single call will retrieve a maximum of 100 teacher records by default, though this limit can be adjusted according to your requirements.
Filtering: Partners have the ability to filter the returned teacher data. This can be extremely useful when searching for teachers who meet specific criteria, such as department, qualifications, or tenure.
Sorting: You can also sort the data retrieved from this endpoint. Sorting can be applied on various fields, including name, subject, or any other relevant field that the organization has made available through the API.

Sample Request for Paging:

When making a request to the Teachers endpoint, you can include parameters to control the paging of the results. Here is an example of a JSON object that can be posted to the endpoint to retrieve a slice of teacher records:


{
	"$skip": 20,
	"$take": 10,
	"$includeTotalCount": true
}

The $skip parameter specifies the number of records to skip before returning the results, while $take indicates the number of records to include in the response. The includeTotalCount parameter is used to request the total count of records available, which can be useful for pagination.

If you include the includeTotalCount parameter in your request and set it to true, the total count of available records will be included in the response header with the name TotalCount. This allows you to determine the total number of student records available for the organization.

Customizable Data Fields:

As with student information, the specific fields included in the response from the Teachers endpoint are determined by the organization. This means that the dataset for teachers may include a variety of fields, tailored to the organization’s preferences and policies regarding data sharing.

As a Partner, it is important to design your integration to be flexible and capable of handling varying data structures. Your application should be prepared to process the essential information that is consistently provided, as well as any additional fields that may be unique to certain organizations.

Proper error handling and data validation strategies are recommended to ensure that your application can effectively manage the data provided through this endpoint, maintaining robust interaction with the diverse datasets of teachers across different K12NET organizations.