Universal Rostering API Home
Supported OneRoster Endpoints
OneRoster Specification v1 p1
Grade Book Endpoints
- GET /api/ims/oneroster/v1p1/categories
- GET /api/ims/oneroster/v1p1/categories/{id}
- PUT /api/ims/oneroster/v1p1/categories/{id}
- DELETE /api/ims/oneroster/v1p1/categories/{id}
- GET /api/ims/oneroster/v1p1/lineItems
- GET /api/ims/oneroster/v1p1/lineItems/{id}
- GET /api/ims/oneroster/v1p1/classes/{class_id}/lineItems
- PUT /api/ims/oneroster/v1p1/lineItems/{id}
- DELETE /api/ims/oneroster/v1p1/lineItems/{id}
- GET /api/ims/oneroster/v1p1/results
- GET /api/ims/oneroster/v1p1/results/{id}
- GET /api/ims/oneroster/v1p1/classes/{class_id}/results
- GET /api/ims/oneroster/v1p1/classes/{class_id}/lineItems/{li_id}/results
- GET /api/ims/oneroster/v1p1/classes/{class_id}/students/{student_id}/results
- PUT /api/ims/oneroster/v1p1/results/{id}
- DELETE /api/ims/oneroster/v1p1/results/{id}
Roster Endpoints
- GET /api/ims/oneroster/v1p1/academicSessions
- GET /api/ims/oneroster/v1p1/academicSessions/{id}
- GET /api/ims/oneroster/v1p1/classes
- GET /api/ims/oneroster/v1p1/classes/{id}
- GET /api/ims/oneroster/v1p1/classes/{class_id}/students
- GET /api/ims/oneroster/v1p1/classes/{class_id}/teachers
- GET /api/ims/oneroster/v1p1/courses
- GET /api/ims/oneroster/v1p1/courses/{id}
- GET /api/ims/oneroster/v1p1/enrollments
- GET /api/ims/oneroster/v1p1/enrollments/{id}
- GET /api/ims/oneroster/v1p1/gradingPeriods
- GET /api/ims/oneroster/v1p1/gradingPeriods/{id}
- GET /api/ims/oneroster/v1p1/orgs
- GET /api/ims/oneroster/v1p1/orgs/{id}
- GET /api/ims/oneroster/v1p1/schools
- GET /api/ims/oneroster/v1p1/schools/{id}
- GET /api/ims/oneroster/v1p1/students
- GET /api/ims/oneroster/v1p1/students/{id}
- GET /api/ims/oneroster/v1p1/teachers
- GET /api/ims/oneroster/v1p1/teachers/{id}
- GET /api/ims/oneroster/v1p1/terms
- GET /api/ims/oneroster/v1p1/terms/{id}
- GET /api/ims/oneroster/v1p1/users
- GET /api/ims/oneroster/v1p1/users/{id}
- GET /api/ims/oneroster/v1p1/schools/{school_id}/classes
- GET /api/ims/oneroster/v1p1/teachers/{teacher_id}/classes
- GET /api/ims/oneroster/v1p1/schools/{school_id}/classes/{class_id}/enrollments
- GET /api/ims/oneroster/v1p1/schools/{school_id}/classes/{class_id}/students
- GET /api/ims/oneroster/v1p1/schools/{school_id}/classes/{class_id}/teachers
- GET /api/ims/oneroster/v1p1/schools/{school_id}/courses
- GET /api/ims/oneroster/v1p1/schools/{school_id}/enrollments
- GET /api/ims/oneroster/v1p1/schools/{school_id}/students
- GET /api/ims/oneroster/v1p1/schools/{school_id}/teachers
- GET /api/ims/oneroster/v1p1/schools/{school_id}/terms
OneRoster Specification v1 p2
Grade Book Endpoints
- GET /api/ims/oneroster/gradebook/v1p2/scoreScales
- GET /api/ims/oneroster/gradebook/v1p2/scoreScales/{id}
- GET /api/ims/oneroster/gradebook/v1p2/categories
- GET /api/ims/oneroster/gradebook/v1p2/categories/{id}
- PUT /api/ims/oneroster/gradebook/v1p2/categories/{id}
- DELETE /api/ims/oneroster/gradebook/v1p2/categories/{id}
- GET /api/ims/oneroster/gradebook/v1p2/lineItems
- GET /api/ims/oneroster/gradebook/v1p2/lineItems/{id}
- GET /api/ims/oneroster/gradebook/v1p2/classes/{class_id}/lineItems
- PUT /api/ims/oneroster/gradebook/v1p2/lineItems/{id}
- DELETE /api/ims/oneroster/gradebook/v1p2/lineItems/{id}
- GET /api/ims/oneroster/gradebook/v1p2/results
- GET /api/ims/oneroster/gradebook/v1p2/results/{id}
- GET /api/ims/oneroster/gradebook/v1p2/classes/{class_id}/results
- GET /api/ims/oneroster/gradebook/v1p2/classes/{class_id}/lineItems/{li_id}/results
- GET /api/ims/oneroster/gradebook/v1p2/classes/{class_id}/students/{student_id}/results
- PUT /api/ims/oneroster/gradebook/v1p2/results/{id}
- DELETE /api/ims/oneroster/gradebook/v1p2/results/{id}
Roster Endpoints
- GET /api/ims/oneroster/rostering/v1p2/academicSessions
- GET /api/ims/oneroster/rostering/v1p2/academicSessions/{id}
- GET /api/ims/oneroster/rostering/v1p2/classes
- GET /api/ims/oneroster/rostering/v1p2/classes/{id}
- GET /api/ims/oneroster/rostering/v1p2/classes/{class_id}/students
- GET /api/ims/oneroster/rostering/v1p2/classes/{class_id}/teachers
- GET /api/ims/oneroster/rostering/v1p2/courses
- GET /api/ims/oneroster/rostering/v1p2/courses/{id}
- GET /api/ims/oneroster/rostering/v1p2/enrollments
- GET /api/ims/oneroster/rostering/v1p2/enrollments/{id}
- GET /api/ims/oneroster/rostering/v1p2/gradingPeriods
- GET /api/ims/oneroster/rostering/v1p2/gradingPeriods/{id}
- GET /api/ims/oneroster/rostering/v1p2/orgs
- GET /api/ims/oneroster/rostering/v1p2/orgs/{id}
- GET /api/ims/oneroster/rostering/v1p2/schools
- GET /api/ims/oneroster/rostering/v1p2/schools/{id}
- GET /api/ims/oneroster/rostering/v1p2/students
- GET /api/ims/oneroster/rostering/v1p2/students/{id}
- GET /api/ims/oneroster/rostering/v1p2/teachers
- GET /api/ims/oneroster/rostering/v1p2/teachers/{id}
- GET /api/ims/oneroster/rostering/v1p2/terms
- GET /api/ims/oneroster/rostering/v1p2/terms/{id}
- GET /api/ims/oneroster/rostering/v1p2/users
- GET /api/ims/oneroster/rostering/v1p2/users/{id}
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/classes
- GET /api/ims/oneroster/rostering/v1p2/teachers/{teacher_id}/classes
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/classes/{class_id}/enrollments
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/classes/{class_id}/students
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/classes/{class_id}/teachers
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/courses
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/enrollments
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/students
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/teachers
- GET /api/ims/oneroster/rostering/v1p2/schools/{school_id}/terms
Documentation