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.
Course Attendance Record (CAR)
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
Table | Field | Description | Required? | Stored in PS? | Notes |
STU | ID | Student ID | YES | YES | Student ID |
STU | CID | State Student ID | NO | YES | State Student ID |
STU | FN | First Name | YES | YES | Student First Name |
STU | LN | Last Name | YES | YES | Student Last Name |
STU | GN | Gender | NO | YES | Student Gender |
STU | GR | Grade | YES | YES | Student Grade Level |
STU | TG | Status Code | YES | YES | Status - Pre-enrolled students will be added to the "Incoming" group in ParentSquare |
STU | LF | Language Fluency | NO | YES | English Language Learner |
STU | CL | Correspondence Language | NO | YES | Used for Correspondence Language if Parent/Guardian CL not present in CON table. This can be updated in ParentSquare and will not be overwritten by the sync |
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 StudentSquare is enabled |
STU | MPH | Student Mobile Phone | NO | YES | Loaded if StudentSquare is enabled |
Table Name: Contacts
API Endpoint: /api/v5/schools/{schoolcode}/contacts
Table | Field | Description | Required? | Stored in PS? | Notes |
CON | FN | First Name | YES | YES | Contact First Name |
CON | LN | Last Name | YES | YES | Contact Last Name |
CON | NM | Mailing Name | NO | YES | ParentSquare will use Mailing Name if FN and LN are not populated |
CON | CP | Cell Phone | NO | YES | Contact Cell Phone |
CON | EM | Email Address | NO | YES | Contact Email |
CON | TL | Primary Phone | NO | YES | Loaded only if Cell phone is blank |
CON | RL | Relationship To Student | YES | YES | Relationship To Student |
CON | NP | Notification Preference | YES | NO | Contact Notification Preference is the recommended sync option for all Aeries Communications districts |
CON | AN | Attendance Notification | NO | NO | Attendance Notification is utilized to determine which Contact records will receive the Attendance Notifications for the student in question. A "Blank" is treated like a "Yes". |
CON | CL | Correspondence Language | NO | YES | Contact Preferred Language. This can be updated in ParentSquare and will not be overwritten by the sync |
CON | RF | Red Flag | NO | NO | Red Flagged Contact Records are excluded by default |
Table Name: Staff
API Endpoint: /api/v5/staff/[StaffID]
Table | Field | Description | Required? | Stored in PS? | Notes |
STF | ID | Staff ID | YES | YES | Staff ID |
STF | FN | First Name | YES | YES | Staff First Name |
STF | LN | Last Name | YES | YES | Staff Last Name |
UGN or STF | EM* | Email Address | YES | YES | Staff Email Address |
STF | CP | Cell Phone | NO | YES | Staff Cell Phone |
STF | TI | Title | NO | YES | Staff Title |
STF | TG | Status | YES | NO | ParentSquare only pulls active staff records |
STF | PSC | Primary Aeries School | YES | YES | All active staff records will be linked to their Primary School Code in ParentSquare |
STJ | SCL | Staff Job Assignment | NO | YES | Teachers are granted Communications Access for each school listed |
*The API pulls the email address from the UGN table if there is an active User Account. If there is no user account, then it will pull STF.EM.
Table Name: Master Schedule
API Endpoint: /api/v5/schools/{schoolcode}/sections
Table | Field | Description | Required? | Stored in PS? | Notes |
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 |
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 |
* 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
Table | Field | Description | Required? | Stored in PS? | Notes |
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
Table | Field | Description | Required? | Stored in PS? | Notes |
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 current section roster |
CAR | DE | DateEnded | YES | NO | Used to determine if 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.
Table Name: Student Groups
API Endpoint: /api/v5/schools/{schoolcode}/StudentGroups
Table | Field | Description | Required? | Stored in PS? | Notes |
SGD | GD | Group Description | NO | YES | Group Description |
SGD | DX | Group Expiration Date | NO | NO | Group Expiration Date |
SGD | GI | Group Identifier | YES | NO | Unique Identifier |
SGD | CM | Is Communication Group? | NO | YES | ParentSquare only syncs Student Groups if the "Communications View" is checked |
SGD | CG | Confidential Group | NO | YES | Will indicate whether the group is a Confidential Group in ParentSquare. |
SGD | GN | Group Name | YES | YES | Group Name |
SGS | ID | Group Member Staff ID | YES | YES | Staff Members associated to the Student Group |
SGM | ID | Group Member Student ID | YES | YES | Student Group Members |