This section contains a list of OneRoster 1.1 endpoints that Aeries has currently implemented and those that are not implemented. For details about these endpoints, please refer to the OneRoster 1.1 specification: https://www.imsglobal.org/oneroster-v11-final-specification
All OneRoster 1.1 endpoints include the API root URL and version. The API root URL is /ims/oneroster, and the current version is /v1p1. These are added to the Aeries base URL.
Using the Aeries demo site as an example, here is a complete URL for the /orgs endpoint:
https://demo.aeries.net/aeries/ims/oneroster/v1p1/orgs
Aeries base URL: https://demo.aeries.net/aeries
API root URL: /ims/oneroster
Version: /v1p1
Endpoint: /orgs
List of Endpoints
| Rostering | HTTP Verb(s) | Aeries Permission |
|---|---|---|
| /academicSessions | GET | Terms (TRM) |
| /academicSessions/{id} | GET | Terms (TRM) |
| /classes | GET | Master Schedule (MST) |
| /classes/{id} | GET | Master Schedule (MST) |
| /courses | GET | Course Data (CRS) |
| /courses/{id} | GET | Course Data (CRS) |
| /demographics | GET | Student Data (STU) |
| /demographics/{id} | GET | Student Data (STU) |
| /enrollments | GET | Classes (SEC) |
| /enrollments/{id} | GET | Classes (SEC) |
| /gradingPeriods | GET | Terms (TRM), Grading Periods (GRP,GPD) |
| /gradingPeriods/{id} | GET | Terms (TRM), Grading Periods (GRP,GPD) |
| /orgs | GET | Schools (LOC) |
| /orgs/{id} | GET | Schools (LOC) |
| /schools | GET | Schools (LOC) |
| /schools/{id} | GET | Schools (LOC) |
| /students | GET | Student Data (STU) |
| /students/{id} | GET | Student Data (STU) |
| /teachers | GET | Teacher Data (TCH) |
| /teachers/{id} | GET | Teacher Data (TCH) |
| /terms | GET | Terms (TRM) |
| /terms{id} | GET | Terms (TRM) |
| /users | GET | Student Data (STU) |
| /users/{id} | GET | Student Data (STU) |
| /schools/{school_id}/classes/{class_id}/enrollments | GET | Classes (SEC) |
| /schools/{school_id}/classes/{class_id}/students | GET | Classes (SEC) |
| /schools/{school_id}/classes/{class_id}/teachers | GET | Classes (SEC) |
| /schools/{school_id}/enrollments | GET | Classes (SEC) |
| /schools/{school_id}/students | GET | Classes (SEC) |
| /schools/{school_id}/teachers | GET | Classes (SEC) |
| /schools/{school_id}/terms | GET | Terms (TRM) |
| /terms/{term_id}/classes | GET | Master Schedule (MST) |
| /courses/{course_id}/classes | GET | Master Schedule (MST) |
| /students/{student_id}/classes | GET | Classes (SEC) |
| /teachers/{teacher_id}/classes | GET | Master Schedule (MST) |
| /schools/{school_id}/classes | GET | Master Schedule (MST) |
| /users/{user_id}/classes | GET | Classes (SEC) |
| /classes/{class_id}/students | GET | Classes (SEC) |
| /classes/{class_id}/teachers | GET | Master Schedule (MST) |
| Gradebook | HTTP Verb(s) | Aeries Permission |
|---|---|---|
| /categories | GET | Gradebook Category (GBT) |
| /categories/{id} | GET, PUT | Gradebook Category (GBT) |
| /lineItems | GET | Gradebook Assignment (GBA) |
| /lineItems/{id} | GET, PUT | Gradebook Assignment (GBA) |
| /results | GET | Gradebook Scores |
| /results/{id} | GET, PUT | Gradebook Scores |
| /classes/{class_id}/results | GET | Gradebook Scores |
| /classes/{class_id}/lineItems | GET | Gradebook Assignment (GBA) |
| /classes/{class_id}/lineItems/{li_id}/results | GET | Gradebook Scores |
| /classes/{class_id}/students/{student_id}/results | GET | Gradebook Scores |
| Not Implemented | HTTP Verb(s) |
|---|---|
| /schools/{id}/courses | GET |
| /resources | GET |
| /resources /{id} | GET |
| /courses/{course_id}/resources | GET |
| /classes/{class_id}/resources | GET |
| /terms/{term_id}/gradingPeriods | GET |
| /categories/{id} | DELETE |
| /lineItems/{id} | DELETE |
| /results/{id} | DELETE |