eSD with Custom Endpoints – Operoo

Working closely with our integrations partner eSchoolData (eSD) we now have a new API endpoint available in eSD. For our clients using integration with eSD, there is now an option to "Use Operoo Endpoints". When "Yes" is selected, the API endpoint to eSD is updated to include `/operoo/` in its URI path for Pre-enrolled students and their contacts.

This means that each eSD integration has two sets of rules. Here's what happens when "Using Operoo Endpoints" option is selected as:

Yes:

All Pre-enrolled students come from Operoo endpoint only, not the standard eSD endpoint.
When no schools are selected, only sync Pre-enrolled students who have not been assigned to any school.
When any school is selected, both Enrolled and Pre-enrolled students from that school will sync. This is not optional.
When a student is removed from eSD, that student is also removed in Operoo.

No:

All Pre-enrolled students come from the standard eSD endpoint, not the custom Operoo endpoint.
When no schools are selected, no students will sync.
When any school is selected, Enrolled and Pre-enrolled options may be used to sync the selected type of student.
When a student is removed from eSD, that student is also removed in Operoo.

Troubleshooting Example: Using Operoo Endpoints, check if a student is Enrolled or Pre-Enrolled. If Pre-Enrolled students exist in eSD that have not been allocated to a school, these students will sync into Operoo and be placed in the "All District Pre-Enrolled Students" group.

When facing with the challenge of reconciling data accuracy between Operoo and eSD, it often helps to consult the source of data for Operoo. For us, eSD provide this interface by using the browser. This interface is called Guru. To log into the Guru interface for your organization, go to Integration Settings > Press 'Edit' button. From here Copy the Client API URL and paste it into Chrome browser. (This must be Chrome, and you need to be in the US region when making this request). To log into the API explorer, add `/api/developers/login` to the end of the address you just entered in Chrome, with the address looking something like `https://guru.mydistrict.org/api/developers/login` . Here you will see a login prompt, where you should enter the Client ID and Client Secret. You will now be presented with the API Explorer web interface for eSD. Be mindful, this might take a while to load.

Once loaded, you can explore eSD data to reconcile any differences that may exist in Operoo. For example, when using the Operoo Endpoints option you might want to check if there are any students who are Pre-Enrolled and have not been assigned to a school yet, scroll down until you find the Operoo API endpoints, select the `/operoo/students` call and select Yes for the isPreEnrolled Option:

When you press the `Try it out!` button to fetch those Pre-Enrolled students, a list will appear in the Response Body field. Here search for the `"school": null` string to identify students who have not been allocated to a school. If you cannot find any students who have the `"school": null` attribute set, then all Pre-Enrolled students have been allocated to a school:

You can also query any other eSD data in this API Explorer interface. If things don't look correct here you will need to contact the administrators responsible for populating this data in eSD. If this data in eSD looks correct but it does not in Operoo, then contact your friendly Operoo Support staff by using our chat widget, or your Operoo Customer Success Manager directly.

Related articles