This article explains what data is imported from Aeries into JumpRope through the Aeries API integration, how each data type is filtered, and what configuration options are available to control the import.

Overview

JumpRope connects to the Aeries v5 REST API to perform a one-way data synchronization. This article covers data that flows from Aeries into JumpRope -- not JumpRope back to Aeries. The import runs automatically on a nightly basis and can also be triggered manually by a JumpRope administrator.

The integration imports the core roster data your school or district needs to get started with the JumpRope gradebook: teachers, students, courses, class sections, and student enrollments. Optional features can also import family/guardian portal accounts and student photos.


Data Types Imported

Schools

JumpRope imports basic school information for each school included in the integration.

What's imported:

  • School name

  • School code (used as the unique identifier)

  • Address information

  • Grade levels offered

Filtering: Only schools whose school codes are listed in your integration configuration are imported. Schools not in the list are ignored.

Teachers & Staff

Teacher and staff accounts are synced so that JumpRope class sections can be associated with the correct instructors.

What's imported:

  • First and last name

  • Email address

  • Staff ID (used as the unique identifier)

  • School assignment(s)

Filtering:

  • School access required -- For each school import, only staff members who are assigned to the school as their primary school in Aeries, who have access permissions for the school in Aeries, or who are assigned to active class sections at the school are included. Staff without school access are skipped.

  • Inactive staff excluded -- Staff members marked as inactive in Aeries (with an Inactive Status Code such as "I" or "N") are not imported.

  • Name required -- Staff records missing a first or last name are skipped.

Ongoing Automatic account provisioning -- JumpRope will automatically create or update teacher and staff user accounts based on the Aeries staff data. New teachers added in Aeries will automatically receive JumpRope accounts. If a teacher is removed from your school in Aeries, their JumpRope account is be deactivated automatically. Safety limits are in place to prevent accidental bulk deactivations.

Courses

JumpRope imports the course catalog from Aeries so that class sections can reference their parent course.

What's imported:

  • Course ID (unique identifier)

  • Course title and description

  • Department

  • Subject area

  • Default credit value

Filtering: All courses in the district catalog are imported. Course filtering is done at the section level, not the course level.

Class Sections

Class sections represent the individual class sections that teachers teach and that students are enrolled in.

What's imported:

  • Section number (unique identifier)

  • Associated course

  • Assigned teacher(s) -- Aeries v5 supports multiple teachers per section (team teaching)

  • Period and room information

  • Term/semester assignment

  • Active/inactive status

Filtering:

  • Inactive sections excluded -- Sections marked as inactive in Aeries are not imported.

  • Only sections belonging to included schools are imported.

Students

Student demographic and enrollment data is imported so that students appear in the correct classes in JumpRope.

What's imported:

  • Student ID (unique identifier)

  • Student number

  • First and last name (middle name optional -- see Settings below)

  • Grade level

  • Email address (optional -- see Settings below)

  • Date of birth

  • Gender

  • State ID

  • School enrollment dates

Filtering:

  • Inactive students identified -- Students with a School Leave Date set in Aeries are marked as inactive in JumpRope.

  • Future enrollments excluded -- Students with a School Enter Date in the future are not imported until that date arrives.

  • Grade level filter (optional) -- If a grade level filter is configured, only students in the specified grade levels are imported. For example, a high school might choose to import only grades 9-12. Students in other grade levels are skipped entirely, including their enrollments.

Enrollments (Student-to-Section Assignments)

Enrollments connect students to their class sections, determining which classes each student appears in.

What's imported:

  • Student assignment to section

  • Enrollment start and end dates

Filtering:

  • Valid references required -- An enrollment is only created if both the student and the section exist in JumpRope.

  • End date filter (optional) -- When enabled (it is on by default), enrollments with a past end date are excluded. This prevents students who have dropped a class from still appearing in that section. If an enrollment end date matches the class end date, the enrollment will always be preserved.

  • Grade level filter applies -- If a grade level filter is set, enrollments for students outside the included grade levels are also skipped.

Family & Guardian Portal Accounts and Contact Information (Optional)

When the family contacts feature is enabled, JumpRope can import parent, guardian, and other family contact information for students. Each contact gets an account for the JumpRope Family Portal.

What's imported:

  • Contact first and last name

  • Email address

  • Phone and mobile phone numbers

  • Relationship to student (e.g., Mother, Father, Guardian)

Filtering:

  • Active students only -- Family contacts are only imported for students with an active enrollment.

  • Name required -- Contacts missing a first or last name are skipped for security reasons.

  • Email required -- Contacts missing an email cannot have an account created.

  • Restricted contacts excluded -- Contacts flagged as restricted in Aeries are automatically excluded. The specific restricted codes are determined by your district's Aeries configuration -- JumpRope reads them dynamically.

  • Relationship and authorization code filters (optional) -- Administrators can configure which authorization codes to include. Only contacts matching the specified codes will be imported.

Student Photos (Optional)

When enabled, JumpRope imports student photos from Aeries to display in the gradebook and student profiles.

What's imported:

  • Student photo image

Filtering:

  • Active students only -- Photos are only fetched for active students.

  • New photos only -- Students who already have a photo in JumpRope are skipped. This prevents unnecessary re-uploads and reduces API calls.


Available Settings & Configuration

The following settings can be configured to control what data is imported and how. These are typically configured during initial setup by your JumpRope implementation specialist but can be adjusted as needed.

Import Settings

These settings control the behavior of the import and can be configured per-school:

Setting Description
School IDs Which Aeries school codes to include in the import. Only schools listed here will be synced.
Grade Levels Limit the import to specific grade levels (e.g., "9, 10, 11, 12"). Leave blank to import all grade levels.
Include Student Middle Name Whether to import the student's middle name from Aeries. Off by default.
Filter Enrollment by End Date Exclude enrollments where the end date has passed. Enabled by default.
Save Student Photos Import student photos from Aeries.
Import Family Accounts Controls whether family accounts are created during import. Can be set to import verified contacts only, all contacts, or disabled entirely.
Family Account Authorization Codes Comma-separated list of authorization codes to filter which contacts are imported.

Validation & Safety Limits

JumpRope includes safeguards to prevent accidental data loss during imports:

Safeguard Description
Staff Deactivation Limit Maximum number of staff accounts that can be deactivated in a single import. If exceeded, the import is flagged for review.
Staff Deactivation Percentage Limit Maximum percentage of staff that can be deactivated. Prevents a data issue from wiping out all teacher accounts.
Student Deactivation Limit Maximum number of students that can be deactivated in a single import.
Student Deactivation Percentage Limit Maximum percentage of students that can be deactivated.
Family Contact Deactivation Threshold Minimum retention ratio (default 25%) -- if family contact counts drop below this threshold, deactivation is skipped.

Note: During August and September (back-to-school season), validation limits are automatically increased to accommodate the larger roster changes typical at the start of a school year.


How the Import Works

Nightly automation -- The import runs automatically each night. JumpRope connects to the Aeries API, reads the current data, and updates JumpRope to match.

One-way sync -- Data only flows automatically from Aeries to JumpRope.

Manual trigger -- District and school administrators can trigger an import manually from the JumpRope admin panel when immediate updates are needed (for example, after a large batch of schedule changes in Aeries).

Import results -- After each import, administrators can view a summary of what changed: how many students, teachers, courses, sections, and enrollments were added, updated, or deactivated.


What Is Not Imported

The following data types are not currently part of the Aeries integration:

  • Grades and marks -- JumpRope does not pull grades from Aeries. Grade submission to Aeries (for Class Grades) is a separate feature.

  • Attendance -- Attendance data is not synced between Aeries and JumpRope.

  • Assignments -- Assignment data from Aeries is not imported.

  • Standards -- Standards/learning objectives are managed within JumpRope and are not pulled from Aeries.

  • Student discipline records -- Not imported.

  • Bell schedules -- Not imported.


Frequently Asked Questions

Q: How often does the import run? A: The import runs automatically once per night. Administrators can also trigger a manual import at any time.

Q: Will the import overwrite changes I made in JumpRope? A: The import updates roster data (students, teachers, sections, enrollments) to match Aeries. Manual changes to these records in JumpRope may be overwritten on the next import. However, JumpRope-specific data like standards, scores, and gradebook settings are never affected by the import.

Q: What happens when a student transfers to a new school? A: If the student's new school is also connected to JumpRope, they will appear in the new school's roster on the next import. In the previous school, their enrollment will reflect the leave date from Aeries.

Q: What happens when a new teacher is hired mid-year? A: The new teacher will automatically appear in JumpRope on the next import, as long as they have a school assignment or school access permissions set in Aeries. If Provision Users is enabled, a JumpRope account will be created for them automatically.

Q: Can I import only certain grade levels? A: Yes. The Grade Levels setting lets you specify which grades to include. Students in other grade levels, and their enrollments, will be excluded.

Q: What if the import encounters an error? A: The import includes validation checks and safety limits. If something looks unusual (for example, an unexpectedly large number of deactivations), the import will stop and flag the issue for administrator review. Import results and any errors are available in the JumpRope admin panel.


Related Articles

  • How to create the API credentials in Aeries for JumpRope - Aeries API Certificate Setup

  • General SIS integration overview - Automated Data Transfer from Student Information System