Veracross API

Overview - Veracross API

Are you sure you want to remove this component?

The Veracross API populates the School User Data Store (SUDS) with user profile and timetable information.

Once SUDS has been populated, the User Provisioning System (UPS) is able to run as a scheduled process for the creation of and ongoing updates to a user’s Schoolbox Profile. A user's timetable and profile page (that directly rely on the Veracross API data in SUDS) will surface the most recently uploaded information as per the schema and do not require the UPS to have completed its scheduled run (though caching of data may delay this). 

NOTE: Due to the duration that the import of data can take, it is recommended that an hourly sync is NOT used.

On this page, you will find the following information:

Generating your Veracross API Key

Managing the Veracross API Connector

Managing the Veracross API Imports

Mapping of Staff - Veracross API to SUDS

Mapping of Students - Veracross API to SUDS

Mapping of Parents & Relationships - Veracross API to SUDS

Generating your Veracross API Key

Are you sure you want to remove this component?

Managing the Veracross API Connector

Are you sure you want to remove this component?

1. Log in to Schoolbox.

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

image.php?hash=b302e431fc2690f9a41a5ef6038bf27b79de4843

3. Select data source as 'Veracross'.

4. Enter your School Data Endpoint Host.

5. Choose your Import Frequency

Note: It is recommended that an import is conducted after midnight to ensure that SUDS is populated with the correct timetable day and to gather current profile data (including new starters). The completion of this import should precede the User Provisioning System’s scheduled run. An additional import before the start of the school day may be utilised to present changes made to the timetable for cover lessons and room changes that may have been made in the SIS that day. A final import after working hours can also be utilised to update any changes made by the SIS administrators that day.

6. Enter your Import Timeout.

7. Enter your Veracross Configuration School Route, Client ID and Client Secret.

8. Select Save.

image.php?hash=6f2d15f0bf47186c9b38ba5a1dc7888549e261f5

Managing the Veracross API Imports

Are you sure you want to remove this component?

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

1. Navigate to Administration > School Data Import > Home.

image.php?hash=7c0e97888862344c840a1f18ec533fc58bc50577

2. Select the 3-dot Menu and select 'Perform Live Update'.

image.php?hash=21f4d779e9499d2f8376320a66e327ac42b7ad6a

To view your current endpoint status and the status of previous imports.

1. Scroll beyond the API configuration.

image.php?hash=df513b50c51dbe3ef79131d7407cb2573d45f780

2. 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 upon the SIS and API configuration used. 

  • The School User Data Store (SUDS) and its Schema

Mapping of Staff - Veracross API to SUDS

Are you sure you want to remove this component?

SUDS Field API Endpoint API Node
External ID v3/staff_faculty ['id']
Username v3/staff_faculty ['username']
Title v3/staff_faculty ['name_prefix']
Firstname v3/staff_faculty ['first_name']
Preferred Firstname v3/staff_faculty ['preferred_name']
Surname v3/staff_faculty ['last_name']
Email v3/staff_faculty ['email_1']
Campus v3/staff_faculty ['campus']
Work Phone v3/staff_faculty ['business_phone']
Staff Category v3/staff_faculty ['faculty_type']
Position Title v3/staff_faculty ['job_title']
Department v3/staff_faculty ['department']
Building - -
Room - -

Mapping of Students - Veracross API to SUDS

Are you sure you want to remove this component?

SUDS Field API Endpoint API Node
External ID v3/students ['id']
Username v3/students ['username']
Title - -
Firstname v3/students ['first_name']
Preferred Firstname v3/students ['preferred_name']
Surname v3/students ['last_name']
Email v3/students ['email_1']
Date of Birth v3/students ['birthday']
Gender v3/students ['gender']
Mobile - -
Emergency Contact Name 1 /v3/emergency_contacts ['first_name'] and ['last_name']
Emergency Contact Phone 1 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Emergency Contact Phone Alt 1 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Emergency Contact Name 2 /v3/emergency_contacts ['first_name'] and ['last_name']
Emergency Contact Phone 2 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Emergency Contact Phone Alt 2 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Emergency Contact Name 3 /v3/emergency_contacts ['first_name'] and ['last_name']
Emergency Contact Phone 3 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Emergency Contact Phone Alt 3 /v3/emergency_contacts ['mobile_phone'],['business_phone'],['home_phone']
Campus - -
House - -
Head of House ID - -
Head of House Name - -
Form - -
Form Teacher ID v3/students ['advisor']['id']
Form Teacher Name v3/students ['advisor']['name']
Tutor Group v3/students ['homeroom']
Tutor Teacher ID v3/students ['homeroom_teacher']['id']
Tutor Teacher Name v3/students ['homeroom_teacher']['name']
Year Level v3/students ['grade_level']
Year Level Coordinator ID - -
Year Level Coordinator Name - -
Studies Code - -
Medical Alert v3/health/patients ['allergies_symptoms', 'current_medications', 'general_medical_notes']
Comment - -
Contact Alert - -
Legal Alert - -
Enrolment Date v3/students ['entry_date']
Leaving Date v3/students ['exit_date']
IB - -
ILP - -
EAL v3/students ['eal']
Special Needs - -
Boarding Status - -

Mapping of Parents & Relationships - Veracross API to SUDS

Are you sure you want to remove this component?

SUDS Field     API Endpoint     API Node

External ID 

 v3/parents ['id']
Username v3/parents ['username']
Title v3/parents ['name_prefix']
Firstname v3/parents ['first_name']
Preferred Firstname v3/parents ['preferred_name']
Surname v3/parents ['last_name']
Email v3/parents ['email_1']
Mobile /v3/contact_info ['mobile_phone']
Home Phone /v3/contact_info ['home_phone']
Work Phone /v3/contact_info ['business_phone']
Relationship  /v3/relationships ['relationship']