Skip to main content
  • Home
  • Confidential Assessment Results API Resource

Confidential Assessment Results API Resource

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.


The Assessments resource allows applications to upload assessment data (assessment definitions and assessment results) to School Loop. The operations are summarized below:

Operation HTTP Method Description Example URI
Insert POST Add 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 on successful completion. An error code, and detailed message is 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 URI format to POST grades is (replace “myhs” with your target school).

The POST’ed data must be assessment XML that adheres to the schema below.

Note that 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 the command:

curl -X POST -u “my_admin_id:my_password” –data-binary “@assessment.xml” “”

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, a error status code and detailed message describing the failure is returned.

Assessment XMLS Schema

<Assessment TestID=”001″ Name=”CA Standards Geometry” SchoolYear=”2009-2010″ Subject=”Math” AdministrationDate=”2008-05-01T00:00:00″>
<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” />
<Student LastName=”Rodgers” FirstName=”Rebeka” StudentID=”12086805″ ScaledScore=”412″ PerformanceBand=”4″ TeacherID=”41″ Teacher=”Sanchez, Rosie” />

Sample Use

Sample Use