This API allows external applications to upload progress reports for display in the School Loop system. Progress report grades displayed, populate trend and other data analysis tools, and can be exported to the SIS. Progress reports are not imported into the School Loop gradebook.
The High Priority Groups resource provides operations to create, read, update and delete high priority groups. The operations are summarized below:
|Operation||HTTP Method||Description||Example URI|
|Add reports||POST||Add progress reports to School Loop||https://myhs.schoolloop.com/api/progressReports|
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 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.
Posting Progress Reports
Progress reports are added with a simple http POST command. The URI format to post a Progress Report XML document is:
Note that a valid username and password must be set in the HTTP Authorization header.
Progress Report XML Format
The progress report XML upload format is detailed separately in the OpenLoop API document entitled “Upload Progress Report Schema“.
Successful OpenLoop API web-service create, update, and delete operations return the HTTP status code SC_OK (200) and a one-line text response: “SUCCESS”. If an operation fails, an error status code and detailed message describing the failure is returned.