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. Does not send a record when the Calendar Exclude checkbox is marked. Does not send a record when the School Exclude checkbox is marked.
Put	When fields that are not part of the natural key are changed. Type - when the type is changed on the Calendar Information editor. Grade Levels - when a grade level is deleted from Grade Levels Setup, it is removed from the array. Grade Levels - when a grade level is added to Grade Levels Setup and a mapping exists already for that grade level.
Delete	When a calendar and/or schedule structure is deleted.
Delete/Post	Delete 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 is sent when the School or Calendar is marked as Exclude.
Delete	When the Calendar is marked as excluded after the Calendar or any dependent data is sent, the calendar and all dependent data will be deleted upon a resync even if the resource is toggled 'OFF.'
None	When a resource is toggled to 'OFF' after data has been sent, all sent data will remain in the ODS, but no new data will be sent.
Resync	When a Calendar record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be 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 will be deleted from the ODS.
Resync	When a mapping is changed in Resource Preferences, a resync will 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 2nd schedule structure is added after data is sent, the first Calendar record will need to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID. When a calendar or schedule structure is moved via a script, all data sent to the ODS will remain, and the Delete tool needs to be used to remove all data sent. When the School ID changes, a delete/post occurs with the cascading deletes from the School ID change triggers.

Action

Trigger

Post/Delete

Natural Key change: When a 2nd schedule structure is added after data is sent, the first Calendar record will need to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID.

When a calendar or schedule structure is moved via a script, all data sent to the ODS will remain, and the Delete tool needs to be used to remove all data sent.
When the School ID changes, a delete/post occurs 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 send 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 send 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	Will update the Grade Levels field if a grade level is added/removed to the school and a mapping exists for that grade level.

Error Log

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.

Object Data Elements

This table describes data elements sent within the Calendars resource.

Data Element Label	Business Requirements 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, the Calendar ID reports. When there is more than one schedule structure associated with the calendar, the Calendar ID + Schedule Structure ID reports. Format: Calendar ID-Structure ID Example: 12-34	M	Calendar Information, Schedule Structure Setup calendar.calendarID + schedulestructure.structureID
SchoolReference	A reference to the related School resource. Reports the Ed-Fi School ID.	M	School Information > School ID
SchoolYearTypeReference	A reference to the related School Year resource. Reports the end year the calendar is associated with.	M
calendarTypeDescriptor	Indicates the type of Calendar. Reports the Ed-Fi Code the Calendar Type is mapped to in Calendar Resource Preferences. When the Type is not selected on the Calendar or not mapped, report hard-coded value of: uri://ed-fi.org/CalendarTypeDescriptor#Student Specific	M	Calendar Information > Type calendar.type
gradeLevels	Indicates the Grade Level associated with the Calendar. See the array logic below.	O

Arrays

Click here to expand...

Grade Levels

Data Element Label	Business Requirement	Mandatory, Conditional or Optional	Location
gradeLevelDescriptor	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.	M	Grade Level Setup gradelevel.name

Data Element Label

Business Requirement

Mandatory, Conditional or Optional

Location

gradeLevelDescriptor

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.

Grade Level Setup

gradelevel.name

Type/Descriptor