Skip to main content

Operoo Wonde Sync - How does it work?

Warren Chan
Updated

 

At Operoo, our developers often get asked how our Wonde sync works and what fields we use, so we decided to put this technical article together to try and answer some of those questions.

 

Wonde Documentation

We use this documentation for Wonde API v1.0 
 

Integration Setup Process

  1. Operoo submits a request to Wonde to integrate with a school's SIS
  2. Wonde support contacts the school's POC to help in integrating their SIS to Wonde, or if they already have a Wonde account, configure the permissions for sharing.
  3. Once Wonde support is done with the above, Operoo gets an email to say that the school's data is now live in Wonde.
  4. Operoo generates a Wonde API read-only token to read the Wonde data
  5. Operoo generates an Operoo API key called "WondeTwo" to populate data into Operoo
 

How It Works 
 

Every school will have a unique Wonde School ID. 
For this article, we will use the Wonde School ID 'A1234'   

Interrogating Wonde EndPoints

Step 1 
 

We interrogate the following Wonde URL:
We then use the retrieved data to display log entries, from the data field 'name'
 

Step 2

Getting staff, students, and groups data from Wonde
We make calls to the following endpoints:
  • /schools
  • /students
  • /students-pre-admission
  • /classes
  • /employees
  • /students
  • /groups (where the type = campus)
 
Wonde data comes in the following format: 
 
{ "data": [ <Item>, ... ] }
Mapping Staff Data
From the data retrieved from the 'employees' URL, we translate each employee Item of the root 'data' array into an Operoo Staff Member. https://api.wonde.com/v1.0/schools/A1234/employees?include=employment_details,contact_details
 
We only bring to Operoo, Wonde employee records with the flag ['employment_details']['data']['current'] set to 'true'
 
This is the Staff mapping used:
Operoo Staff Member Data 
 
Wonde Staff Item Data 
 
integration_id 
 
id 
 
first_name 
 
legal_forename (and in its absence 'forename')
 
last_name 
 
legal_surname (and in its absence 'surname')
 
user_request_id 
 
mis_id 
 
request_email 
 
contact_details['data']['emails']['work']
 
 
Mapping Student Data
From the data retrieved from the 'students' URL, we translate each student Item of the root 'data' array into an Operoo Student Member. https://api.wonde.com/v1.0/schools/A1234/students?include=contacts,contacts.contact_details,permissions
This is the Student mapping used for Community Edition (CE):
Operoo Student Member Data 
 
Wonde Student Item Data 
 
integration_member_id 
 
id 
 
user_request_id
mis_id
first_name
legal_forename (and in its absence 'forename')
last_name
legal_surname (and in its absence 'surname')
request_email 
 
best_contact primary email (or in its absence the first. See details below)
 
request_mobile_number
best_contact primary phone (or in its absence the first. See details below)
 
 This is the Student mapping used for Group Edition (GE):
Operoo Student Member Data 
 
Wonde Student Item Data 
 
integration_member_id 
 
id 
 
user_request_id
mis_id
first_name
legal_forename (and in its absence 'forename')
last_name
legal_surname (and in its absence 'surname')
preferred_first_name
 
forename
 
preferred_last_name
surname
middle_names
middle_names
request_email 
 
best_contact primary email (or in its absence the first. See details below)
 
request_mobile_number
best_contact primary phone (or in its absence the first. See details below)
 
Student phone numbers and email addresses

Operoo syncs student email addresses and student phone numbers from Wonde.
 

Wonde has 5 types of phone numbers
  • phone
  • primary
     
  • home
     
  • work
     
  • mobile
     

and 4 types of email addresses
 

  1. email
     
  2. primary
     
  3. home
     
  4. work

For students in Operoo, we only display:

  • the email address of type "home"
  • the phone numbers of type "home" and "mobile"
 
Community Edition

 

Parent contact
The best parent contact is determined by the following:

  1. if there are contacts with the ['relationship']['priority'] attribute set to '1', choose the first one
  2. in its absence choose the first contact with the ['relationship']['relationship'] attribute set to 'Mother'
  3. in its absence choose the first contact with the ['relationship']['relationship'] attribute set to 'Father'
  4. in its absence choose the first where the attribute ['contact_details']['data']['emails']['primary'] has data
  5. in its absence choose the first where the attribute ['contact_details']['data']['phones']['primary'] has data
  6. in its absence choose the first where the attribute ['contact_details']['data']['phones']['phone'] has data
  7. in its absence choose the first contact

Parent phone numbers

We sync the parent's phone numbers in the following order of preference.

  1. 1.  Primary
  2. 2. Phone

Staff

We don't sync staff phone numbers from Wonde.

Staff can add/change their mobile phone number directly in Operoo Central

Group Edition

Student Contacts Phone Numbers 

We sync all phone numbers and display them in the following order:

  1. Mobile
  2. Work

  3. a random selection from any other provided phone number

    Student contacts in Group Edition must have
    a first name and last name to sync successfully
     

     

Student Contact Email addresses

For student contacts, we sync one of the provided emails as the primary Operoo email.  The order of preference is as follows:

  1. Home

  2. Work

  3. a random selection from any other provided email addresses

Contacts using SSO
The primary Operoo email will be used for SSO login.  Home email address is the default primary Operoo email address but if there is no Home email address in Wonde then Operoo will use the Work email address.  If the primary email address in Operoo is manually overridden, then Operoo will use the overridden email address.

 

Staff

We sync staff phone numbers in the following order of preference.

  • 1. Mobile
  • 2. Work
  • 3. Primary
  • 4. Phone
Mapping Groups Data


 

Community Edition 
 
From the data retrieved from the 'groups' URL, we translate each group Item of the root 'data' array into an Operoo Group.
Groups with no data in the 'name' attribute are skipped.
 
Mapping Year Groups Data
Only Groups with 'type' attribute having the value 'YEAR'
 
This is the Year Group mapping used:
Operoo Group Data
Wonde Group Item Data
integration_group_id
id
name
description (and in its absence 'name')
student_memberships
a compilation of the 'student_memberships' from Registration Groups with this year group id into parent_group_id
 
Mapping Registration Group Data
Only Groups with 'type' attribute having the value 'REGISTRATION'
 
 
This is the Registration Group mapping used:
Operoo Group Data
Wonde Group Item Data
integration_group_id
id
name
description (and in its absence 'name')
parent_group_id
the id of a year group, matching by similar group name, or no id
student_memberships
all the 'id' attributes from the ['students']['data'] array
Having a 'parent_group_id' will cause that group to be displayed on a tree level in Operoo
 
Group Edition
In Group Edition, the Groups description is taken from the "code" field in Wonde.  The "name" field is not used.

Only the following groups are synced into Operoo

  • Year Level
    • Year Description/name
  • Registration Groups
    • Registration Description/name
  • Houses
    • House Description/name
  • Classes
    • Class Description/name

Groups Staff Assignments

Staff assignments are only synced to the following groups

  • Classes
 

Step 3

Getting Student Photos
 
Mapping Student Data 
 
From the data retrieved from the 'students' URL, we translate each student Item of the root 'data' array into a Operoo Student Photo.
 
The records with the flag ['permissions']['data']['photograph_student'] set to false' are skipped as Wonde is telling us we don't have permission to have that Student Photo on our website.
 

Step 4

Getting Staff Photos
We interrogate the following Wonde URL:
 
Mapping Staff Data: 
 
From the data retrieved from the 'employees' URL, we translate each employee Item of the root 'data' array into a Operoo Staff Photo.
The records with the flag ['employment_details']['data']['current'] set to 'false' are skipped as Wonde is telling us this employee has left the School.
 
 
Additional information: 
 
 
SIMS Profiles:
To sync both blue and white SIMS profiles into Operoo, make sure both profile types are synced from SIMS into Wonde.  Operoo will then sync the data from Wonde.

Why is an existing person archived and recreated?
If any of the following things change, the Operoo sync cannot know if the person is the same so we treat them as a new person (student, staff, or parent)

Changes in:

  • parent relationship
  • parent name
  • student integration id
  • student id
 
 

Related articles