• Home
  • Reporting
  • Ed-Fi
  • Ed-Fi State Information
  • Texas Ed-Fi
  • Texas Ed-Fi Resources v4.0
  • Education Organization Information

Schools (Texas v4.0)

Tool Search: Ed-Fi

This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. This field only accepts numeric values for the School ID, so some states may implement a different State School Number for Ed-Fi.

Object Triggering Logic

ActionTrigger
Post

When a new School is created and saved OR the Ed-Fi School Number or State School Number Changes.

  • Do not send if the Exclude checkbox is marked.
  • Do not send if the Schools resource is toggled 'OFF' in the Schools Resource Preferences.
Put

When any of the fields not part of the Natural Key changes:

  • Name of Institution

  • Addresses

  • Institution Telephones
  • Grade Levels
  • School Type
  • Grade Type
DeleteSchools can only be deleted using the Delete Tool only if all dependent data for a school has been removed from the ODS.


School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

ActionBusiness Rule
NoneNo data will send for a school after it is marked as excluded.
NoneIf the School is marked as exclude after the School or any dependent data is sent, the data will remain in the ODS.  The user must use the Delete tool to delete any dependent data that as sent for that school.
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS and no new data will send.
ResyncIf an Ed-Fi Code mapping is changed to a new code or made NULL, a resync must be performed for the data to be updated in the ODS.


Natural Key Changes, Cascading Updates, and Delete Logic

ActionBusiness Rule
PostNatural Key change:  Ed-Fi School ID or State School Number.
  • If the School Number/Ed-Fi School Number changes, a delete/post will occur with the cascading deletes from the School ID/Ed-Fi ID Change triggers.
DeleteIf the School ID changes all dependent resources are deleted and reposted.
Dependent ResourcesCalendars, Class Periods, Courses, Course Offerings, Discipline Incidents, Grading Periods, Locations, Sessions, Staff Education Organization Assignment Associations, Staff Education Organization Employment Associations, Staff School Associations, Student School Associations, Student School Attendance Events
Resources with SchoolID Reference from a Dependent ResourceCalendar Dates, Staff Section Associations, Student Section Associations, Student Section Attendance Events, Grades, Student Discipline Incident Associations, Discipline Actions, Course Transcripts


Scope Year Logic

Business Rules
Schools are not aligned to a year so all schools send to each scoped year with a valid configuration.
A resync must be completed on the resource when a new scope year is connected in order for this data to send.


Identity Mapping Object Key

campusObjectTypeObject Key Data Source
Schoolschool.number


Event Queue Detail

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

Ed-Fi. 400:

[message:Validation of 'School' failed.  EducationOrganizationAddresses requires at least one object in the collection. ].

The physical address fields must be populated on the School editor as address is a mandatory field to send the Schools resource.

Ed-Fi. 400:

[message:Validation of 'School' failed.  SchoolGradeLevels requires at least one object in the collection. ].

At least 1 grade level must be created under System Administration> Calendar> Calendar> Grade Levels.


Object Data Elements

This table describes data elements sent within the Schools resource. Required data elements are listed in bold.

Click here to expand...


Array Data Elements

Click here to expand...

Descriptors / Types

Education Organization Categories

Code
Description
Namespace
01
Education Service Centeruri://tea.texas.gov/EducationOrganizationCategoryDescriptor#01
02
Local Educational Agencyuri://tea.texas.gov/EducationOrganizationCategoryDescriptor#02
03
Schooluri://tea.texas.gov/EducationOrganizationCategoryDescriptor#03
04
State Education Agencyuri://tea.texas.gov/EducationOrganizationCategoryDescriptor#04