/
Aeries API integration (CatapultConnect/CatapultEMS)

Aeries API integration (CatapultConnect/CatapultEMS)

Owned by EMS Accounts (Unlicensed)
Last updated: Aug 05, 2020
3 min read

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

Contents

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)

  • 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

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 will be outputted if the following criteria are valid:

        • 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)

      • If there is an associated Term (MST.SM)

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

  • 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

  • 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

    • CorrespondanceLanguageCode (CON.CL)

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

  • 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)