High Priority Student API Resources – School Loop Support

Overview

This article provides the information needed to list, add, or delete students in High Priority Student Resources using the OpenLoop API.

Note: High Priority Group (HPG) students are managed using the group’s unique ID, and local student IDs.

Resource Details

Operations

The HPG Students resource provides operations to list, add, and remove students for a specified group’s unique group_id. The operations are summarized below:

Operation	HTTP Method	Description	Sample URI
List	`GET`	Get a list of the current students	`https://myhs.schoolloop.com/api/hpgroups/(group_id)/students`
Create	`POST`	Add student IDs to the group	`https://myhs.schoolloop.com/api/hpgroups/(group_id)/students?student_ids=1111+2222+3333`
Delete	`DELETE`	Remove student IDs to the group	`https://myhs.schoolloop.com/api/hpgroups/(group_id)/students?student_ids=1111+2222+3333`

IMPORTANT: The HTTP authorization headers must be set with a valid, privileged School Loop user name and your web-service password (e.g., “jsmith:mywebpass”). Note also that all parameters must be properly URL encoded.

Listing Students

The HPG member student IDs can be listed with an HTTP GET method to the following URI:

https://myhs.schoolloop.com/api/hpgoups/group_id/students

The student IDs are returned as rows of text, one ID per line.

Example:

Adding Students

Adding a student to a high priority group is executed with a POST of the student (or students') ID(s) to that group’s student URI.

Example:

POST https://myhs.schoolloop.com/api/hpgroups/mygroup1/students?student_ids=1111+2222+3333

The above example adds student ID’s 1111, 2222, and 3333 to the group with unique ID “mygroup1”.

Removing Students

Removing students from a high priority group is executed with an HTTP DELETE method to the group’s students URI, with the desired student (or students) ID(s).

Example:

DELETE [https://myhs.schoolloop.com/api/hpgroups/mygroup1/students?student_ids=1111+2222+3333

The above removes student ID’s 1111, 2222, and 3333 (if they are members) from the group with unique ID “mygroup1”.

Service Response

Successful web-service LIST, POST, and DELETE calls return the HTTP status SC_OK (200) with successful completion, along with a one-line text response: SUCCESS. An error code and detailed message are returned if a request fails to execute for any reason.

Back to the top