Rostering Service Configurations

Instructure provisions rostering data using two rostering services. Configure your integration to support both service methods. Additionally, review the rostering best practices.

Note: All payloads are expected to pass IMS global validator.Β Learn more about OneRoster REST service certification.

Note: Instructure is a OneRoster Consumer. For OneRoster Consumer and Provider definitions, view the Introduction to OneRoster.

Bulk Rostering Service

Β 

Service Call Endpoint HTTP Verb Required
getAllClasses
/classes GET βœ“
getAllCourses
/courses GET βœ“
getAllDemographics
/demographics GET 𝗫
getAllEnrollments
/enrollments GET βœ“
getAllOrgs
/orgs GET βœ“
getAllSchools
/schools GET βœ“
getAllStudents
/students GET βœ“
getAllTeachers
/teachers GET βœ“
getAllUsers
/users GET βœ“
getAllTerms
/terms GET βœ“
getAllAcademicSessions
/academicSessions GET βœ“
getAllGradingPeriods
/gradingPeriods GET βœ“

School Specific Rostering Service

Β 

Service Call Endpoint HTTP Verb Required
getCoursesForSchool
/schools/{id}/courses GET βœ“
getEnrollmentsForSchool
/schools/{school_id}/enrollments GET βœ“
getStudentsForSchool
/schools/{school_id}/students GET βœ“
getTeachersForSchool
/schools/{school_id}/teachers GET βœ“
getTermsForSchool
/schools/{school_id}/terms GET βœ“
getAllAcademicSessions
/academicSessions GET βœ“
getAllGradingPeriods
/gradingPeriods GET βœ“
getAllOrgs /orgs GET βœ“
getAllSchools /schools GET βœ“