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. See state specific logic for more information.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new School is created and saved OR the Ed-Fi School Number or State School Number Changes.
|
| Put | When any of the fields not part of the Natural Key changes:
|
| Delete | Schools 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
This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.
| Action | Business Rule |
|---|---|
| None | No data will send for a school after it is marked as excluded. |
| None | If 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. |
| None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS and no new data will send. |
| Resync | If 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
This table describes the Natural Key Changes/Cascading Updates and Delete logic of this object.
| Action | Business Rule |
|---|---|
| Post | Natural 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. | |
| Delete | If the School ID changes all dependent resources will be deleted and reposted: |
| Calendars, 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 | |
| Delete | Resources with SchoolID Reference from a Dependent Resource: |
| Calendar Dates, Staff Section Associations, Student Section Associations, Student Section Attendance Events, Grades, Student Discipline Incident Associations, Discipline Actions, Course Transcripts |
Scope Year Logic
Data does not send for any of the resources if they reference a school that is marked as Exclude on the School editor.
| Logic |
|---|
| 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
This table describes the Identity Mapping Object Key of this object.
| campusObjectType | Object Key Data Source |
|---|---|
| School | school.number |
Event Queue Detail
This table describes the Event Queue Detail of this object.
| Campus Table | Ed-Fi Action | Fields |
|---|---|---|
| school | Post/Put/Delete | The primary table used for sending data for this resource. |
| grade | 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
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. |
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. |
| 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 Schools resource.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
|---|---|---|---|---|---|
id | The unique identifier of the resource. | M | |||
| addresses | The set of elements that describes the physical location of the education entity, including the street address, city, state, ZIP code, and ZIP code + 4. |
| O | ||
| educationOrganization Categories | The classification of the education agency within the geographic boundaries of a state according to the level of administrative and operational control granted by the state. |
| O | ||
| gradeLevels | The grade levels served at the school. |
| M | ||
| schoolId | The identifier assigned to a school. |
| M | System Administration> Resources> School | school.entityID or school.number |
| charterApprovalSchool YearTypeReference | Key for School Year. |
| O | ||
| localEducation AgencyReference | A reference to the related Local Education Agency resource. |
| O | ||
| administrativeFunding ControlDescriptor | The type of education institution as classified by its funding source, for example public or private. |
| O | ||
| charterApprovalAgency TypeDescriptor | The type of agency that approved the establishment or continuation of a charter school. |
| |||
| charterStatusDescriptor | A school or agency providing free public elementary or secondary education to eligible students under a specific charter granted by the state legislature or other appropriate authority and designated by such authority to be a charter school. |
| O | ||
| identificationCodes | A unique number or alphanumeric code assigned to an education organization by a school, school system, a state, or other agency or entity. |
| M | ||
| institutionTelephones | The 10-digit telephone number, including the area code, for the education entity. |
| O | ||
| internationalAddresses | The set of elements that describes the international physical location of the education entity. |
| O | ||
| internetAccessDescriptor | Indicates the type of Internet access that is available. |
| O | ||
| magnetSpecialProgram EmphasisSchoolDescriptor | A school that has been designed: 1) to attract students of different racial/ethnic backgrounds for the purpose of reducing, preventing, or eliminating racial isolation; and/or 2)to provide an academic or social focus on a particular theme (e.g., science/math, performing arts, gifted/talented, or foreign language). |
| O | ||
| nameOfInstitution | The full, legally accepted name of the institution. |
| M | System Administration> Resources> School | school.name |
| operationalStatus Descriptor | The current operational status of the education organization (e.g., active, inactive). |
| O | ||
| schoolCategories | The one or more categories of school. For example: High School, Middle School, and/or Elementary School. |
| O | ||
| schoolType Descriptor | The type of education institution as classified by its primary focus. |
| O | System Administration> Resources> School> School Type | school.type |
| shortNameOfInstitution | A short name for the institution. |
| O | System Administration> Resources> School | school.name |
| titleIPartASchool DesignationDescriptor | Denotes the Title I Part A designation for the school. |
| O | ||
| webSite | The public web site address (URL) for the educational organization. |
| O | ||
| etag | O |
