Overview
This article provides instructions for using this OpenLoop API resource for the retrieval of detailed rosters.
Operation
The Roster resource provides an operation to retrieve complete rosters for each teacher or the entire school. Rosters include comprehensive course, period, teacher, student, and assignment data. The operation is summarized below:
|
Operation
|
HTTP Method
|
Description
|
Sample URI
|
|
Retrieve
|
GET |
Gets a roster
|
IMPORTANT! The HTTP authorization headers must be set with a valid, privileged School Loop user name and your web-service password. Example: “jsmith:mywebpass.”
Get a Roster
The roster for an entire school (or 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 a specified local teacher id is returned.