Using the industry standard OneRoster format, Visitor Aware can automatically synchronize your student information system information to keep your students, guardians, contact information, and relationships in sync. 


The OneRoster format, developed by IMS Global, is a widely recognized industry standard for exchanging data between Student Information Systems (SIS) or Student Management Systems (SMS). By utilizing OneRoster's REST-based APIs (version 1.1, and forthcoming support for 1.2) created by your SIS/SMS provider, you can directly connect to your system and synchronize data. This approach eliminates the need for CSV files and streamlines the data syncing process.


For more information on how to set up your account to use the OneRoster API as a source, see Configuring your OneRoster Connection here: https://visitoraware.freshdesk.com/support/solutions/articles/43000696261-configuring-your-oneroster-connection


Getting Started

We encourage you to reach out to us if you don't see your student information system listed below.  The list below provides a general reference to our known supported OneRoster integrations, however, we can integrate with any provider that offers a OneRoster API connection, or is able to send OneRoster or CSV files via SFTP.


Supported OneRoster Providers


Provider Name Connection Type
Aequitas QAPI
AeriesAPI
Arbor EducationAPI
AlmaSFTP
AscenderSFTP
Blackbaud Education ManagementAPI
ClassLinkAPI
ClassterAPI
Edge LearningAPI
Educate by Community BrandsAPI
eSchoolDataAPI
eSchoolingAPI
EventfulAPI
FACTSAPI
Focus School SoftwareAPI
Follett AspenAPI
Genesis Educational ServicesSFTP
Infinite CampusAPI
iSAMSAPI
ISTAPI
LibrusAPI
MySchoolAPI
PowerSchoolAPI, SFTP
Realtime (New Jersey)API, pilot
Rediker SoftwareAPI
SchoolToolAPI
SIMSAPI
SkoolAPI
SkywardAPI
Sycamore SchoolAPI, Pilot
Synergy SISAPI
PowerSchool Unified ClassroomAPI
VeracrossAPI, SFTP
VigiloAPI
VULCAN UONET+API


Don't see your provider on the list? No problem!  Contact us and we'll get it added!


API Access Credentials Required for OneRoster

To enable the connection to the OneRoster API for your SIS/SMS, you'll need to provide the connection credentials. For more information, see your specific provider's documentation to obtain or generate them.


  • Web access URL: URL where your OneRoster API is accessible for your SIS/SMS
  • Client ID that will be used to connect to your SIS/SMS OneRoster API
  • Client Secret that will be used to connect to your SIS/SMS OneRoster API
  • Access Token URL, if your SIS/SMS OneRoster API is configured for authentication using OAuth2, you'll also need to provide the Access Token URL endpoint that will be used to connect. The endpoint is different from the Web access URL.


Helpful notes and tips

  • The endpoints always come after 'https://{server_URL}/ims/oneroster/v1p1'
  • Endpoints have requirements on filter parameter support to allow filtering by status, or to enable delta sync.
  • Visitor Aware applies a filter on the dateLastModified property for delta sync/incremental sync processing and is required for integration.
  • Providers must choose to implement either OAuth1(a) or OAuth 2.0 (client credentials grant) authentication scheme. OAuth 2.0 is preferred.
  • If authentication protocol supported is "OAuth 2.0" - client credentials grant type, Visitor Aware will send the credentials in "Authorization" header. As recommended in the OneRoster specification we send the encoded client credentials in the Authorization header of token requests.
  • SIS ( OneRoster ) Data Integration Requirements Guide




Automatic User-student Contact Relationships 

Student contact relationships may be specified for student users to automatically associate students with guardians for communication to parents and guardians, and student sign-out authorization. Contacts are more users that are supplied with the /users and association to a student are found in the student’s user record under ‘agents’.


Required API Endpoints for VIsitor Aware's OneRoster Sync

ActionURLFilters
GetAllAcademicSessions/academicSessionsstatus, dateLastModified
GetAllOrgs/orgsstatus
GetAllUsers/usersstatus, dateLastModified
GetAllClasses/classesstatus, dateLastModified
GetAllEnrollments/enrollmentsstatus, dateLastModified


Optional API Endpoints for VIsitor Aware's OneRoster Sync

You may choose to include optional demographic data, student contact relationships, and student user flags depending on the optional data capabilities supported by your SIS/SMS OneRoster provider profile. If the provider supports this data, we will automatically consume it.


If you would like the provider to support demographics, contacts, or user demographic flags and enable SDS to ingest the data, allowing you to enable the scenarios and experiences the data supports, you can contact your provider and request that they add support for these features.


ActionURLFilters
GetAllCourses/coursesstatus, dateLastModified
GetAllDemographics/demographicsstatus, dateLastModified


OneRoster Provider Details and Additional Information



Aequitas Q

SIS Vendor

Aequitas Solutions, Inc
Minimum Version of SoftwareQ 3.6.1, Q Web API 3.6.0
Configuration Prerequisites    See Q Web API setupSee Q Web API setup
How to get Client ID, Client Secret, and URL(s)See Q Web API setup
Specific InstructionsN/A

Help

Contact Support at (909) 946-1600



Aeries

SIS Vendor

Aeries
Minimum Version of Softwarev8.18.6.29 or later
Configuration Prerequisites    See Q Web API setupSee OneRoster API Set Up.
How to get Client ID, Client Secret, and URL(s)Self-hosted. See OneRoster API Set Up.
Specific InstructionsN/A

Help

Contact Support by Phone (toll-free): (888) 324-5363 or support@aeries.com




Arbor Education

SIS Vendor

Arbor Education

Minimum Version of Software

N/A

Configuration Prerequisites

The integration between Arbor MIS and Visitor Aware is enabled on your Arbor MIS. Contact your account manager at Arbor to make sure it's enabled via accountmanagers@arbor-education.com. You must have an Office 365 education tenant, global administrator permissions, and School Data Sync (Plan 1) enabled.

How to get Client ID, Client Secret, and URL(s)

These can be generated in your Arbor MIS. Steps to complete are detailed in the Arbor Help Center.

Specific Instructions

Contact Arbor or your dedicated support partner to help set up this integration via myteam@arbor-education.com.

Help

Find support articles at Arbor's Help Centre. For questions, reach out to myteam@arbor-education.com or your dedicated support partner.



Alma SIS

SIS Vendor

Alma
Minimum Version of SoftwareN/A
Configuration PrerequisitesContact your Alama Representative to configure your OneRoster SFTP sync with Visitor Aware by adding the Visitor Aware application within Alma
How to get Client ID, Client Secret, and URL(s)N/A
Specific InstructionsN/A

Help

Contact Support to configure your SFTP sync




Ascender

SIS Vendor

Ascender

Minimum Version of Software

N/A

How to get Client ID, Client Secret, and URL(s)

N/A.  Contact Visitor Aware to configure your SFTP connection.

Specific Instructions

Contact Ascender or your dedicated support partner to help set up this integration at https://ascendertx.com/contact-us-ascender-texas/.

Help

N/A



Blackbaud Education Management

SIS Vendor

Blackbaud Education Management

Minimum Version of Software

The latest version of BEM is always available to users.

Configuration Prerequisites

Not applicable

How to get Client ID, Client Secret, and URL(s)

The step-by-step instructions are described here

Specific Instructions

The Access Token Scope if not provided by Blackbaud should be entered as: 


https://purl.imsglobal.org/spec/or/v1p1/scope/roster.readonly

Help

support.blackbaud.com



ClassLink

SIS Vendor

ClassLink

Minimum Version of Software

N/A

Configuration Prerequisites

Add the Visitor Aware app in the console. Reach out to ClassLink Support for instructions on this.

How to get Client ID, Client Secret, and URL(s)

Customers can get their oAuth credentials from the console after they add the app. An email will also be sent to the developer at Visitor Aware that set up the app. 


If there are issues connecting, ensure that the Web Access URL has "/ims/oneroster/v1p1" to point to the correct connectors.

Specific Instructions

N/A

Help

E-mail rostersupport@classlink.com.



Classter

SIS Vendor

Classter

Minimum Version of Software

All versions are supported

Configuration Prerequisites

https://help.classter.com/kb/integration-with-sds/sds-integration-manual/

How to get Client ID, Client Secret, and URL(s)

https://help.classter.com/kb/integration-with-sds/sds-integration-manual/

Specific Instructions

https://help.classter.com/kb/integration-with-sds/sds-integration-manual/

Help

support@classter.com



Edge Learning

SIS Vendor

Edge Learning

Minimum Version of Software

Edge is a web application so the version currently running will always work.

Configuration Prerequisites

Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster

How to get Client ID, Client Secret, and URL(s)

Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster

Specific Instructions

Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster

Help

Available through “Help” in the Edge application Microsoft School Data Sync via OneRoster



Educate by Community Brands

SIS Vendor

Educate by Community Brands

Minimum Version of Software

N/A

Configuration Prerequisites

N/A

How to get Client ID, Client Secret, and URL(s)

Contact customer support.

Specific Instructions

Contact customer support.

Help

For support, contact educate_support@communitybrands.com.




eSchoolData

SIS Vendor

eSchoolData

Minimum Version of Software

N/A

Configuration Prerequisites

Districts must be subscribers of the eSD GURU product.

How to get Client ID, Client Secret, and URL(s)

See specific instructions.

Specific Instructions

In order to enable an API integration with Visitor Aware, district administrators must first create a vendor account within GURU. 

  • Navigate to Configuration > Vendors and select Create New Vendor. 
  • Enter a Vendor Name and retain the Client ID and Client Secret that is automatically generated. These will be needed (along with your regional GURU API URL) when configuring the Visitor Aware integration. 
  • Select Next and enable all OneRoster API permissions. 
  • Select Finish when complete to save the new account.

Help

For questions, contact your eSchoolData support team.



eSchooling

SIS Vendor

eSchooling by Codevision

Minimum Version of Software

1.1.20

Configuration Prerequisites

None

How to get Client ID, Client Secret, and URL(s)

Follow directions in eSchooling platform: System Administration > School Data Sync

Specific Instructions

Same as above

Help

Contact suporte@codevision.pt



Eventful

SIS Vendor

Eventful

Minimum Version of Software

A list of supported student registers can be found at Eventful OneRoster.

Configuration Prerequisites

Reach out to Eventful by email at info@eventful.se or by phone at (+46) 10 209 9001

How to get Client ID, Client Secret, and URL(s)

Will be provided in the setup process.

Specific Instructions

N/A

Help

Contact Eventful Support by email at info@eventful.se or by phone at (+46) 10 209 9001



FACTS

SIS Vendor

FACTS

Minimum Version of Software

Not applicable. Latest version is always available to customers.

Configuration Prerequisites

Not applicable

How to get Client ID, Client Secret, and URL(s)

Customers sign up for OneRoster API and FACTS provides this information to them.

Specific Instructions

From within the SIS, go to System > Configuration > SIS Integrations > OneRoster API > Fill out the form.


See the attached PDF Here  or our helpdesk article here

Help

Customer Support 866-800-6593



Focus School Software

SIS Vendor

Focus School Software

Minimum Version of Software

Focus v 8.7

Configuration Prerequisites

N/A

How to get Client ID, Client Secret, and URL(s)

  • From the Focus portal screen, Setup > System Setup > Third Party Systems. 
  • On the record insert row, enter, Title: Visitor Aware 1.0 > Dialect: OneRoster. 
  • Upon saving, the URL, Client ID, and client secret will be generated.

Specific Instructions

N/A

Help

Call Focus' phone support line at 877-410-6637.



Follett Aspen

SIS Vendor

Follett Aspen

Minimum Version of Software

Latest version of Aspen, 5.9

Configuration Prerequisites

Contact the Customer Relationship Manager for your district if you do not have access to the OAuth Access section.

How to get Client ID, Client Secret, and URL(s)

Create a new OAuth ID and Shared Key under the Admin -> Security -> OAuth Access section under your district view

Specific Instructions

See the information beginning in section "C" of the linked PDF to configure your OneRoster API credentials and tokens

Help

Contact your Customer Relationship Manager for help.



Genesis Educational Services

SIS Vendor

Genesis Educational Services

Minimum Version of Software

N/A

Configuration Prerequisites

N/A

How to get Client ID, Client Secret, and URL(s)

Contact the Customer Relationship Manager for your district to enable the OneRoster SFTP export to Visitor Aware

Specific Instructions

N/A

Help

Contact your Customer Relationship Manager for help.



Infinite Campus

SIS Vendor

Infinite Campus

Minimum Version of Software

For roster provisioning, the minimum version is Campus.1821.

Configuration Prerequisites

Creating an OAuth Client

How to get Client ID, Client Secret, and URL(s)

Sign in and find the latest product documentation for the oAuth configuration screen can be found at OneRoster guidance for Infinite Campus

Specific Instructions

Before V 1933.3 - Go to the Infinite Campus user interface >> select System Administration >> select Campus Learning >> select OneRoster Tools >> select on OneRoster.

Version 1933.3 and later - Go to the Infinite Campus user interface >> select System Administration >> select Learning Interoperability


When selecting attributes within Infinite Campus to sync, ensure that period is not selected. If it's selected, there's a possibility this can generate a large number of errors when syncing and lock the profile in quarantine.

Help

For Help, contact your Customer Success Manager.

Grade Sync Instructions

Onboarding guidance and Grade Sync- Infinite Campus



iSAMS by IRIS

SIS Vendor

iSAMS by IRIS

Minimum Version of Software

21.4.23.12

Configuration Prerequisites

None

How to get Client ID, Client Secret, and URL(s)

You should email helpdesk requesting OneRoster API credentials at helpdesk@isams.co.uk

Specific Instructions

None

Help

Contact iSAMS Helpdesk to ask for help documents at helpdesk@isams.co.uk.



IST

SIS Vendor

IST

Minimum Version of Software

Not applicable.

Configuration Prerequisites

See specific instructions.

How to get Client ID, Client Secret, and URL(s)

See specific instructions.

Specific Instructions

Information for setup will be provided privately.

Help

For questions, contact your IST support team.



LIBRUS

SIS Vendor

LIBRUS

Minimum Version of Software

Current version

Configuration Prerequisites

Client must have a license for LIBRUS Synergia

How to get Client ID, Client Secret, and URL(s)

To enable an API integration with Visitor Aware, you must be logged in as an administrator or school principal. Navigate to Settings > Configuration

Specific Instructions

Detailed instructions are available in the help section.

Help

Contact our support team at pomoc@LIBRUS.pl



MySchool

SIS Vendor

MySchool Ltd

Minimum Version of Software

Not applicable

Configuration Prerequisites

Initial setup of the MySchool system assisted through the support team.

How to get Client ID, Client Secret, and URL(s)

Assisted through the support team.

Specific Instructions

Support can be found here

Help

Contact us



Rediker Software

SIS Vendor

TeacherPlus Gradebook by Rediker Software

Minimum Version of Software

1.12.0.0

Configuration Prerequisites

None. OneRoster integration is enabled for all the schools by default.

How to get Client ID, Client Secret, and URL(s)

Auto-generated by the program when a new school has been created. Admin can manage user settings through the Gradebook Manager application.

Specific Instructions

None

Help

Questions can be directed to GBSupport@rediker.com or APSupport@rediker.com


SchoolTool

SIS Vendor

SchoolTool by Mindex

Configuration Prerequisites

Before attempting to interface with SchoolTool, the district must first install the API Service on any web server used to access SchoolTool. Note that each server must have TLS 1.2 enabled. Refer to the Installing the API Service for OneRoster documentation for the steps required to install this.

How to get Client ID, Client Secret, and URL(s)

Follow the instructions found here: https://documenter.getpostman.com/view/8225618/TzzGHtti#initial-setup

Specific Instructions

See:https://documenter.getpostman.com/view/8225618/TzzGHtti

Help

Currently only supports syncing Orgs and Users (1/5/2024).
Mindex is working on expanding their OneRoster syncing support.

Questions can be directed to your SchoolTool Representative or submitted here: https://www.mindex.com/schooltool/support


SIMS

SIS Vendor

SIMS by Education Software Solutions

Minimum Version of Software

SIMS 7 Summer 2019 or later

Configuration Prerequisites

A SIMS ID account is required.

How to get Client ID, Client Secret, and URL(s)

Use this support link for SDS

Specific Instructions

See https://id.sims.co.uk/support/wiki/136

Help

See https://id.sims.co.uk/support/



Skool

SIS Vendor

Skool

Minimum Version of Software

Miloo+ service is required to enable School Data Sync

Configuration Prerequisites

Contact your Account Manager with Skool to set up and enable Visit.

How to get Client ID, Client Secret, and URL(s)

N/A

Specific Instructions

N/A

Help

Contact Skool support at (+31) 40 750 77 77 or by email at servicedesk@skool.nl.



Skyward

SIS Vendor

Skyward

Minimum Version of Software

05.20.10.00.10

Configuration Prerequisites

The Skyward API must be installed. This is a separate IIS web application from the main Skyward application.

How to get Client ID, Client Secret, and URL(s)

This document shows how to set up the API and generate a key and secret

Specific Instructions

Specific instructions can be found in this document

Help

Submit a service call at https://support.skyward.com



SmartSchool

SIS Vendor

SmartSchool

Minimum Version of Software

The product is a SaaS solution, all clients have the latest version

Configuration Prerequisites

No specific prerequisites

How to get Client ID, Client Secret, and URL(s)

In the software, go to ‘General Configuration’, ‘OneRoster clients’, and follow the instructions there.

Specific Instructions

N/A

Help

Customers can contact SmartSchool through known support channels.



Synergy SIS

SIS Vendor

Synergy SIS by Edupoint

Minimum Version of Software

2022

Configuration Prerequisites

OneRoster API License Key

How to get Client ID, Client Secret, and URL(s)

Contact Edupoint support

Specific Instructions

N/A

Help

https://support.edupoint.com/




PowerSchool Unified Classroom

SIS Vendor

PowerSchool Unified Classroom

Minimum Version of Software

N/A

Configuration Prerequisites

N/A

How to get Client ID, Client Secret, and URL(s)

Instructions on how to create and locate the Client ID, Client Secret, and URL can be located on PowerSchool's OneRoster Documentation Page.

Specific Instructions

N/A

Help

Reach out to your normal PowerSchool support channels at [https://help.powerschoolcom] or by calling +1 (866) 434-6276



Vigilo

SIS Vendor

Vigilo

Minimum Version of Software

None

Configuration Prerequisites

None

How to get Client ID, Client Secret, and URL(s)

Contact Vigilo.

Specific Instructions

See Vigilo OneRoster documentation here (https://vigilo.no/wp-content/uploads/2022/09/Vigilo-OneRoster-implementation_20220907.pdf)

Help

Contact Vigilo for support through the process.



VULCAN UONET+

SIS Vendor

VULCAN UONET+

Minimum Version of Software

Current

Configuration Prerequisites

A client must have a license for UONET+

How to get Client ID, Client Secret, and URL(s)

From the VULCAN Admin portal; Select “Configuration” > “Office 365 settings” > API exchange configuration. Enable “Synchronization with Office 365”. On this tab, you'll also get Client ID, Client Secret, and URL(s).

Specific Instructions

N/A

Help

Contact Support at https://vulcan.edu.pl during standard office hours.



Not seeing your provider? No problem- let us know and we'll get it added!