Overview
This article shares information about the OpenLoop API Performance Resource that provides a web-interface for downloading current School Loop student grades and scores.
Information
API Key
This resource requires a secret API key from the School District. Each GET operation must have a valid API key set for the “APIKey” header. Contact a District Administrator to obtain a key for access to this API resource.
Operations
The Performance Resource allows an HTTP GET of currently published student performance data:
| Operation | Method | Description | Example URI |
|---|---|---|---|
| Create | GET |
Get |
https://myhs.schoolloop.com/api/performance |
IMPORTANT: All posts must use SSL (https). The HTTP header “APIKey” must be set with a valid API key for this resource, as obtained from the school district. An error code and message are returned if a call fails to execute.
Getting Performance
The get performance operation returns current marking period grades for each student in each course in the CSV format.
The columns are:
- School Student Permanent ID
- School Course ID
- School Teacher ID
- School Section ID
- Letter Grade
- Percent Score
- Number of Zeros
- Number of Assignments
- Marking Period
- School Loop Progress Report URL