Tool Search: Ed-Fi Configuration
This article defines all of the elements of data sent per entity between Campus and the Ed-Fi system.
- Data in schools and calendars marked as Exclude will not send data to Ed-Fi.
- Person-related records do not trigger a send of data to Ed-Fi if the person does not have an Ed-Fi ID value assigned.
- Ed-Fi ignores custom field data entered in Campus.
- Staff Cohort Associations
- Staff Education Organization Assignment Association
- Staff
- Staff School Association
- Staff Section Association
- Student
- Student Academic Record
- Student Cohort Associations
- Student Discipline Incident Association
- Student Education Organization Association
- Student Parent Association
- Student Program Association
- Student School Association
- Student School Attendance Event
- Student Section Association
- Student Section Attendance Event
- Student Special Education Program Association
- Student Title I Part A Program Association
Understand Object Triggering Tables
The Object Triggering Logic Tables describe what actions within Campus result in data being triggered to sync to Ed-Fi.
The following table lists the definition of each potential Action:
| Action | Definition |
|---|---|
| Post | This will insert new records and data within Ed-Fi. |
| Put | This action will update existing information within Ed-Fi. |
| Get | This action is used for items that are pre-loaded. For example, Courses and Programs. |
| Delete | This will delete records and data within Ed-Fi. |
Understand Object Data Element Tables
The Object Data Element tables describe all of the elements contained within a reporting entity. Each element is given a description of what it is and any potential logic used to calculate the element, if the element is mandatory for reporting to Ed-Fi (indicated by an M), where the data is pulled from the Campus database and where the pulled information is entered within the Campus UI.
Elements marked as M are mandatory elements which must report data to Ed-Fi in order to meet reporting requirements. Elements marked as O are optional elements which are not mandatory for the Ed-Fi requirement but can be populated and report data for additional state-specific reporting purposes. Elements listed as C are conditional elements which are not required to report but will report data if the data is present within Campus.
Data Element Labels in bold are part of the Natural Key and are required data elements for data to send to Ed-Fi.
Understand Type/Descriptor Tables
The Type/Descriptor section describes each element and their corresponding Campus to Ed-Fi value translation that is occurring.
If the element is reporting a Descriptor, the Ed-Fi Code Value is reported.
If the element is reporting a Type, the Ed-Fi Short Description is reported.
Entities and Elements
The following lists all the currently available and syncing entities and their respective elements.
Calendar Dates
This entity represents a day in the school calendar.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Days report by school not calendar in Ed-Fi, so when working with multiple calendars/schedule structures it is possible a day could be reporting even if it is not in the calendar you are working in.
| Action | Trigger |
|---|---|
| Post | When a Day and/or a Day Event is created and saved or the Instruction checkbox is checked.
|
| Put | When a Day Event or Duration is changed and saved. |
| Delete | When the Instruction checkbox is unchecked or a Day Event is deleted and saved.
|
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports the calendar dates in the scope year to which the calendar is aligned. |
| Data will only send for the years that have a valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Calendar Dates resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| schoolReference | Reports data from the SchoolID field that is part of the natural key for the Schools resource. The following elements are reported:
| M | School.entityID | System Administration > Resources > School > Entity ID | |
| date | Month, day, and year of the date being reported. | M | Day.date | System Administration > Calendar > Calendar > Days > Date | |
| calendarEvents | An unordered collection of calendarDateCalendarEvents. This entity represents a day in the school calendar.
See the Calendar Event Descriptor table in the Type/Descriptor section below. | N/A | N/A | ||
| Calendar Event Descriptor | This descriptor holds the types of scheduled or unscheduled events for the day. Logic reports as follows:
See the Calendar Event Descriptor table in the Type/Descriptor section below. | M | Day.instruction | System Administration > Calendar > Calendar > Day | |
| eventDuration | Reports the duration of the day event being reported. This element is optional and does not report. | O | N/A | N/A | |
| _etag | A unique system-generated value that identifies the version of the resource. This does not report. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Calendar Event Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Instructional Day | Instructional Day | Instructional Day |
| Teacher only day | Teacher only day | Teacher only day |
| Holiday | Holiday | Holiday |
| Make-up day | Make-up day | Make-up day |
| Weather Day | Weather Day | Weather Day |
| Student late arrival/early dismissal | Student late arrival/early dismissal | Student late arrival/early dismissal |
| Emergency day | Emergency day | Emergency day |
| Strike | Strike | Strike |
| Other | Other | Other |
Class Periods
This entity represents the designation of a regularly scheduled series of class meetings at designated times and days of the week.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a Period Schedule is created and saved.
|
| Post | When a Period Schedule Name or Period Name is changed and saved. |
| Delete | When a Period Schedule Name or Period Name is changed and saved. |
| Delete | When a Period Schedule or Period is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports the class periods in the scope year to which the calendar is aligned. |
| Data is only sent for the years that have a valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Class Periods resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| schoolReference | Reports data from the SchoolID field that is part of the natural key for the Schools resource. The following elements are reported:
| M | School.number | System Administration> Resources> School> State School Number |
| name | Indicates the portion of a typical daily session in which students receive instruction in a specified subject (e.g., morning, sixth period, block period, etc). The Period Schedule Name + Period Name + Schedule Structure ID reports (with a space between each value). The maximum value for this field is 20 characters. The Period Schedule Name or Period Name may have to be abbreviated if the concatenation exceeds the 20 character limit. | M | PeriodSchedule.name Period.name ScheduleStructure. structureID | System Administration > Calendar > Calendar > Periods System Administration > Calendar > Calendar > Schedule Structure |
| etag | A unique system-generated value that identifies the version of the resource. This is optional and does not report. | O | N/A | N/A |
Cohorts
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a Program Session is added and is mapped to a Program where the Program's Name matches a Cohort Type |
| The Program can only be created from Program Admin> Programs> Programs tab | |
| Put | If the Category or Description changes |
| Post/Delete | If the Program Name changes |
| Delete | If the Program Session is deleted |
Object Data Elements
This table describes data elements sent within the Cohorts resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrganizationReference | A reference to the related EducationOrganization resource Reports the State District Number | M | System Administration> Resources> District Information> State District Number | district.number | |
| identifier | The name or ID for the cohort. Reports the Program Session ID | M | Program Admin> Programs> Program> Program Sessions ID | programsession. programSessionID | |
| description | The description of the cohort and its purpose.
| O | Program Admin> Programs> Programs> Description | program.description | |
| type | The type of the cohort (academic intervention, attendance intervention, discipline intervention, breakout session, etc.). Reports the Cohort Type selected on the mapping page for the program being reported. | M | program.name | ||
| scopeType | The scope of cohort (e.g., campus, district, classroom).
| O | Program Admin> Programs> Programs> Category | program.program Category | |
| academicSubjectDescriptor | The subject for an academic intervention (e.g., science, mathematics) | O | |||
| programs | An unordered collection of cohortPrograms. The optional program associated with this cohort (e.g., Special Education) | O | |||
| etag | |||||
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Cohort Type
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
| Academic Intervention | Academic Intervention | Academic Intervention |
| Attendance Intervention | Attendance Intervention | Attendance Intervention |
| Classroom Pullout | Classroom Pullout | Classroom Pullout |
| Counselor List | Counselor List | Counselor List |
| Discipline Intervention | Discipline Intervention | Discipline Intervention |
| Extracurricular Activity | Extracurricular Activity | Extracurricular Activity |
| Field Trip | Field Trip | Field Trip |
| In-school Suspension | In-school Suspension | In-school Suspension |
| Other | Other | Other |
| Principal Watch List | Principal Watch List | Principal Watch List |
| Study Hall | Study Hall | Study Hall |
This table describes the Ed-Fi Value mapped and reported for Cohort Scope Type
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
| District | District | District |
| School | School | School |
| Network | Network | Network |
| Classroom | Classroom | Classroom |
| Teacher | Teacher | Teacher |
| Principal | Principal | Principal |
| Counselor | Counselor | Counselor |
| Statewide | Statewide | Statewide |
| Other | Other | Other |
Course
This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a course is created and saved.
|
| Delete/Insert | If the course number is changed, do a delete/insert of the record. |
| Put | When course information not part of the natural key is changed and saved:
|
| Delete | When a Course is deleted and there are no other courses with the same number in the same school and year |
Object Data Elements
This table describes data elements sent within the Course resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| education Organization Reference | A reference to the related EducationOrganization resource. Reports the school number associated with the course. | M | N/A | N/A | |
| code | The code that identifies the organization of subject matter and related learning experiences provided for the instruction of students. | M | Course.number | Scheduling > Course > Number | |
| title | The descriptive name given to a course of study offered in a school or other institution or organization. In departmentalized classes at the elementary, secondary, and post-secondary levels (and for staff development activities), this refers to the name by which a course is identified (e.g., American History, English III). For elementary and other non-departmentalized classes, it refers to any portion of the instruction for which a grade or report is assigned (e.g., reading, composition, spelling, and language arts). | M | Course.name | Scheduling > Course > Name | |
| numberOfParts | The number of parts identified for a course. The number in the SCED Sequence Part M field is reported. This field reports a default value of 1 for all courses if blank. | M | course.sced SequenceNum | Defaults to 1 for all courses | |
| academicSubject Descriptor | The intended major subject area of the course. NEDM: Secondary Course Subject Area. See the Type/Descriptor table below. Reports the Ed-Fi code from the value selected in the SCED Subject Area dropdown. If SCED codes are not used or Ed-Fi Value is blank, it does not report. | O | Course.SCED | Scheudling > Course > Courses > SCED Subject Area | |
| description | A description of the content standards and goals covered in the course. Reference may be made to state or national content standards. This field does not report. | O | N/A | N/A | |
| dateCourseAdopted | The date the district adopted the course. This field does not report. | O | N/A | N/A | |
| highSchoolCourse Requirement | An indication that this course credit is required for a high school diploma. This field does not report. | O | N/A | N/A | |
| gpaApplicability Type | An indicator of whether or not this course being described is included in the computation of the student’s Grade Point Average, and if so, if it is weighted differently from regular courses. This field does not report. | O | N/A | N/A | |
| definedByType | Specifies whether the course was defined by the SEA, LEA, school or national organization. This field does not report. | O | N/A | N/A | |
| minimumAvailable CreditType | The type of credits or units of value awarded for the completion of a course. This field does not report. | O | N/A | N/A | |
| minimumAvailable CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. | O | N/A | N/A | |
| minimumAvailable Credit | The minimum amount of credit available to a student who successfully completes the course. This field does not report. | O | N/A | N/A | |
| maximumAvailable CreditType | The type of credits or units of value awarded for the completion of a course. This field does not report. | O | N/A | N/A | |
| maximumAvailable CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This field does not report. | O | N/A | N/A | |
| maximumAvailable Credit | The maximum amount of credit available to a student who successfully completes the course. This field does not report. | O | N/A | N/A | |
| careerPathwayType | The career cluster or pathway representing the career path of the Vocational/CTE concentrator. This field does not report. | O | N/A | N/A | |
| timeRequired ForCompletion | The actual or estimated number of clock minutes required for class completion. This number is especially important for career and technical education classes and may represent (in minutes) the clock hour requirement of the class. This field does not report. | O | N/A | N/A | |
| competencyLevels | An unordered collection of courseCompetencyLevels. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field does not report. | O | N/A | N/A | |
| gradeLevels | An unordered collection of courseGradeLevels. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field does not report. | O | N/A | N/A | |
| IdentificationCodes | An unordered collection of courseIdentificationCodes. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field is an array. | O | N/A | N/A | |
| courseIdentification SystemDescriptor | Reports 'LEA course code' when reporting the Course Number Reports 'State course code' when reporting the State Code | O | N/A | N/A | |
| assigningOrganization IdentificationCode | The organization code or name assigning the staff Identification Code. This field does not report. | O | N/A | N/A | |
| identificationCode | A unique number or alphanumeric code assigned to a space, room, site, building, individual, organization, program, or institution by a school, school system, a state, or other agency or entity. Reports the Course Number when reporting 'LEA course code' Reports the State Code when reporting 'State course code' | M | Scheduling> Courses | course.number or course.statecode | |
| learningObjectives | An unordered collection of courseLearningObjectives. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field does not report. | O | N/A | N/A | |
| learningStandards | An unordered collection of courseLearningStandards. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field does not report. | O | N/A | N/A | |
| levelCharacteristics | An unordered collection of courseLevelCharacteristics. This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis. This field is an array. | O | N/A | N/A | |
| type | Reports the Ed-Fi code from the Course Level selected. Does not report if the Ed-Fi Code is NULL or field is blank. | M | Scheduling> Courses> Course Level | course.honorsCode | |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Academic Subject Descriptor:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Career and Technical Education | Career and Technical Education | Career and Technical Education |
| Composite | Composite | Composite |
| Critical Reading | Critical Reading | Critical Reading |
| English | English | English |
| English Language Arts | English Language Arts | English Language Arts |
| Fine and Performing Arts | Fine and Performing Arts | Fine and Performing Arts |
| Foreign Language and Literature | Foreign Language and Literature | Foreign Language and Literature |
| Life and Physical Sciences | Life and Physical Sciences | Life and Physical Sciences |
| Mathematics | Mathematics | Mathematics |
| Military Science | Military Science | Military Science |
| Other | Other | Other |
| Physical, Health, and Safety Education | Physical, Health, and Safety Education | Physical, Health, and Safety Education |
| Reading | Reading | Reading |
| Religious Education and Theology | Religious Education and Theology | Religious Education and Theology |
| Science | Science | Science |
| Social Sciences and History | Social Sciences and History | Social Sciences and History |
| Social Studies | Social Studies | Social Studies |
| Writing | Writing | Writing |
This table describes the Ed-Fi Value mapped and reported for Course Level Characteristic Types:
Ed-Fi Code Value | Ed-Fi Short Description | Description |
|---|---|---|
| Accepted as high school equivalent | Accepted as high school equivalent | Accepted as high school equivalent |
| Advanced | Advanced | Advanced |
| Advanced Placement | Advanced Placement | Advanced Placement |
| Basic | Basic | Basic |
| Career and Technical Education | Career and Technical Education | Career and Technical Education |
| College-level | College-level | College-level |
| Core Subject | Core Subject | Core Subject |
| Correspondence | Correspondence | Correspondence |
| Distance Learning | Distance Learning | Distance Learning |
| Dual Credit | Dual Credit | Dual Credit |
| English Language Learner | English Language Learner | English Language Learner |
| General | General | General |
| Gifted and Talented | Gifted and Talented | Gifted and Talented |
| Graduation Credit | Graduation Credit | Graduation Credit |
| Honors | Honors | Honors |
| International Baccalaureate | International Baccalaureate | International Baccalaureate |
| Magnet | Magnet | Magnet |
| Other | Other | Other |
| Pre-AP | Pre-AP | Pre-AP |
| Pre-IB | Pre-IB | Pre-IB |
| Remedial | Remedial | Remedial |
| Students with disabilities | Students with disabilities | Students with disabilities |
| Untracked | Untracked | Untracked |
This table describes the Ed-Fi Value mapped and reported for Course Identification System Descriptor:
Code Value | Short Description | Description |
|---|---|---|
CSSC course code | CSSC course code | CSSC course code |
Intermediate agency course code | Intermediate agency course code | Intermediate agency course code |
LEA course code | LEA course code | LEA course code |
NCES Pilot SNCCS course code | NCES Pilot SNCCS course code | NCES Pilot SNCCS course code |
Other | Other | Other |
SCED course code | SCED course code | SCED course code |
School course code | School course code | School course code |
State course code | State course code | State course code |
University course code | University course code | University course code |
Course Offering
This entity represents an offering of a course by school during a session, representing the course catalog of available courses.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
This resource will not push data for Courses marked as Inactive or State Exclude.
| Action | Trigger |
|---|---|
| Post | When a section with Section Placements is created and saved.
|
| Delete/Post | When the Local Course number is changed. |
| Delete/Post | If the Term Descriptor changes either via section placement or mapping override and a course offering already exists with non-matching Term Descriptors. |
| Delete/Post | When there are two Courses with the same natural key and 1 is deleted, the other record will post with the remaining records data. |
| Put | When the Course Information is changed and saved.
|
| Delete | When a section is deleted. |
| Delete | When a section schedule placement is removed and saved. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports course offerings for the scope year to which the courses calendar is aligned. |
| Data will only send for the years that have valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Course Offering resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| courseReference | Reports the following elements that are part of the Natural Key for the Course resource:
| M | N/A | N/A |
| schoolReference | Reports the following elements that are part of the Natural Key for the Schools resource:
| M | School.entityID | System Administration > Resources > School > Number |
| sessionReference | Reports the following elements that are part of the Natural Key for the Sessions resource:
| M | N/A | N/A |
| localCourseCode | The local code assigned by the LEA or Campus that identifies the organization of subject matter and related learning experiences provided for the instruction of students. | M | Course.number | Scheduling > Course > Number |
| localCourseTitle | The descriptive name given to a course of study offered in the school, if different from the CourseTitle. | O | Course.name | Scheduling > Course > Name |
| InstructionalTimePlanned | The planned total number of clock minutes of instruction for this course offering. Generally, this should be at least as many minutes as is required for completion by the related state- or district-defined Course. | O | N/A | N/A |
| curriculumUsed | An unordered collection of courseOfferingCurriculumUseds. This entity represents an offering of a course by school during a session, representing the course catalog of available courses. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Course Transcripts
This entity is the final record of a student's performance in their courses at the end of a semester or school year.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When transcript records are posted for a student and they have a valid Student School Association for the Scoped Year.
|
If the District Number on the Transcript record does not match the reporting district look to see if the course number exists in the School:
| |
| Post/Delete | When a transcript record is modified we always do a post/delete and never do a "Put". |
| Delete | When a transcript record is deleted for a student. |
| Delete | Transcript records delete when a student has only one Student School Association record for a specific Year and that record is deleted. If a new Student School Association record is created, existing records will not re-post, a resync must be completed to resend the data. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Transcript records will send to each scope year where the student has a Student School Association, regardless of the Transcript School Year. |
| Data will only send for the years that have valid configuration. |
| A resync must be completed at the beginning of each year so that all years transcript records will be loaded in the ODS. |
Object Data Elements
This table describes data elements sent within the Course Transcripts resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||||
|---|---|---|---|---|---|---|---|
| courseReference | The unique identifier of the resource. Natural Key fields for the Course resource:
| M | N/A | N/A | |||
| schoolReference | A reference to the related School resource. Reports the Natural Key fields for the School resource:
If the School ID is not valid, this field will report blank. | O | N/A | N/A | |||
| studentAcademic RecordReference | A reference to the related Student Academic Record resource. Reports the Natural Key fields for the Student Academic Record resource:
| M | N/A | N/A | |||
| courseAttemptResultType | The result from the student's attempt to take the course, for example: Pass, Fail, Incomplete, Withdrawn. When reporting from Transcript Records use the Credits Earned vs. Credit Attempted to determine the Result Type:
| M | Transcriptcredit. Transcriptcredit. | Student Information > General > Transcripts > Earned Student Information > General > Transcripts> Attempted | |||
| attemptedCreditType | The type of credits or units of value attempted for the completion of a course. This field is optional and does not report. | O | N/A | N/A | |||
| attemptedCreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This field is optional and does not report. | O | N/A | N/A | |||
| attemptedCredits | The number of credits attempted for a course. Report the sum of credits from the Attempted field on the Transcript record being reported. | O | Transcriptcredit. creditsAttempted | Student Information > General > Transcripts > Attempted | |||
| earnedCreditType | The type of credits or units of value awarded for the completion of a course. This field is optional and does not report. | O | N/A | N/A | |||
| earnedCreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This field is optional and does not report. | O | N/A | N/A | |||
| earnedCredits | The number of credits awarded or earned for the course. Report the sum of credits from the Earned field on the Transcript record being reported. | M | Transcriptcredit. creditsEarned | Student Information > General > Transcripts > Earned | |||
| whenTakengrade LevelDescriptor | Student's grade level at time of course.
| O | N/A | Student Information > General > Transcript > Transcript Course Editor > Grade | |||
| methodCreditEarnedType | The method the credits were earned, for example: Classroom, Examination, Transfer. This field is optional and does not report. | O | N/A | N/A | |||
| finalLetterGradeEarned | The final letter grade earned for the course. Logic determines if the posted score is an integer or not:
| O | Transcriptcourse.score | Student Information > General > Transcripts > Current Score | |||
| finalNumericGradeEarned | The final numeric grade earned for the course. Logic determines if the posted score is an integer or not:
| O | Transcriptcourse.score | Student Information > General > Transcripts > Current Score | |||
| courseRepeatCodeType | Indicates that an academic course has been repeated by a student and how that repeat is to be computed in the student''s academic grade average. This field is optional and does not report. | O | N/A | N/A | |||
| courseTitle | Reports the name of the course completed. Report the Course Name from the transcript record. | O | Transcriptcourse. courseName | Student Information > General > Transcripts > Course Name | |||
| alternativeCourseCode | The local code assigned by the school that identifies the course offering, the code from an external educational organization, or other alternate course code. This field is optional and does not report. | O | N/A | N/A | |||
| earnedadditionalCredits | An unordered collection of courseTranscriptAdditionalCredits. This entity is the final record of a student's performance in their courses at the end of a semester or school year. This field is only reported if the student has a grading task with an associated credit to report. | O | N/A | N/A | |||
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Course Attempt Result Type:
| Ed-Fi Short Description | Ed-Fi Description |
|---|---|
| Pass | Pass |
| Fail | Fail |
| Incomplete | Incomplete |
| Withdrawn | Withdrawn |
Discipline Action
This event entity represents actions taken by an education organization after a disruptive event that is recorded as a discipline incident.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | Reports when a Behavior Resolution is added to an incident that is marked as Complete and is aligned to a reported Behavior Event.
|
| Delete/Post | When data that is part of the Natural Key is changed.
|
| Delete/Post | When the Incident's status is changed.
|
| Delete | When a resolution is deleted. |
| Delete | When all resolutions are removed from the incident. |
| Delete | When all Behavior Events are removed from the Incident. |
| Delete | When the student's Role changes to anything other than Offender or Participant. |
| Delete | When all non-excluded enrollments in the school and year are deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Discipline records will only send to the school year that the incident date is aligned to based on the School Year Start and End dates.
|
| Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Discipline Action resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| assignmentschool Reference | A reference to the related School resource This is optional and does not report. | O | N/A | N/A | |
| responsibility schoolReference | Reports data from the SchoolID field that is part of the natural key for the Schools resource of the school where the incident occurred. The following elements are reported:
| M | School.entityID | System Administration > Resources > School > Entity ID | |
| studentReference | Reports data from the Ed-Fi ID field that is part of the natural key for the Student resource of the school where the incident occurred. The following elements are reported:
| M | Person.edfiID | Census > People > Demographics > EdFi ID | |
| identifier | Identifier assigned by the education organization to the discipline action. | M | BehaviorResolution. resolutionID | Behavior > Behavior Management > Resolution > Resolution ID | |
| disciplineDate | The month, day, and year of the discipline action. | M | BehaviorResolution. timestamp | Behavior > Behavior Management > Resolution > Resolution Start Date | |
| length | The length of time in school days for the Discipline Action (e.g. removal, detention), if applicable. | O | N/A | N/A | |
| actualDiscipline ActionLength | The length of time in school days for the Discipline Action (e.g. removal, detention), if applicable.
| O | behaviorResolution.schoolDaysDuration | Behavior> Behavior Management> Resolution>Duration in School Days | |
| lengthDifference ReasonType | Indicates the reason for the difference, if any, between the official and actual lengths of a student s disciplinary assignment. This is optional and does not report. | O | N/A | N/A | |
relatedToZero | An indication of whether or not this disciplinary action taken against a student was imposed as a consequence of state or local zero tolerance policies. This is optional and does not report. | O | N/A | N/A | |
| disciplines | An unordered collection of disciplineActionDisciplines. | N/A | N/A | ||
| Discipline Descriptor | This descriptor defines the type of action or removal from the classroom used to discipline the student involved as a perpetrator in a discipline incident.
See the Discipline Descriptor table in the Type/Descriptor section below. | O | N/A | Behavior > Behavior Management > Resolution Details > Resolution Type | |
| disciplineIncidents | An unordered collection of disciplineActionDisciplineIncidents.
| O | N/A | N/A | |
| staffs | An unordered collection of disciplineActionStaffs. | O | behaviorresolution. adminPersonId | Behavior Resolution> Behavior Admin Staff Name | |
Reports the reference for the Staff assigned to the Behavior Admin Staff Name
| |||||
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Discipline Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Expulsion | Expulsion | Expulsion |
| Removal from Classroom | Removal from Classroom | Removal from Classroom |
| Community Service | Community Service | Community Service |
| Expulsion with Services | Expulsion with Services | Expulsion with Services |
| Out of School Suspension | Out of School Suspension | Out of School Suspension |
| In School Suspension | In School Suspension | In School Suspension |
| Other | Other | Other |
Discipline Incident
This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery).
A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | Reports a behavior incident when the incident's Status is marked and saved as "Complete."
|
| Put | When a change is found to the following fields:
|
| Delete/Post | When data that is part of the Natural Key is changed.
|
| Delete/Post | When the Incident's status is changed.
|
| Delete | When an incident is deleted. |
| Delete | When the associated student enrollment is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Discipline records will only send to the school year that the incident date is aligned to based on the School Year Start and End dates.
|
| Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Discipline Incident resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| schoolReference | Reports data from the SchoolID field that is part of the natural key for the Schools resource. The following elements are reported:
| M | School.entityID | System Administration > Resources > School > Entity ID | |
| staffReference | A reference to the related Staff resource. | O | behaviorincident.referralPersonID | Behavior> Behavior Management> Submitted by | |
Reports the Natural Key from the Staff Resource when there is a person selected in the Submitted By field
| O | ||||
| incidentIdentifier | The locally assigned unique identifier (within the school or school district) to identify each specific incident or occurrence. The same identifier should be used to document the entire incident even if it included multiple offenses and multiple offenders. | M | BehaviorIncident. incidentID | Behavior > Behavior Management > Incident ID | |
| incidentDate | The month, day, and year on which the incident occurred. | M | BehaviorIncident. timestamp | Behavior > Behavior Management > Date of Incident | |
| incidentTime | An indication of the time of day the incident took place. This is optional and does not report. | O | N/A | N/A | |
| incidentLocationType | Identifies where the incident occurred and whether or not it occurred on campus. Logic reports the Ed-Fi code mapped to the selection in the Location field on the Incident. | O | BehaviorIncident. location | Behavior Management > Location | |
| reporterDescription Descriptor | Information on the type of individual who reported the incident. | O | behaviorincident.referralPersonID | Behavior> Behavior Managment> Submitted by | |
| |||||
| reporterName | Identifies the reporter of the incident by name. | O | N/A | N/A | |
| |||||
| reportedTo LawEnforcement | Indicator of whether the incident was reported to law enforcement. This is optional and does not report. | O | N/A | N/A | |
| caseNumber | The case number assigned to the incident by law enforcement or other organization. This is optional and does not report. | O | N/A | N/A | |
| incidentDescription | The description for an incident. This is optional and does not report. | O | N/A | N/A | |
| incidentCost | The value of any quantifiable monetary loss directly resulting from the incident. This is optional and does not report. | O | N/A | N/A | |
| behaviors | An unordered collection of disciplineIncidentBehaviors. This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). | O | N/A | N/A | |
| behaviorDescriptor | Report all behavior events that are associated with the incident.
| M | N/A | Behavior > Behavior Management > Event Type | |
| behaviorDetailedDescription | Report the Details entered on the Incident
| O | BehaviorIncident. description | Behavior > Behavior Management > Incident Detail Information | |
| weapons | An unordered collection of disciplineIncidentWeapons. This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). This does not report. | O | N/A | N/A | |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Behavior Descriptors:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
State Offense | State Offense | State Offense |
School Violation | School Violation | School Violation |
Other | Other | Other |
School Code of Conduct | School Code of Conduct | School Code of Conduct |
Grades
This educational entity represents an overall score or assessment tied to a course over a period of time (i.e., the grading period). Student grades are usually a compilation of marks and other scores.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a grade is posted to a Grading Task that is marked as State Reported and has an Ed-Fi Grade Type populated
|
| Put | When a grade is updated on a Grading Task that is mapped to an Ed-Fi Grade Type. |
| Delete | When a grade is deleted from a Grading Task that is mapped to an Ed-Fi Grade Type |
| Delete | When the Student School Association record is deleted for the school in which the grades are associated. |
| Delete/Insert | When any field that is part of the Natural Key is changed. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Grades will post to the scope year the course's calendar is aligned to.
|
Object Data Elements
This table describes data elements sent within the Grade resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| gradingPeriodReference | Reports the fields that are part of the Natural Key for the Grading Periods resource:
| M | N/A | N/A | |
| studentSection AssociationReference | Reports the fields that are part of the Natural Key for the Student Section Association.
When a student has more than 1 eligible Student Section Association record (for example, a course that covered 2 periods and or multiple period schedules) the grade will report on section association with the highest period schedule sequence and or period sequence. | M | N/A | N/A | |
| type | The type of grade (e.g., Exam, Final, Grading Period, Progress Report). Reports the Ed-Fi Code from the Ed-Fi Grade Type selected on the Grading Task or Standard being reported. See the Grade Type table in the Type/Descriptors section below. | M | N/A | Grading & Standards > Grading Tasks | |
| performanceBase ConversionType | The performance base conversion assessed for the student. This field is optional and will not report. | O | N/A | N/A | |
| letterGradeEarned | A final or interim (grading period) indicator of student performance in a class as submitted by the instructor. Logic will determine if the posted score is an integer or not:
| O | GradingScore.score | Grading & Standards > Score Groups & Rubrics > Score | |
| numericGradeEarned | A final or interim (grading period) indicator of student performance in a class as submitted by the instructor. Logic determines if the posted score is an integer or not:
| O | GradingScore.score | Grading & Standards > Score Groups & Rubrics > Score | |
| diagnosticStatement | A statement provided by the teacher that provides information in addition to the grade or assessment score. This field is optional and will not report. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Grade Type:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Conduct | Conduct | Conduct |
| Exam | Exam | Exam |
| Final | Final | Final |
| Grading Period | Grading Period | Grading Period |
| Mid-Term Grade | Mid-Term Grade | Mid-Term Grade |
| Progress Report | Progress Report | Progress Report |
| Semester | Semester | Semester |
Grading Periods
This entity represents the time span for which grades are reported. Quarter, Semester, Final, etc. The Start and End dates must have a calendar event in the Calendar Dates resource before Grading Periods can send. User needs to perform a day reset prior to filling out Grading Periods tab.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new Grading Period is created and saved on the Grading Periods tab.
|
| Put | When the Grading Period End Date is updated and saved. |
| Delete | Grading Periods cannot be deleted due to the dependency of the core Ed-Fi model where it is required for Sessions to report grading periods. |
** The Grading Periods tab will not be populated until there is at least 1 Grading Task with an Ed-Fi Grade Type that is assigned to a course with at least 1 Term Mask selected.
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Reports the grading periods in the scope year to which the calendar is aligned.
|
Object Data Elements
This table describes data elements sent within the Grading Periods resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| schoolReference | Reports the Natural Key for the Schools resource the grading period is aligned to. | M | N/A | N/A |
| beginDate | The start date of the grading period. Report the start date from the Grading Period being reported:
| M | N/A | System Administration > Calendar > Calendar > Ed-Fi Grading Periods > Grading Period Start Date |
| endDate | The end date of the grading period. Report the end date from the Grading Period being reported:
| M | N/A | System Administration > Calendar > Calendar > Ed-Fi Grading Periods > Grading Period End Date |
| descriptor | The name of the grading period. See the Grading Period Descriptor table in the Type/Descriptor section below.
| M | N/A | System Administration > Calendar > Calendar > Ed-Fi Grading Periods > Grading Period Name |
| totalInstructionalDays | The total number of instructional days in the grading period.
| M | N/A | System Administration > Calendar > Calendar >Days |
| periodSequence | The sequence of the grading period. | O | term.seq | System Administration > Calendar > Terms> Seq |
| ||||
| _etag | N/A | O | N/A | N/A |
Type/Descriptors
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Grading Period Descriptors Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| End of Year | End of Year | End of Year |
| Fifth Six Weeks | Fifth Six Weeks | Fifth Six Weeks |
| First Nine Weeks | First Nine Weeks | First Nine Weeks |
| First Semester | First Semester | First Semester |
| First Six Weeks | First Six Weeks | First Six Weeks |
| First Summer Session | First Summer Session | First Summer Session |
| First Trimester | First Trimester | First Trimester |
| Fourth Nine Weeks | Fourth Nine Weeks | Fourth Nine Weeks |
| Fourth Six Weeks | Fourth Six Weeks | Fourth Six Weeks |
| Second Nine Weeks | Second Nine Weeks | Second Nine Weeks |
| Second Semester | Second Semester | Second Semester |
| Second Six Weeks | Second Six Weeks | Second Six Weeks |
| Second Summer Session | Second Summer Session | Second Summer Session |
| Second Trimester | Second Trimester | Second Trimester |
| Sixth Six Weeks | Sixth Six Weeks | Sixth Six Weeks |
| Summer Semester | Summer Semester | Summer Semester |
| Third Nine Weeks | Third Nine Weeks | Third Nine Weeks |
| Third Six Weeks | Third Six Weeks | Third Six Weeks |
| Third Summer Session | Third Summer Session | Third Summer Session |
| Third Trimester | Third Trimester | Third Trimester |
Graduation Plan
This entity is a plan outlining the required credits, credits by subject, credits by course, and other criteria required for graduation. A graduation plan may be one or more standard plans defined by an education organization and/or individual plans for some or all students.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a Career Tech Program or a Graduation Program is mapped to a Graduation Plan Descriptor in Graduation Plan Preferences.
|
| Put | If the sum of the total number of required credits changes on a reported Graduation program. |
| Delete | Graduation Plans will not delete due to the association across multiple cohort years. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Records will report for each year the Career Tech Program or a Graduation Program is active.
|
Object Data Elements
This table describes data elements sent within the Graduation Plan resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrganization Reference | A reference to the related Education Organization resource. Reports the District Number. | M | N/A | N/A | |
| graduationSchool YearTypeReference | A reference to the related SchoolYearType resource. Reports the End Year in the School Year being reported based on the Cohort years the Graduation Plan covers. | M | N/A | N/A | |
| typeDescriptor | This descriptor defines the set of graduation plan types.
See the Graduation Plan Type table in the Type/Descriptors section below. | M | Program. edfiPlanType | Program Admin > Programs > Graduation Programs > Graduation Program Detail or Career Tech Programs | |
| individualPlan | An indicator of whether the GraduationPlan is tailored for an individual. This field is optional and does not report. | O | N/A | N/A | |
| totalRequiredCredits | The total number of credits required for graduation under this plan.
| M | N/A | Calculated value from the CreditRequirement table | |
| totalRequiredCreditType | The type of credits or units of value awarded for the completion of a course. This field is optional and does not report. | O | N/A | N/A | |
| totalRequired CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This field is optional and does not report. | O | N/A | N/A | |
| creditsByCourses | An unordered collection of graduation Plan Credits By Courses. The total credits required for graduation by taking a specific course, or by taking one or more from a set of courses. This field is optional and does not report. | O | N/A | N/A | |
| creditsBySubjects | An unordered collection of graduation Plan Credits By Subjects. The total number of credits required in a subject to graduate. Only those courses identified as a high school course requirement are eligible to meet subject credit requirements. This field is optional and does not report. | O | N/A | N/A | |
| requiredAssessments | An unordered collection of graduation Plan Required Assessments. The total credits required for graduation by taking a specific course, or by taking one or more from a set of courses. This field is optional and does not report. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Graduation Plan Type Descriptors:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Career and Technical Education | Career and Technical Education | Career and Technical Education |
| Distinguished | Distinguished | Distinguished |
| Minimum | Minimum | Minimum |
| Recommended | Recommended | Recommended |
| Standard | Standard | Standard |
Locations
This entity represents the physical space where students gather for a particular class/section. The location may be an indoor or outdoor area designated for the purpose of meeting the educational needs of students.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new Room is created and saved. |
| Post | When a Room is added to a section that does not already exist in Ed-Fi. |
| Post | When a Room Name is changed and saved. |
| Put | When the Maximum Number Of Seats is modified. |
| Delete | When a Room Name is changed and saved. |
| Delete | When a Room is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Rooms are not aligned to a year so all Rooms will send to each scoped year. |
| Data will only send for the years that have valid configuration. |
| A resync must be completed on the Locations resource when a new scope year is connected in order for this data to send. |
Object Data Elements
This table describes data elements sent within the Locations resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| schoolReference | Reports the following elements that are part of the Natural Key for the Schools resource:
| M | School.entityID | System Administration > Resources > School > EntityID |
| classroom IdentificationCode | A unique number or alphanumeric code assigned to a room by a school, school system, state, or other agency or entity. | M | Room.name | System Administration > Resources > Resources > Rooms > Name |
| maximumNumber OfSeats | The maximum number of seats the class can maintain. The value in the Capacity field is reported. If blank, do not report. | O | Room.capacity | System Administration > Resources > Resources > Capacity |
| optimalNumber OfSeats | The number of seats that is most favorable to the class. This field is not collected or reported. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. This field is optional and does not report. | O | N/A | N/A |
Parents
This entity represents a parent or guardian of a student, such as mother, father or caretaker.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When the Guardian checkbox is marked AND 1 person is a student and 1 person is not a student.
|
| Put | A record will be updated when any of the following are changed and saved:
|
| Delete | A Parent record is a shared resource among all districts in the state and cannot be deleted. When the Student Parent Association is removed, the district will no longer have authorization to see the parent record. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A parent record will report when they are a guardian to a student with an enrollment aligned to a scoped year.
|
When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.
|
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) to report the data to.
|
Object Data Elements
This table describes data elements sent within the Parents resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |||||
|---|---|---|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | ||||
| parentUniqueId | A parent's Ed-Fi ID is reported. | M | Person.edFiId | Census > People > Demographics > EdFi ID | ||||
| personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This element is not collected or reported. | C | N/A | N/A | ||||
| firstName | The reporting parent's first name. This is reported from the person's most recent identity record. | M | Identity.firstName | Census > People > Identities > First Name | ||||
| middleName | The reporting parent's middle name. This is reported from the person's most recent identity record. | C | Identity.middleName | Census > People > Identities > Middle Name | ||||
| lastSurname | The reporting parent's last name. This is reported from the person's most recent identity record. | M | Identity.lastName | Census > People > Identities > Last Name | ||||
| generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). This is reported from the person's most recent identity record. | C | Identity.suffix | Census > People > Identities > Suffix | ||||
| maidenName | The person's maiden name, if applicable. This element is not collected or reported. | O | N/A | N/A | ||||
| sexType | A person's gender. This element is not collected or reported. | O | N/A | N/A | ||||
| loginId | The login ID for the user; used for security access control interface. This element is not collected or reported. | M | N/A | N/A | ||||
| addresses | Report the person's address(s). Reports the Primary address that is marked as "Mailing."
| O | Household Addresses > Mailing Household Membership > Start Date Household Addresses > Start Date | |||||
| addressType | The type of home address. See the Address Type table in the Type/Description section below. | M | ||||||
| streetNumberName | The street number and street name or post office box number of an address.
| M | Address.postOfficeBox Address.number Address.street Address.tag Address.prefix Address.dir | Households > Address Info | ||||
| apartmentRoom SuiteNumber | The apartment, room, or suite number of an address. | O | Address.apt | Households > Address Info > Apt | ||||
| buildingSiteNumber | The number of the building on the site, if more than one building shares the same address. This is optional and does not report. | O | N/A | N/A | ||||
| city | The name of the city in which an address is located. | M | Address.city | Households > Address Info > City | ||||
| stateAbbreviation Type | The abbreviation for the state (within the United States) or outlying area in which an address is located. | M | Address.state | Households > Address Info > State | ||||
| postalCode | The five or nine digit zip code portion of an address. | M | Address.zip | Households > Address Info > Zip Code | ||||
| nameOfCounty | The name of the county, parish, borough, or comparable unit (within a state) in which an address is located. Reports the County for the addressing being reported. | O | address.county | Households> Address Info> County | ||||
| countyFIPSCode | 5 digit code consisting of the two digit state code followed by the three digit FIPS code for the county. This is optional and does not report. | O | N/A | N/A | ||||
| latitude | The geographic latitude of the physical address. This is optional and does not report. | O | N/A | N/A | ||||
| longitude | The geographic longitude of the physical address. This is optional and does not report. | O | N/A | N/A | ||||
| beginDate | The first date the address is valid. For physical addresses, the date the person moved to that address. This is optional and does not report. | O | N/A | N/A | ||||
| endDate | The last date the address is valid. For physical addresses, this would be the date the person moved from that address. This is optional and does not report. | O | N/A | N/A | ||||
| electronicMails | An unordered collection of parentElectronicMails. This entity represents a parent or guardian of a student, such as mother, father or caretaker.
| O | Contact.email | Census > People > Demographics > Email | ||||
| electronicMailType | Reports the mail type. See the Electronic Mail Type table in the Type/Description section below. | M | N/A | N/A | ||||
| electronic MailAddress | The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. | M | Contact.email | Census > People > Demographics > Email | ||||
| primaryEmail AddressIndicator | An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization. | O | N/A | N/A | ||||
| identification Documents | Reports an unordered collection of the parent's identification documents. This element is not collected or reported.. | O | N/A | N/A | ||||
| international Addresses | Reports an unordered collection of the parent's international addresses. This element is not collected or reported. | O | N/A | N/A | ||||
| otherNames | Reports an unordered collection of the parent's other known names (aliases). This field is optional and does not report. | O | N/A | N/A | ||||
| telephones | An unordered collection of parentTelephones. This entity represents a parent or guardian of a student, such as mother, father or caretaker.
| O | Contact.homephone Contact.workphone Contact.cellphone Contact.pager | Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager | ||||
| telephone NumberType | Reports the number type. See the Telephone Number Type table in the Type/Description section below. | M | N/A | N/A | ||||
| orderOfPriority | The order of priority assigned to telephone numbers to define which number to attempt first, second, etc. This field is optional and does not report. | O | N/A | N/A | ||||
| telephoneNumber | The 10-digit telephone number, including the area code, for the person. | M | Contact.homephone Contact.workphone Contact.cellphone Contact.pager | Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager | ||||
| textMessage CapabilityIndicator | An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages. This field is optional and does not report. | O | N/A | N/A | ||||
| etag | A unique system-generated value that identifies the version of the resource. This field is optional and does not report. | O | N/A | N/A | ||||
Type/Descriptor Layout
This table describes the Ed-Fi Value mapped and reported for Telephone Number Types.
| Campus Value | Ed-Fi Type | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|---|---|
| Other Phone | 1 | Home | Home | Home |
| Does not report, not collected in Campus | 2 | Fax | Fax | Fax |
| Cell Phone | 3 | Mobile | Mobile | Mobile |
| Does not report, not collected in Campus | 4 | Unlisted | Unlisted | Unlisted |
| Work Phone | 5 | Work | Work | Work |
| Pager | 6 | Other | Other | Other |
| Does not report, not collected in Campus | 7 | Emergency 1 | Emergency 1 | Emergency 1 |
| Does not report, not collected in Campus | 8 | Emergency 2 | Emergency 2 | Emergency 2 |
This table describes the Ed-Fi Value mapped and reported for Electronic Mail Types.
| Campus Value | Ed-Fi Type ID | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|---|---|
| Primary email reports as "Home/Personal" | 1 | Home/Personal | Home | Home |
| Primary email reports as "Home/Personal" | 2 | Organization | Organization | Organization |
| Primary email reports as "Home/Personal" | 3 | Other | Other | Other |
| Secondary email reports as "Work" | 4 | Work | Work | Work |
This table describes the Ed-Fi Value mapped and reported for Address Types.
| Campus Value | Ed-Fi Type ID | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|---|---|
| All address report as "Home" | 1 | Home | Home | Home |
| 2 | Physical | Physical | Physical | |
| 3 | Mailing | Mailing | Mailing | |
| 4 | Other | Other | Other | |
| 5 | Work | Work | Work | |
| 6 | Billing | Billing | Billing | |
| 7 | Temporary | Temporary | Temporary | |
| 8 | Father Address | Father Address | Father Address | |
| 9 | Guardian Address | Guardian Address | Guardian Address | |
| 10 | Mother Address | Mother Address | Mother Address | |
| 11 | Shipping | Shipping | Shipping | |
| 12 | Shelters | Shelters, Transitional housing, Awaiting Foster Care | Shelters, Transitional housing, Awaiting Foster Care | |
| 13 | Doubled | Doubled - up (i.e., living with another family) | Doubled - up (i.e., living with another family) | |
| 14 | Unsheltered | Unsheltered (e.g. cars, parks, campgrounds, temp trailers including FEMA trailers, or abandoned buildings) | Unsheltered (e.g. cars, parks, campgrounds, temp trailers including FEMA trailers, or abandoned buildings) | |
| 15 | HotelMotel | Hotels/Motels | Hotels/Motels |
Programs
This entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Logic | |
|---|---|
| Post | When a student has a EL Program Status = EL and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
Do not report if the student's Enrollment has any of the following indicated:
| |
| Post | When Flag is created and the 'Name' matches an Ed-FI Program Type and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
| Do not create a English as a Second Language (ESL) or Special Education program from Flags, these will come from EL Programs and Locked IEPs | |
| Post | When a student has a locked IEP and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
| **All students will reference the same programs once the first one is created | |
| Post | When a student has a Title 1 record that overlaps the configured year |
| Put | N/A |
| Delete | Delete if all Flags are deleted with the matching Name |
| Delete | Delete if all qualifying IEPs are unlocked or deleted |
| Delete | If all qualifying EL records are deleted |
Object Data Elements
This table describes data elements sent within the Programs resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrgranization Reference | A reference to the related Education Organization resource. This sends the State District Number associated with the school. If the State District Number is changed, a resync on the school needs to be performed. | O | District.stateDistrict Number | System Administration > Resources > District Information > State District Number | |
| type | Reports the type of program.
| M | lep.programstatus OR program.name | Student Information> Program Participation> English Learners Or Program Admin> Flags> Name Or Special Education> IEP Or Student Information> Program Participation> Title I | |
| name | The formal name of the program of instruction, training, services or benefits available through the federal,state or local agencies
| M | lep.programstatus OR program.name or title1.title1Program | Student Information> Program Participation> English Learners Or Program Admin> Flags> Name Or Special Education> IEP Or Title I > Title I Program | |
| programID | A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity.
| O | program.programId | Program Admin> Flags | |
| sponsorType | Key for ProgramSponsor. This field does not report. | O | N/A | N/A | |
| beginDate | This field does not report. | O | N/A | N/A | |
| characteristics | An unordered collection of programCharacteristics. Reflects important characteristics of the Program, such as categories or particular indications. This field does not report. | O | N/A | N/A | |
| learningObjectives | An unordered collection of programLearningObjectives. Learning Standard followed by this program. This field does not report. | O | N/A | N/A | |
| learningStandards | An unordered collection of programLearningStandards. References the Learning Objective(s) the Program is associated with. This field does not report. | O | N/A | N/A | |
| services | An unordered collection of programServices. Defines the services this program provides to students. This field does not report. | O | N/A | N/A | |
Type/Descriptors
The highlighted column indicates the reported value.
This table describes the Program Type.
Ed-Fi Code value | Short Description | Description |
|---|---|---|
Adult/Continuing Education | Adult/Continuing Education | Adult/Continuing Education |
| Alternative Education | Alternative Education | Alternative Education |
| Athletics | Athletics | Athletics |
| Bilingual | Bilingual | Bilingual |
| Bilingual Summer | Bilingual Summer | Bilingual Summer |
| Career and Technical Education | Career and Technical Education | Career and Technical Education |
| Cocurricular Programs | Cocurricular Programs | Cocurricular Programs |
| College Preparatory | College Preparatory | College Preparatory |
| Community Service Program | Community Service Program | Community Service Program |
| Community/Junior College Education Program | Community/Junior College Education Program | Community/Junior College Education Program |
| Compensatory Services for Disadvantaged Students | Compensatory Services for Disadvantaged Students | Compensatory Services for Disadvantaged Students |
| Counseling Services | Counseling Services | Counseling Services |
| District-Funded GED | District-Funded GED | District-Funded GED |
| Early Head Start | Early Head Start | Early Head Start |
| Early Intervention Services Part C | Early Intervention Services Part C | Early Intervention Services Part C |
| English as a Second Language (ESL) | English as a Second Language (ESL) | English as a Second Language (ESL) |
| Even Start | Even Start | Even Start |
| Expelled Education | Expelled Education | Expelled Education |
| Extended Day/Child Care Services | Extended Day/Child Care Services | Extended Day/Child Care Services |
| Fee For Service | Fee For Service | Fee For Service |
| Foreign Exchange | Foreign Exchange | Foreign Exchange |
| Gifted and Talented | Gifted and Talented | Gifted and Talented |
| Head Start | Head Start | Head Start |
| Health Services Program | Health Services Program | Health Services Program |
| High School Equivalency Program (HSEP) | High School Equivalency Program (HSEP) | High School Equivalency Program (HSEP) |
| Home Visiting | Home Visiting | Home Visiting |
| IDEA | IDEA | IDEA |
| Immigrant Education | Immigrant Education | Immigrant Education |
| Independent Study | Independent Study | Independent Study |
| Indian Education | Indian Education | Indian Education |
| International Baccalaureate | International Baccalaureate | International Baccalaureate |
| Kindergarten - Extended Day | Kindergarten - Extended Day | Kindergarten - Extended Day |
| Kindergarten - Full Day | Kindergarten - Full Day | Kindergarten - Full Day |
| Kindergarten - Half Day | Kindergarten - Half Day | Kindergarten - Half Day |
| Library/Media Services Program | Library/Media Services Program | Library/Media Services Program |
| Magnet/Special Program Emphasis | Magnet/Special Program Emphasis | Magnet/Special Program Emphasis |
| Migrant Education | Migrant Education | Migrant Education |
| Neglected and Delinquent Program | Neglected and Delinquent Program | Neglected and Delinquent Program |
| Optional Flexible School Day Program (OFSDP) | Optional Flexible School Day Program (OFSDP) | Optional Flexible School Day Program (OFSDP) |
| Other | Other | Other |
| Prekindergarten - Extended Day | Prekindergarten - Extended Day | Prekindergarten - Extended Day |
| Prekindergarten - Full Day | Prekindergarten - Full Day | Prekindergarten - Full Day |
| Prekindergarten - Half Day | Prekindergarten - Half Day | Prekindergarten - Half Day |
| Preschool Special Education | Preschool Special Education | Preschool Special Education |
| Public Preschool | Public Preschool | Public Preschool |
| Regular Education | Regular Education | Regular Education |
| Remedial Education | Remedial Education | Remedial Education |
| Section 504 Placement | Section 504 Placement | Section 504 Placement |
| Service Learning | Service Learning | Service Learning |
| Special Education | Special Education | Special Education |
| Student Retention/Dropout Prevention | Student Retention/Dropout Prevention | Student Retention/Dropout Prevention |
| Substance Abuse Education/Prevention | Substance Abuse Education/Prevention | Substance Abuse Education/Prevention |
| Teacher Professional Development/Mentoring | Teacher Professional Development/Mentoring | Teacher Professional Development/Mentoring |
| Technical Preparatory | Technical Preparatory | Technical Preparatory |
| Title I Part A | Title I Part A | Title I Part A |
| Title I Part D Subpart 1 | Title I Part D Subpart 1 | Title I Part D Subpart 1 |
| Title I Part D Subpart 2 | Title I Part D Subpart 2 | Title I Part D Subpart 2 |
| Vocational Education | Vocational Education | Vocational Education |
Schools
This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.
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 State School Number changes.
|
| Put | When any of the fields not part of the Natural Key change:
|
| Delete | A delete is not sent. |
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. |
| Data only sends for the years that have 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. |
Object Data Elements
This table describes data elements sent within the Schools resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| localEducation AgencyReference | A reference to the related Local Education Agency resource. This sends the State District Number associated with the school. If the State District Number is changed, a resync on the school needs to be performed. | O | N/A | N/A | |
| schoolId | Indicates the State School Number | M | Schoolnumber | System Administration > Resources > School > State School Number | |
| stateOrganizationId | The identifier assigned to an education agency byt the State Education Agency. This is also known as State LEP ID. NEDML Identification Code, LEA Identifier. Reports the State School Number. | M | School.stateNumber | System Administration > Resources > School > State School Number | |
| nameOfInstitution | The full, legally accepted anme of the institution. NEDM: Name of Institution. Reports the school name. | M | School.name | System Administration > Resources > School > Name | |
| shortNameOfInstitution | This field does not report. | O | N/A | N/A | |
| webSite | This field does not report. | O | N/A | N/A | |
| operationalStatus Type | This field does not report. | O | N/A | N/A | |
| type | Report the type of school from the mapped value in school type if populated on the reporting school | O | school.type | System Administration> Resources> School> School Type | |
| charterStatusType | This field does not report. | O | N/A | N/A | |
| titleIPartASchool DesignationType | This field does not report. | O | N/A | N/A | |
| magnetSpecialProgram EmphasisSchoolType | This field does not report. | O | N/A | N/A | |
| administrativeFunding ControlDescriptor | This field does not report. | O | N/A | N/A | |
| internetAccessType | This field does not report. | O | N/A | N/A | |
| addresses | An unordered collection of educationOrganizationAddresses. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. Reports the Physical Address for the school. If blank, does not report. This element is an array that reports the following data: | O | |||
| addressType | All addresses will report as 'Physical'. This will report the Ed-Fi mapped value in the Address Type table in the section below. | M | N/A | N/A | |
| streetNumberName | The street number and street name or post office box number of an address. Reports the Address PO Box + Number + Street + Tag + Prefix + Dir | M | System Administration> Resources> School Information | ||
| apartmentRoom SuiteNumber | The apartment, room, or suite number of an address. This field does not report. | O | N/A | N/A | |
| buildingSiteNumber | The number of the building on the site, if more than one building shares the same address. This field does not report. | O | N/A | N/A | |
| city | The name of the city in which an address is located. | M | school.physicalcity | System Administration> Resources> School Information | |
| stateAbbreviationType | The abbreviation for the state (within the US) or outlying area in which an address is located. | M | school.physicalstate | System Administration> Resources> School Information | |
| postalCode | The five or nine digit zip code portion of an address. | M | school.physicalzip | System Administration> Resources> School Information | |
| nameOfCounty | The name of the county, parish, borough, or comparable unit (within a state) in which an address is located. This field does not report. | O | N/A | N/A | |
| countyFIPS | 5-digit code consisting of the two digit state code followed by the three digit FIPS code for the county. This field does not report. | O | N/A | N/A | |
| latitude | The geographic latitude of the physical address. This field does not report. | O | N/A | N/A | |
| longitude | The geographic longitude of the physical address This field does not report. | O | N/A | N/A | |
| beginDate | The first date the address is valid. For physical addresses, the date the person moved to that address This field does not report. | O | N/A | N/A | |
| endDate | The last date the address is valid. For physical addresses, this would be the date the person moved from that address. This field does not report. | O | N/A | N/A | |
| educationOrganization Categories | An unordered collection of educationOrganizationCategories. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. This element is an array that reports the following data: | O | N/A | N/A | |
| type | 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. Always reports 'School.' | M | N/A | N/A | |
| identificationCodes | An unordered collection of educationOrganizationIdentificationCodes. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups.
| O | school.entityID or school.number | System Administration> Resources> School | |
| institutionTelephones | An unordered collection of educationOrganizationInstitutionTelephones. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. Reports the Phone Number for the school. If blank, does not report. This element is an array that reports the following data: | O | N/A | N/A | |
| institutionTelephone NumberType | Type of phone number. Always reports 'Main.' | ||||
| telephoneNumber | The telephone number including the area code, and extension, if applicable. Reports the phone number entered. If blank, does not report. | School.phoneNumber | System Administration > Resources > School Information | ||
| internationalAddresses | An unordered collection of educationOrganizationInternationalAddresses. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. This field does not report. | O | N/A | N/A | |
| schoolCategories | An unordered collection of schoolCategories. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. | O | schools.gradeType | System Administration> Resources> Schools> Grade Type | |
| |||||
| gradeLevels | An unordered collection of schoolGradeLevels. This entity represents an educational organization that includes staff and students who participate in classes and educational activity groups. Reports the Ed-Fi Code Value from all state grade levels. This element is an array that reports the following data: | O | N/A | N/A | |
| gradeLevelDescriptor | The grade levels served at the school. Reports the Ed-Fi code from the State Grade Level Code for all grades in all Calendars/Schedule Structures associated with the reporting School and Year. Calendar End Year must equal the scoped end year.
See the Type/Descriptors below. | O | calendar.gradeLevel | System Administration > Calendar > Calendar > Grade Levels | |
| etag | N/A | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Institution Telephone Number Type.
| Ed-Fi Code Value | Short Description | Description |
|---|---|---|
| Main | Main | Main |
| Administrative | Administrative | Administrative |
| Health Clinic | Health Clinic | Health Clinic |
| Attendance | Attendance | Attendance |
| Other | Other | Other |
| Fax | Fax | Fax |
| Food Service | Food Service | Food Service |
This table describes the Education Organization Category Type.
| Ed-Fi Code Value | Short Description | Description |
|---|---|---|
| Education Service Center | Education Service Center | Education Service Center |
| Local Education Agency | Local Education Agency | Local Education Agency |
| School | School | School |
| State Education Agency | State Education Agency | State Education Agency |
| Education Organization Network | Education Organization Network | Education Organization Network |
| Other | Other | Other |
| Code Value | Short Description | Description |
|---|---|---|
| All Levels | All Levels | All Levels |
| Adult School | Adult School | Adult School |
| Elementary/Secondary School | Elementary/Secondary School | Elementary/Secondary School |
| Elementary School | Elementary School | Elementary School |
| High School | High School | High School |
| Infant/toddler School | Infant/toddler School | Infant/toddler School |
| Intermediate School | Intermediate School | Intermediate School |
| Junior High School | Junior High School | Junior High School |
| Middle School | Middle School | Middle School |
| Preschool/early childhood | Preschool/early childhood | Preschool/early childhood |
| Primary School | Primary School | Primary School |
| SecondarySchool | SecondarySchool | SecondarySchool |
| Ungraded | Ungraded | Ungraded |
| Other Secondary | Other Secondary | Other Secondary |
| Other Combination | Other Combination | Other Combination |
This table describes the Ed-Fi Value mapped and reported for Grade Levels Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Infant/toddler | Infant/toddler | Infant/toddler |
| Early Education | Early Education | Early Education |
| Preschool/Prekindergarten | Preschool/Prekindergarten | Preschool/Prekindergarten |
| First grade | First grade | First grade |
| Second grade | Second grade | Second grade |
| Third grade | Third Grade | Third Grade |
| Fourth grade | Fourth Grade | Fourth Grade |
| Fifth grade | Fifth Grade | Fifth Grade |
| Sixth grade | Sixth Grade | Sixth Grade |
| Seventh grade | Seventh Grade | Seventh Grade |
| Eighth grade | Eighth Grade | Eighth Grade |
| Ninth grade | Ninth Grade | Ninth Grade |
| Tenth grade | Tenth Grade | Tenth Grade |
| Eleventh grade | Eleventh Grade | Eleventh Grade |
| Twelfth grade | Twelfth Grade | Twelfth Grade |
| Grade 13 | Grade 13 | Grade 13 |
| Postsecondary | Postsecondary | Postsecondary |
| Adult Education | Adult Education | Adult Education |
| Ungraded | Ungraded | Ungraded |
| Other | Other | Other |
Section
This educational entity represents a setting in which organized instruction of course content is provided to one or more students for a given period of time. A course may be offered to more than one class/section. Instruction, provided by one or more teachers or other staff members, may be delivered in person or via a different medium.
This entity reports per section per term type combination.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a section is created and saved.
|
| Post | When a section schedule placement is changed and saved. |
| Post | When the Local Course Number or Term type Override is changed. |
| Put | When any fields listed below are changed:
|
| Delete | When a section is deleted. |
| Delete | When Section Placement is changed or removed and saved on a section. |
| Delete | When the Local Course Number or Term type Override is changed. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports Sections in the scope year the course's calendar is aligned to. |
| Data will only send for the years that have valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Section resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| classPeriod Reference | Reports the following elements that are part of the Natural Key for the Class Periods:
| M | N/A | N/A | |
| courseOffering Reference | Reports the following elements that are part of the Natural Key for the Course Offering:
| M | N/A | N/A | |
| locationReference | Reports the following elements that are part of the Natural Key for the Locations resource:
| M | N/A | N/A | |
| schoolReference | Reports the following elements that are part of the Natural Key for the Schools resource:
| M | N/A | N/A | |
| uniqueSectionCode | A unique identifier for the section, that is defined for a campus by the classroom, the subjects taught, and the instructors that are assigned. This element reports the section ID of the section being reported. | M | N/A | N/A | |
| sequenceOfCourse | When a section is part of a sequence of parts for a course, the number if the sequence. If the course has only onle part, the value of this section attribute should be 1.
| M | N/A | N/A | |
| educational EnvironmentType | The setting in which a child receives education and related services. For example, Center-based instruction Home-based instruction, Hospital class, Mainstream Residential care, treatment facility.
| O | section.instructionalSetting | Course > Section > Instructional Setting | |
| mediumOf InstructionType | The media through which teachers provide instruction to students and students and teachers communicate about instructional matters | O | N/A | N/A | |
| populationServed Type | The population for which the course was designed. This element is optional and does not report. | O | N/A | N/A | |
| availableCredit Type | The type of credits or units of value awarded for the completion of a course. This element is optional and does not report. | O | N/A | N/A | |
| availableCredit Conversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This element is optional and does not report. | O | N/A | N/A | |
| instructionLanguage Descriptor | This element is optional and does not report. | O | N/A | N/A | |
| availableCredit | Credits or units of value awarded for the completion of a course. Logic calculates this as follows:
| O | GradingTaskCredit. Credit | Scheduling > Courses > Course > Grading Tasks > Credit | |
| characteristics | This descriptor defines characteristics of a section, such as whether attendance is taken and the section is graded.
| O | GradingTaskCredit. Credit | Scheduling > Course > Attendance/Positive Attendance Scheduling > Course > Grading Tasks | |
| sectionCharacteristic Descriptor | Defines the characteristics of a section, such as whether attendance is taken and the section is graded. See the Type/Description Layout for more information. | O | N/A | N/A | |
| programs | An unordered collection of sectionPrograms. This educational entity represents a setting in which organized instruction of course content is provided to one or more students for a given period of time. | O | N/A | N/A | |
| etag | A unique system-generated value that identifies the version of the resource. This element is optional and does not report. | O | N/A | N/A | |
Type/Descriptor Layout
This table describes the Ed-Fi Value mapped and reported for Section Characteristic Descriptors.
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Attendance Tracked | Attendance Tracked | Attendance Tracked |
| Graded Credit Available | Graded Credit | Graded Credit Available |
This table describes the Ed-Fi Value mapped and reported for Educational Environment Types.
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Classroom | Classroom | Classroom |
| Homebound | Homebound | Homebound |
| Hospital class | Hospital class | Hospital class |
| In-school suspension | In-school suspension | In-school suspension |
| Laboratory | Laboratory | Laboratory |
| Mainstream (Special Education) | Mainstream (Special Education) | Mainstream (Special Education) |
| Off-school center | Off-school center | Off-school center |
| Pull-out class | Pull-out class | Pull-out class |
| Resource room | Resource room | Resource room |
| Single sex classroom | Single sex classroom | Single sex classroom |
| Self-contained (Special Education) | Self-contained (Special Education) | Self-contained (Special Education) |
| Self-study | Self-study | Self-study |
| Shop | Shop | Shop |
This table describes the Ed-Fi Value mapped and reported for Section Characteristic Descriptors.
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Attendance Tracked | Attendance Tracked | Attendance Tracked |
| Graded Credit Available | Graded Credit | Graded Credit Available |
This table describes the Ed-Fi Value mapped and reported for Educational Environment Types.
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Classroom | Classroom | Classroom |
| Homebound | Homebound | Homebound |
| Hospital class | Hospital class | Hospital class |
| In-school suspension | In-school suspension | In-school suspension |
| Laboratory | Laboratory | Laboratory |
| Mainstream (Special Education) | Mainstream (Special Education) | Mainstream (Special Education) |
| Off-school center | Off-school center | Off-school center |
| Pull-out class | Pull-out class | Pull-out class |
| Resource room | Resource room | Resource room |
| Single sex classroom | Single sex classroom | Single sex classroom |
| Self-contained (Special Education) | Self-contained (Special Education) | Self-contained (Special Education) |
| Self-study | Self-study | Self-study |
| Shop | Shop | Shop |
Sessions
This entity represents the prescribed span of time when an education institution is open, instruction is provided and students are under the direction and guidance of teachers and/or education institution administration. A session may be interrupted by one or more vacations.
In order to report properly, the Ed-Fi Term Type field needs to be populated on the Calendar Term Detail editor. This ties the Course Section to the Term. If the Course Section needs to use a different term type, the Ed-Fi Term Type Override field needs to be populated on the Course Section Editor.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Data will not report for calendars, schools, and courses marked as Exclude.
| Action | Trigger |
|---|---|
| Post | When a new Term is created and saved that is Mapped to a Term Type and a resync of Sessions is completed.
|
| Post | When a Term Descriptor Override is selected on a Course or Section and saved and the course is mapped to a Term Descriptor Override and a resync of Sessions is completed.
Start and End dates are not part of the natural Key so only 1 record per Term Type can be sent to Ed-Fi. Logic has been implemented to determine the priority of what start and end dates to use for a Term Type. |
| Put | When the Grading Period, Term Name, start or end dates are changed and saved. |
| Delete | Terms are never deleted; they are only used as a reference. They remain if a Term Schedule is deleted or Term Types are changed. Start and End dates are not part of the natural Key so only 1 record per Term Type can be sent to Ed-Fi. Logic has been implemented to determine the priority of what start and end dates to use for a Term Type. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| . Reports Sessions for the scope year to which the calendar is aligned. |
| Data will only send for the years that have valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Sessions resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |||||
|---|---|---|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | ||||
| schoolReference | Reports the following elements that are part of the Natural Key for the School resource | M | N/A | N/A | ||||
| schoolYearTypeReference | A reference to the related SchoolYearType resource. This element reports the End year from the calendar term reported. | M | N/A | N/A | ||||
| name | The identifier for the calendar for the academic session. | M | Term.edfiTypeName | System Administration > Calendar > Calendar > Terms > Term Type Name | ||||
| termDescriptor | This descriptor defines the term of a session during the school year (e.g., Fall Semester). See the Term Descriptor mapping in the Type/Descriptor section below.
| O | Term.edFiTermType Course.edFiTermType Section.edFiTermType | System Administration > Calendar > Calendar > Terms > Term Type OR Scheduling > Courses/Sections | ||||
| beginDate | The term start date. This element reports the start date of the term being reported.
| M | Term.startDate | System Administration > Calendar > Calendar > Terms > Start Date | ||||
| endDate | The term end date. This element reports the end date of the term being reported.
| M | Term.endDate | System Administration > Calendar > Calendar > Terms > End Date | ||||
| totalInstructionalDays | This element reports the total number of instructional days from the Days tab from the calendar and schedule structure the term is associated with.
A day reset must be completed before the days will calculate. Use the resync function of Ed-Fi Tools to have instructional days calculated and sent. | M | N/A | N/A | ||||
| academicWeeks | An unordered collection of sessionAcademicWeeks. | O | N/A | N/A | ||||
| gradingPeriods | An unordered collection of sessionGradingPeriods. | O | N/A | N/A | ||||
| gradingPeriodReference | Report a record for each Grading Period reported in the Grading Periods Resource that occurs in the session being reported. When reporting from Term Type Override, reference all grading periods that are associated with any course or section with the same Term Type Override
If there is not a Grading Period association with the Session, the array will be NULL and the Session record will error | M | N/A | N/A | ||||
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | ||||
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Term Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Fall Semester | Fall Semester | Fall Semester |
| Spring Semester | Spring Semester | Spring Semester |
| Summer Semester | Summer Semester | Summer Semester |
| First Trimester | First Trimester | First Trimester |
| Second Trimester | Second Trimester | Second Trimester |
| Third Trimester | Third Trimester | Third Trimester |
| Full Year | Full Year | Full Year |
| MiniTerm | MiniTerm | MiniTerm |
| First Quarter | First Quarter | First Quarter |
| Second Quarter | Second Quarter | Second Quarter |
| Third Quarter | Third Quarter | Third Quarter |
| Fourth Quarter | Fourth Quarter | Fourth Quarter |
| Other | Other | Other |
Staff Cohort Associations
This association indicates the Staff associated with a cohort of students.
Object Triggering Logic
This table describes logic for triggering syncing of this object
| Action | Trigger |
|---|---|
| Post | When a Staff is assigned as "Instructor" to a Program Session that is reported as a Cohort in the Scoped Year |
| The Cohort can only be created from Program Admin> Programs> Programs tab | |
| The Staff member must have an Ed-Fi ID to report | |
| Put | The end date is updated on the Program Sessions tab |
| Delete/Post | If any part of the Natural Key changes |
| Delete | If the Program Session is deleted |
| Delete | Staff is removed from the "Instructor" field |
Object Data Elements
This table describes data elements sent within the Staff Cohort Associations resource.
Data Element Label | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
id | The unique identifier of the resource | M | ||
| cohortReference | Reports the Natural Key of the Cohort resource | M | ||
| staffreference | Reports the Natural Key of the Staff resource | M | ||
| beginDate | The month, day, and year on which the Student was first identified as part of the Cohort.
| O | programSession.startdate | Programs Admin> Programs> Program Sessions> Start Date |
| endDate | The month, day, and year on which the Student was removed as part of the Cohort.
| O | programSession.enddate | Programs Admin> Programs> Program Sessions> End Date |
| studentRecordAccess | O | |||
| etag | O | |||
Staff Education Organization Assignment Association
This association indicates the education organization to which a staff member provides services; also known as school of service.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a person has a District Employment record with the District Staff check box checked and a District Assignment Code populated. OR |
Do NOT report a record if any one of the following scenarios are true:
| |
If school staff member has more than 1 qualifying District Assignment record, a record will generate for each eligible School/Start date | |
| Put | N/A, a delete and insert occurs when any field is edited and saved. |
| Delete/Post | When the person’s employment assignment record is changed |
| Delete/Post | When the person’s employment record is changed |
| Delete/Post | When the Assignment Code, Start Date or End date is modified on the District Assignment record |
| Delete | When a District Assignment record is deleted. |
| Delete | When a District Employment record is deleted |
| Delete | When a District Employment record > District Staff is unchecked AND no district assignment exists for the staff. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A record will report when a person has a District Assignment record that is aligned to a scoped year.
|
When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.
|
Object Data Elements
This table describes data elements sent within the Staff Education Organization Agreement Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| StaffEducationOrganization EmploymentAssociationReference | Reports the data that is part of the Natural Key for the Staff Education Organization Employment Association resource:
| M | N/A | N/A |
| educationOrganizationReference | A reference to the related EducationOrganization resource.
| M | N/A | N/A |
| staffReference | Reports the data that is part of the Natural Key for the Staff resource:
| M | N/A | N/A |
| staffClassificationDescriptor | The titles of employment, official status, or rank of education staff. Report the Ed-Fi code mapped to the value selected:
| M | EmploymentAssignment. assignmentCode | Census> People> District Employment> District Assignment Code Census> People> District Assignment> Assignment Code |
| beginDate | The month, day and year of the start or effective date of a staff member's employment, contract or relationship with the LEA. This element reports the Start Date from the District Assignment being reported.
| M | EmploymentAssignment. startDate | Census > People > District Assignment > Start Date |
| positionTitle | The descriptive name of an individual's position.
| O | employment.assignmentCode employmentassignment.assignmentCode | Census> People> District Employment> District Assignment Code Census> People> District Assignment> Assignment Code |
| endDate | The month, day and year of the end or termination date of a staff member's employment, contract or relationship with the LEA.
| O | EmploymentAssignment. endDate | Census > People > District Assignment > End Date |
| orderOfAssignment | Describes whether the assignment is the staff member's primary assignment, secondary assignment. This element is optional and does not report. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Staff Classification Descriptors:
Staff Classification Descriptors
The District Assignment Code from the District Employment tab and the Assignment Code from the District Assignment tab is a shared Data Dictionary that is an unlocked list that is managed by the districts
To create a new or modify an existing Assignment Code go to System Administration> Custom> Attribute/Dictionary> Definition> Assignment Code
| Ed-Fi Code | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Assistant Principal | Assistant Principal | Assistant Principal |
| Assistant Superintendent | Assistant Superintendent | Assistant Superintendent |
| Counselor | Counselor | Counselor |
| Instructional Aide | Instructional Aide | Instructional Aide |
| Instructional Coordinator | Instructional Coordinator | Instructional Coordinator |
| LEA Administrator | LEA Administrator | LEA Administrator |
| LEA Specialist | LEA Specialist | LEA Specialist |
| LEA System Administrator | LEA System Administrator | LEA System Administrator |
| Librarians/Media Specialists | Librarians/Media Specialists | Librarians/Media Specialists |
| Operational Support | Operational Support | Operational Support |
| Other | Other | Other |
| Principal | Principal | Principal |
| School Administrator | School Administrator | School Administrator |
| School Leader | School Leader | School Leader |
| School Specialist | School Specialist | School Specialist |
| State Administrator | State Administrator | State Administrator |
| Substitute Teacher | Substitute Teacher | Substitute Teacher |
| Superintendent | Superintendent | Superintendent |
| Support Services Staff | Support Services Staff | Support Services Staff |
| Teacher | Teacher | Teacher |
Staff
This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a person has a District Employment record and the District Employment > Ed-Fi Org Title's Standard Code = 000 OR When a person has a District Assignment record and District Employment > Ed-Fi Org Title is blank or the Standard Code does not = 000 |
Do NOT report a record when the following scenario is true:
| |
| Put | When any data is edited for the person in the Data Elements fields below.
|
| Delete | Staff records are a shared resource among all districts, this record will not delete. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A record will report when a person has a District Assignment record that is aligned to a scoped year. |
Report when a staff has an active District Assignment record that overlaps with the School year Start and End Dates.
|
Data will only send for the years that have valid configuration. |
When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.
|
When using data in Campus that has start and end dates, the following logic will be applied to determine the scope year(s) to report the data to.
|
Object Data Elements
This table describes data elements sent within the Staff resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| staffUniqueId | A unique alpha-numeric code assigned to a staff. The staff member's Ed-Fi ID is reported. | M | Census.edFiId | Census > People > Demographics > EdFi ID | |
| personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This element is currently not reported or collected. | C | N/A | N/A | |
| firstName | The staff member's legal first name. The first name from the person's current identity record is reported. | M | Identity.firstName | Census > People > Identities > First Name | |
| middleName | The staff member's legal middle name. The middle name from the person's current identity record is reported. | C | Identity. middleName | Census > People > Identities > Middle Name | |
| lastSurname | The staff member's legal last name. The last name from the person's current identity record is reported. | M | Identity.lastName | Census > People > Identities > Last Name | |
| generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). The suffix form the person's current identity record is reported. | C | Identity.suffix | Census > People > Identities > Suffix | |
| maidenName | The person''s maiden name, if applicable. This element is currently not reported or collected. | O | N/A | N/A | |
| sexType | The person's gender. | M | Identity.gender | Census > People > Identities > Gender | |
| birthDate | The month, day, and year on which an individual was born. The Birth Date from the person's current identity record is reported. | M | Identity.birthDate | Census > People > Identities > Birth Date | |
| hispanicLatinoEthnicity | An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central and South America, and other Spanish cultures, regardless of race. Report from "Is the individual Hispanic/Latino?" from the person's current identity:
| M | Identity. hispanicEthnicity | Census > People > Identities > Date Entered US | |
| oldEthnicityType | Previous definition of Ethnicity combining Hispanic/latino and race 1 - American Indian or Alaskan Native 2 - Asian or Pacific Islander 3 - Black, not of Hispanic origin 4 - Hispanic 5 - White, not of Hispanic origin. This element is optional and is not reported. | O | Identity. raceEthnicityFed | Historical data in Campus database | |
| highestCompletedLevel OfEducationDescriptor | The highest level of completed for a staff member. The Education value from the person's Credentials tab is reported.
Scope Year logic is used to determine the Scope Year to post or update. See the Level of Education Descriptors table in the section below for the Ed-Fi value that is reported. | O | N/A | Census > People > Credentials Census > People > District Employment | |
| yearsOfPrior ProfessionalExperience | The total number of years that an individual has previously held a similar professional position in one or more education institutions. This element is currently not reported or collected. | O | N/A | N/A | |
| yearsOfPrior TeachingExperience | The total number of years that an individual has previously held a teaching position in one or more education institutions. This element is currently not reported or collected. | O | N/A | N/A | |
| highlyQualifiedTeacher | An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL sections being taught. This element reports True when the person has a Credential Type = HQ: Highly Qualified.
This element reports False when the person is a teacher on any active course section and does not have an HQ: Highly Qualified Credential. If person is not a teacher, do not report a record. Scope Year logic is used to determine the Scope Year to post or update. | O | N/A | Census > People > Credentials | |
| loginId | The login ID for the user; used for security access control interface. This element is currently not reported or collected. | O | N/A | N/A | |
| citizenshipStatusType | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. This element is currently not reported or collected. | O | N/A | N/A | |
| addresses | Report the person's address(es). This element is optional and is not reported. | O | N/A | N/A | |
| credentials | An unordered collection of staffCredentials. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is optional and is not reported. | O | N/A | N/A | |
| electronicMails | An unordered collection of staffElectronicMails. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. See the Electronic Mail table in the section below for the Ed-Fi value that is reported. This element is an array which also reports the following data: | O | Contact.email | Census > People > Demographics > Email | |
| electronicMailType | This element reports the Electric Mail mapping listed in the table and section below. | M | N/A | N/A | |
| electronicMailAddress | The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. | M | Contact.email | Census > People > Demographics > Email | |
| primaryEmail AddressIndicator | An indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization. | O | N/A | N/A | |
| identificationCodes | An unordered collection of staffIdentificationCodes. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. | O | |||
| Staff Identification System Type | Reports District when reporting the local stff number; reports State when reporting the license number. | M | Person.stateID Person.staffNumber | Census>People>Demographics> Local Staff ID Census>People> District Employment> License Credentials> License Number | |
| Assigning Organization Identification Code | The organization code or name assigning the Staff Identification Code. This does not report. | O | N/A | N/A | |
| Identification Code | A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity. Reporting Logic is as follows:
| M | Person.stateID | Census > People > Demographics > State Staff ID/Local Staff ID, Staff State ID | |
| identificationDocuments | An unordered collection of staffIdentificationDocuments. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is currently not reported or collected. | O | N/A | N/A | |
| internationalAddresses | An unordered collection of staffInternationalAddresses. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is currently not reported or collected. | O | N/A | N/A | |
| languages | An unordered collection of staffLanguages. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is currently not reported or collected. | O | N/A | N/A | |
| otherNames | An unordered collection of staffOtherNames. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is currently not reported or collected. | O | N/A | N/A | |
| races | An unordered collection of staffRaces. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element looks at the Race Ethnicity checkboxe(s) marked on the person's Identity record. See the Race Type table in the section below for the Ed-Fi value that is reported. This element is also an array which reports the following data: | O | Identity. and RaceEthnicity. | Census > People > Identities > Race/Ethnicity | |
| raceType | The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. This element reports the short description mapped based on the Race Type table in the section below. | M | Identity. raceEthnicity and RaceEthnicity. | Census > People > Identities > Race/Ethnicity | |
| telephones | An unordered collection of staffTelephones. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element reports the phone numbers entered in the person's Personal Contact Information editor. See the Telephone Number table in the section below for the Ed-Fi value that is reported. This element is an array which reports the following additional data: | O | Contact.homephone Contact.workphone Contact.cellphone Contact.pager | Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager | |
| telephoneNumberType | This element reports the short description mapped in the Telephone Number Type table listed in the section below. | M | N/A | N/A | |
| orderOfPriority | The order of priority assigned to telephone numbers to define which number to attempt first, second, etc. | O | N/A | N/A | |
| textMessage CapabilityIndicator | An indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages. | O | N/A | N/A | |
| telephoneNumber | The 10-digit telephone number, including the area code, for the person. This element reports the phone numbers entered in the person's Personal Contact Information editor. | M | Contact.homephone Contact.workphone Contact.cellphone Contact.pager | Census > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager | |
| visas | An unordered collection of staffVisas. This entity represents an individual who performs specified activities for any public or private education institution or agency that provides instructional and/or support services to students or staff at the early childhood level through high school completion. This element is currently not reported or collected. | O | N/A | N/A | |
| repRaceOrders | An unordered collection of staffREPRaceOrders. This element is an array which reports the following additional data: | O | N/A | N/A | |
| raceOrderChoice Descriptor | Always reports a value of 1. | M | N/A | N/A | |
| raceType | The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. Report the short description from the Race Type page linked under the Type/Descriptor section below based on the mapping provided. | M | Identity.raceEthnicity RaceEthnicity.raceID | Census> People> Identities> Race/Ethnicity | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Level of Education Descriptors:
| Ed-Fi Code Value | Short Description | Description |
|---|---|---|
| High School Diploma | High School Diploma | High School Diploma |
| Doctorate | Doctorate | Doctorate |
| Bachelor's | Bachelor's | Bachelor's |
| Associate's Degree (two years or more) | Associate's Degree (two years or more) | Associate's Degree (two years or more) |
| Some College No Degree | Some College No Degree | Some College No Degree |
| Did Not Graduate High School | Did Not Graduate High School | Did Not Graduate High School |
| Master's | Master's | Master's |
Staff School Association
This association indicates the school(s) to which a teacher provides instructional services.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a District Assignment record is created or changed and saved for a staff member. |
Do NOT report a record if any one of the following scenarios are true:
| |
| Delete/Insert | When the person’s employment assignment record is changed |
| Delete/Insert | When the person’s employment assignment record is changed. |
| Delete | When a District Assignment record is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A record will report when a person has a District Assignment or District Employment record that is aligned to a scoped year.
|
| Data will only send for the years that have valid configuration |
Object Data Elements
This table describes data elements sent within the Staff School Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource | M | N/A | N/A |
| schoolReference | Reports data from the SchoolID field that is part of the natural key for the Schools resource. The following elements are reported:
| M | N/A | N/A |
| staffReference | Reports data from the SchoolID field that is part of the natural key for the Staff resource. The following elements are reported:
| M | N/A | N/A |
| programAssignment Descriptor | The name of the program for which the individual is assigned; for example: Regular education Title I-Academic Title I-Non-Academic Special Education Bilingual/English as a Second Language .A value of 03 reports. Reports a default value of "Regular Education". | M | N/A | N/A |
| schoolYear | The reporting school year. | O | N/A | N/A |
| academicSubjects | An unordered collection of staffSchoolAssociationAcademicSubjects. This association indicates the school(s) to which a teacher provides instructional services. | O | ||
academicSubjectDescriptor
| employmentassignment. primaryTeachingArea | Census> People> District Assignments> Primary Teaching Area | ||
| gradeLevels | An unordered collection of staffSchoolAssociationGradeLevels. This association indicates the school(s) to which a teacher provides instructional services. | O | ||
gradeLevelDescriptor
| employmentassignment.grade | Census> People> District Assignments> Grade Level | ||
| _etag | A unique system-generated value that identifies the version of the resource | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Academic Subject Descriptors:
| Code Value | Short Description | Description |
|---|---|---|
| Career and Technical Education | Career and Technical Education | Career and Technical Education |
| Composite | Composite | Composite |
| Critical Reading | Critical Reading | Critical Reading |
| English | English | English |
| English Language Arts | English Language Arts | English Language Arts |
| Fine and Performing Arts | Fine and Performing Arts | Fine and Performing Arts |
| Foreign Language and Literature | Foreign Language and Literature | Foreign Language and Literature |
| Life and Physical Sciences | Life and Physical Sciences | Life and Physical Sciences |
| Mathematics | Mathematics | Mathematics |
| Military Science | Military Science | Military Science |
| Other | Other | Other |
| Physical, Health, and Safety Education | Physical, Health, and Safety Education | Physical, Health, and Safety Education |
| Reading | Reading | Reading |
| Religious Education and Theology | Religious Education and Theology | Religious Education and Theology |
| Science | Science | Science |
| Social Sciences and History | Social Sciences and History | Social Sciences and History |
| Social Studies | Social Studies | Social Studies |
| Writing | Writing | Writing |
This table describes the Ed-Fi Value mapped and reported for Grade Level Descriptors:
| Code Value | Short Description | Description |
|---|---|---|
| Adult Education | Adult Education | Adult Education |
| Early Education | Early Education | Early Education |
| Eighth grade | Eighth grade | Eighth grade |
| Eleventh grade | Eleventh grade | Eleventh grade |
| Fifth grade | Fifth grade | Fifth grade |
| First grade | First grade | First grade |
| Fourth grade | Fourth grade | Fourth grade |
| Grade 13 | Grade 13 | Grade 13 |
| Infant/toddler | Infant/toddler | Infant/toddler |
| Kindergarten | Kindergarten | Kindergarten |
| Ninth grade | Ninth grade | Ninth grade |
| Other | Other | Other |
| Postsecondary | Postsecondary | Postsecondary |
| Preschool/Prekindergarten | Preschool/Prekindergarten | Preschool/Prekindergarten |
| Second grade | Second grade | Second grade |
| Seventh grade | Seventh grade | Seventh grade |
| Sixth grade | Sixth grade | Sixth grade |
| Tenth grade | Tenth grade | Tenth grade |
| Third grade | Third grade | Third grade |
| Twelfth grade | Twelfth grade | Twelfth grade |
| Ungraded | Ungraded | Ungraded |
Staff Section Association
This association indicates the course sections to which a staff person is assigned.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a staff person is added to a course section on Staff History.
|
| Post | When a Role with an Ed-Fi code is added to an existing teacher on the Staff History Record. |
| Put | When Start or End dates are modified on the Staff History. If the start or end dates are modified on the District Assignment record, an update will not occur. A resync must be completed to have all the records updated. |
| Delete | When a staff member is deleted from Staff History. |
| Delete | When a Role is removed from a Teacher on Staff History. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Reports for Sections in the scope year the course's calendar is aligned to. |
Data will only send for the 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 reduces 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. |
Object Data Elements
This table describes data elements sent within the Staff Section Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| section Reference | A reference to the related Section resource. Reports:
| M | N/A | N/A | |
| staffReference | A reference to the related Staff resource. Reports the Staff Unique ID. | M | N/A | N/A | |
| classroomPosition Descriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.
| M | sectionStaffhistory.role | Scheduling > Courses > Section > Staff History > Role | |
| beginDate | Month, day and year of a teacher''s assignment to the section. If blank, defaults to the first day of the first grading period for the section. Report the Staff History Start date if populated. If not populated, look at the District Assignment record for the teacher for that School and report Assignment Start Date if it is on or after the lowest Term Start Date and on or before the highest Term End Date for that section. If the District Assignment Start Date is Prior to the lowest Term Start Date, report the lowest Term Start Date for that section. | M | sectionstaffhistory.startdate employmentassignment.startdate term.startdate | Scheduling > Courses > Course > Section > Staff History> Start Date Census > People > District Assignment > Start Date System Administration > Calendar > Calendar > Terms | |
| endDate | Month, day and year of the last day of a teacher's assignment to the section. NEDM: Ending Date. Reports the Staff History End Date if populated. If not populated, look at the District Assignment record for the teacher for that School and report Assignment End Date if it is on or after the lowest Term Start Date and on or before the highest Term End Date for that section. Otherwise, reports the Term End Date for that section. | O | sectionstaffhistory.enddate employmentassignment.enddate | Scheduling > Courses > Course > Section > Staff History > End Date Census > Peopl e> District Assignment > End Date | |
| highlyQulaifiedTeacher | An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for this section being taught. This is optional and does not report. | O | N/A | N/A | |
| teacherStudent DataLinkExclusion | Indicates that the student-section combination is excluded from calculation of value-added or growth attribution calculations used for a particular teacher evaluation. This is optional and does not report. | O | N/A | N/A | |
| percentageContribution | The percentage of time the teacher is responsible for the student. This is optional and does not report. | O | N/A | N/A | |
| _etag | A unique system-generated value that identifies the version of the resource. This is optional and does not report. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Classroom Position Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Teacher of Record | Teacher of Record | Teacher of Record |
| Assistant Teacher | Assistant Teacher | Assistant Teacher |
| Support Teacher | Support Teacher | Support Teacher |
| Substitute Teacher | Substitute Teacher | Substitute Teacher |
Student Academic Record
This educational entity represents the cumulative record of academic achievement for a student.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | Report a StudentAcademicRecord instance for each school year in which the student has a transcript record and they have a Student School Association record for the scoped year.
|
| Post/Put | When a student is given a Diploma Date and Diploma Type:
|
| Delete | If records are posted from course transcript records and no Diploma information exits, all Student Academic Records will only delete when a student has only 1 Student School Association record for a specific Year and all Student School Association records are deleted |
| Delete | When the State Exclude or No Show checkboxes are checked on the student's enrollment. If these boxes are unchecked, the data will not post. A resync must be completed in order to resend the data. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Records will send to each scope year in which the Course Transcript record is posted. |
Records will only post to the SAR records for the year the diploma date occurs in but SAR records will post to all scoped years.
|
| Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Student Academic Record resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||||
|---|---|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |||
| educationOrganization Reference | A reference to the related EducationOrganization resource. Reports the District Number | M | N/A | N/A | |||
| schoolYearTypeReference | A reference to the related SchoolYearType resource.
| M | N/A | N/A | |||
| studentReference | Reports the fields that are part of the Natural Key for the Student resource
| M | N/A | N/A | |||
| termDescriptor | The term for the session during the school year. See the Term Descriptor table in the Type/Descriptor section below.
| M | N/A | N/A | |||
| cumulativeEarnedCreditType | Key for Credit. This is optional and does not report. | O | N/A | N/A | |||
| cumulativeEarnedCredit Conversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This is optional and does not report. | O | N/A | N/A | |||
| cumulativeEarnedCredits | The cumulative number of credits an individual earns by completing courses or examinations during his or her enrollment in the current school as well as those credits transferred from schools in which the individual had been previously enrolled.
| O | Calculated value from the earned credit field in the transcriptcredit table | Student Information > General > Transcripts | |||
| cumulativeAttemptedCreditType | Key for Credit This is optional and does not report. | O | N/A | N/A | |||
| cumulativeAttempted CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This is optional and does not report. | O | N/A | N/A | |||
| cumulativeAttemptedCredits | The cumulative number of credits an individual earns by completing courses or examinations during his or her enrollment in the current school as well as those credits transferred from schools in which the individual had been previously enrolled.
| O | N/A | N/A | |||
| cumulativeGradePointsEarned | The cumulative number of grade points an individual earns by successfully completing courses or examinations during his or her enrollment in the current school as well as those transferred from schools in which the individual had been previously enrolled. This is optional and does not report. | O | N/A | N/A | |||
| cumulativeGradePointAverage | A measure of average performance in all courses taken by an individual during his or her school career as determined for record-keeping purposes. This is obtained by dividing the total grade points received by the total number of credits attempted. This usually includes grade points received and credits attempted in his or her current school as well as those transferred from schools in which the individual was previously enrolled. This is optional and does not report. | O | N/A | N/A | |||
| gradeValueQualifier | The scale of equivalents, if applicable, for grades awarded as indicators of performance in schoolwork. For example, numerical equivalents for letter grades used in determining a student's Grade Point Average (A=4, B=3, C=2, D=1 in a four-point system) or letter equivalents for percentage grades (90-100%=A, 80-90%=B, etc.). This is optional and does not report. | O | N/A | N/A | |||
| projectedGraduationDate | The month and year the student is projected to graduate. This is optional and does not report. | O | N/A | N/A | |||
| sessionEarnedCreditType | Key for Credit This is optional and does not report. | O | N/A | N/A | |||
| sessionEarnedCreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. This is optional and does not report. | O | N/A | N/A | |||
| sessionEarnedCredit | The number of an credits an individual earned in this session. This is optional and does not report. | O | N/A | N/A | |||
| sessionAttemptedCreditType | Key for Credit. This is optional and does not report. | O | N/A | N/A | |||
| sessionAttempted CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units This is optional and does not report. | O | N/A | N/A | |||
| sessionAttemptedCredit | The number of an credits an individual attempted to earn in this session This is optional and does not report. | O | N/A | N/A | |||
| sessionGradePointsEarned | The number of grade points an individual earned for this session This is optional and does not report. | O | N/A | N/A | |||
| sessionGradePointAverage | The grade point average for an individual computed as the grade points earned during the session divided by the number of credits attempted This is optional and does not report. | O | N/A | N/A | |||
| classRanking | This educational entity represents the cumulative record of academic achievement for a student This is optional and does not report. | O | N/A | N/A | |||
| academicHonors | An unordered collection of studentAcademicRecordAcademicHonors. This educational entity represents the cumulative record of academic achievement for a student This is optional and does not report. | O | N/A | N/A | |||
| diplomas | An unordered collection of studentAcademicRecordDiplomas. This educational entity represents the cumulative record of academic achievement for a student.
| O | N/A | N/A | |||
| Diploma Type | The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements.
| M | Student Information> General> Graduation | Graduation. diplomaType | |||
| Diploma Date | The month, day, and year on which the student met graduation requirements and was awarded a diploma. Reports the Diploma Date | M | N/A | N/A | |||
| achievementCategory Descriptor | This descriptor defines the category of achievement attributed to the learner.
| M | Student Information > General > Graduation > Diploma Type | Graduation. diplomaType | |||
| recognitions | An unordered collection of studentAcademicRecordRecognitions. This educational entity represents the cumulative record of academic achievement for a student This is optional and does not report. | O | N/A | N/A | |||
| reportCards | An unordered collection of studentAcademicRecordReportCards. This educational entity represents the cumulative record of academic achievement for a student This is optional and does not report. | O | N/A | N/A | |||
| _etag | A unique system-generated value that identifies the version of the resource. This is optional and does not report. | O | N/A | N/A | |||
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Diploma Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Regular diploma | Regular diploma | Regular diploma |
| Regents diploma | Regents diploma | Regents diploma |
| Post graduate certificate (grade 13) | Post graduate certificate (grade 13) | Post graduate certificate (grade 13) |
| Other diploma | Other diploma | Other diploma |
| Other | Other | Other |
| Occupational License | Occupational License | Occupational License |
| Modified diploma | Modified diploma | Modified diploma |
| International Baccalaureate | International Baccalaureate | International Baccalaureate |
| Industry-recognized Certification | Industry-recognized Certification | Industry-recognized Certification |
| High school equivalency credential, other than GED | High school equivalency credential, other than GED | High school equivalency credential, other than GED |
| General Educational Development (GED) credential | General Educational Development (GED) credential | General Educational Development (GED) credential |
| Endorsed/advanced diploma | Endorsed/advanced diploma | Endorsed/advanced diploma |
| Certificate of completion | Certificate of completion | Certificate of completion |
| Certificate of attendance | Certificate of attendance | Certificate of attendance |
| Career and Technical Education certificate | Career and Technical Education certificate | Career and Technical Education certificate |
| Apprenticeship Certificate | Apprenticeship Certificate | Apprenticeship Certificate |
| Alternative credential | Alternative credential | Alternative credential |
This table describes the Ed-Fi Value mapped and reported for Achievement Category Descriptors
Code Value | Short Description | Description |
|---|---|---|
| Certificate Earned | Certificate Earned | Certificate Earned |
| Competency Retained | Competency Retained | Competency Retained |
| Level Completed | Level Completed | Level Completed |
| License Earned | License Earned | License Earned |
| Non-Academic Honor | Non-Academic Honor | Non-Academic Honor |
| Competency Mastered | Competency Mastered | Competency Mastered |
| Diploma Earned | Diploma Earned | Diploma Earned |
| Course Completed | Course Completed | Course Completed |
| License Endorsement Earned | License Endorsement Earned | License Endorsement Earned |
| Participation | Participation | Participation |
| Recognition | Recognition | Recognition |
Student Cohort Associations
This entity represents any type of list of designated students for tracking, analysis, or intervention.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a Student is assigned to a Program that is reported as a Cohort and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
| The Cohort can only be created from Program Admin> Programs> Programs tab | |
| Put | The end date is updated on the Student's Programs tab |
| Delete/Post | If any part of the Natural Key changes |
| Delete/Post | When the student has two of the same flags with the same start date and 1 record is deleted, the remaining records data will post |
| Delete | If the Program Participation record is Deleted |
Object Data Elements
This table describes data elements sent within the Student Cohort Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| cohortReference | Reports the Natural Key of the Cohort resource | M | N/A | N/A | |
| studentreference | Reports the Natural Key of the Student resource | M | N/A | N/A | |
| beginDate | The month, day, and year on which the Student was first identified as part of the Cohort.
| O | programparticipation.startdate | Student Information> Program Participation> Programs> Start Date | |
| endDate | The month, day, and year on which the Student was removed as part of the Cohort.
| O | programparticipation.enddate | Student Information> Program Participation> Programs> End Date | |
| sections | An unordered collection of studentCohortAssociationSections. The cohort representing the subdivision of students within one or more sections. For example, a group of students may be given additional instruction and tracked as a cohort This field is optional and does not report. | O | N/A | N/A | |
Student Discipline Incident Association
This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery).
A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | Reports a behavior incident when the incident's Status is marked and saved as "Complete"
|
| Delete/Post | When data that is part of the Natural Key is changed
|
| Delete/Post | When the Incident's status is changed
|
| Deete | When an incident is deleted |
| Delete | When all non-excluded enrollments in the school and year are deleted |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Discipline records will only send to the school year that the incident date is aligned to based on the School Year Start and End dates.
|
Data will only send for the years that have valid configuration |
Object Data Elements
This table describes data elements sent within the Student Discipline Incident Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| discipline Incident Reference | Reports data from the fields that are part of the natural key for the Discpline Incident resource. The following elements are reported:
| M | N/A | N/A | |
| studentReference | Reports data from the fields that are part of the natural key for the Student resource. The following elements are reported:
| M | N/A | N/A | |
| Student Participation Code Type | The role or type of participation of a student in a discipline incident. Report the Ed-Fi Code value from the Role that is selected for the Student being reported
| M | BehaviorEvent.role | Behavior > Behavior Management > Participant Details > Role | |
| behaviors | An unordered collection of disciplineIncidentBehaviors. This event entity represents an occurrence of an infraction ranging from a minor behavioral problem that disrupts the orderly functioning of a school or classroom (such as tardiness) to a criminal act that results in the involvement of a law enforcement official (such as robbery). A single event (e.g., a fight) is one incident regardless of how many perpetrators or victims are involved. Discipline incidents are events classified as warranting discipline action. This field is optional and does not report. | O | N/A | N/A | |
| _etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Student Participation Code Types:
| Campus Role | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Victim | Victim | Victim |
| Offender | Perpetrator | Perpetrator |
| Witness | Witness | Witness |
| Reporter | Reporter | Reporter |
Student Education Organization Association
This association indicates any relationship between a student and an education organization other than however the state views enrollment. Enrollment relationship semantics are covered by Student School Association.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When an enrollment is saved with Resident District field populated and/or Serving District field = NULL.
|
| Delete/Insert | When an enrollment Serving or Resident District is changed on an existing enrollment.
|
| Post | When an enrollment start date is changed on an existing enrollment.
|
| Put | When the start date for an enrollment is changed. |
| Delete | When an enrollment resident district is changed to NULL on an existing enrollment and a serving district with the same key (District Number) does not exist. |
| Delete | When an enrollment serving district is changed to NULL on an existing enrollment and a resident district with the same key (District Number) does not exist. |
| Delete | When the enrollment is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
The record will send to the scope year for the school year the enrollment is associated with. |
Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Student Education Organization Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| educationOrganization Reference | A reference to the related EducationOrganization resource.
| M | Enrollment. Enrollment. servingDistrict | Student Information General > Enrollments > Resident District Student Information General > Enrollments > Resident District |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource:
| M | N/A | N/A |
| responsibility Descriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.
| M | N/A | N/A |
etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Responsibility Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Accountability | Accountability | Accountability |
| Attendance | Attendance | Attendance |
| Funding | Funding | Funding |
| Graduation | Graduation | Graduation |
| Individualized Education Program | Individualized Education Program | Individualized Education Program |
| Transportation | Transportation | Transportation |
Student Parent Association
This association relates students to their parents, guardians or caretakers.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When the Guardian checkbox is marked on the Relationships tab.
|
| Put | When the relationship type is changed. |
| Delete | When the Guardian checkbox is unchecked, relationship is end dated or deleted.
|
| Delete | Records delete when a student has only 1 Student School Association record for a specific School and Year that record is deleted for. If a new Student School Association record is created, existing records will not re-post, a resync must be completed to resend the data |
| Delete | When the State Exclude or No Show checkboxes are marked. if the boxes are unchecked the data will not re-post, a resync must be completed to resend the data |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A record will report when they are a guardian to a student with an enrollment aligned to a scoped year.
|
Data will only send for the years that have valid configuration. |
| A resync must be completed on the resource when a new scope year is configured in order for this data to send. |
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) to report the data to:
|
Object Data Elements
This table describes data elements sent within the Student Parent Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource | M | N/A | N/A |
| parentReference | Reports the fields that are part of the Natural Key for the Parents resource:
| M | N/A | N/A |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource:
| M | N/A | N/A |
| relationType | The nature of an individual's relationship to a student; for example: Father/Mother, Step Father/Step Mother, Foster Father/Foster Mother, Guardian.
See the Relationship Type table in the section below for the Ed-Fi value that is reported. | O | RelatedPair.name | Census > People > Relationships > Relationship |
| primaryContactStatus | Indicator of whether the person is a primary parental contact for the student. This element reports True if the Guardian checkbox is marked on the Relationships tab. If the student has more than one guardian, the guardian with the earliest start date is reported. If start dates are the same or null for two guardians, the guardian with the lowest personID is reported. | O | N/A | Census > People > Relationships > Guardian |
| livesWith | Indicator of whether the student lives with the associated parent. This element reports True if the student is in the same household of the parent being reported. Otherwise, reports False.
| O | N/A | Census > People > Households |
| emergency ContactStatus | Indicator of whether the person is a designated emergency contact for the student. This element will report true if there is a number entered in the Emergency Priority field for the parent being reported. | O | N/A | Census > People > Relationships > Emergency Priority |
| contactPriority | The numeric order of the preferred sequence or priority of contact. This data is not collected in Campus is not reported. | O | N/A | N/A |
| contactRestrictions | Restrictions for student and/or teacher contact with the individual. This data is not collected in Campus is not reported. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Relationship Type:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Aunt | Aunt | Aunt |
| Brother | Brother | Brother |
| BrotherInLaw | BrotherInLaw | BrotherInLaw |
| CourtAppointedGuardian | CourtAppointedGuardian | CourtAppointedGuardian |
| Cousin | Cousin | Cousin |
| Daughter | Daughter | Daughter |
| DaughterInLaw | DaughterInLaw | DaughterInLaw |
| Employer | Employer | Employer |
| Father | Father | Father |
| Father, step | Father, step | Father, step |
| FathersSignificantOther | FathersSignificantOther | FathersSignificantOther |
| FathersCivilPartner | FathersCivilPartner | FathersCivilPartner |
| FatherInLaw | FatherInLaw | FatherInLaw |
| Fiance | Fiance | Fiance |
| Fiancee | Fiancee | Fiancee |
| Foster parent | Foster parent | Foster parent |
| Friend | Friend | Friend |
| Grandfather | Grandfather | Grandfather |
| Grandmother | Grandmother | Grandmother |
| Great aunt | Great aunt | Great aunt |
| Great uncle | Great uncle | Great uncle |
| Great Grandparent | Great Grandparent | Great Grandparent |
| Husband | Husband | Husband |
| MothersSignificantOther | MothersSignificantOther | MothersSignificantOther |
| Mother | Mother | Mother |
| Mother, step | Mother, step | Mother, step |
| MothersCivilPartner | MothersCivilPartner | MothersCivilPartner |
| Nephew | Nephew | Nephew |
| Niece | Niece | Niece |
| Other | Other | Other |
| SignificantOther | SignificantOther | SignificantOther |
| Sister | Sister | Sister |
| Son | Son | Son |
| Unknown | Unknown | Unknown |
| Uncle | Uncle | Uncle |
| Ward | Ward | Ward |
| Wife | Wife | Wife |
Student Program Association
This association represents the Program(s) that a student participates in or is served by. A student may have multiple records; one for each program they participate in.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
# | Action | Trigger |
|---|---|---|
| R1 | Post | When a student has a EL Program Status = EL and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
| R2 | Post | When a Flag is created and the 'Name' matches an Ed-FI Program Type and the record overlaps an enrollment with a valid Student School Association in the current scoped year |
| R2.BR1 | Do not create a record when the Flag Name is = Title I Part A or Special Education | |
| R3 | Put | When either the student is given an EL Exit Date or an End Date on a reported Flag |
| R4 | Delete/Post | When part of the records Natural Key changes |
| R4.BR1 | When the student has two of the same flags with the same start date and 1 record is deleted, the remaining records data will post | |
| R5 | Delete | When a student's EL record is deleted or when the record no longer overlaps any reported enrollment in the Scoped Year |
| R6 | Delete | When a Flag is deleted or when the record no longer overlaps any reported enrollment in the Scoped Year |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Records will send to the scope year for the school year they are associated with based on the student's enrollment |
| Data will only send for the years that have valid configuration |
Object Data Elements
This table describes data elements sent within the Student Program Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Interface | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrganizationReference | A reference to the related EducationOrganization resource. Reports the state school number that is aligned to the student's enrollment. Reports enrollments in Primary, Partial, Special Ed order. | M | School.number | System Administration > Resources > School > State School Number | |
| programReference | A reference to the related Program resource. Reports EL Program Reference. | M | N/A | N/A | |
| studentReference | A reference to the related Student resource. Reports the studentUniqueId from the Student Resource. | M | N/A | N/A | |
| beginDate | The month, day, and year on which the Student first received services.
| M | Lep.identifiedDate OR programparticipation. startdate | Student Information> English Learners> Identified Date OR Student Information> General> Flags> Start Date | |
| endDate | The month, day, and year on which the Student exited the Program or stopped receiving services.
| O | Lep.exitDate OR programparticipation. enddate | Student Information> English Learners> Exit Date OR Student Information> General> Flags> End Date | |
| reasonedExitedDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table This field is optional and does not report. | O | N/A | N/A | |
| servedOutsideOf regularSession | Indicates whether the student received services during the summer session or between sessions. This field is optional and does not report. | O | N/A | N/A | |
| enrollmentStatus | This field is optional and does not report. | O | N/A | N/A | |
| services | An unordered collection of studentProgramAssociationServices. Indicates the services being provided to the student by the program. This field is an array. See below for more information. This field is optional and does not report. | O | N/A | N/A | |
Student School Association
This association represents the school in which a student is enrolled.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new enrollment is saved for a student or the No Show or State Exclude checkbox is unchecked.
|
| Post | When the start date for an enrollment is changed.
|
| Put | When an enrollment is updated for a student.
|
| Put | When a change is made to the Graduation > NCLB Cohort End Year field. |
| Put | When a student is assigned to a Graduation or CTE Program or the start and/or end dates are modified. |
| Delete | When an enrollment is deleted or the No Show or the State Exclude checkboxes are marked.
|
| Delete | When the start date of an enrollment is changed |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| The record will send to the scope year for the school year the enrollment is associated with. |
| Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Student School Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| graduationPlan Reference | A reference to the related GraduationPlan resource.
| O | N/A | Student Information > Academic Planning > Programs |
| schoolReference | Reports the fields that are part of the Natural Key for the School resource:
| M | N/A | N/A |
| classOfSchool YearTypeReference | The year the student is expected to graduate. Report only for students with an enrollment in grade 9-12:
| C | Graduation.gradYear | Student Information > General > Graduation |
| schoolYearType Reference | The school year the student is being reported in.
| O | N/A | N/A |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource:
| M | N/A | N/A |
| entryDate | The month, day, and year on which an individual enters and begins to receive instructional services in a campus. | M | Enrollment.startDate | Student Information > General > Enrollments > Start Date |
| entryGradeLevel Descriptor | The grade level or primary instructional level at which a student enters and receives services in a school or an educational institution during a given academic session.
| M | Enrollment.grade | Student Information > General > Enrollments > Grade |
| entryGradeLevel ReasonType | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. This is optional and does not report. | O | N/A | |
| entryTypeDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. Reports the Ed-Fi Code Value from the Start Status selected. If blank, does not report. See the Entry Type Descriptor table in the section below for reported Ed-Fi code values. | O | Enrollment. startStatus | Student Information > General > Enrollments > Start Status |
| repeatGradeIndicator | An indicator of whether the student is enrolling to repeat a grade level, either by failure or an agreement to hold the student back. Look at the student's last enrollment record prior to the enrollment that is reporting and report the following:
| O | enrollment. endAction | Student Information> General> Enrollments> End Action |
| schoolChoiceTransfer | An indication of whether students transferred in or out of the school did so during the school year under the provisions for public school choice in accordance with Title I, Part A, Section 1116.
| O | enrollment. stateFundingCode | Student Information> General> Enrollments> School Choice |
| exitWithdrawDate | The month, day, and year of the first day after the date of an individual's last attendance at a campus (if known), the day on which an individual graduated, or the date on which it becomes known officially that an individual left school. NEDM: Exit/Withdraw Date. | O | Enrollment.endDate | Student Information > General > Enrollments > End Date |
| exitWithdrawType Descriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. Reports the Ed-Fi Code Value from the End Status selected. See the Exit Withdrawal Reason Descriptor table in the section below for more information on the Ed-Fi code reported. | O | Enrollment.endStatus | Student Information > General > Enrollments > End Status |
| residencyStatus Descriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.
| O | enrollment.residentdistrict and/or enrollment.servingdistrict | Student Information> General> Enrollments |
| primarySchool | Indicates if a given enrollment record should be considered the primary record for a student. If omitted, the default is true. This element reports a value of True if Service Type = P: Primary; otherwise, reports False. | O | Enrollment.type | Student Information > General > Enrollments > Service Type |
| employedWhile Enrolled | An individual who is a paid employee or works in his or her own business, profession, or farm and at the same time is enrolled in secondary, postsecondary, or adult education. This is optional and does not report. | O | N/A | N/A |
| educationPlans | An unordered collection of studentSchoolAssociationEducationPlans. This association represents the school in which a student is enrolled. This is optional and does not report. | Array | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Entry Type Descriptor:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Transfer | Transfer | Transfer |
| Re-entry | Re-entry | Re-entry |
| Next year school | Next year school | Next year school |
| New to education system | New to education system | New to education system |
| Other | Other | Other |
This table describes the Ed-Fi Value mapped and reported for Exit Withdrawal Type Descriptor:
Code Value | Short Description | Description |
|---|---|---|
| Completed | Completed | Completed |
| Incarcerated | Incarcerated | Incarcerated |
| Dropout | Dropout | Dropout |
| Expelled | Expelled | Expelled |
| Died or is permanently incapacitated | Died or is permanently incapacitated | Died or is permanently incapacitated |
| Invalid enrollment | Invalid enrollment | Invalid enrollment |
| End of school year | End of school year | End of school year |
| Graduated | Graduated | Graduated |
| Enrolled in a high school diploma program | Enrolled in a high school diploma program | Enrolled in a high school diploma program |
| Involuntarily Removed | Involuntarily Removed | Involuntarily Removed |
| No show | No show | No show |
| Other | Other | Other |
| Reached maximum age | Reached maximum age | Reached maximum age |
| Transferred | Transferred | Transferred |
| Withdrawn | Withdrawn | Withdrawn |
Student School Attendance Event
This event entity represents the recording of whether a student is in attendance on a daily basis at their school.
Object Triggering Logic
| Action | Trigger |
|---|---|
| Post | When a new attendance event is verified for a student and is marked Excused Absent, Unexcused Absent or Tardy
|
| Put | N/A - only deletes and posts are sent for this Resource.
|
| Delete | Delete attendance record if all attendance is removed for the day and determined present minutes or present periods is 50% or more. MSDS Attendance Model for the day will need to be referenced. |
| Delete | When an enrollment is deleted or the No Show or State Exclude checkboxes are checked. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Attendance will send to the scope year for the school year the attendance dates are associated with based on the student's enrollment. |
| Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Student School Attendance Event resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource | M | N/A | N/A |
| schoolReference | Reports the fields that are part of the Natural Key for the Schools resource: | M | N/A | N/A |
| sessionReference | Reports the fields that are part of the Natural Key for the Sessions resource:
Only report the Term Type from the Terms tab that is associated with the date and term schedule the attendance is being reported for. | M | N/A | N/A |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource:
| M | N/A | N/A |
| eventDate | Date for this attendance event. | M | N/A | N/A |
| attendanceEvent CategoryDescriptor | Report the Ed-Fi Code from the Attendance Event Category Descriptor page below based when the student has an attendance record with the following attendance status and excuse:
| M | v_AttDailyDetail.unexcused v_AttDailyDetail.tardies | N/A |
| attendanceEventReason | The reported reason for a student's absence.
| O | attendance.comments | N/A |
| educational EnvironmentType | The educational environment. This element is optional and does not report. | O | N/A | N/A |
| absenceAmountDescriptor | N/A | O | N/A | N/A |
| instructionalMinutes | N/A | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource | O | N/A | N/A |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Attendance Event Category Type:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Unexcused Absence | Unexcused Absence | Unexcused Absence |
| Excused Absence | Excused Absence | Excused Absence |
| Tardy | Tardy | Tardy |
Student Section Association
This association indicates the course sections to which a student is assigned.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a student is scheduled into a course section.
|
| Post | Send a new record if a student's roster start date is changed. |
| Put | When section information is updated for a student or section.
|
| Delete | When a student is deleted from a course section. |
| Delete | Delete any future records if the student is given a roster end date for the course. Roster End Date must be before the Term Start date of future records. |
| Delete | Delete the record if a student's roster start date is changed. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
| Reports records in the scope year the course/section's calendar is aligned to. |
| Data will only send for the years that have valid configuration. |
Future Years data will be suppressed until the Active Year is changed:
|
Object Data Elements
This table describes data elements sent within the Student Section Association resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A |
| sectionReference | Reports the fields that are part of the Natural Key for the Section resource:
| M | N/A | N/A |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource:
| M | N/A | N/A |
| beginDate | Month, day and year of the student's entry or assignment to the section. If blank, default is the start date of the first grading period. Logic reports based on the following:
| M | Enrollment.startDate Terms.startDate | Student Information > General > Enrollments > Start Date OR System Administration > Calendar > Calendar > Terms |
| endDate | Month, day, and year of the withdrawal or exit of the student from the section. Logic reports based on the following:
| O | Roster.endDate Terms.endDate | Student Information > General > Schedule > Roster End Date OR System Administration > Calendar > Calendar > Terms |
| homeroomIndicator | Indicator that the class is the student's designated homeroom used for daily attendance reporting.
| O | Course.homeroom Section.homeroom | Scheduling > Course > Homeroom or Scheduling > Course > Section > Homeroom |
| repeatIdentifierType | An indication as to whether a student has previously taken a given course. This element is currently not reported or collected. | O | N/A | N/A |
| teacherStudent DataLinkExclusion | Indicates that the student-section combination is excluded from calculation of value-added or growth attribution calculations used for a particular teacher evaluation. This element is currently not reported or collected. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Student Section Attendance Event
This event entity represents the recording of whether a student is in attendance for a class.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When a new attendance event is verified for a student in a course section.
|
| Put | N/A - only deletes and posts are sent for this Resource.
|
| Delete | Delete attendance record if all attendance is removed for the day |
| Delete | When an enrollment is deleted or the No Show or State Exclude checkboxes are checked |
| Delete | If the student is removed from the course section |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
Attendance will send to the scope year for the school year the attendance dates are associated with based on the student's enrollment.
|
Object Data Elements
This table describes data elements sent within the Student Section Attendance Event resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | |
|---|---|---|---|---|
| id | The unique identifier of the resource | M | N/A | N/A |
| sectionReference | Reports the fields that are part of the Natural Key for the Section resource. | M | N/A | N/A |
| studentReference | Reports the fields that are part of the Natural Key for the Student resource. | M | N/A | N/A |
| eventDate | Date for this attendance event. | M | N/A | N/A |
| attendanceEvent CategoryDescriptor | Key for AttendanceEventCategoryType. Reports when a student has a verified attendance mark for a course section
| M | N/A | N/A |
| attendanceEventReason | The reported reason for a student's absence
| O | N/A | N/A |
| educationalEnvironmentType | Key for EducationalEnvironment This element is optional and does not report. | O | N/A | N/A |
| etag | A unique system-generated value that identifies the version of the resource This element is optional and does not report. | O | N/A | N/A |
Type/Descriptors
This table describes the Ed-Fi Value mapped and reported for Attendance Event Category Type:
| Code Value | Short Description | Description |
|---|---|---|
| Excused Absence | Excused Absence | Excused Absence |
| Unexcused Absence | Unexcused Absence | Unexcused Absence |
| Tardy | Tardy | Tardy |
Student
Provide a summary of what the report/function will cover and the logistics around the data collection or reporting.
The Student Resource is a shared record among all districts. If two districts have the same student in the same year, the last district to trigger data to Ed-Fi is the data stored in Ed-Fi.
For example, if one district put in a first name of "Robert" and the second district put in a first name of "Rob", the last district to update the student record is what will appear in Ed-Fi and on both District's reports. This is true for all field logic in the Student Resource.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When an enrollment is created and saved for a person.
|
| Put | When any student data is edited for the person in the Data Elements fields below.
|
| Delete | Student records are never deleted because Student records are a shared resource among all districts. |
Scope Year Logic
This table describes scope year logic of this object.
| Logic |
|---|
A record will report when an enrollment is created and saved that is aligned to a scoped year.
|
| Data will only send for the years that have valid configuration. |
When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.
|
When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) to report the data to.
|
Object Data Elements
This table describes data elements sent within the Student resource.
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| studentUniqueId | A unique alpha-numeric code assigned to a student. This element reports the Ed-Fi ID of the student. | M | Person.edFiId | Census >People >Demographics > EdFi ID | |
| personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This element is currently not reported or collected. | C | N/A | N/A | |
| firstName | The reporting student's first name. This is reported from the person's most recent identity record. If Legal First and Last name fields are blank, the First Name reports. | M | Identity.legalFirstName Identity.firstName | Census > People > Identities > Protected Identity Information > Legal First Name Census > People > Identities > First Name | |
| middleName | The reporting student's middle name. This is reported from the person's most recent identity record. If Legal First Name and Legal Last Name are populated and Middle Name is blank, a blank value reports. If all legal name fields are blank, value reports from the Middle Name field. | O | Identity.legalMiddleName Identity.middleName | Census > People > Identities > Protected Identity Information > Legal Middle Name Census > People > Identities > Middle Name | |
| lastSurname | The reporting student's last name. This is reported from the person's most recent identity record. Reports first from the Legal Last Name field. If Legal First and Last name fields are blank, value reports from the Last Name field. | M | Identity.legalLastName Identity.lastName | Census > People > Identities > Protected Identity Information > Legal Last Name Census > People > Identities > Last Name | |
| generation CodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). This is reported from the person's most recent identity record. Reports first from the Legal Suffix field. If Legal First Name and Legal Last Name are populated and Legal Suffix is blank, a blank value reports. If Legal First and Last name fields are blank, value reports from the Suffix field, if populated. | C | Identity.legalSuffix Identity.suffix | Census > People > Identities > Protected Identity Information > Legal Suffix Census > People > Identities > Suffix | |
| maidenName | The person's maiden name, if applicable. This element is currently not reported or collected. | O | N/A | N/A | |
| sexType | The person's gender. This is reported from the person's most recent identity record. Reports the Legal Gender from the student's current identity record. If Legal Gender is not populated, the value reports from the student's Gender from the current Identity record. Reports the following based on the value selected in the Gender or Legal Gender field:
| M | Identity.legalGender Identity.gender | Census > People > Identity > Protected Identity Fields > Gender Census > People > Identity > Gender | |
| birthDate | The month, day, and year on which an individual was born. The Birth Date from the student's currently Identity record is reported. | M | Identity.birthDate | Census > People > Identities > Birth Date | |
| birthCity | The set of elements that capture relevant data regarding a person's birth, including birth date and place of birth.
| O | identity.birthcity | Census> People> Demographics> Birth City | |
| birthState AbbreviationType | The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born. Logic determines the Birth State from the student's current identity record.
| C | Identity.birthState | Census > People > Identities > Birth State | |
| birthCountry Descriptor | The name of the country in which an individual was born.
| C | Identity.birthCountry | Census > People > Identities > Birth Country | |
| dateEnteredUS | For students born outside of the US, the date the student entered the US. This element reports the value entered in the Date Entered US field. | C | Identity. dateEnteredUS | Census > People > Identities > Date Entered US | |
multipleBirthStatus | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.) This element is currently not reported or collected. | O | N/A | N/A | |
| profileThumbnail | File name for the ProfileThumbnail photograph. This element is currently not reported or collected. | O | N/A | N/A | |
| hispanicLatino Ethnicity | An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central and South America, and other Spanish cultures, regardless of race. This element reports based on the value in the Is the individual Hispanic/Latino? field on the student's identity record. Report "Is the individual Hispanic/Latino?" from the student's current identity:
| M | Identity. hispanicEthnicity | Census > People > Identities > Is the individual Hispanic/Latino? | |
| oldEthnicityType | No longer reports data. | O | N/A | N/A | |
economic | An indication of inadequate financial condition of an individual''s family, as determined by family income, number of family members/dependents, participation in public assistance programs, and/or other characteristics considered relevant by federal, state, and local policy. NEDM Economic Disadvantaged Status.
| O | PosEligibility.eligibility | FRAM > Eligibility > Eligibility | |
schoolFoodServices | This descriptor defines indications of a student's level of eligibility for breakfast, lunch, snack, supper and milk programs.
| C | PosEligibility.eligibility | FRAM > Eligibility > Eligibility | |
limitedEnglish | An optional globally unique namespace that identifies this descriptor set. If supplied, the author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary. Actual usage of this element for matching descriptors will be system-specific.
| O | N/A | Student Information > Program Participation > English Learners (EL) | |
| displacementStatus | Indicates a state health or weather related event that displaces a group of students, and may require additional funding, educational, or social services. This element is currently not reported or collected. | O | N/A | N/A | |
| loginId | The login ID for the user; used for security access control interface. This element is currently not reported or collected. | O | N/A | N/A | |
| citizenshipStatus Type | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. This element is currently not reported or collected. | O | N/A | N/A | |
| learningStyle | This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element is currently not reported or collected. | O | N/A | N/A | |
| addresses | Reports the student's address(es). Logic reports the most current Primary address that is marked as "Mailing".
This element is an array that reports the following data: | O | HouseholdLocation. HouseholdMember. Householdlocation. | Household Addresses > Mailing Household Membership > Start Date Household Addresses > Start Date | |
| addressType | All addresses will report as 'Home'. This will report the Ed-Fi mapped value in the Address Type table in the section below. | M | N/A | N/A | |
| streetNumberName | The street number and street name or post office box number of an address. Reports the Address PO Box + Number + Street + Tag + Prefix + Dir | M | Address.postOfficeBox Address.number Address.street Address.tag Address.prefix Address.dir | Households > Address Info | |
| apartmentRoomSuiteNumber | The apartment, room, or suite number of an address. | O | Address.apt | Households > Address Info > Apt | |
| buildingSiteNumber | The number of the building on the site, if more than one building shares the same address. This field is optional and does not report. | O | N/A | N/A | |
| city | The name of the city in which an address is located. | M | Address.city | Households > Address Info > City | |
| stateAbbreviationType | The abbreviation for the state (within the United States) or outlying area in which an address is located. | M | Address.state | Households > Address Info > State | |
| postalCode | The five or nine digit zip code portion of an address. | M | SAddress.zip | Households > Address Info > Zip | |
| nameOfCounty | The name of the county, parish, borough, or comparable unit (within a state) in which an address is located. This field is optional and does not report. | O | N/A | N/A | |
| countyFIPSCode | 5 digit code consisting of the two digit state code followed by the three digit FIPS code for the county. This field is optional and does not report. | O | N/A | N/A | |
| latitude | The geographic latitude of the physical address. This field is optional and does not report. | O | N/A | N/A | |
| longitude | The geographic longitude of the physical address. This field is optional and does not report. | O | N/A | N/A | |
| beginDate | The first date the address is valid. For physical addresses, the date the person moved to that address. This field is optional and does not report. | O | N/A | N/A | |
| endDate | The last date the address is valid. For physical addresses, this would be the date the person moved from that address. This field is optional and does not report. | O | N/A | N/A | |
characteristics | An unordered collection of studentCharacteristics. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. | O | programparticipation. name | Student Information> General> Flags | |
| descriptor | This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program.
| M | |||
| beginDate | The organization code or name assigning the assessment identification code. This element is optional and does not report. | O | N/A | N/A | |
| endDate | A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity. This element is optional and does not report. | O | N/A | N/A | |
| designatedBy | The person, organization, or department that designated the characteristic. This element is optional and does not report. | O | N/A | N/A | |
| cohortYears | An unordered collection of studentCohortYears. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. This element is optional and does not report. | O | N/A | N/A | |
disabilities | An unordered collection of studentDisabilities. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.
| O | Enrollment.disability1 Enrollment.disability2 Enrollment.disability3 Enrollment.disability3 Enrollment.disability3 | Student Information > General > Enrollments > Special Ed Fields | |
| disabilityDescriptor | This descriptor defines a student's impairment.
| M | planstate.disability1 planstate.disability2 planstate.disability3 planstate.disability4 planstate.disability5 | Special Ed> Documents> Plan> IEP> Primary Disability, Secondary Disability, Tertiary Disability, Fourth Disability, Fifth Disability | |
| disabilityDiagnosis | A description of the disability diagnosis. This element is optional and does not report. | O | N/A | N/A | |
| orderOfDisability | The order by severity of student's disabilities: 1- Primary, 2 - Secondary, 3 - Tertiary, etc.
| O | N/A | N/A | |
| disabilityDetermination SourceType | Key for Disability Determination Source Type This element is optional and does not report. | O | N/A | N/A | |
electronicMails | An unordered collection of studentElectronicMails. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program.
| O | N/A | N/A | |
identificationCodes | An unordered collection of studentIdentificationCodes. This element reports the Local Student Number, if populated. This element is an array that reports the following data: | O | Person. | Census > People > Demographics > Local Student Number | |
| studentIdentificationSystemType | Reports the short description from the Student Identification Code mapping listed in the table and section below.
| M | N/A | N/A | |
| Assigning Organization Identification Code | The organization code or name assigning the assessment identification code.
| O | N/A | N/A | |
| Identification Code | A unique number or alphanumeric code assigned to a student by a school, school system, a state, or other agency or entity.
| M | Person. studentNumber | Census > People > Demographics > Local Student Number | |
| identification Documents | An unordered collection of studentIdentificationDocuments. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element is currently not reported or collected. | O | N/A | N/A | |
| indicators | An unordered collection of studentIndicators. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element is currently not reported or collected. | O | N/A | N/A | |
| international Addresses | An unordered collection of studentInternationalAddresses. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element is currently not reported or collected. | O | N/A | N/A | |
languages | An unordered collection of studentLanguages. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. Report the Code from the Home Primary Language saved on the student's current identity record.
This element is an array that reports the following data: | O | Identity. homePrimaryLanguage | Census > People > Demographics > Home Primary Language | |
| languageDescriptor | An unordered collection of studentLanguageUses. Language(s) the individual uses to communicate. This reports the Ed-Fi mapped value in the Language Type table in the section below.
| M | Identity. homePrimaryLanguage | Census > People > Identities > Home Primary Language | |
| uses | An unordered collection of studentLanguageUses. Language(s) the individual uses to communicate.
| O | N/A | N/A | |
| otherNames | An unordered collection of studentOtherNames. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element reports the student's name from a previous Identity record. This element is an array that reports the following data: | O | N/A | Census > People > Identities | |
| otherNameType | This reports the Other Name Type Ed-Fi value mapped in the Other Name Type table in the section below. | M | N/A | N/A | |
| personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This element is not collected or reported. | C | N/A | N/A | |
| firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. | M | Identity.firstName | Census > People > Identities > First Name | |
| middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony. | C | Identity.middleName | Census > People > Identities > Middle Name | |
| lastSurname | The name borne in common by members of a family. | M | Identity.lastName | Census > People > Identities > Last Name | |
| generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). | C | Identity.suffix | Census > People > Identities > Suffix Name | |
| programParticipations | An unordered collection of studentProgramParticipations. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. This element is not collected or reported. | O | N/A | N/A | |
| races | An unordered collection of studentRaces. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution. Logic reports based on the following:
This element is an array that reports the following data: | O | IdentityRaceEthnicity and Racethnicity.raceId | Census > People > Identities > Race/Ethnicity | |
| raceType | The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. This reports the Ed-Fi value mapped in the Race Type table in the section below. | M | IdentityRaceEthnicity and Racethnicity.raceId | Census > People > Identities > Race/Ethnicity | |
| telephones | An unordered collection of studentTelephones. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program.
| O | N/A | N/A | |
| visas | An unordered collection of studentVisas. This entity represents an individual for whom instruction, services and/or care are provided in an early childhood, elementary or secondary educational program under the jurisdiction of a school, education agency or other institution or program. This element is currently not reported or collected. | O | N/A | N/A | |
| etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A | |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for School Food Services Eligibility Type:
Ed-Fi Code | Short Descrption | Description |
|---|---|---|
| Reduced price | Reduced price | Reduced price |
| Free | Free | Free |
| Full Price | Full Price | Full Price |
| Unknown | Unknown | Unknown |
This table describes the Ed-Fi Value mapped and reported for Student Characteristic Descriptors:
| Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Asylee | Asylee | Asylee |
| Displaced Homemaker | Displaced Homemaker | Displaced Homemaker |
| Foster Care | Foster Care | Foster Care |
| Homeless | Homeless | Homeless |
Immigrant | Immigrant | Immigrant |
| Migrant | Migrant | Migrant |
| Neglected or Delinquent | Neglected or Delinquent | Neglected or Delinquent |
| Parent in Military | Parent in Military | Parent in Military |
| Pregnant | Pregnant | Pregnant |
| Refugee | Refugee | Refugee |
| Runaway | Runaway | Runaway |
| Section 504 Handicapped | Section 504 Handicapped | Section 504 Handicapped |
| Single Parent | Single Parent | Single Parent |
| Unaccompanied Youth | Unaccompanied Youth | Unaccompanied Youth |
This table describes the Ed-Fi Value mapped and reported for Disability Descriptors:
Code Value | Short Description | Description |
|---|---|---|
| Autism Spectrum Disorders | Autism Spectrum Disorders | Autism Spectrum Disorders |
| Deaf-Blindness | Deaf-Blindness | Deaf-Blindness |
| Hearing Impairment, including Deafness | Hearing Impairment, including Deafness | Hearing Impairment, including Deafness |
| Infant/Toddler with a Disability | Infant/Toddler with a Disability | Infant/Toddler with a Disability |
| Intellectual Disability | Intellectual Disability | Intellectual Disability |
| Medical condition | Medical condition | Medical condition |
| Mental impairment | Mental impairment | Mental impairment |
| Motor impairment | Motor impairment | Motor impairment |
| Multiple Disabilities | Multiple Disabilities | Multiple disabilities |
| Orthopedic Impairment | Orthopedic Impairment | Orthopedic Impairment |
| Other Health Impairment | Other Health Impairment | Other Health Impairment |
| Other | Other | Other |
| Physical Disability | Physical Disability | Physical Disability |
| Preschooler with a Disability | Preschooler with a Disability | Preschooler with a Disability |
| Sensory impairment | Sensory impairment | Sensory impairment |
| Serious Emotional Disability | Serious Emotional Disability | Serious Emotional Disability |
| Specific Learning Disability | Specific Learning Disability | Specific Learning Disability |
| Speech or Language Impairment | Speech or Language Impairment | Speech or Language Impairment |
| Traumatic Brain Injury | Traumatic Brain Injury | Traumatic Brain Injury |
| Visual Impairment, including Blindness | Visual Impairment, including Blindness | Visual Impairment, including Blindness |
Student Special Education Program Association
This association represents the Special Education program(s) that a student participates in or receives services from. The association is an extension of the StudentProgramAssociation particular for Special Education programs.
Object Triggering Data
| Action | Trigger |
|---|---|
| Post | When an IEP is created and locked and overlaps a student's enrollment with a valid Student School Association in the current scoped year
|
| Post | When a new enrollment record is createdfor a student who has an active IEP
|
| Delete/Post | When any part of the natural key is changed. When a SPED entry date is changed. |
| Delete | When an IEP is deleted. |
| Delete | When all overlapping enrollments are deleted for a student. |
| Delete | When an IEP is unlocked. |
Scope Year Logic
This table describes the scope year logic of this object.
| Logic |
|---|
A record will report for each year where an active IEP record exists.
|
Object Data Elements
Data Element Labels in bold are part of the Natural Key and are required data elements for Data to send to Ed-Fi
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrganizationReference | A reference to the related EducationOrganization resource. Reports the state school number. If the student has multiple enrollments, values report in the following order:
| M | School.stateSchool Number | System Administration > Resources > School Information > State School Number | |
| programReference | A reference to the related Program resource. Reports the Special Education Program reference. | M | N/A | N/A | |
| studentReference | A reference to the related Student resource.Reports the data that is part of the natural key for the student resource. | M | N/A | N/A | |
| beginDate | The month, day, and year on which the Student first received services.
| M | Plan.startDate | Student Information > Special Ed > General > Documents > Plan > Education Plan Editor > Start Date | |
| endDate | The month, day, and year on which the Student exited the special education program or stopped receiving services. This field is optional and does not report. | O | N/A | N/A | |
| reasonExitedDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. This field is optional and does not report. | O | N/A | N/A | |
| servedOutsideofRegularSession | Indicates whether the student received services during the summer session or between sessions. This field is optional and does not report. | O | N/A | N/A | |
| specialEducationSettingDescriptor | This descriptor defines the major instructional setting (more than 50 percent of a student's special education program).
| O | PlanState. specialEdsetting | Student Information > General > Enrollments > Special Ed Fields > Special Ed Setting Student Information > Special Education > Documents > IEP > Special Ed Setting | |
| ideaEligibility | Indicator of the eligibility of the student to receive special education services according to the Individuals with Disabilities Education Act (IDEA). This field is optional and does not report. | O | N/A | N/A | |
| specialEducationHoursPerWeek | The number of hours per week for special education instruction and therapy. This field is optional and does not report. | O | N/A | N/A | |
| schoolHoursPerWeek | Indicate the total number of hours of instructional time per week for the school that the student attends. This field is optional and does not report. | O | N/A | N/A | |
| multiplyDisabled | Indicates whether the Student receiving special education and related services has been designated as multiply disabled by the admission, review, and dismissal committee as aligned with federal requirements. This field is optional and does not report. | O | N/A | N/A | |
| medicallyFragile | Indicates whether the Student receiving special education and related services is:
This field is optional and does not report. | O | N/A | N/A | |
| lastEvaluationDate | The date of the last special education evaluation. This field is optional and does not report. | O | N/A | N/A | |
| iepReviewDate | The date of the last IEP review. This field is optional and does not report. | O | N/A | N/A | |
| iepBeginDate | Reports the start date of the IEP This field is optional and does not report. | O | N/A | N/A | |
| iepEndDate | Reports the end date of the IEP This field is optional and does not report. | O | N/A | N/A | |
| services | An unordered collection of studentProgramAssociationServices. Indicates the services being provided to the student by the program. This field is an array. This field is optional and does not report. | O | N/A | N/A | |
| serviceProviders | An unordered collection of studentSpecialEducationProgramAssociationServiceProviders. The staff providing Special Education services to the student. This field is an array. This field is optional and does not report. | O | N/A | N/A | |
Type/Descriptors
The highlighted column indicates the reported valued.
This table describes the Ed-Fi Value mapped and reported for Disability Descriptors
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
|---|---|---|
| Correctional Facility | Correctional Facility | Correctional Facility |
| Homebound/Hospital | Homebound/Hospital | Homebound/Hospital |
| Inside reg class between 40% and 79% of the day | Inside reg class between 40% and 79% of the day | Inside reg class between 40% and 79% of the day |
| Inside regular class 80% or more of the day | Inside regular class 80% or more of the day | Inside regular class 80% or more of the day |
| Inside regular class less than 40% of the day | Inside regular class less than 40% of the day | Inside regular class less than 40% of the day |
| Parentally-placed in Private Schools | Parentally-placed in Private Schools | Parentally-placed in Private Schools |
| Residential Facility | Residential Facility | Residential Facility |
| Separate School | Separate School | Separate School |
Student Title I Part A Program Association
This association represents the Title I Part A program(s) that a student participates in or from which the student receives services.
Object Triggering Data
| Action | Trigger |
|---|---|
| Post | When a student is given a Flag with the name 'Title I Part A' and the record overlaps an enrollment with a valid Student School Association in the current scoped year Do not send a student record for an enrollment that is marked as State Exclude or No Show. Do not send a record if enrollment is in a calendar marked as Exclude. Do not send a record if enrollment is in a School marked as Exclude. |
| Delete/Post | When any part of the natural key is changed. When Start Date is changed. |
| Put | When End Date is changed. |
| Delete | When a Flag is deleted or when the record no longer overlaps any reported enrollment in the Scoped Year |
Scope Year Logic
This table describes the scope year logic of this object.
| Logic |
|---|
The record will send to the scope year for the school year the enrollment is associated with |
Object Data Elements
Data Element Labels in bold are part of the Natural Key and are required data elements for Data to send to Ed-Fi
| Data Element | Description | Campus Database Field | Campus GUI Location | ||
|---|---|---|---|---|---|
| id | The unique identifier of the resource. | M | N/A | N/A | |
| educationOrganizationReference | A reference to the related EducationOrganization resource.
| M | N/A | N/A | |
| programReference | A reference to the related Program resource. | M | N/A | N/A | |
| studentReference | A reference to the related Student resource. Reports the data that is part of the natural key for the student resource. | M | N/A | N/A | |
| beginDate | The month, day, and year on which the Student first received services.
| M | Student Information > General >Flags > Start Date | ||
| endDate | The month, day, and year on which the Student exited the program or stopped receiving services.
| O | dent Information > General >Flags > End Date | ||
| reasonExitedDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. This field is optional and does not report. | O | N/A | N/A | |
| servedOutsideofRegularSession | Indicates whether the student received services during the summer session or between sessions. This field is optional and does not report. | O | N/A | N/A | |
| titleIPartAParticipantType | An indication of the type of Title I program, if any, in which the student is participating and served: Public Targeted Assistance Program Public Schoolwide Program Private school student participating Local Neglected Program NEDM: Title I Participant
| System Administration> Resources> School> Title 1 | |||
| services | An unordered collection of studentProgramAssociationServices. Indicates the services being provided to the student by the program. This field is an array. This field is optional and does not report. | O | N/A | N/A | |
Type/Descriptors
The highlighted column indicates the reported valued.
This table describes the Ed-Fi Value mapped and reported for Title 1 Part A Participant Type
| Code Value | Short Description | Description |
|---|---|---|
| Public Targeted Assistance Program | Public Targeted Assistance Program | Public Targeted Assistance Program |
| Public Schoolwide Program | Public Schoolwide Program | Public Schoolwide Program |
| Private school students participating | Private school students participating | Private school students participating |
| Local Neglected Program | Local Neglected Program | Local Neglected Program |
| Was not served | Was not served | Was not served |
Additional Logic and Considerations
The following describes additional logic and considerations to be aware of when working with Ed-Fi.
AzEDS
| Attendance | Only attendance that is “verified” will send to Ed-Fi. Unknown records marked by a teacher will not send. Negative attendance will send when it is given an excuse code. |
| No Show/Excludes | If the State Exclude or No Show buttons are marked or unmarked on an enrollment the record, they will be deleted/added from Ed-Fi. |
| Required Fields | The Room number on the Section editor will become required once Ed-Fi is enabled. This data is required for the section data to send to Ed-Fi. Do a check on all course sections prior to doing a resync on the Schedule Data to verify all sections have a Room number. |
