WI DPI WISEdata Ed-Fi Docs
/studentContactAssociation (aka. /studentParentAssociation)
- Jaidaa Shafaei
- heather.kluck
This endpoint is expected from Choice schools.
Ed-Fi Tech Docs: v3 Parent > StudentParentAssociation - Ed-Fi Certification - Ed-Fi TechDocs
Data Properties:
# | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition | Data Element Page |
1.0 | parentUniqueId* | string | REQ'D | REQ'D | A unique alphanumeric code assigned to a parent. parentUniqueId: [LEA ID+’-’+parent unique ID in SIS system] | |
2.0 | studentUniqueId* | string | REQ'D | REQ'D | A unique alphanumeric code assigned to a student. | |
3.0 | relationDescriptor | string | CONDITIONALLY REQ’D | CONDITIONALLY REQ’D | The nature of an individual's relationship to a student. Values are: Father (F), Mother (M), Other (O), or Guardian (G). | NA |
4.0 | legalGuardian (2024-25 SY and later) | boolean | CONDITIONALLY REQ’D | CONDITIONALLY REQ’D | This information is needed for NSLP participating school where the student is eligble for free or reduced lunch. This is an Indicator of whether the person is a legal guardian for the student. | NA |
5.0 | livesWith (2024-25 SY and later) | boolean | CONDITIONALLY REQ’D | CONDITIONALLY REQ’D | This information is needed for NSLP participating school where the student is eligble for free or reduced lunch. Indicator of whether the student lives with the associated parent. | NA |
6.0 | primaryContactStatus | boolean | CONDITIONALLY REQ’D | CONDITIONALLY REQ’D | This information is needed for NSLP participating school where the student is eligble for free or reduced lunch. Indicator of whether the person is a primary parental contact for the student. | NA |
Descriptors:
NameSpace | Code Value | Short Description | Long Description |
---|
NameSpace | Code Value | Short Description | Long Description |
---|---|---|---|
uri://dpi.wi.gov/RelationDescriptor | M | Mother | Mother |
F | Father | Father | |
G | Guardian | Guardian | |
O | Other | Other |
Use Cases:
# | Use Case Title | Use Case Description | What to Submit/retrieve |
---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
---|---|---|---|
1.0 | Sending parent/guardian information for each parent/guardian | The /parent and /studentParentAssociation resources have been renamed to /contacts and /studentContactAssociation starting 25-26 SY. For 2024-25 SY, the parent/guardian data collection has been updated to include legal guardian information, living arrangements, and primary contact status. These new data elements will facilitate the distribution of Summer Electronic Benefit Transfer (S-EBT) cards to families, ensuring a more targeted and efficient outreach strategy based on the enhanced data insights. The parent/guardian data collection is optional for LEAs to submit to WISEdata.
| POST on /studentParentAssociations: POST on /studentParentAssociations: "livesWith": true, |
2.0 | Sending the student's parent/guardian information for a student who resides with their mother, but the legal guardian is the grandparent | The student resides with their mother (livesWith: true), but the legal guardian is the grandparent (legalGuardian: true). The mother in this example is marked as the primary contact (primaryContactStatus: true). | POST on /parent "parentReference": POST on /parent "parentReference": |
3.0 | Sending the student's parent/guardian information for a student who lives with the grandparent, but the father is identified as the legal guardian | The father is identified as the legal guardian (legalGuardian: true), but the student lives with the grandparent (livesWith: true), who is also in this example assigned as the primary contact (primaryContactStatus: true). | POST on /parent "parentReference": POST on /parent "parentReference": |
4.0 | Sending parent/guardian information when they more than one students in the same LEA |
|
|
5.0 | Sending parent/guardian information when student transferres to a new LEA | Because the parentUniqueId includes the LEA ID, each LEA is expected to send /parent AND /studentParentAssociation records | LEA 1: submits a /Parent record AND a /studentParentAssociation record AND LEA 2: submits a /Parent record AND a /studentParentAssociation record |
6.0 | Sending parent/guardian information for a student whose guardianship arrangements have changed | When a parent/guardian is changed in the SIS, then the SIS/LEA should delete the /parent and /studentParentAssociation records and send updated records with the new parent/guardian information. This is important for foster students and adopted students. To delete the /parent, the /studentParentAssociation must be deleted first. |
|
7.0 | Updating parent/guardian information for a student | There is an Ed-Fi issue when SIS vendors do a POST->GET->DELETE->POST on /parent using the same unique id. This issue appears to be a problem for v3.4, but not for v5.2. Instead of deleting a /parent record, vendors should update (PUT) the rcords with the changes. |
|
JSON Sample:
{
"parentReference": {
"parentUniqueId": "string",
},
"studentReference": {
"studentUniqueId": "string",
},
"legalGuardian": true,
"livesWith": true,
"primaryContactStatus": true,
"relationDescriptor": "string"
}
Wisconsin Department of Public Instruction