Students

Students

For Partners who need to access student information, the K12NET API provides a comprehensive endpoint that supports paging, filtering, and sorting to streamline data retrieval:

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

Replace {organization_id} with the specific identifier of the organization whose student data you wish to access.

Features of the Students Endpoint:

• Paging: To manage large sets of student data, the endpoint implements paging. By default, up to 100 student records are retrieved in a single API call, but you can adjust the page size to suit your needs.

• Filtering: You can apply filters to this endpoint to retrieve only the student data that matches certain criteria, such as enrollment status, grade level, or any other relevant field provided by the organization.

• Sorting: The endpoint allows sorting of the student data by various fields such as name, enrollment date, or grade, enabling you to organize the returned data in a way that is most useful for your application's context.

Sample Request for Paging:

When making a request to the Students 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 student 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.

Controlling Data Fields:

Just like with other endpoints, the fields returned from the Students endpoint are controlled by the organization. This means that the data you receive may vary between different organizations, depending on their configuration and data sharing policies. As a Partner, it is crucial to design your application to be adaptable to different data structures and to handle the potential variability in the fields provided.

When implementing this endpoint in your application, ensure to include appropriate error handling and data validation to accommodate the flexible nature of the returned data. This ensures that your application can robustly interact with the diverse datasets of students across various K12NET organizations.