High Priority Student Resources

This OpenLoop API resource provides a method for creating, listing, updating, and deleting students in a particular high priority group. High priority group students are managed using the group’s unique ID, and local student IDs.

Operations

The High Priority Group 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 Example 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. For example “jsmith:mywebpass”. Note also that all parameters must be properly URL encoded. All successful web-service POST, PUT, and DELETE calls return HTTP status SC_OK on successful completion. An error code, and detailed message is returned if a call fails to execute for any reason.

Listing Group Students

The high priority group member student IDs can be listed with an HTTP GET to the following URI:

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

The student IDs are return as rows of text, one ID per line. For example:

“11111

22222

33333

…”

A valid user-name and password must be set in the HTTP Authorization header.

 

Adding Students

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

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

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

A valid user-name and password must be set in the HTTP Authorization header.

 

Removing Students

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

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

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

A valid user-name and password must be set in the HTTP Authorization header.

 

Service Response

Successful hpgroups students web-service add and remove operations return the HTTP status code SC_OK (200) and a one-line text response: “SUCCESS”. If an operation fails, a error status code and detailed message describing the failure is returned.