OpenLoop Roster API

Use rosters and assignments in other apps.

Roster Resource


This API allows the retrieval of detailed rosters per teacher, or for the entire school. Rosters include detailed course, period, teacher, student, and assignment data.


Operations


The Roster resource provides operations to retrieve detailed rosters per teacher, or for the entire school. Rosters include detailed course, period, teacher, student, and assignment data. The operations are summarized below:

Operation
HTTP
Method
Description Example URI
Retrieve
GET Gets a roster
https://myhs.schoolloop.com/api/roster


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".

Get a Roster


The roster for an entire school (or optionally a single teacher) can be retrieved with an HTTP GET to the following URI:https://myhs.schoolloop.com/api/roster(?teacher_id=1234567)
The roster for all teachers is returned by default, otherwise the roster for the specified local teacher id is returned.

Note that a valid username and password must be set in the HTTP Authorization header.

Sample Roster Format


Rosters are returned as detailed XML text documents.  View sample roster format.

School loop has opened the door of communication with parents, and has made my job as an educator much easier. I love it.

Karen Curcio
San Clemente High School