OneRoster API through ClassLink

userXello Admin Xello productAccounts Time3 minutes

If you are a ClassLink user, we can integrate via OneRoster to pull in student, educator, and class rostering information.

To integrate via OneRoster:

  1. Click the Apps tab, then click + ADD
  2. Toggle on Show Development Apps, then search for Xello under Name or Career Cruising under Company Name. Click the + Add when you see the Xello icon.
  3. Once Xello is added, you’ll want to define vendor permissions. Roster Server offers three permission types: Rule-Based, Full, and Legacy.

Setting up sharing rules

When setting up your sharing rules in ClassLink, you’ll need to share:

  • Orgs
  • Classes
  • Users - Xello can only pull in the following roles:
    • Student
    • Administrator
    • Teacher
    • Parent
    • Guardian
  • Enrollments

Optional areas to share in ClassLink:

  • Courses - if you’re going to be using the Course Planner feature, this is helpful for us to see what active courses your district offers
  • Demographics - Xello only pulls in two fields:
    • Date of Birth
    • Gender

These are used in Xello to be able to fine-tune reports (search by M or F, for example) and are not mandatory.

When sharing your classes, the students and educators in those classes will automatically be shared with us and have profiles created. For educators who need district level access in Xello, additional sharing rules will need to be set up.

FYIFYI: How the roles in ClassLink translate to Educator permission levels: 
Administrator = Adminstrator.
Teacher = User.
If you're interested in anyone being Limited access, please talk to your Success and Onboarding Managers to set up that customization in the background.