Overview
OpenLoop provides a RESTful interface for uploading assessment results into the School Loop for the use of certificated staff. Assessment results are displayed in a special section of the Dashboard on the Student Record, which can only be viewed by teachers and school administrators.
This article shares information about using this API resource.
DISCLAIMER: The personal contact information in this article is fictitious and is purely meant for instructional purposes.
Information
Operations
The assessment resource allows applications to upload assessment data (assessment definitions and assessment results) to School Loop. The operation is summarized below:
| Operation | HTTP Method | Description | Example URI |
|---|---|---|---|
| Insert | POST | Add assessment | https://myhs.schoolloop.com/api/assessment |
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”. All successful web-service POST calls return HTTP status SC_OK (200) on successful completion. An error code and detailed message are returned if a call fails to execute for any reason.
Posting Assessments
The add-assessments operation is executed with a simple HTTP POST command. The URL format to POST grades is https://myhs.schoolloop.com/api/assessment (replace “myhs” with your target school).
The POST’ed data must be assessment XML that adheres to the schema below.
Note: A valid user name and password must be set in the HTTP authorization header.
If the assessment to be inserted is stored in a file called, for example, “assessment.xml”, then a post to the web service, using the curl utility, could be made with a command similar to the following:
curl -X POST -u “my_admin_id:my_password” –data-binary “@assessment.xml” “http://myschool.schoolloop.com/api/assessment”
Service Response
Successful assessment-post 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 a detailed message describing the failure are returned.
Assessment XML Schema
<AssessmentExport>
<Assessment TestID=”001″ Name=”CA Standards Geometry” SchoolYear=”2009-2010″ Subject=”Math” AdministrationDate=”2008-05-01T00:00:00″>
<CutRanges>
<CutRange MinScore=”1″ MinScoreCode=”FBB” MinScoreDesc=”Far Below Basic” />
<CutRange MinScore=”2″ MinScoreCode=”BB” MinScoreDesc=”Below Basic” />
<CutRange MinScore=”3″ MinScoreCode=”B” MinScoreDesc=”Basic” />
<CutRange MinScore=”4″ MinScoreCode=”P” MinScoreDesc=”Proficient” />
<CutRange MinScore=”5″ MinScoreCode=”A” MinScoreDesc=”Advanced” />
</CutRanges>
<Students>
<Student LastName=”Rodgers” FirstName=”Rebeka” StudentID=”12086805″ ScaledScore=”412″ PerformanceBand=”4″ TeacherID=”41″ Teacher=”Sanchez, Rosie” />
</Students>
</Assessment>
</AssessmentExport>