Skip to main content
Sign in

Aeries API Integration (CatapultEMS/CatapultConnect)

  • Updated

If you need to know exactly which fields CatapultEMS and CatapultConnect draw from in the Aeries student information system, see below.

If you use an HR or student information system other than Aeries, see Tips for SIS export (CatapultEMS) or the equivalent for CatapultConnect.

Contents

Account setup

Certificate instructions

Permissions needed

  • “Student Data” section
    • Student Data
    • Contacts
    • Class Schedules/History
  • “Scheduling” section
    • Teacher Data
    • Staff Data
    • Course Data
    • Master Schedule
  • “Attendance” section (only needed if you send attendance alerts through CatapultConnect)
    • Attendance Data (ATT)
    • Attendance History Security

Share with Catapult staff

For security, share these details in the document that Catapult shares with you rather than sending via email.

  • Aeries certificate: A random series of letters and numbers generated by Aeries.
  • Aeries base URL: For example, https://yourdistrict.aeries.net/admin
  • School list: Do any schools in Aeries share the same physical location and need to be merged into one for CatapultEMS?

Staff information

  • ID

    • For Teachers: Pulled from StaffID1 (TCH.ID), and / or StaffID2 (TCH.ID2), and / or StaffID3 (TCH.ID3).

    • For Non-Teacher Staff: Pulled from ID (STF.ID)

  • School Association

    • For Teachers:

      • Pulled from SchoolCode (TCH.SC)

    • For Non-Teacher Staff:

      • Pulled from PrimaryAeriesSchool (STF.PSC)

  • First Name

    • For Teachers:

      • If valid Staff record (TCH.ID, TCH.ID2, TCH.ID3), then pulled from FirstName (STF.FN)

      • Else pulled from FirstName (TCH.TF)

    • For Non-Teacher Staff:

      • Pulled from FirstName (STF.FN)

  • Last Name

    • For Teachers:

      • If valid Staff record (TCH.ID, TCH.ID2, TCH.ID3), then pulled from LastName (STF.LN)

      • Else pulled from LastName (TCH.TLN)

    • For Non-Teacher Staff:

      • Pulled from LastName (STF.LN)

  • Email

    • For Teachers:

      • If valid Staff record (TCH.ID, TCH.ID2, TCH.ID3), then pulled from EmailAddress (UGN.EM)

      • Else pulled from EmailAddress (TCH.EM)

    • For Non-Teacher Staff:

      • Pulled from EmailAddress (UGN.EM)

      • According to API doc, if EmailAddress (UGN.EM) is blank, then pulled from EmailAddress (STF.EM)

  • Mobile Number

    • For Teachers:

      • If valid Staff record (TCH.ID, TCH.ID2, TCH.ID3), then pulled from CellPhone (STF.CP)

    • For Non-Teacher Staff:

      • Pulled from CellPhone (STF.CP)

  • Title

    • For Teachers: “Teacher”

    • For Non-Teacher Staff:

      • Pulled from Title (STF.TI)

  • Status

    • For Teachers: 

      • Check InactiveStatusCode (TCH.TG)

      • If teacher has associated staff record, then it checks the InactiveStatusCode (STF.TG)

    • For Non-Teacher Staff:

      • Checks the InactiveStatusCode (STF.TG)

Student information

  • ID

    • Pulled from PermanentID (STU.ID)

  • School Association

    • Pulled from SchoolCode (STU.SC)

      • If a student attends an additional specialized attendance program to which the student belongs, please enter the additional school in AttendanceProgramCodeAdditional2 (STU.AP2) 

  • First Name

    • Pulled from FirstName (STU.FN)

  • Last Name

    • Pulled from LastName (STU.LN)

  • Email

    • Not Pulled

  • Mobile Number

    • Not Pulled

  • Bus Route
    • Can be pulled from UserCode1 (UC1) by request.

Student-teacher association

  • Classes

    • If there are "classes" (as in High School and Middle School), then the student-teacher association is pulled from the Course Attendance Record (CAR.TN + STU.ID).

      • If there are classes, then the association pulls based on the following criteria:

        • The class hasn't ended (CAR.DE)

        • The class has an associated Course (CAR.CN)

        • The associated course is valid (CRS.TG is blank)

      • If processing Sections,

        • There is a valid associated Section (CAR.SE)

        • There is an associated Term (MST.SM)

        • The term is currently happening (current date is after Start Date (TRM.D1), and before End Date (TRM.D2))

      • If using Flex Schedule,
        • The class is currently happening (current date is after start date (CAR.DS) and before end date (CAR.DE))
        • The class has an associated Course (CAR.CN)
        • The associated course is valid (CRS.TG is blank)
        • The section is valid (CAR.SE)
        • The section is active (MST.STG),
        • The section staff are active (SSE.TG)
        • The section staff are valid (SSE.ID/STF.ID)

  • No Classes

    • If there are no "classes" (as in Elementary School), then the student-teacher association is pulled from CounselorNumber (STU.CU).

Contact/guardian information

CatapultEMS and Connect pulls up to two contacts per student. By request, Catapult can import based on contact order (for example CON.OR 1 and 2).

  • Name

    • Pulled from MailingName (CON.NM)

      • If it is not set, then it pulls from FirstName (CON.FN) and LastName (CON.LN)

      • If the FirstName or LastName are blank then it pulls from the ParentGuardianName (STU.PG)

  • Language

    • Contact's CorrespondenceLanguageCode (CON.CL). Note: this is the correspondence language of the contact not the student.

      • If it is not set, then it pulls from the HomeLanguageCode of the student (STU.HL)

      • By request, CatapultConnect can pull STU.CL instead of STU.HL. This is a district-wide setting.

  • Email

    • Pulled from EmailAddress (CON.EM)

      • If it is not set, then it pulls from ParentEmailAddress (STU.PEM)

  • Cell Phone

    • Contact's Phone comes from CellPhone (CON.CP)

      • If it is not set, then it pulls from HomePhone (CON.TL)

  • Alert Types Received

    • Contact’s NotificationPreferenceCode (CON.NP). Catapult skips any contacts labeled, "Do No Contact."

Related articles