WI DPI WISEdata Ed-Fi Docs
/calendars and calendarDates
- Jaidaa Shafaei
- heather.kluck
The calendar endpoint is intended to represent a set of specific dates, usually instructional days.
The calenderDate endpoint represents a specific date and allows additional information to describe the type of date (e.g., Instructional day, Make-up day, Weather day, etc.).
Ed-Fi Tech Docs: https://schema.ed-fi.org/datahandbook-v400/index.html#/Calendar2600 and https://schema.ed-fi.org/datahandbook-v400/index.html#/CalendarDate545
Data Properties:
# | Endpoint | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition |
1.0 | /calendars | calendarCode | string | Required | Required | The identifier for the Calendar. |
2.0 | schoolReference | integer | Required | Required | The identifier assigned to a school. | |
3.0 | schoolYearTypeReference | integer | Required | Required | Key for School Year | |
4.0 | calendarTypeDescriptor | string | Required | Required | Indicates the type of Calendar | |
5.0 | gradeLevels | string | Optional | Optional | Indicates the GradeLevel associated with the Calendar. | |
6.0 | /calenderDates | calendarEvents | string | Required | Required | An unordered collection of calendarDateCalendarEvents. The type of scheduled or unscheduled event for the day. |
7.0 | date | string | Required | Required | The month, day, and year of the CalendarEvent. | |
8.0 | calendarReference | array |
|
|
| |
9.0 | calendarCode | string | Required | Required | The identifier for the Calendar. | |
10.0 | schoolId | integer | Required | Required | The identifier assigned to a school. | |
11.0 | schoolYear | integer | Required | Required | The identifier for the school year associated with the Calendar. |
Descriptors:
Endpoint | Namespace | Code Value | Short Description | Long Description |
|---|
Endpoint | Namespace | Code Value | Short Description | Long Description |
|---|---|---|---|---|
/calendars | uri://ed-fi.org/CalendarTypeDescriptor | Student Specific | Student Specific | Student Specific |
School | School | School | ||
IEP | IEP | IEP | ||
Grade Level | Grade Level | Grade Level | ||
Staff | Staff | Staff | ||
uri://ed-fi.org/CalendarEventDescriptor | Emergency day | Emergency day | Instruction cancelled or reduced due to an emergency | |
Instructional day | Instructional day | Student instructional day | ||
Make-up day | Make-up day | Make-up instructional day | ||
Holiday | Holiday | Instruction cancelled or reduced due to a holiday | ||
Strike | Strike | Instruction cancelled or reduced due to a strike | ||
Teacher only day | Teacher only day | Non-instructional day for students designated for teachers (e.g., staff development, work day) | ||
Other | Other | Other | ||
Student late arrival/early dismissal | Student late arrival/early dismissal | Abbreviated instructional day due to student late arrival or early dismissal | ||
Weather day | Weather day | Instruction cancelled or reduced due to weather | ||
Non-instructional day | Non-instructional day | Non-instructional day | ||
/calenderDates | 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 |
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 the school calendar | The Calendar endpoint represents a set of specific dates, which usually represent instructional days.
---------------------------- The CalendarDate entity models a specific date, and allows additional information to describe the type of date.
| POST on /calendars: "calendarCode":"020TEST", POST on /calendarDates (for each date): "calendarEvents": |
2.0 | Sending multiple calendars | Schools in K12 often have multiple calendars. While schools may have an overall calendar that applies to everyone, others sometimes have slightly different calendars for various grade levels. When using individual (or small group) calendars, it is RECOMMENDED that the StudentSchoolAssociation. Calendar reference only be populated when and if the student has a unique, individualized calendar, and not a school or grade level calendar. Such calendars SHOULD have a type set to a Ed-Fi standard descriptor value (e.g., "Student Specific" or "IEP") to ensure clarity on the scope and avoid confusion with a school or grade-level calendar. "
| POST on /calendars: -- overall calendar that applies to everyone POST on /studentSchoolAssociation: POST on /calendars: -- individualized calendar POST on /studentSchoolAssociation: |
JSON Sample:
Wisconsin Department of Public Instruction