Overview

The JSON Payload Explorer allows schools to inspect the raw and transformed LMS data retrieved during a Compass sync.

This tool assists with:

• Troubleshooting sync issues

• Reviewing transformed student and parent data

• Understanding which LMS fields are used during processing

Accessing the JSON Payload Explorer

After a successful sync:

1. Navigate to:

   1. Integrations → LMS → Compass

   2. View Sync Details

This opens the JSON Payload Explorer.

Search Functionality

At the top of the page:

• Use the search bar to filter results by:

  • Student name

  • Student code

In Compass, the student code is the student’s LMS username.

Student Overview

Each student card displays:

• Student name

• Student number/code

• Active status

• Campus

• Year level

Used Fields Count

The upper-right corner of the student card displays:

• Number of fields currently used during processing

• Total available fields

This includes:

• Student fields

• Parent fields

GUI View

By default, results display in a user-friendly GUI format.

This includes:

• Student data

• Parent data

• Relationship information

• Processed/transformed values

Parent Information

Each parent card displays:

• Name

• LMS identifier

• Email

• Phone number

• Address

• Parent priority

• Correspondence status

• Lives with student status

Important Notes

Parent Email Requirement

Parents without an email address:

• Will not sync into RollCall

Emails are required for:

• Parent login access

• LMS linking

Raw Data View

Below the transformed data:

• Raw LMS response data can be viewed

This displays:

• Unprocessed LMS data

• Nested objects and linked records

Used Fields Indicators

Blue dots/highlights indicate:

• Fields currently used during RollCall processing

Example:

• Student first name

• Parent email

• Address fields

JSON View

Toggle to:

• JSON View

This displays:

• Exact LMS JSON response data

• Original LMS payload structure

Linked Objects

Some JSON fields begin with:

• _linked_

These indicate:

• Additional data retrieved from separate LMS endpoints

Sync Settings Panel

The right-hand panel displays:

• Current school sync settings

This can help troubleshoot:

• Missing students

• Missing parents

• Filtered sync results

Best Practice Recommendations

✅ Use the search bar to quickly locate students
✅ Review transformed data before troubleshooting sync issues
✅ Check Used Fields when diagnosing missing data
✅ Verify parent email addresses exist in Compass
✅ Review Sync Settings if records are unexpectedly excluded