Set Up Roster: OneRoster API

 

●      What roster option should I choose?

If you wish to use an API integration, be sure to visit our SIS Vendors page for compatibility.

Note: If you are interested in a non-API solution, visit our other links (OneRoster CSV, Simple File Format, Other).

 

Visit the IMS Product Certifications page .

 

●      How do I get my Source URL, API Key, and Secret?

If your vendor is IMS Certified, you should be able to get connection information under an administrator role from your data provider. Please reach out to your Student Information System or Data provider to get this information.  

 

●      What can I do if my Student Information System is not OneRoster Certified?

We recommend working with a partner like Clever or ClassLink , which can offer excellent features at minimal costs.

 

●      Do you support other versions?

At this time, we are fully certified for OneRoster 1.1. Future versions will be investigated and prioritized. Users on older versions should look to upgrade to OneRoster 1.1.

 

●      Do you support the Resources or Class Resources object?

–      Ed, the HMH Learning Platform: OR Resources is supported for Ed. Download your file, as detailed in the Assign Resources Using OR resources File topic.

Note: To align your import with this data requires that you be part of the onboarding pilot. Contact Tech Support to be considered for this pilot.

–      ThinkCentral: See TC-Automate Products for All Classes for details.

–      Holt McDougal Online: See HMO-Activate Products for details.

We continue to explore compatibility with these objects for future releases.

To verify that your vendor supports OneRoster 1.1 API, visit the IMS Product Certifications page .

➔    Select OneRoster API.

The fields on the page change to accommodate your selection.

To set up your OneRoster API connection:

 

1.    In Source URL field, enter your API connection.

Note: API URLs must conform to the IMS standards.

–      For OneRoster 1.1, click here to view specific details provided by IMS .

The API Root URL MUST be "/ims/oneroster", and the new version number MUST be "/v1p1". For example, "https://imsglobal.org/ims/oneroster/v1p1/*".

–      To learn more about older versions of OneRoster, click hereFor OneRoster 1.0, click here for specific details provided by IMS . The API Root URL MUST be "/learningdata", and the initial version number MUST be "/v1". For example, "https://imsglobal.org/learningdata/v1/*"..

2.    In the API Key, enter your API key.

3.    In the Secret field, enter your secret encrypted key.

4.    Click Next to continue.