This lesson provides specifications and business rules related to the ParentSquare Groups API integration.
Business Rules
Groups
The school, school type and grade filters will be applied to currently enrolled students.
The student status filters affect which student statuses will be pulled in the output. It does not affect which students will be pulled.
Statuses will only be potentially pulled if they are specifically selected in the filters even if they display as "All".
The "District Records" and "School Records" options will affect whether the student status-related records (Remote Learning Codes, Special Education, Disability Codes, Funding Sources, Meal Statuses, Program Services, and Student Statuses) will be pulled as district-level records and/or as school-level records. Either one of them or both must be selected for the student status-related records to be pulled.
The "Apply Student Status Filter to Learning Codes" option will affect the Learning Code-related records by restricting them to the Student Status filter instead of exporting all Learning Code records.
The Student Group filter will pull student groups from all buildings. A student group will appear multiple times if it is in multiple buildings. If that student group needs to be included in the export, either choose all instances of that student group in the filter or change the student group name in all buildings to include an indication of what building each one is from so that they appear in the student group filter.
File: groups.csv
The following data will be pulled:
| Buses | Any existing AM, PM and Late buses |
| Remote Learning Codes | Any current remote learning codes (student statuses with the Learning Code flag on) currently in use by active students |
| Special Education | The student disability code "SE" if currently in use by any active students |
| Homeroom Teacher | The teacher assigned as the active students' advisor |
| Counselor | The teacher assigned as the active students' counselor |
| Disability Codes | Any current Disability Codes that does not have the "SE" code, currently in use by any active students, and is specifically selected in the filter |
| Funding Sources | Any current Funding Sources currently in use by any active students and is specifically selected in the filter |
| Meal Statuses | Any current Meal Statuses currently in use by any active students and is specifically selected in the filter |
| Program Services | Any current Program Services currently in use by any active students and is specifically selected in the filter |
| Student Statuses | Any current Student Statuses that is not a learning code, currently in use by any active students and is specifically selected in the filter |
| Column | Explanation |
| school_id | Primary key of the district or school building (eSD internal primary key, that is what Parent Square will utilize to link students to the demographics when pulled from the API) |
| group_id | Pull data in the format as per the below table |
| group_name | Name or description of the status, staff, or bus route. Buses will have the bus type included. District-wide records will have " - DW" added at the end |
| owner_staff_id | Blank |
| Abbreviation | The School Abbreviation of the school building intended for use to combine multiple buildings to be of a single school type for use by ParentSquare. District-level records will have this field blank |
| group_id format | ||
| Data type | Format | Example |
| Buses | AMBus_(Route with spaces removed) PMBus_(Route with spaces removed) LATEBus_(Route with spaces removed) |
AMBus_111 PMBus_123ABC LATEBus_231 |
| Counselor | Counselor_(Name with spaces removed)_(Building Primary Key) | Counselor_JohnSmith_1234 |
| Homeroom Teacher | HomeroomTeacher_(Name with spaces removed)_(Building Primary Key) | HomeroomTeacher_BrianThomas_1234 |
| Special Education | SpecialEducation_(Building or District Primary Key) | SpecialEducation_1234 |
| Remote Learning Code | RemoteLearningCode_(Code)_(Building or District Primary Key) | RemoteLearningCode_BLUE_1234 |
| Disability Codes | DisabilityCode_(Code)_(Building or District Primary Key) | DisabilityCode_0473_1234 |
| Funding Sources | FundingSource_(Code)_(Building or District Primary Key) | FundingSource_0286_1234 |
| Meal Statuses | MealStatus_(Status Primary Key)_(Building or District Primary Key) | MealStatus_1_1234 |
| Program Services | ProgramService_(Code)_(Building or District Primary Key) | ProgramServices_5709_1234 |
| Student Statuses | StudentStatus_(Code)_(Building or District Primary Key) | StudentStatus_0231_1234 |
| Student Groups | StudentGroup_(Code)_(Building or District Primary Key) | StudentGroup_SS23_1234 |
Group Members
The school, school type and grade filters will be applied to currently enrolled students.
The student status filters affect which student statuses will be pulled in the output. It does not affect which students will be pulled.
Statuses will only be potentially pulled if they are specifically selected in the filters even if they display as "All".
The "District Records" and "School Records" options will affect whether the student status-related records (Remote Learning Codes, Special Education, Disability Codes, Funding Sources, Meal Statuses, Program Services, and Student Statuses) will be pulled as district-level records and/or as school-level records. Either one of them or both must be selected for the student status-related records to be pulled.
The "Apply Student Status Filter to Learning Codes" option will affect the Learning Code-related records by restricting them to the Student Status filter instead of exporting all Learning Code records.
The Student Group filter will pull student groups from all buildings. A student group will appear multiple times if it is in multiple buildings. If that student group needs to be included in the export, either all instances of that student group should be chosen in the filter or the student group name in all buildings should be edited to include an indication of what building each one is from so that they appear in the student group filter.
File: group_memebers.csv| Column | Explanation |
| school_id | Primary key of the district or school building (eSD internal primary key, that is what Parent Square will utilize to link students to the demographics when pulled from the API) |
| group_id | Pull data in the format as per the table in the groups.csv tab |
| student_id | ID Number of the student who currently have the bus, homeroom teacher, counselor, or status assigned. |
| Abbreviation | The School Abbreviation of the school building intended for use to combine multiple buildings to be of a single school type for use by ParentSquare. District-level records will have this field blank |