Sentral API

Overview - Sentral API

Are you sure you want to remove this component?

The Sentral 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 Sentral 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). With this, the school staff can mark attendance to their class via the deep linking 'Mark Attendance' in their timetable.

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 Sentral API Key

Managing the Sentral API Connector

Managing the Sentral API Imports

Mapping of Staff - Sentral API to SUDS

Mapping of Students - Sentral API to SUDS

Mapping of Parents & Relationships - Sentral API to SUDS

Generating your Sentral API Key

Are you sure you want to remove this component?

View All Files

Managing the Sentral 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 'Sentral'.

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 Sentral Configuration Key and Tenant.

8. Select which type(s) of contact will be identified as parents of students.

NOTE: If none are selected, "Parent, Step-Parent, Adoptive Parent, Foster Parent, Guardian" will be identified by default.

9. Select the checkbox in the Receives Portal Access field to select which parents or contacts are created and linked to their students to display in the Student profile page Contacts tab. 

image.png

10. When done, select Save.

Managing the Sentral 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 - Sentral API to SUDS

Are you sure you want to remove this component?

SUDS FieldAPI EndpointAPI Node
External IDenrolments/staff['attributes']['staffCode']
Usernameenrolments/staff['attributes']['timetableCode']
Titleenrolments/staff['relationships']['person']['data']['attributes']['title']
Firstnameenrolments/staff['relationships']['person']['data']['attributes']['firstName']
Preferred Firstnameenrolments/staff['relationships']['person']['data']['attributes']['preferredName']
Surnameenrolments/staff['relationships']['person']['data']['attributes']['lastName']
Emailenrolments/staff['relationships']['person']['data']['attributes']['email']
Campus--
Work Phoneenrolments/person['data']['relationships']['phoneNumbers']
Staff Categoryenrolments/staff['attributes']['employmentClassification']
Position Titleenrolments/staff['attributes']['jobTitle']
Department--
Building--
Room--

Mapping of Students - Sentral API to SUDS

Are you sure you want to remove this component?

SUDS FieldAPI EndpointAPI Node
External IDenrolments/student['attributes']['studentCode']
Username--
Titleenrolments/student['relationships']['person']['data']['attributes']['title']
Firstnameenrolments/student['relationships']['person']['data']['attributes']['firstName']
Preferred Firstnameenrolments/student['relationships']['person']['data']['attributes']['preferredName']
Surnameenrolments/student['relationships']['person']['data']['attributes']['lastName']
Emailenrolments/student['relationships']['person']['data']['attributes']['email']
Date of Birthenrolments/student['relationships']['person']['data']['attributes']['dateOfBirth']
Genderenrolments/student['relationships']['person']['data']['attributes']['gender']
Mobile--
Emergency Contact Name 1enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['firstName'] and ['data']['attributes']['lastName']
Emergency Contact Phone 1enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - MOBILE_TELEPHONE_NUMBER or HOME_TELEPHONE_NUMBER
Emergency Contact Phone Alt 1enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - WORK_TELEPHONE_NUMBER
Emergency Contact Name 2enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['firstName'] and ['data']['attributes']['lastName']
Emergency Contact Phone 2enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - MOBILE_TELEPHONE_NUMBER or HOME_TELEPHONE_NUMBER
Emergency Contact Phone Alt 2enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - WORK_TELEPHONE_NUMBER
Emergency Contact Name 3enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['firstName'] and ['data']['attributes']['lastName']
Emergency Contact Phone 3enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - MOBILE_TELEPHONE_NUMBER or HOME_TELEPHONE_NUMBER
Emergency Contact Phone Alt 3enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] - WORK_TELEPHONE_NUMBER
Campus--
House--
Head of House ID--
Head of House Name--
Formenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['rollClass']
Form Teacher ID--
Form Teacher Name--
Tutor Groupenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['tutorGroup']
Tutor Teacher ID--
Tutor Teacher Name--
Year Levelenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['schoolYear']
Year Level Coordinator ID--
Year Level Coordinator Name--
Studies Code--
Medical Alertenrolments/student['relationships']['person']['data']['relationships']['medicalConditions']['links']['related']
Comment--
Contact Alert--
Legal Alert--
Enrolment Dateenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['startDate']
Leaving Dateenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['endDate']
IB--
ILP--
EAL--
Special Needs--
Boarding House Nameenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['boardingHouse']
Boarding Statusenrolments/student['relationships']['primaryEnrolment']['data']['attributes']['isBoarding']
Photo Redacted  

Mapping of Parents & Relationships - Sentral API to SUDS

Are you sure you want to remove this component?

SUDS Field    API Endpoint    API Node
External ID enrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['externalId']
Username--
Titleenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['title']
Firstnameenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['firstName']
Preferred Firstnameenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['preferredName']
Surnameenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['lastName']
Emailenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['attributes']['email']
Mobileenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] and ['attributes']['typeName']
Home Phoneenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] and ['attributes']['typeName']
Work Phoneenrolments/person/{$contact['attributes']['personId']}?include=phoneNumbers['data']['relationships']['phoneNumbers'] and ['attributes']['typeName']
Relationship person/v1/GetParents['attributes']['relationName']