WI DPI WISEdata Ed-Fi Docs
Use Cases for the 2023-24 SY
heather.kluck
Jaidaa Shafaei
First Day of School (FDS) and Last Day of School (/session) - All LEAs
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | Sending First Day of School (FDS) and Last Day of School (LDS) (Required 2023-24 SY and later) | SIS vendors should submit an 'Annual' session with a begin date and an end date that reflect the school calendar for all LEAs, regardless of type (Public school districts, public charter schools, and private choice schools, as well as DHS, DOC, WSD, WCBVI, and CDEB schools). The SIS vendors/LEAs should send at least one 'Annual' session at the beginning of the school year to submit the FDS and the LDS. This can be submitted using one of two methods:
SIS vendors/LEAs send at least one 'Annual' session at the beginning of the school year to submit the FDS and LDS.
2. Allow the DPI to derive the FDS and the LDS from /session records sent as part of the Roster data collections.
| POST on /sessions schoolReference: |
2.0 | Updating the First Day of School (FDS) and the Last Day of School (LDS) after it has been submitted to WISEdata Portal (Required 2023-24 SY and later) | SIS vendor can update the beginDate and endDate on the /session endpoint. However, the sessionName is a primary key and cannot be updated. If LEAs updates the sessionName, the SIS vendor will need to deleted the submitted /session resource and re-submit it with the updated sessionName. | POST on /sessions schoolReference: DELETE on /sessions POST on /sessions schoolReference: |
Resident LEA Changes (/studentEducationOrganizationAssociation) - Public Schools Only
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | Sending the Resident Local Education Agency (LEA) on the /studentEducationOrganizationAssociation (SEOA) endpoint | Starting the 2023-24 SY, the Resident LEA ID will no longer be collected under /SEOA. The Resident LEA ID will be part of the /studentSchoolAssociation (SSA) endpoint under the ResidencyPeriod collection. This will affect the Membership Pupil Count Collection. Prior to 2023-24, Resident LEA ID is submitted under /SEOA. The Resident LEA ID cannot be a School ID. | The Resident LEA ID should not be reported under the extension of the /SEOA endpoint. Instead, the Resident LEA ID will be submitted under the /SSA endpoint: |
2.0 | Sending Resident LEA ID when the student's residence changes in the middle of the school year (District Resident) | The student's attending district could be different from the resident district. When the student residence change in the middle of the school year, SIS vendors/LEAs do not have to change the student's enrollment record (entryDate and exitWithdrawDate). Instead, the SIS vendor/LEA, can update the ResidencyPeriod on the /SSA record. The Resident LEA ID cannot be a School ID. | POST on /studentSchoolAssociation:
|
3.0 | Deleting Resident LEA ID on on the /studentEducationOrganizationAssociation (SEOA) endpoint and /studentSchoolAssociation (SSA) | LEAs/vendors can leave the the localEducationAgencyId data proerty as blank and reubmit the /SEOA or /SSA endpoint to remve the localEducationAgencyId value. | PUT on /studentEducationOrganizationAssociation:
|
Enrollment Type Changes (/studentSchoolAssociation) - All LEAs
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | Sending the Enrollment Type to WISEdata Portal | Starting the 2023-24 SY, the enrollmentTypeDescriptor will be a single-value data proparty -- not an array. SIS vendor will need to update their code to reflect the change. Possible values for the enrollmentTypeDescriptor are:
| Prior to 2023-24 SY, the enrollmentTypeDescriptor was under the enrollmentTypes array:
|
Digital Equity Changes (/StudentEducationOrganizationAssociation) - All LEAs
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | SIS handling of data submitted/updated directly by the parent during/after online registration | Demo the SIS and parent portal, including the online registration screen, how data flows to WISEdata, and any quality checks implemented by SIS | Student digital equity data should flow to the Ed-Fi API (/studentEducationOrganizationAssociation endpoint) at the time of enrollment and whenever student data is updated. |
2.0 | Sending the digital equity questions and responses for a student enrolled in the school/district | Starting the 2023-24 SY, the Digital Equity data collection will no longer be collected as part of the studentIndicators under /SEOA. The Digital Equity data will be collected on the below data properties:
Can the student access the internet on their primary learning device at home?
If the student is unable to access internet in their primary place of residence, why not?
What is the primary type of internet service used at the residence?
Can the student stream a video on their primary learning device without interruption?
What device does the student most often use to complete school work at home?
Who provided the primary learning device to the student?
Is the primary learning device shared with anyone else in the household?
| POST on /StudentEducationOrganizationAssociation: |
3.0 | Editing the digital equity data for a student enrolled in the school/district | Via API update the student indicators on /StudentEducationOrganizationAssociation | Successfully update student indicators on /StudentEducationOrganizationAssociation |
4.0 | Sending the digital equity data points for a student with multiple enrollments in the school/district | Via API submit the student indicators on each /StudentEducationOrganizationAssociation record Enrollment in School 1: submits /SEOA Data submitted on SEOA from each school may or may not be different. | Successfully submit student indicators on /StudentEducationOrganizationAssociation from both schools/districts |
5.0 | Sending contradicting Digital Equity values | Some Digital Equity responses submitted by families and LEAs contradict each other; therefore, SIS vendors should have some validations (if possible) to prevent LEAs from submitting contradictory responses. Error 7154 will be displayed in WISEdata Portal when LEAs submit contradicting values. | If Q1. 'Internet Access in Residence' = 'Yes' then skip Q2. BarrierToInternetAccessInResidenceDescriptor and continue with Q3. InternetAccessTypeInResidenceDescriptor and Q4. InternetPerformanceInResidenceDescriptor
|
6.0 | Deleting the digital equity data for a student enrolled in the school/district | LEA can either remove the submitted digital equity response by resubmitting the SEOA records and leaving the digital equity data properties blank. Or They can delete /SEOA record and resubmit it with the updates responses (blank). | POST on /StudentEducationOrganizationAssociation: internetAccessInResidence: True Then PUT on /StudentEducationOrganizationAssociation: internetAccessInResidence: False |
Discipline Changes (/StudentDisciplineIncidentBehaviorAssociation) and (/disciplineAction) - Public Schools Only
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | Deprecating the /studentDisciplineIncidentAssociation endpoint starting 2023-24 SY | The /studentDisciplineIncidentAssociation endpoint will be deprecated starting the 23-24 SY. Vendor should update their code and integration to NOT use the /studentDisciplineIncidentAssociation endpoint on the 23/24 SY and after. | For 2022-23 and prior, vendors are expected to use the /studentDisciplineIncidentAssociation endpoint. |
2.0 | Sending discipline incident data on /studentDisciplineIncidentBehaviorAssociation starting 2023-24 SY | Vendor should update their code and integration to use the /studentDisciplineIncidentBehaviorAssociation endpoint starting on 23/24 SY. | For 2023-24 and after, vendors are expected to use the /StudentDisciplineIncidentBehaviorAssociation endpoint POST on /studentDisciplineIncidentBehaviorAssociation: |
3.0 | Sending behavior | In v6, only one behaviorDescriptor can be submitted under the /studentDisciplineIncidentBehaviorAssociation endpoint.
| POST on /disciplineIncident POST on /studentDisciplineIncidentBehaviorAssociation - Record 1: disciplineIncidentReference: POST on /studentDisciplineIncidentBehaviorAssociation - Record 2: POST on /disciplineActions - Record 2: |
4.0 | Deprecating the /studentDisciplineIncidentAssociation endpoint starting 2023-24 SY | The /studentDisciplineIncidentAssociation endpoint will be deprecated starting the 23-24 SY. Vendor should update their code and integration to NOT use the /studentDisciplineIncidentAssociation endpoint on the 23/24 SY and after. | For 2022-23 and prior, vendors are expected to use the /studentDisciplineIncidentAssociation endpoint. |
5.0 | Sending discipline incident data on /studentDisciplineIncidentBehaviorAssociation starting 2023-24 SY | Vendor should update their code and integration to use the /studentDisciplineIncidentBehaviorAssociation endpoint starting on 23/24 SY. | For 2023-24 and after, vendors are expected to use the /StudentDisciplineIncidentBehaviorAssociation endpoint POST on /studentDisciplineIncidentBehaviorAssociation: |
6.0 | Sending behavior | In v6, only one behaviorDescriptor can be submitted under the /studentDisciplineIncidentBehaviorAssociation endpoint. One behavior (studentDisciplineIncidentBehaviorAssociation) may be associated to one or more action (disciplineActions) | POST on /disciplineIncident POST on /studentDisciplineIncidentBehaviorAssociation - Record 1: disciplineIncidentReference: POST on /studentDisciplineIncidentBehaviorAssociation - Record 2: POST on /disciplineActions - Record 2: |
7.0 | Sending the discipline Actual Action Length | Starting the 2023-24 SY, the data type max for the data property 'actualDisciplineActionLength' | POST on /disciplineActions: |
API v6.X (Ed-Fi Data Standard v4.x) Changes - All LEAs
Finance Changes (Annual Financial & Budget Reports /chartOfAccount and /localAccount) - Public Only
Transition from SCED 9.0 to SCED 10.0 (/course ) - Public Schools Only
World Language Codes for Indigenous Asian and North American Languages (/studentSectionAssociation) - Public Schools Only
CEIS Changes (/studentProgramAssociation) - Public Schools Only
Supporting different API Credentials (key/secret) in different school years - All LEAs
Student Address must be a physical residence (/StudentEducationOrganizationAssociation) - All LEAs
Term Completion Indicator (/studentSchoolAssociation) - Public Only
Parent Information (/Parent and /studentParentAssociation) - All LEAs
WISEdata Ed-Fi Validations API - Optional Integration for All LEAs
This integration allows vendors to display the WISEdata validation messages within their product, which in turn will help LEAs to easily identify what the error/warning is and where to fix it. The WISEdata Ed-Fi Validations API is an optional integration, does not require integration testing, and can be completed at anytime during the school year. DPI does require vendors to demonstrate their implementation.
Student Identity Integration - Required Integration for All LEAs
This integration helps LEAs with the retrieval, the potential matches review, and the creation of WISEids for students through their SIS. Moreover, it will reduce the frequency of WISEid file uploads for LEAs.
Immunization Registry Integration - Optional Integration for All LEAs
This integration helps LEAs to retrieve their students' immunization records from the Wisconsin Immunization Registry (WIR) system and ingest them into the SIS.
Wisconsin Department of Public Instruction