WI DPI WISEdata Ed-Fi Docs
/studentSchoolAssociation
heather.kluck
Jaidaa Shafaei
This association represents the School in which a student is enrolled. A student and school must exist prior to making this association.
This endpoint is expected from Choice schools.
Ed-Fi Tech Docs: v3 Student Enrollment > StudentSchoolAssociation - 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 | entryDate* | string | REQ'D | REQ'D | The month, day, and year on which an individual enters and begins to receive instructional services in a school. | |
2.0 | schoolReference | array | REQ'D | REQ'D | A reference to the related School resource |
|
3.0 | schoolId* | integer | REQ'D | REQ'D | The identifier assigned to a school. | |
4.0 | studentReference | array | REQ'D | REQ'D | A reference to related Student resource |
|
5.0 | studentUniqueId* | string | REQ'D | REQ'D | A unique alphanumeric code assigned to a student. | |
6.0 | entryGradeLevelDescriptor | string | REQ'D | REQ'D | The grade level or primary instructional level at which a student enters and receives services in a school or an educational institution during a given academic session. | |
7.0 | exitWithdrawDate | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The recorded exit or withdraw date for the student.The circumstances under which the student exited from membership in an educational institution. | |
8.0 | exitWithdrawTypeDescriptor | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The circumstances under which the student exited from membership in an educational institution. | |
9.0 | primarySchool | boolean | REQ'D | REQ'D | Indicates if a given enrollment record should be considered the primary record for a student. | |
10.0 | repeatGradeIndicator | boolean | CONDITINALLY REQ'D | NOT REQ'D | An indicator of whether the student is enrolling to repeat a grade level, either by failure or an agreement to hold the student back. | |
11.0 | termCompletionIndicator | boolean | CONDITINALLY REQ'D | CONDITINALLY REQ'D | Indicates whether or not a student completed the most recent school term. | |
12.0 | WI_studentSchoolAssociationExtensions | array |
|
|
|
|
13.0 | actualDaysAttendance | number | REQ'D | REQ'D | Aggregate value that captures the actual days in attendance for a student | |
14.0 | possibleDaysAttendance | number | REQ'D | REQ'D | Aggregate value that capture the possible days in attendance for a student | |
15.0 | privateSchoolChoiceProgramParticipant (2024-25 and prior) | boolean | CONDITINALLY REQ'D | CONDITINALLY REQ'D | An indicator of whether the student attends a school participating in the Private School Choice Programs (Choice). | |
16.0 | SchoolChoice | boolean | CONDITINALLY REQ'D | CONDITINALLY REQ'D | An indicator of whether the student attends a school participating in the Private School Choice Programs (Choice). | |
17.0 | expectedTransferLocalEducationAgencyReference (2024-25 and prior) | array |
|
| A reference to the related EducationOrganization resource |
|
18.0 | localEducationAgencyId (2024-25 and prior) | integer | CONDITINALLY REQ'D | NOT REQ'D | The identifier assigned to an education organization. | |
19.0 | expectedTransferSchoolReference (2024-25 and prior) | array |
|
| A reference to the related School resource |
|
20.0 | schoolId (2024-25 and prior) | integer | CONDITIONALLY REQ'D | NOT REQ'D | The identifier assigned to a school. | |
21.0 | nextYearSchoolReference (2025-26 onward) |
|
|
| A reference to the related School resource |
|
22.0 | schoolId (2025-26 onward) | integer | CONDITIONALLY REQ'D | NOT REQ'D | The identifier assigned to a school. | |
23.0 | enrollmentTypes (2022-23 and prior) | array |
|
| An unordered collection of studentSchoolAssociationEnrollmentTypes |
|
24.0 | enrollmentTypeDescriptor (moved to core for 2025-26 onward) | string | REQ'D | REQ'D | Indicates how a student is enrolled at a school, whether as a primary or non-primary enrollment. | |
25.0 | receivingServices | array |
|
| An unordered collection of studentSchoolAssociationReceivingServices. The status of a student during a specific count date. |
|
26.0 | countDateNameDescriptor | string | REQ'D | REQ'D | The count date name for the student status (e.g 3rd Fri Sept) | https://dpi.wi.gov/wise/data-elements/tfscountinclusion https://dpi.wi.gov/wise/data-elements/octchildcountinclusion |
27.0 | countDateReceivingServiceDescriptor | string | REQ'D | REQ'D | The status of the student during the specific count date (e.g. Present) | |
28.0 | residencyPeriod (2023-24 and later) | array |
|
|
|
|
29.0 | beginDate (2023-24 and later) | string | CONDITINALLY REQ'D | NOT REQ'D | The month, day, and year on which the student entered the residency status. |
|
30.0 | endDate (2023-24 and later) | sting | CONDITINALLY REQ'D | NOT REQ'D | The month, day, and year on which the student exited the residency status. |
|
31.0 | residentLocalEducationAgencyReference (2023-24 and later) |
| CONDITINALLY REQ'D | NOT REQ'D | The district in which the student resides. | |
32.0 | localEducationAgencyId (2023-24 and later) | integer | CONDITINALLY REQ'D | NOT REQ'D |
|
|
Descriptors:
Namespace | Code Value | Short Description | Long Description |
|---|
Namespace | Code Value | Short Description | Long Description |
|---|---|---|---|
uri://dpi.wi.gov/GradeLevelDescriptor | KG | 5 year old Kindergarten | 5 year old Kindergarten |
PK | Pre-Kindergarten | Pre-Kindergarten | |
01 | First Grade | First Grade | |
02 | Second Grade | Second Grade | |
03 | Third Grade | Third Grade | |
04 | Fourth Grade | Fourth Grade | |
05 | Fifth Grade | Fifth Grade | |
06 | Sixth Grade | Sixth Grade | |
07 | Seventh Grade | Seventh Grade | |
08 | Eighth Grade | Eighth Grade | |
09 | Ninth Grade | Ninth Grade | |
10 | Tenth Grade | Tenth Grade | |
11 | Eleventh Grade | Eleventh Grade | |
12 | Twelfth Grade | Twelfth Grade | |
K4 | 4-year-old Kindergarten | 4-year-old Kindergarten | |
K3 | 3-year-old Kindergarten | 3-year-old Kindergarten (2023/24 SY and prior) | |
uri://dpi.wi.gov/ExitWithdrawTypeDescriptor | BCA | Below Compulsory Age | Below Compulsory Age |
TOS | Transfer Out-of-State. | Transfer Out-of-State. Known to be Continuing. | |
TNC | Transfer to a WI school not covered by WISEdata. | Transfer to a WI school not covered by WISEdata. Known to be continuing. | |
ETC | Expected transfer/ promotion to new school covered by WISEdata. | Expected transfer/ promotion to new school covered by WISEdata. Not known to be continuing. | |
HSC | High School Completion | High School Completion | |
DE | Death | Death | |
MA | Reached Maximum Age For Services | Reached Maximum Age For Services | |
ODO | Other Dropout or Possible Dropout | Other Dropout or Possible Dropout | |
TC | Transfer to Another WI School covered by WISEdata | Transfer to another WI school covered by WISEdata or continuing in the same school. Known to be continuing. | |
ISM | Interstate move. Move to another state within the country. | Interstate move. Move to another state within the country. Not known to be continuing | |
INM | International move. | International move. Not known to be continuing | |
CE (2022-23 and after) | Compassion Exit | Compassion Exit | |
PCC (2022-23 and prior) (Removed starting 22/23 SY) | Prior Completion Credential | Prior Completion Credential | |
uri://dpi.wi.gov/EnrollmentTypeDescriptor | P | Primary | Primary |
PPP | Parent Placed Private | Parent Placed Private | |
C | Coursework | Coursework | |
uri://dpi.wi.gov/CountDateNameDescriptor | 3FS | 3rd Fri Sept | 3rd Friday of September |
O1 | Oct 1st | October 1st | |
uri://dpi.wi.gov/CountDateReceivingServiceDescriptor | A | Absent | Absent, receiving services on the count date |
P | Present | Present, receiving services on the count date | |
N | Not Receiving Services | Not receiving services |
Use Cases:
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
| Starting the 24/25 SY, discontinue submitting K3 data through the API. K3 is not the same as K4 or PK Birth to 3 programs. | Informational Only | Verify not sending K3 |
1.0 | Sending a student enrollment record for a student who’s primarily attending a public school district or a charter school |
| The public district/charter school submits a primary enrollment. POST on /studentSchoolAssociations: |
2.0 | Sending the Resident Local Education Agency (LEA) (2023-24 and later) | Prior to 2023-24, Resident LEA ID is submitted under /SEOA. Starting the 23/24SY, the Resident LEA ID will be part of the /studentSchoolAssociation (SSA) endpoint under the ResidencyPeriod collection. When the submitting district is an independent charter school (non-district charter school), then the Resident LEA is set to a public school district that is open in the school year. The Resident LEA ID cannot be a School ID. For more details see about how this affect the pupil count for membership report, see https://wisconsindpi.atlassian.net/wiki/spaces/widpiedfi/pages/2785505 | POST on /studentSchoolAssociation residencyPeriods: |
3.0 | Sending the Enrollment Type to WISEdata Portal | The enrollmentTypeDescriptor will be a single-value data property, not an array. SIS vendor will need to update their code to reflect the change. Values for the enrollmentTypeDescriptor include:
| enrollmentTypeDescriptor is a single-value data property: _EXT: |
4.0 | Submit a primary enrollment record for a student that completed the most recent school term (year) | In the 2020-21 SY, the completedSchoolTerm data property under the /SSA was replaced with termCompletionIndicator. The 20-21 SY is disabled in WISEdata; therefore, the completedSchoolTerm will be removed from WISEdata UI. SIS vendors must ensure that the termCompletionIndicator is submitted to WISEdata Portal. | Successfully POST data on /studentSchoolAssociations: termCompletionIndicator: True |
5.0 | Submit a Term Completion Indicator for a student with multiple enrollment records | The Term Completion Indicator is only expected on the most recent enrollment record for the school term. | Informational only |
6.0 | Submit a non-primary enrollment record for a student that completed the most recent school term (year) | The Term Completion Indicator is not required - L2 rule (6569) will be thrown when submitted. | Informational only |
7.0 | Sending a student enrollment record for a student who’s primarily attending a private choice school that chooses to report all students (All Students Report Card: Opt IN) The opt in/out status for the Private School – All Students Report Card indicates whether a school would like to have just the Choice students included in the required report card or if they would like all of their students to be included in a report card. Visit this page to learn more: https://dpi.wi.gov/parental-education-options/choice-programs/school-reports | If a school chooses to report all students, then they have to report both Choice and non-Choice students:
NOTE: Choice schools are not expected to send a non-primary enrollment type. Enrollments from Choice schools should always be primary. | The private choice school submits a primary enrollment. POST on /studentSchoolAssociations: |
8.0 | Sending a student enrollment record for a student who’s primarily attending a private choice school that chooses to report only Choice students (All Students Report Card: Opt OUT) | If a school is opted out of the Private School – All Students Report Card, then they should not send non-Choice students should to WISEdata. | The private choice school submits a primary enrollment. POST on /studentSchoolAssociations: |
9.0 | Sending a student enrollment record when the student’s choice program participant status changes in the middle of the school year due to determination of ineligibility AND the school is opted OUT of private school – All students report card. | Students may be determined ineligible through the choice audit and they may lose their Choice status. If the determination is that the student was never eligible, then the school has to delete the enrollment (and other records). | DELETE on /studentSchoolAssociations |
10.0 | Sending a student enrollment record when the student’s choice program participant status changes in the middle of the school year due to determination of ineligibility AND the school is opted IN of private school – All students report card. | If a student determined never eligible to the choice program, then the school should change the privateSchoolChoiceProgramParticipant in the existing SSA record to No/False. | PUT on on /studentSchoolAssociations to change the SchoolChoice from True to False. |
11.0 | Sending a student enrollment record when the student’s choice program participant changes in the middle of the school year because the student/family chose to no longer participate in the Choice program but remain in the same school. And the AND the school is opted IN of private school – All students report card. | If there is a change in the student's Choice program participant status, then a new SSA with a new PrivateSchoolChoiceProgramParticipant value is appropriate. If the the school is opted OUT of private school – All students report card, then the school should not report a non-choice student, and will just report one studentSchoolAssociation record for when the student was a choice program participant. | PUT on /studentSchoolAssociations to end the existing record. POST on /studentSchoolAssociations to send a new enrollment record with SchoolChoice as False |
12.0 | Sending a student enrollment record for a student who’s attending a private choice school, and receiving special education services in a public school district |
| Choice School: Public School: |
13.0 | Sending a student enrollment record for a student who’s taking coursework in multiple public schools |
| Public School A: POST on /studentSchoolAssociations, studentEducationOrganizationAssociation, studentSchoolFoodServicesProgramAssociation, studentSpecialEducationProgramAssociation, studentSectionAssociation, StudentCTEProgramAssociation, etc. Public School B: POST on /studentSchoolAssociations, studentEducationOrganizationAssociation, courseOffering, section, studentSectionAssociation, and grade |
14.0 | Sending a student enrollment record for a student who’s primarily enrolled in a Choice school, and taking one or two courses from a public district. |
| Choice School: |
15.0 | Sending a student enrollment record for a student who’s enrolled in a Charter school, and taking courses in non-charter school within the same district | The charter school is considered the primary enrollment regardless of which school provides more courses.
| Charter School POST on /studentSchoolAssociations, studentEducationOrganizationAssociation, studentSchoolFoodServicesProgramAssociation, studentSpecialEducationProgramAssociation, studentSectionAssociation, StudentCTEProgramAssociation, etc. Non-Charter School B: POST on /studentSchoolAssociations, studentEducationOrganizationAssociation, courseOffering, section, studentSectionAssociation, and grade |
16.0 | Sending a student enrollment record for a student who’s enrolled in a school within the Department of Corrections, the Department of Health Services, or a CCDEB school | These organizations sends primary Enrollment, associated student data, and Roster data to WISEdata
| POST on /studentSchoolAssociations, studentEducationOrganizationAssociation, studentSchoolFoodServicesProgramAssociation, studentSpecialEducationProgramAssociation, studentSectionAssociation, etc |
17.0 | Sending Receiving Services when the student enrollment Entry Date is post 3rd Friday of Sept or Oct 1 | For a child to count on a count date, the student must have been enrolled in the school wishing to count the student. If the student isn’t enrolled on TFS or Oct. 1, the child cannot be counted. October 1 Child Count is NOT gathered from Choice schools. NOTE: The count date has no impact on the requirement for the studentSchoolAssociations (enrollment) tobe submitted to WISEdata. | POST on /studentSchoolAssociations: |
18.0 | Sending Receiving Services when the Count Date falls on a weekend or a non-attendance day | If October 1 falls on a weekend or either count dates (Oct 1 or 3rd Fri of Sept) is a non attendance day, e.g., staff professional development day, then preceding or following attendance day surrounding the non-attendance date may be used to determine the value of ‘Present’ versus ‘Absent’ for Receiving Services | POST on /studentSchoolAssociations: |
19.0 | Sending Receiving Services when the for a student who transferred districts during the count date | When a student transfers to a new district/school around the count date time, then only the school with the student enrolled on the count date can count the student. The WISEdata Effective Date logic allows the second district to receive credit for the count. |
|
20.0 | Sending Receiving Services when the student is enrolled, but NOT actively receiving educational services. | When a student is NOT receiving services from the district / school, then the student should be exited in WISEdata. This is necessary to maintain accurate Full Academic Year indicators and to identify students expected to participate in assessments. The code ‘N - Not receiving services' should NOT be used except in the scenarios of a terminally ill student, an abducted student, or similarly dire circumstance for which the student is being held in enrollment so that the school does not have to prematurely report the exit type of ‘Death’ or 'Compassion Exit’. | POST on /studentSchoolAssociations: |
21.0 | Updating the Entry Date of the enrollment | The Entry Date is a primary key so vendors will need to insert a new studentSchoolAssociation record with the updated entryDate, then delete the old studentSchoolAssociation record. |
|
22.0 | Updating the Exit Date and Exit Type of the enrollment (2022-23 and after) | Simply updating the exitWithdrawDate and ExitWithdrawTypeDescriptor for an existing studentSchoolAssociation record.
| POST on /studentSchoolAssociations: |
23.0 | Sending multiple student enrollment records in the same LEA |
| School A: School B: POST on /studentSchoolAssociations: |
24.0 | Sending a student enrollment record when student is expected to transfer | When an inter-district transfer is expected, then the LEA should send the existing enrollment record with exitWithdraw Descriptor as ‘ETC’, and the expected transfer school. If the specific school to which the student is transferring is unknown, send any school within the anticipated transfer district. | PUT on /studentSchoolAssociations: |
25.0 | Deleting a student enrollment record | To delete an enrollment record, all child records (/studentEducationOrganizationAssociation, /studentAcademicRecords, /studentSpecialEducationProgramAssociation, discipline data, roster data, etc.) must be deleted first. |
|
| Reporting Full Time Equivalency (FTE) |
|
|
| Any change in FTE requires a new enrollment unless update | Informational Only |
|
JSON Sample:
{
"schoolReference": {
"schoolId": 711
},
"studentReference": {
"studentUniqueId": "7013013246"
},
"entryDate": "2023-07-02",
"exitWithdrawDate": "2024-06-05",
"entryGradeLevelDescriptor": "uri://dpi.wi.gov/GradeLevelDescriptor#09",
"exitWithdrawTypeDescriptor": "uri://dpi.wi.gov/exitWithdrawTypeDescriptor#ETC",
"primarySchool": "true",
"termCompletionIndicator": "true",
"repeatGradeIndicator": "false",
"_EXT": {
"WI": {
"actualDaysAttendance": 0.5,
"possibleDaysAttendance": 2.5,
"expectedTransferLocalEducationAgencyReference": {
"localEducationAgencyId": 12472
},
"expectedTransferSchoolReference": {
"schoolId": 851
},
"residencyPeriods": [{
"residentLocalEducationAgencyReference": {
"localEducationAgencyId": 7533
},
"beginDate": "2023-09-12",
"residencyStatusDescriptor": "",
"endDate": "2024-01-05"
}],
"enrollmentTypeDescriptor": "uri://dpi.wi.gov/EnrollmentTypeDescriptor#P",
"receivingServices": [{
"countDateNameDescriptor": "uri://dpi.wi.gov/CountDateNameDescriptor#3FS",
"countDateReceivingServiceDescriptor": "uri://dpi.wi.gov/CountDateReceivingServiceDescriptor#P"
},
{
"countDateNameDescriptor": "uri://dpi.wi.gov/CountDateNameDescriptor#O1",
"countDateReceivingServiceDescriptor": "uri://dpi.wi.gov/CountDateReceivingServiceDescriptor#A"
}
]
}
}
}
Wisconsin Department of Public Instruction