Veracross API

To access Veracross' documentation on generating an API Key:

1. Navigate to https://community.veracross.com/s/article/Setting-Up-New-Integration-Partners-in-Veracross-API

Scopes Required For Data Import

• academics.classes.meeting_times:list
• academics.enrollments:list
• academics.student_alerts:list
• admission.languages:list
• classes:list
• contact_info:list
• emergency_contacts:list
• health.patients:list
• parents:list
• person_photos:list
• staff_faculty:list
• students:list

Scopes Required for Identity

• openid
• sso

1. Log in to Schoolbox.

2. Go to Administration > School Data Import > Home.

3. Select data source as 'Veracross'.

4. Enter your School Data Endpoint Host.
  Note: This is likely to be either https://api.veracross.com or https://api.veracross.au, but you should check with Veracross where your region endpoint is located.

5. Choose your Import Frequency

Note: It is recommended to run your import at least twice daily. 1 prior to the the run of the user provisioning system to get updated student enrolments and one in the morning for the first updated timetable data. 

6. Enter your Import Timeout.

7. Enter your Veracross Configuration School Route, Client ID and Client Secret.
The appropriate school route is shown for each school in the Partner Portal or can be seen in the URL used to access the portal, its the first segment after the domain. https://axiom.veracross.com/{school_route}/

8. Enter your Portal Access Name

This name is the portal which you have configured for staff to mark attendance within.  When teachers mark the roll they will be taken to this portal in order to complete the roll marking.  This name can be seen in the portal URL https://portal.veracross.com/{school_route}/{portal_access_name}/ .  By default this is usually set to 'faculty'. 

8. Select Save.

Schoolbox gives you more control over how you import data using School User Data Store (SUDS) from an API connector into Schoolbox. You can now import specific groups of data - like user profile data, timetable data - separately, instead of all at once.

This will help you when you want to make small updates or test new data without affecting everything in your system.

To perform an update of your SUDS data from an API connector:

1. First, ensure you have enabled school data import for your school. See Managing the School User Data Store (SUDS). 
    
2. Next, go to Administration > School Data Import > Home.
   This opens the school data import home page for you. 
    
3. Then, select the 3-dot menu iconand select one of the following:
   • Update user data and timetables
   • Update user data only
   • Update timetable only
4. For each, select Save to proceed with the import.
    
5. Next, in Daily Org Import Time, enter the specific time of day when you want your school’s timetable data to be automatically imported into Schoolbox from your external system.
   Note: This runs every day of the week.
   This scheduled import ensures that any timetable updates made in your source system are reflected in Schoolbox each day.
   Timetable data updates are not immediate. They typically take around 15–20 minutes to appear in Schoolbox, though in some cases, it may take longer.
   Note: This field only affects the import of timetable data.
    
6. To view your current endpoint status and the status of previous imports, scroll beyond the API configuration:
    
7. Select 'current endpoint status' for a detailed view of the status of each endpoint and node as required.
   Note: The 'Previous Imports' section will vary based on the SIS and API configuration used.