Calendars (Indiana v3.6)

Last Modified on 04/10/2024 12:57 pm CDT

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.

ActionTrigger
Post

When a new Calendar is created.

  • Do not send a record if the Calendar Exclude checkbox is marked.

  • Do not send a record if the School Exclude checkbox is marked.

When a new Schedule Structure in an existing Calendar is created and saved.

Put

When calendar data below are changed or updated

  • Calendar Type
  • Grade Level
DeleteWhen a calendar and/or schedule structure is deleted.


Delete/PostDelete if a 2nd Schedule Structure is added after 1st 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.

ActionTrigger
NoneNo data will send if the School or Calendar is marked as Exclude.
DeleteIf the Calendar is marked as exclude after the Calendar or any dependent data is sent, the calendar and all dependent data will delete upon a resync even if the resource is toggled 'OFF'.
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
ResyncIf 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.
ResyncIf 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.
ResyncIf a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes.

Scope Year Logic

This table describes scope year logic of this object.

Logic

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

  • Data will only send for years that have valid configuration.
  • Future Years data will be suppressed until the Active Year is changed. This allows the Schedule Wizard to be used and reducing the number of records sent until the final schedule is completed.

    A resync must be done after the Active Year is changed to send data.


Identity Mapping Object Key

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

campusObjectTypeObject Key Data Source
ScheduleStructurestructureID

Event Queue Detail

Campus TableEd-Fi ActionFields
calendarPost/Put/DeleteThe primary table used for sending data for this resource.
gradeLevelPutWill 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

ErrorPossible 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. If 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 Labels in bold are part of the Natural Key and are required data elements for information to send to Ed-Fi.

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Location

idThe unique identifier of the resource.

N/A

MN/A
calendarCode

The identifier for the Calendar.

Reports Calendar ID + Schedule Structure ID separated by -'s.
  • Example: 12-34
M

Index > System Administration > Calendar > Calendar > Calendar ID
+
Index > System Administration > Calendar > Schedule Structure > Structure ID



Calendar.calendarID
+
ScheduleStructure.StructureID

schoolReferenceA reference to the related School resource.

See references table below.


M
schoolYearTypeReferenceA reference to the related School Year resource.

See references table below.

M
calendarTypeDescriptor

Indicates the type of Calendar.

Report the Ed-Fi Code the Calendar Type is mapped to in Calendar Resource Preferences.
  • If the Type is not selected on the Calendar or not mapped, an error will occur.
MSystem Administration > Calendar > Calendar > Type

calendar.type
gradeLevelsIndicates the Grade Level associated with the Calendar.

See arrays logic below.

OSystem Administration > Calendar > Calendar > Grade Levels

gradelevel.name

Arrays

Click here to expand...

Calendar Event Descriptor

Data Element Label

Business Requirement

Business Rules

M, C or O

Location

gradeLevelDescriptor

Indicates the GradeLevel associated with the Calendar.

  1. Report all unique Grade Levels for the Calendar/Schedule Structure that are mapped to an Ed-Fi Grade Level.
    • Do not report if the Grade Level is in a Calendar marked as Exclude.
  2. If a grade level is not mapped, do not report.
 M

System Administration > Calendar > Calendar > Grade Levels


gradelevel.name


References

Reference
Business Rule
Example
Location
schoolReferenceReport the school as: 10+District#+School#
  • Example: 1010009999

"schoolReference": {
      "schoolId": 0,
      "link": {
        "rel": "string",
        "href": "string"
      }

System Administration > Resources > District Info > State District Number

+
System Administration > Resources > School > State School Number


district.stateDistrictNumber
school.stateSchoolNumber
schoolYearTypeReferenceReport the End Year of School Year
  • Example: SY 22-23, report 2023

"schoolYearTypeReference": {
      "schoolYear": 0,
      "link": {
        "rel": "string",
        "href": "string"
      }

System Administration > Calendar > School Years > School Year Editor > End Year

SchoolYear.endYear

Type/Descriptor

Click here to expand...

Calendar Type Descriptor

Code ValueDescriptionNamespace
Student Specific ElementaryStudent Specific Elementaryhttp://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml
Student Specific Non-CompulsoryStudent Specific Non-Compulsoryhttp://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml
Student Specific SecondaryStudent Specific Secondaryhttp://doe.in.gov/Descriptor/CalendarTypeDescriptor.xml

Grade Level Descriptor
Code ValueDescriptionNamespace
01Grade 1uri://doe.in.gov/GradeLevelDescriptor
02Grade 2uri://doe.in.gov/GradeLevelDescriptor
03Grade 3
uri://doe.in.gov/GradeLevelDescriptor
04Grade 4
uri://doe.in.gov/GradeLevelDescriptor
05Grade 5
uri://doe.in.gov/GradeLevelDescriptor
06Grade 6
uri://doe.in.gov/GradeLevelDescriptor
07Grade 7
uri://doe.in.gov/GradeLevelDescriptor
08Grade 8
uri://doe.in.gov/GradeLevelDescriptor
09Grade 9
uri://doe.in.gov/GradeLevelDescriptor
10Grade 10
uri://doe.in.gov/GradeLevelDescriptor
11Grade 11
uri://doe.in.gov/GradeLevelDescriptor
12Grade 12
uri://doe.in.gov/GradeLevelDescriptor
13Grade 13
Used for an individual assigned to a class or program that does not have standard grade designations. This may include students who remain enrolled in school after completing high school in order to earn additional high school credits and students with disabilities.
uri://doe.in.gov/GradeLevelDescriptor
KGKG - Full Day
uri://doe.in.gov/GradeLevelDescriptor
KG - Afternoon
KG - Afternoon
uri://doe.in.gov/GradeLevelDescriptor
KG - Morning
KG - Morning
uri://doe.in.gov/GradeLevelDescriptor
PKPrekindergarten ages 3 - 5
uri://doe.in.gov/GradeLevelDescriptor
UGUngradeduri://doe.in.gov/GradeLevelDescriptor

Related Articles

Was this helpful?
Thank you for your feedback!
User Icon

Thank you!

Copyright ©️ 2010-2023 Infinite Campus, Inc. All rights reserved. | Terms of Use | Privacy Policy | infinitecampus.com