Tool Search: Ed-FI

This entity represents a set of dates associated with an organization.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

Action	Trigger
Post	A Calendars record is created for each Calendar/Schedule Structure combination. When a new Calendar and Schedule Structure is created and saved via the Calendar Wizard. When a new Schedule Structure in an existing Calendar is created and saved. Does not send a record when the Calendars resource is toggled 'OFF' in the Calendars Resource Preferences.
Put	When fields that are not part of the natural key are changed. When the Type is changed on the Calendar. When a grade level is deleted from the Grade Levels tool, it is removed from the array. When a grade level is added to the Grade Levels tool and a mapping exists already for that grade level.
Delete	When a calendar and/or schedule structure is deleted.
Delete/Post	Deletes when a second Schedule Structure is added after the first Calendar is sent.

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.

Action	Trigger
None	No data sends the School or Calendar is marked as Exclude.
Delete	When the Calendar is marked as exclude after the Calendar or any dependent data is sent, the calendar and all dependent data deletes upon a resync even when the resource is toggled 'OFF'.
None	When a resource is toggled to 'OFF' after data has sent, all sent data remains in the ODS but no new data is sent.
Resync	When a Calendar record is in the Ed-Fi Identity Mapping table and not in the ODS, it is deleted from the Ed-Fi Identity Mapping table.
Resync	When a Calendar record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it is deleted from the ODS.
Resync	When a mapping is changed in Resource Preferences, a resync is needed to reflect the changes.

Natural Key Changes, Cascading Updates, and Deletes Logic

This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.

Action	Trigger
Post/Delete	Natural Key change: When a second schedule structure is added after data is sent, the first Calendar record needs to be Deleted/Posted with new Calendar Code logic to be Calendar ID plus Schedule Structure ID. When a calendar or schedule structure is moved via script, all data send to the ODS will remain and the Delete tool will need to be used to remove all data sent. When the School ID changes, a delete/post will occur with the cascading deletes from the School ID change triggers.

Action

Trigger

Post/Delete

Natural Key change: When a second schedule structure is added after data is sent, the first Calendar record needs to be Deleted/Posted with new Calendar Code logic to be Calendar ID plus Schedule Structure ID.

When a calendar or schedule structure is moved via script, all data send to the ODS will remain and the Delete tool will need to be used to remove all data sent.

When the School ID changes, a delete/post will occur with the cascading deletes from the School ID change triggers.

Scope Year Logic

This table describes scope year logic of this object.

Logic
Calendars only send for the school year to which they are aligned. Data only sends for years that have valid configuration. A resync must be completed on the resource when a new scope year is connected in order for this data to send.

Logic

Calendars only send for the school year to which they are aligned.

Data only sends for years that have valid configuration.
A resync must be completed on the resource when a new scope year is connected in order for this data to send.

Resource Preferences

This table describes the Resource Preferences of this object.

Data Element Label	Mapping Needed
calendarTypeDescriptor	calendar.type
gradeLevelDescriptor	Uses the overall 'Grade Levels' mapping

Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectType	Object Key Data Source
ScheduleStructure	structureID

Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus Table	Ed-Fi Action	Fields
calendar	Post/Put/Delete	The primary table used for sending data for this resource.
gradelevel	Put	Updates the Grade Levels field when a grade level is added/removed to the school and a mapping exists for that grade level.

Error Log

This table describes the Error logic of this object.

Error	Possible Causes/How to Fix
403 Forbidden: {"message": "Access to the resource could not be authorized for the requested action 'http://ed-fi.org/odsapi/actions/create'."}	This is usually caused by a security set up error in the ODS. Contact the Ed-Fi Alliance for assistant on correct security setup in the ODS.
Error code return from Ed-Fi. 400: [message:Validation of 'Calendar' failed. CalendarTypeDescriptorId is required.].	The Type field is not selected on the Calendar that is being sent or the Type selected on the Calendar is not mapped to an Ed-Fi Code in Resource Preferences.
The School ID being sent is non-numeric. Enter a numeric Ed-Fi School Number or State School Number on the Schools editor to correct this issue.	Ed-Fi does not accept alpha-values in the School ID field. When the State School Number has any alpha characters, use the Ed-Fi School ID field to create a numeric school number to send.

Object Data Elements

This table describes data elements sent within the Calendars resource.

Data Element Label	Business Requirement and Rules	Mandatory, Conditional or Optional	Location
id	The unique identifier of the resource.	M
Calendar Code	The identifier for the Calendar. When there is only one Schedule Structure associated with the Calendar, only reports the Calendar ID. When there is more than one Schedule Structure associated with the Calendar, reports the Calendar ID plus the Schedule Structure ID. Reports the Calendar ID-Structure ID. A dash reports between the two numbers.	M	School & District Settings > District > District Information > District Entity ID School & District Settings > Schools > School Information > Ed-Fi School ID Scheduling & Courses > Calendar Setup > Schedule Structure Setup > Structure ID CustomSchool.value district.entityID School.entityID Calendar.daysPerWeek CustomCalendar.value ScheduleStructure.structureID
SchoolReference	A reference to the related School resource. Reports the fields that are part of the Natural Key for the Schools resource.	M
SchoolYearTypeReference	A reference to the related School Year resource. Reports the End Year to which the calendar is associated.	M
calendarTypeDescriptor	Indicates the type of Calendar. Reports the Ed-Fi Code the Calendar Type is mapped to in the Calendar Resource Preferences. When the Type is not selected on the Calendar or not mapped, an error occurs.	M	Scheduling & Courses > Calendar Setup > Calendar Information > Type Calendar.type
gradeLevels	Indicates the GradeLevel associated with the Calendar. Reports all unique Grade Levels for the Calendar/Schedule Structure that are mapped to an Ed-Fi Grade Level. Does not report when the Grade Level is in a Calendar marked as Exclude. When a grade level is not mapped, does not report.	O	Scheduling & Courses > Calendar Setup > Grade Level Setup Gradelevel.name

Type/Descriptor

This table describes the Ed-Fi Value mapped and reported for Calendar Type Descriptor:

Code Value	Description	Namespace	Short Description
Student Specific	Student Specific	uri://ed-fi.org/CalendarTypeDescriptor	Student Specific
IEP	IEP	uri://ed-fi.org/CalendarTypeDescriptor	IEP

Calendars (Vermont v3.6)