Rostering via OneRoster API
Rostering with OneRoster API is usually very quick and easy to implement. You will work with your District or School IT Administrator to complete the OneRoster Setup Checklist below which will help you complete the setup in your source system to all Resonant Education to pull data through the OneRoster API and ensure that Admin receives the correct data for User IDs
Instructions for SIS or LMS Admin
- Create a OneRoster API Client for Resonant Education
- Set up OneRoster Permissions in your Source System
When creating the OneRoster Client for Resonant Education, please ensure to set permissions to roster.readonly and roster-demographics.readonly or select all permissions. - Complete the 2 Connection Details and Setup Instructions sections below and send this securely to your Resonant Education project manager.
OneRoster API Connection Details |
|---|
Date Provided | xx/yy/zzzz |
Name & Email of OneRoster API Admin |
|
OneRoster Provider (SIS or LMS name, ClassLink, MiDataHub, etc) |
|
OneRoster Authentication Type (oAuth1 or oAuth2) |
|
Authentication Token URL (only used for oAuth2) | Note: this is not needed for oAuth1 |
OneRoster API Base URL | For example:
ClassLink - https://exampleonly.oneroster.com/ims/oneroster/v1p1/
MiDataHub - https://apihub.midatahub.org:443/ims/oneroster/v1p1/ |
OneRoster Client ID for Resonant Education |
|
OneRoster Client Secret for Resonant Education |
|
Does your OneRoster Provider require Scopes (permissions) to be sent | If so, please list the full scopes url here, for example ‘https://purl.imsglobal.org/spec/or/v1p1/scope/roster.readonly’ ‘https://purl.imsglobal.org/spec/or/v1p1/scope/roster-demographics.readonly’ |
OneRoster API Setup Instructions |
|---|
Field to use for Organization ID | ‘sourcedId’ or ‘identifier’ |
Field to use for Student ID | ‘sourcedId’ or ‘identifier’ or ‘username’ or ‘email’ or (specify other field) |
Field to use for Teacher ID | ‘sourcedId’ or ‘identifier’ or ‘username’ or ‘email’ or (specify other field) |
What role is used to specify a family agent | ‘parent’ or ‘guardian’ |
Field to use for Family Agent ID | ‘sourcedId’ or ‘identifier’ or ‘username’ or ‘email’ or (specify other field) |
Is the OneRoster Provider sending inactive users? | Note: many source systems do not send users that are inactive or unenrolled |
Will teachers be claiming students to take the survey about? |
|
.
