Table of Contents

Tables mapped by Name

Student (STU)

Contacts (CON)

Staff (STF)

Master Schedule (MST)

Courses (CRS)

Course Attendance Record (CAR)

Overview

ParentSquare uses Aeries REST API to sync with Aeries, making it easy to transfer data into ParentSquare without any ongoing administration. The data pulled using the API and the corresponding Aeries Tables and fields are documented below.


The full Aeries API documentation can be found here:

https://support.aeries.com/support/solutions/articles/14000077926-aeries-api-full-documentation


Field Mapping Aeries to ParentSquare

Table Name: Students

API Endpoint: /api/v5/schools/{schoolcode}/students


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

STU

ID

Student ID

YES

YES

Student ID

STU

FN

FirstName

YES

YES

Student First Name

STU

LN

Last Name

YES

YES

Student Last Name

STU

GR

Grade

YES

YES

Student Grade Level

STU

TG

Status Code


YES

YES

Status (only active students are loaded unless the school has requested to load the incoming students too.)

STU

CL

Correspondence Language

NO

YES

Used for Correspondence Language if Parent/Guardian CL not present in CON table

STU

TL

Primary Phone

NO

YES

Can be loaded if no Primary phone for Parent in CON.

STU

CU

Counselor Number

NO

NO

Used to generate teachers section if section not defined.

STU

SEM

Student Email Address

NO

YES

Loaded if student Communication is enabled

STU

MPH

Student Mobile Phone

NO

YES

Loaded if student Communication is enabled

STU

PG

Parent Guardian Name


NO

YES

Can be loaded if Parent/Guardian information not present in CON table

STU

PEM

Parent Email Address


NO

YES

Can be loaded if Parent/Guardian information not present in CON table


Table Name: Contacts

API Endpoint: /api/v5/schools/{schoolcode}/contacts


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

CON

FN

First Name

YES

YES

Parent First Name

CON

LN

Last Name

YES

YES

Parent Last Name

STU

ID

Student ID

YES

YES

Student ID

CON

CP

Cell Phone

NO

YES

Parent Cell Phone

CON

EM

Email Address

NO

YES

Parent Email

CON

TL

Primary Phone

NO

YES

Loaded only if Cell phone is blank

STU

RAD

Residence Address

NO

YES

Parent Address (only pulled with the initial sync)

STU

RCY

Residence Address City

NO

YES

Parent City (only pulled with the initial sync) 

STU

RZC

Residence Address Zip

NO

YES

Parent Zip (only pulled with the initial sync) 

CON

RL

Relationship To Student


YES

NO

ParentSquare can be

configured to load Contacts

based on Relationship To Student  

CON

NP

Notification Preference


YES

NO

Aeries Communications districts will be configured to load Contacts based on Notification Preference rather than by Relationship To Student

CON

LW

Lives With Student Indicator

NO

NO

ParentSquare can be configured to load the Contacts only if this flag is set to true

CONRFRed Flag
NONOParentSquare can be configured to load or skip these Contacts
CONCLCorrespondence LanguageNONOLanguage Parent prefers for receiving information



Table Name: Staff

API Endpoint: /api/v5/staff/[StaffID]


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

STF

ID

Staff ID

YES

YES

external_id

STF

FN

First Name

YES

YES

first_name

STF

LN

Last Name

YES

YES

last_name

UGN or STF

EM*

Email Address

YES

YES

email

STF

CP

Cell Phone

NO

YES

phone

STF

TI

Title

NO

YES

title

STF

TG

Status

YES

No

Only loads active staff

STF

PSC

Primary Aeries School

YES

No

Only loads staff for the given school

* The API first pulls the email from UGN table and if that field is empty then it will look at STF.EM.


Table Name: Master Schedule

API Endpoint: /api/v5/schools/{schoolcode}/sections


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

MST

CID

ClassID

YES

YES

Section ID

MST

CID

CourseID

YES

YES

Course

MST

PD or

FTF.STI

Period. Flex Schools will pull from FTF.STI

YES

YES

Period

MST

SM

Semester

YES

NO

Used to determine if sections

should be created or not

SectionStaffMembers

Array of Section Staff Objects

SectionStaff Object will return STF.ID for Traditional Schools. Flex Schools will pull from SSE.ID

YES

YES

Staff ID

Note:  Teacher Number is no longer returned in the API. See the API Full Documentation for a complete description.


Table Name: Courses

API Endpoint: /api/v5/courses


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

CRS

CN

Course Number

YES

NO

Used to find course for section

CRS

CO

Course Title

YES

NO

Used to generate section name


Table Name: Course Attendance Record

API Endpoint: /api/v5/schools/{schoolcode}/classes


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

STU

ID

StudentID

YES

YES

Roster student ID

CAR

SE

SectionNumber

YES

YES

Roster section number

CAR

DS

DateStarted

YES

NO

Used to determine if its a

current section roster

CAR

DE

DateEnded

YES

NO

Used to determine if its a current section roster


Note: Before the CAR (Course Attendance Record) table is initialized at the beginning of the school year, data will be pulled from a join of SEC (Student Class Sections), MST (Master Schedule), and TRM (Terms) instead.