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 DB Tables are documented below.


The Aeries API documentation can be found here:

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


DATA TIPS: 

Each Parent should use their best email and/or phone number in your database and be consistent with that same information for all of their children. 

Spouses/co-parents should not share email addresses or phone numbers. 

Students using StudentSquare should use their own email and/or phone number - not a parent’s. For example, a student using StudentSquare can use their email, but no value in the phone number field is better than a parent’s phone number. 


Teachers and staff at your school/district who are also parents of students in your school/district will often get two different ParentSquare accounts: one using their personal email and one with their work email. If they would prefer one account, we recommend that they use their work email in their parent record in your SIS. If two accounts do get created, they can contact support@parentsquare.com and provide both emails and request for them to be merged.


Field Mapping Aeries to ParentSquare

Table Name: Students

API Endpoint: /api/v3/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

Used 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

loaded if Parent/Guardian information not present in CON table

STU

PEM

Parent Email Address


NO

YES

Loaded if Parent/Guardian information not present in CON table


Table Name: Contacts

API Endpoint: /api/v3/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

STU

RCY

Residence Address City

NO

YES

Parent City

STU

RZC

Residence Address Zip

NO

YES

Parent Zip

CON

RL

Relationship To Student


YES

NO

By default only Mother and

Father are loaded, but a contact with any relationship can be loaded on districts request.

CON

NP

Notification Preference


NO

NO

ParentSquare can 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



Table Name: Staff

API Endpoint: /api/v3/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 pull for STF email table.


Table Name: Master Schedule

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


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

MST

CID

ClassID

YES

YES

Section ID

MST

CID

CourseID

YES

YES

Course

MST

PD

Period

YES

YES

Period

MST

SM

Semester

YES

NO

Used to determine if sections

should be created or not

MST

TN

Teacher Number

YES

YES

Staff ID


Table Name: Courses

API Endpoint: /api/courses


TableFieldDescription
Required?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/schools/{schoolcode}/classes


TableFieldDescriptionRequired?Stored in PS?ParentSquare Field

STU

ID

PermanentID

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