The following entities are included in the Cohort domain:
TABLE OF CONTENTS
Entity: Cohort
An asterisk (*) indicates a required element for successful synchronization of the entity. This documentation outlines the supported mappings for various data entities, identifying the supported fields within Aeries for each entity and noting any unsupported elements. Additionally, it provides a sample JSON payload demonstrating the structure.
Ed-Fi Data Element | Aeries Page | Label & Aeries Table.Field | Standard v3.x/v4.x | Standard v5.x |
* Entity Reference - See Education Organization Domain > School Entity | - | - | ✔ Supported | ✔ Supported |
* CohortIdentifier / String | Student Groups | Group ID# SGD.GI | ✔ Supported | ✔ Supported |
AcademicSubjectDescriptor | - | - | ✘ Not Supported | ✘ Not Supported |
* CohortDescription / String | Student Groups | Group Name SGD.GN | ✔ Supported | ✔ Supported |
CohortScopeDescriptor | - | - | ✘ Not Supported | ✘ Not Supported |
CohortTypeDescriptor | - | - | ✘ Not Supported | ✘ Not Supported |
Program - Class | - | - | ✘ Not Supported | ✘ Not Supported |
Special Notes: | ||||
Sample JSON Payload | ||||
{ "cohortIdentifier": "1", "educationOrganizationReference": { "educationOrganizationId": 994 }, "academicSubjectDescriptor": null, "cohortDescription": "Saturday School", "cohortScopeDescriptor": "uri://ed-fi.org/CohortScopeDescriptor#School", "cohortTypeDescriptor": "uri://ed-fi.org/CohortTypeDescriptor#Other" } |
Entity: Staff Cohort Association
Ed-Fi Data Element | Aeries Page | Label & Aeries Table.Field | Standard v3.x/v4.x | Standard v5.x |
* Entity Reference - See Staff Domain > Staff Entity | - | - | ✔ Supported | ✔ Supported |
* Entity Reference - See Cohort Domain > Cohort | - | - | ✔ Supported | ✔ Supported |
BeginDate | Student Groups | Created On SGS.DT | ✔ Supported | ✔ Supported |
EndDate | Student Groups | Expires On SGS.DX | ✔ Supported | ✔ Supported |
StudentRecordAccess | - | - | ✘ Not Supported | ✘ Not Supported |
Special Notes: Staff members are considered associated with the Cohort when the staff is added to the Student Group on the "Student Groups" page > "Associated Staff Member Tab" | ||||
Sample JSON Payload | ||||
{ "beginDate": "2024-09-27", "cohortReference": { "cohortIdentifier": "1", "educationOrganizationId": 994 }, "staffReference": { "staffUniqueId": "994616" }, "endDate": null, "studentRecordAccess": null } |
Entity: Student Cohort
Ed-Fi Data Element | Aeries Page | Label & Aeries Table.Field | Standard v3.x/v4.x | Standard v5.x |
* Entity Reference - See Identification and Demographics Domain > Student Entity | - | - | ✔ Supported | ✔ Supported |
* Entity Reference - See Cohort Domain > Cohort Entity | - | - | ✔ Supported | ✔ Supported |
BeginDate | Student Groups > Students in the Group Tab | Created On SGM.DT | ✔ Supported | ✔ Supported |
EndDate | Student Groups > Students in the Group Tab | Expires On SGM.DX | ✔ Supported | ✔ Supported |
Section - Class | - | - | ✘ Not Supported | ✘ Not Supported |
Special Notes: Students are considered associated with the Cohort when the student is added to the Student Group on the "Student Groups" page > "Students in the Group Tab" | ||||
Sample JSON Payload | ||||
{ "beginDate": "2024-09-27", "cohortReference": { "cohortIdentifier": "1", "educationOrganizationId": 994 }, "studentReference": { "studentUniqueId": "99400875" }, "endDate": null } |