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) |
|---|---|
| /academicSessions |
GET |
| /academicSessions/{id} |
GET |
| /classes |
GET |
| /classes/{id} |
GET |
| /courses |
GET |
| /courses/{id} |
GET |
| /enrollments |
GET |
| /enrollments/{id} |
GET |
| /orgs |
GET |
| /orgs/{id} |
GET |
| /schools |
GET |
| /schools/{id} |
GET |
| /students |
GET |
| /students/{id} |
GET |
| /teachers |
GET |
| /teachers/{id} |
GET |
| /terms |
GET |
| /terms{id} |
GET |
| /users |
GET |
| /users/{id} |
GET |
| /schools/{school_id}/classes/{class_id}/enrollments |
GET |
| /schools/{school_id}/classes/{class_id}/students |
GET |
| /schools/{school_id}/classes/{class_id}/teachers |
GET |
| /schools/{school_id}/enrollments |
GET |
| /schools/{school_id}/students |
GET |
| /schools/{school_id}/teachers |
GET |
| /schools/{school_id}/terms |
GET |
| /terms/{term_id}/classes |
GET |
| /courses/{course_id}/classes |
GET |
| /students/{student_id}/classes |
GET |
| /teachers/{teacher_id}/classes |
GET |
| /schools/{school_id}/classes |
GET |
| /users/{user_id}/classes |
GET |
| /classes/{class_id}/students |
GET |
| /classes/{class_id}/teachers |
GET |
| Gradebook | HTTP Verb(s) |
|---|---|
| /categories |
GET |
| /categories/{id} |
GET, PUT |
| /lineItems |
GET |
| /lineItems/{id} |
GET, PUT |
| /results |
GET |
| /results/{id} |
GET, PUT |
| /classes/{class_id}/results |
GET |
| /classes/{class_id}/lineItems |
GET |
| /classes/{class_id}/lineItems/{li_id}/results |
GET |
| /classes/{class_id}/students/{student_id}/results |
GET |
| Not Implemented | HTTP Verb(s) |
|---|---|
| /gradingPeriods |
GET |
| /gradingPeriods/{id} |
GET |
| /demographics |
GET |
| /demographics/{id} |
GET |
| /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 |