What is IVM’s OneRoster API?
Our Ident-A-Kid API integration is OneRoster compliant, meaning that we are able to transfer data from School Information Systems that are also OneRoster compliant to the Ident-A-Kid Visitor Management System. We’ve also partnered with ClassLink to be able to provide this API and connect with as many SIS as possible and help you more easily manage all integrations across your district.
What is OneRoster?
OneRoster is the standard specification for securely sharing class rosters and related data between a student information system (SIS) and any other system. This specification is maintained by IMS Global Learning Consortium. If a system uses the OneRoster specification in their integration, they may integrate with any other system that also does.
What School Information Systems will this work with?
Some of the SIS that we can currently connect with and are OneRoster compliant include:
If you do not see your SIS here, it does not mean it will not work. It only means they are not listed on the IMS Global site as OneRoster compliant. Please contact your SIS technical support team to ask if they have an API that will work with OneRoster spec.
How does the integration work?
Once a connection is established, Ident-A-Kid will be able to sync from your SIS the following data:
- Student roster data for more efficient tardy and early release tracking
- Parent and guardian lists for validation of custody before student check-outs or visits for improved safety
There will be no need to update lists as students transfer, are registered or removed from schools. As new contacts are updated for students or if custody changes, we will receive those updates. This saves you the headache of updating this information on a daily basis. You can then use your Student lists under your student buttons of IVM and turn on Parent-Student Relationships for Student Early departures from school. This will validate custody for you, providing an added level of security and speed up the check out process.
Does the OneRoster API send back information to my SIS?
Unfortunately, not at this time. Most School Information Systems do not allow third-parties to send information back. The current OneRoster spec does not support us sending tardies and early releases back into your SIS.
Who will this work for? What are the requirements?
This will work for every IVM customer that is on our Enterprise Edition. The district may add this integration on to their current licensing. Standard School Edition users may not use the OneRoster API. The customer must also have a school information system that has an API that is OneRoster compliant. This will be something you should find out from your SIS. Please also ask them if you can export Parent/Guardian contacts.
Districts will have the option to give you programmatic access to the class rosters via the REST API or upload OneRoster CSV files through ClassLink to you. We only support OneRoster v1.1. This Application can support multiple registrations for different endpoints per district. We support 1.0HMAC SHA256 and Oauth 2 bearer token OAuth connections.
What is the cost?
$200 per school per year. There is also a one time set up fee of $500 to configure the integration and set up the use of the data at each of the school locations.
Can I choose what data to sync and for which schools?
Yes! We can sync students and parent/guardian contacts but this is solely up to you to decide. The customer also maps and enables which schools they would like to use the integration for. Please communicate with our support team on your needs.
What if I already have pre-loaded students in my system?
You will want to delete these lists before we sync the new data in or there will be duplicates.
It may be best to schedule turning this integration on for a time when you will not be using IVM for students so the system can receive the new updated list from your SIS.
How often does it update my lists?
Our integration is set up to sync every 24 hours, but this can be changed by our support team. If your list syncs quickly (varies for many reasons), you can sync more frequently. If your list is very large, you may want to consider syncing every few days.