Understanding the Integration Error Note
This article lists possible sync errors that could arise with your SIS (Student Information System). We will keep adding more as we encounter it.
Error Indicator Colors:
Yellow ⚠️ Warning: This indicates that there is an issue, but the sync will continue to run. However, some data might be missing. Example :
"Skipped sync for staff 3292923 due to missing email."
Red ⚠️ Error: Indicates a critical issue that stops the sync process. No data will be fetched until the error is resolved. Example :
"Unauthorized: You do not have access to this route."
How to Address These Errors:
Yellow Warnings: Review the specific message to identify what data might be missing or if any action is needed. The sync will complete, but you may need to correct or add missing information.
Red Errors: These are critical errors that prevent the sync from completing. Carefully read the error message to determine necessary corrective action, such as updating credentials, permissions, or data.
Examples of Error :
Error | Reason |
Unauthorized: You do not have access to this route | Warning: RED Diagnose: The API user configured in Synergetic does not have the required security permissions. Update the user’s permissions in Synergetic to allow access to the required API endpoints, then retry the sync. |
Unable to connect to Synergetic server | Warning: RED Diagnose: The Synergetic API server is unreachable or temporarily unavailable. Confirm the API URL is correct and check with your Synergetic administrator or vendor to verify server availability. |
Error while fetching timetable data | Warning: RED Diagnose: The API user does not have permission to access timetable or timetable definition endpoints. Ensure timetable-related permissions are enabled in Synergetic for the API user. |
Skipped sync for staff [ID] due to missing email | Warning: YELLOW Diagnose: The staff member’s record in Synergetic does not contain an email address. Add an email to the staff profile in Synergetic and retry the sync. |
Synergetic Permissions Overview
Synergetic uses security permissions (not OAuth scopes) to control API access.
The API user configured in Orah must be granted permission for each endpoint listed below. Missing permissions may result in partial syncs or failed integrations.
Reference documentation:
Endpoint | Sync Object |
/apiportal/v1/staff | Staff |
/apiportal/v1/studentcontact | Contact |
/apiportal/v1/student | Student, House |
/apiportal/v1/lookuptables/luFileType | Group |
/apiportal/v1/Student/{id}/class | Group |
/apiportal/v1/timetable | Group |
/apiportal/v1/timetabledefinition | Group |
/apiportal/v1/studentattendance/student/{id} | Attendace History |
Prerequisites Before Connecting Synergetic to Orah
Before enabling the Synergetic integration:
Create or identify a dedicated API user in Synergetic
Grant the API user access to all required endpoints listed above
Confirm the API base URL is reachable from your network
Enter the API credentials in Orah → App Directory → Synergetic
Run an initial sync and review warnings or errors
Troubleshooting & FAQs
Groups or timetables are not syncing
Check that the API user has permission to access timetable and timetable definition endpoints.
Some students or staff are missing
Confirm the API user has access to /student, /staff, and /studentcontact endpoints.
Server unreachable or unknown error
These errors usually originate from Synergetic. Contact your Synergetic administrator or vendor to confirm API availability.
For errors related to unknown issues, permission denials, or server connectivity problems, please contact your Synergetic administrator or SIS vendor, as they have visibility into API access and availability. If you need help interpreting an error message or confirming required endpoints, contact us at support@orah.com.