WI DPI WISEdata Ed-Fi Docs

/session

Information about sessions may be obtained from the WISEdata API via a GET request on the /roster endpoint.

This endpoint is expected for Choice Schools (2023-24 SY and later)

Ed-Fi Tech Docs: https://techdocs.ed-fi.org/display/EDFICERT/v3+Education+Organization+Calendar+%3E+Sessions


Data Properties:

#

Property Name

Data Type

Public (Required/ Optional/ Conditional)

Choice (Required/ Optional/ Conditional)

Business Definition

Data Element Page

1.0

sessionName

string

REQ’D

REQ’D

The identifier for the calendar for the academic session (e.g., 2010/11, School Calendar, 2011 Summer).

https://dpi.wi.gov/wise/data-elements/sessionname

2.0

schoolReference

array

 

 

 

 

3.0

schoolId

integer

REQ’D

REQ’D

The identifier assigned to a school.

https://dpi.wi.gov/wise/data-elements/sessionschoolreference

4.0

schoolYearTypeReference

array

 

 

 

 

5.0

schoolYear

integer

REQ’D

REQ’D

Key for School Year

https://dpi.wi.gov/wise/data-elements/school-year

6.0

beginDate

string

REQ’D

RED’Q

Month, day, and year of the first day of the Session.

https://dpi.wi.gov/wise/data-elements/sessionbeginandenddates

7.0

endDate

string

REQ’D

RED’Q

Month, day and year of the last day of the Session.

https://dpi.wi.gov/wise/data-elements/sessionbeginandenddates

8.0

gradingPeriodReference

array

 

 

 

https://dpi.wi.gov/wise/data-elements/sessiongradingperiodreference

9.0

gradingPeriodDescriptor

string

REQ’D

NOT RED’Q

The name of the period for which grades are reported.

https://dpi.wi.gov/wise/data-elements/gradingperioddescriptor

10.0

periodSequence

integer

REQ’D

NOT RED’Q

The sequential order of this period relative to other periods.

https://dpi.wi.gov/wise/data-elements/sequenceofcourse

11.0

schoolId

integer

REQ’D

REQ’D

The identifier assigned to a school.

https://dpi.wi.gov/wise/data-elements/gradingperiodschoolid

12.0

schoolYear

integer

REQ’D

RED’Q

The identifier for the grading period school year.

https://dpi.wi.gov/wise/data-elements/school-year

13.0

termDescriptor

string

REQ’D

REQ’D

An descriptor value indicating the term (e.g. 'Semester', 'Quarter', etc.).

https://dpi.wi.gov/wise/data-elements/rostertermdescriptor

14.0

totalInstructionalDays

integer

REQ’D

REQ’D

The total number of instructional days in the school calendar.

https://dpi.wi.gov/wise/data-elements/sessiontotalinstructionaldays


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 a course session offered by district, school, and/or grade level

SIS vendors can only submit one Session Name for a Term Descriptor on the /session endpoint.

  • To be able to submit the /courseOfferings endpoint, the /sessions endpoint should be submitted first (/sessions has gradingPeriodReference)

POST on /session:
schoolReference:
schoolId: 7525
schoolYearTypeReference:
schoolYear: 2021
termDescriptor: uri://dpi.wi.gov/TermDescriptor#Q1
sessionName: Sessions-121941
beginDate: 2020-07-03
endDate: 2021-06-30
totalInstructionalDays: 151
gradingPeriods:
gradingPeriodReference:
gradingPeriodDescriptor: uri://dpi.wi.gov/GradingPeriodDescriptor#07
periodSequence: 1
schoolId: 7525,
schoolYear: 2021

2.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:

1. (PREFERRED) SIS vendors/LEAs send at least one 'Annual' session at the beginning of the school year to submit the FDS and LDS.

  • The TermDescriptorId must be submitted as 'Annual'.

  • The month on the beginDate must within July, August or September

  • The month on the endDate must be within May or June.

2. SIS vendors/LEAs send their sessions as part of the Roster data collection, then DPI will derive the FDS and the LDS.

  • When multiple sessions are submitted from the same school, then DPI will use the earliest beginDate and latest endDate.

  • When the Session dates go beyond the DPI SY calendar (7/1/XX - 06/30/XX+1), then DPI will pull the beginDate closest to 7/1 and the endDate closest to 6/30.

POST on /sessions

schoolReference:
schoolId: 7525
schoolYearTypeReference:
schoolYear: 2024
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
sessionName: FDS/LDS or School Calendar
beginDate: 2023-08-21
endDate: 2024-06-30
totalInstructionalDays: 221

3.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:
     schoolId: 7525
schoolYearTypeReference:
    schoolYear: 2024
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
sessionName: FDS/LDS or School Calendar
beginDate: 2023-08-21
endDate: 2024-06-30
totalInstructionalDays: 313

DELETE on /sessions

POST on /sessions

schoolReference:
     schoolId: 7525
schoolYearTypeReference:
     schoolYear: 2024
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
sessionName: School Calendar
beginDate: 2023-09-05
endDate: 2024-06-30
totalInstructionalDays: 298


JSON Sample:

{ "schoolReference": { "schoolId": 7525 }, "schoolYearTypeReference": { "schoolYear": 2024 }, "termDescriptor": "uri://dpi.wi.gov/TermDescriptor#A", "sessionName": "School Calendar", "beginDate": "2023-09-01", "endDate": "2024-06-06", "totalInstructionalDays": 151, "gradingPeriods": [{ "gradingPeriodReference": { "gradingPeriodDescriptor": "uri://dpi.wi.gov/GradingPeriodDescriptor#07", "periodSequence": 1, "schoolId": 7525, "schoolYear": 2024 } }] }
{ "schoolReference": { "schoolId": 7525 }, "schoolYearTypeReference": { "schoolYear": 2024 }, "termDescriptor": "uri://dpi.wi.gov/TermDescriptor#A", "sessionName": "School Calendar", "beginDate": "2023-09-01", "endDate": "2024-06-06", "totalInstructionalDays": 151, }

 

Wisconsin Department of Public Instruction