Classic View: System Administration > Ed-Fi
Search Terms: Ed-Fi
This article defines all of the elements of data sent per entity between Campus and the Ed-Fi system.
- Future data is suppressed when syncing data from Campus to Ed-Fi. Only past and present data is synced.
- Data in 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.
See the following articles for more information about setting up Ed-Fi within Campus:
An entity is a collection of related data which is sent in a cluster of data elements from Campus to Ed-Fi. Select the following links to view what data elements are contained and sent within that entity:
- Staff Education Organization Assignment Association
- Staff Education Organization Employment Association
- Staff Education Organization Identity Associations
- Staff
- Staff School Association
- Student Academic Record
- Student Cohort Association
- Student CTE Program Association
- Student Discipline Incident Association
- Student Parent Association
- Student Program Associations
- Student School Association
- Student School Attendance Event
- Student Section Association
- Student Section Attendance Event
- Student
- Student Special Education Program Association
- Student Title 1 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.
Image 1: Example of an Object Triggering Logic Table
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 by ADE. 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.
Image 2: Example of a Object Data Elements Table
UnderstandType/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.
Image 3: Example of a Type/Descriptor Table
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 check box is checked.
|
Put | When a Day Event or Duration is changed and saved. |
Delete | When the Instruction check box 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 that the 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 Calendar Dates resource.
Data Element | Description | Campus Database Field | Campus GUI Location | ||
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | |||
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 hold 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 | 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 |
---|---|---|
Emergency day | Emergency day | Emergency day |
Holiday | Holiday | Holiday |
Instructional day | Instructional day | Instructional day |
Make-up day | Make-up day | Make-up day |
Other | Other | Other |
Student late arrival/early dismissal | Student late arrival/early dismissal | Student late arrival/early dismissal |
Weather day | Weather day | Weather day |
Teacher only day | Teacher only day | Teacher only day |
Strike | Strike | Strike |
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 that the 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 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.entityID | System Administration > Resources > School > Entity ID |
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 |
etag | A unique system-generated value that identifies the version of the resource. | O | N/A | N/A |
Cohorts
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 Program Session is added and is mapped to a Cohort Type.
|
Put | When the Category or Description changes. |
Post/Delete | When the Program mapping changes. |
Delete | When 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 (educationOrganizationId contained in this property) | A reference to the related EducationOrganization resource. Reports the State District number. | M | district.number | System Administration > Resources > District Information > State District Number |
identifier | The name or ID for the cohort. Reports the Program Session ID. | M | programsession. programSessionID | Program Admin > Programs > Program > Program Sessions ID |
description | The description of the cohort and its purpose.
| O | program.description | Program Admin > Program s> Programs> 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 | ||
scopeType | The scope of cohort (e.g., campus, district, classroom).
| O | program.program Category | Program Admin > Program s> Programs > Category |
academicSubjectDescriptor | The subject for an academic intervention (e.g., science, mathematics) | O | N/A | N/A |
programs | An unordered collection of cohort programs. The optional program associated with this cohort (e.g., Special Education) | 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 Cohort Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
Academic Intervention | Academic Intervention | Academic Intervention |
Attendance Intervention | Attendance Intervention | Attendance Intervention |
Discipline Intervention | Discipline Intervention | Discipline Intervention |
Classroom Pullout | Classroom Pullout | Classroom Pullout |
Extracurricular Activity | Extracurricular Activity | Extracurricular Activity |
Field Trip | Field Trip | Field Trip |
Principal Watch List | Principal Watch List | Principal Watch List |
Counselor List | Counselor List | Counselor List |
In-school Suspension | In-school Suspension | In-school Suspension |
Study Hall | Study Hall | Study Hall |
Other | Other | Other |
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 |
---|---|---|
District | District | District |
School | School | School |
Network | Network | Network |
Classroom | Classroom | Classroom |
Teacher | Teacher | Teacher |
Principal | Principal | Principal |
Counseleor | Counselor | Counselor |
Statewide | Statewide | Statewide |
Other | Other | Other |
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 Placement is created and saved.
|
Post | When the Local Course Number or Term type Override is changed. |
Put | When Course information is changed and saved.
|
Delete | When a section is deleted. |
Delete | When a section schedule placement is removed and saved. |
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 course offerings for the scope year the courses 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 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 > Entity ID |
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 plannned 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.
|
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 will only delete when a student has only 1 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. Look at the Score Group where from the Current Score posted on the transcript record and report the following:
| M | TranscriptCourse.score Scorelistitem.passingScore Scorelistitem.statescore | Student Information > General > Transcripts > Score Grading Standards > Score Groups & Rubrics > State Score | |
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 System Administration > Calendar > Calendar > Grade Levels > Grade Level Detail > State Grade Level Code | |
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.
| O | Transcriptcourse.score Scorelistitem.passingScore Scorelistitem.statescore | Student Information > General > Transcripts > Current Score Grading Standards > Score Groups & Rubrics > State Score | |
finalNumericGradeEarned | The final numeric grade earned for the course. Look at the Score Group where from the Current Score posted on the transcript record and report the following:
| O | Transcriptcourse.score Scorelistitem.passingScore Scorelistitem.statescore | Student Information > General > Transcripts > Current Score Grading Standards> Score Groups & Rubrics> State 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 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 Course Attempt Result Type:
Ed-Fi Short Description | Ed-Fi Description |
---|---|
Pass | Pass |
Fail | Fail |
Incomplete | Incomplete |
Withdrawn | Withdrawn |
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 |
---|---|
Get | No Trigger, this is a look-up as Courses are pre-loaded by DOE. |
Only courses with State Course Codes will send data.
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 following elements that are part of the Natural Key for the Schools resource:
| 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. The State Course Number is reported. | M | Course.stateCode | Scheduling > Course > State Code |
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 N field is reported. This field reports a default value of 1 for all courses. | 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.
| O | Data is preloaded by the State | Data is preloaded by the State |
description | A description of the content standards and goals covered in the course. Reference may be made to state or national content standards. | O | Data is preloaded by the State | Data is preloaded by the State |
dateCourseAdopted | The date the district adopted the course. | O | Data is preloaded by the State | Data is preloaded by the State |
highSchoolCourse Requirement | An indication that this course credit is required for a high school diploma. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
definedByType | Specifies whether the course was defined by the SEA, LEA, school or national organization. | O | Data is preloaded by the State | Data is preloaded by the State |
minimumAvailable CreditType | The type of credits or units of value awarded for the completion of a course. | O | Data is preloaded by the State | Data is preloaded by the State |
minimumAvailable CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units | O | Data is preloaded by the State | Data is preloaded by the State |
minimumAvailable Credit | The minimum amount of credit available to a student who successfully completes the course. | O | Data is preloaded by the State | Data is preloaded by the State |
maximumAvailable CreditType | The type of credits or units of value awarded for the completion of a course. | O | Data is preloaded by the State | Data is preloaded by the State |
maximumAvailable CreditConversion | Conversion factor that when multiplied by the number of credits is equivalent to Carnegie units. | O | Data is preloaded by the State | Data is preloaded by the State |
maximumAvailable Credit | The maximum amount of credit available to a student who successfully completes the course. | O | Data is preloaded by Arizona | Data is preloaded by the State |
careerPathwayType | The career cluster or pathway representing the career path of the Vocational/CTE concentrator. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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. | O | Data is preloaded by the State | Data is preloaded by the State |
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:
State Code | Name | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
EL | Elementary | EL | Elementary Core Subject | Elementary Core Subject |
FA | Fine and Performing Arts | FA | Fine and Performing Arts | Fine and Performing Arts |
FL | Foreign Language | FL | Foreign Language and Literature | Foreign Language and Literature |
LA | English and Language Arts | LA | English Language Arts | English Language Arts |
MA | Math | MA | Mathematics | Mathematics |
NA | Non Academic (Attendance, etc) | NA | Non Academic | Non Academic |
OT | Other (ROTC, Driver's Ed, etc) | OT | Other Academic | Other Academic |
PE | Physical Education and Health | PE | Physical, Health, and Safety Education | Physical, Health, and Safety Education |
RE | Reading | RE | Reading | Reading |
SC | Science | SC | Science | Science |
SS | Social Studies and History | SS | Social Studies | Social Studies |
VE | Vocational Education | VE | Career and Technical Education | Career and Technical Education |
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 that 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. This is optional and does not report. | O | N/A | N/A | |
actualDiscipline ActionLength | The length of time in school days for the Discipline Action (e.g. removal, detention), if applicable. This is optional and does not report. | O | N/A | N/A | |
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. 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. | 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 |
---|---|---|
Removal from Classroom | Removal from Classroom | Removal from Classroom |
I | In School Suspension | In School Suspension |
O | Out of School Suspension | Out of School Suspension |
E | Expulsion (No Educational Services Provided) | Expulsion (No Educational Services Provided) |
S | Expulsion (Educational Services Provided) | Expulsion (Educational Services Provided) |
Community Service | Community Service | Community Service |
R | Other | Other |
A | Alternative Placement by School Personnel | Alternative Placement by School Personnel |
H | Alternative Placement by Hearing Officer due to IDEA | Alternative Placement by Hearing Officer due to IDEA |
J | Juvenile Court System | Juvenile Court System |
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"
|
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. This is optional and does not report. | O | N/A | N/A | |
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. This is optional and does not report. | O | N/A | N/A | |
reporterName | Identifies the reporter of the incident by name. This is optional and does not report. | 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 |
---|---|---|
School Violation | School Violation | School Violation |
State Offense | State Offense | State Offense |
School Code of Conduct | School Code of Conduct | School Code of Conduct |
Other | Other | Other |
This table describes the Ed-Fi Value mapped and reported for Incident Location Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
On campus | On campus | On campus |
Off campus | Off campus | Off campus |
School bus | School bus | School bus |
Grade
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 mapped to an Ed-Fi Grade Type.
|
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 | When the No Show or State Exclude check boxes are checked. |
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 resource.
| 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 mapping for the Grading Task. If the grading task is not mapped, do not report. 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 |
---|---|---|
1 | Conduct | Conduct |
2 | Exam | Exam |
3 | Final | Final |
4 | Grading Period | Grading Period |
5 | Mid-Term Grade | Mid-Term Grade |
6 | Progress Report | Progress Report |
7 | 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 an 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.
Grading Periods cannot be deleted in WY due to the Dependency of the core Ed-Fi model where it is required for Sessions report grading periods.
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 | When a Grading Period is deleted.
|
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
Reports the grading periods in the scope year that the calendar is aligned to.
|
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 | edfigradingperiod.start | 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 | dfigradingperiod.endDate | 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 | edfigradingperiod.name | 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. This element is optional and does not report. | O | term.seq | System Administration> Calendar> Terms> Seq |
_etag | N/A | 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 Grading Period Descriptor:
State Code | Name | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
01 | First Six Weeks | First Six Weeks | First Six Weeks | First Six Weeks |
02 | Second Six Weeks | Second Six Weeks | Second Six Weeks | Second Six Weeks |
03 | Third Six Weeks | Third Six Weeks | Third Six Weeks | Third Six Weeks |
04 | Fourth Six Weeks | Fourth Six Weeks | Fourth Six Weeks | Fourth Six Weeks |
05 | Fifth Six Weeks | Fifth Six Weeks | Fifth Six Weeks | Fifth Six Weeks |
06 | Sixth Six Weeks | Sixth Six Weeks | Sixth Six Weeks | Sixth Six Weeks |
07 | First Nine Weeks | First Nine Weeks | First Nine Weeks | First Nine Weeks |
08 | Second Nine Weeks | Second Nine Weeks | Second Nine Weeks | Second Nine Weeks |
09 | Third Nine Weeks | Third Nine Weeks | Third Nine Weeks | Third Nine Weeks |
10 | Fourth Nine Weeks | Fourth Nine Weeks | Fourth Nine Weeks | Fourth Nine Weeks |
11 | First Four Weeks | First Four Weeks | First Four Weeks | First Four Weeks |
12 | Second Four Weeks | Second Four Weeks | Second Four Weeks | Second Four Weeks |
13 | Third Four Weeks | Third Four Weeks | Third Four Weeks | Third Four Weeks |
14 | Fourth Four Weeks | Fourth Four Weeks | Fourth Four Weeks | Fourth Four Weeks |
15 | Fifth Four Weeks | Fifth Four Weeks | Fifth Four Weeks | Fifth Four Weeks |
16 | Sixth Four Weeks | Sixth Four Weeks | Sixth Four Weeks | Sixth Four Weeks |
17 | Seventh Four Weeks | Seventh Four Weeks | Seventh Four Weeks | Seventh Four Weeks |
18 | Eighth Four Weeks | Eighth Four Weeks | Eighth Four Weeks | Eighth Four Weeks |
19 | Ninth Four Weeks | Ninth Four Weeks | Ninth Four Weeks | Ninth Four Weeks |
20 | First Semester | First Semester | First Semester | First Semester |
21 | Second Semester | Second Semester | Second Semester | Second Semester |
22 | First Trimester | First Trimester | First Trimester | First Trimester |
23 | Second Trimester | Second Trimester | Second Trimester | Second Trimester |
24 | Third Trimester | Third Trimester | Third Trimester | Third Trimester |
25 | End of Year | End of Year | End of Year | End of Year |
26 | Summer Semester | Summer Semester | Summer Semester | Summer Semester |
27 | First Summer Session | First Summer Session | First Summer Session | First Summer Session |
28 | Second Summer Session | Second Summer Session | Second Summer Session | Second Summer Session |
29 | Third Summer Session | Third Summer Session | Third Summer Session | Third Summer Session |
30 | First Grading Period | First Grading Period | First Grading Period | First Grading Period |
31 | Second Grading Period | Second Grading Period | Second Grading Period | Second Grading Period |
32 | Third Grading Period | Third Grading Period | Third Grading Period | Third Grading Period |
33 | Fourth Grading Period | Fourth Grading Period | Fourth Grading Period | Fourth Grading Period |
34 | Fifth Grading Period | Fifth Grading Period | Fifth Grading Period | Fifth Grading Period |
35 | Sixth Grading Period | Sixth Grading Period | Sixth Grading Period | Sixth Grading Period |
36 | Seventh Grading Period | Seventh Grading Period | Seventh Grading Period | Seventh Grading Period |
37 | Eighth Grading Period | Eighth Grading Period | Eighth Grading Period | Eighth Grading Period |
38 | Ninth Grading Period | Ninth Grading Period | Ninth Grading Period | Ninth Grading Period |
39 | Tenth Grading Period | Tenth Grading Period | Tenth Grading Period | Tenth Grading Period |
40 | Eleventh Grading Period | Eleventh Grading Period | Eleventh Grading Period | Eleventh Grading Period |
41 | Twelfth Grading Period | Twelfth Grading Period | Twelfth Grading Period | Twelfth Grading Period |
This table describes the Ed-Fi Value mapped and reported for Grading Type:
State Code | Name | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
CO | Conduct | Conduct | Conduct | Conduct |
EX | Exam | Exam | Exam | Exam |
FI | Final | Final | Final | Final |
GP | Grading Period | Grading Period | Grading Period | Grading Period |
MID | Mid-Term Grade | Mid-Term Grade | Mid-Term Grade | Mid-Term Grade |
PRO | Progress Report | Progress Report | Progress Report | Progress Report |
SE | Semester | Semester | Semester | Semester |
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 | 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:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
CTE | 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 School 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. | 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 check box is checked 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. This is optional and does not report. | 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 any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services or benefits through federal, state or local agencies. Programs may also include organized extracurricular activities for students.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | Special Education:
|
Post | Career and Technical Education:
|
Post | Title I Part A:
|
Post | EL: When an EL record is active for a student in the scope year.
|
Scope Year Logic
This table describes logic for triggering syncing of this object.
Logic |
---|
Special Education: Record will report for each year in which there is a locked "WY" IEP
|
Career and Technical Education: Record will report for each year where an active and state reported Career Tech Program is assigned to a student
|
Title I Part A: Record will report for each year in which there is a student with Title 1 = Checked.
|
Early Learning (EL): Record will report for the year(s) in which a student has an active EL record.
|
Data will only send for the years that have valid configuration. |
Object Data Elements
This table describes data elements sent within the Programs resource.
Data Element | Description | Campus Database Field | Campus GUI Location | |
---|---|---|---|---|
id | N/A | M | N/A | N/A |
educationOrganization Reference | Reports the following elements that are part of the Natural Key for the EducationOrganization resource.
| M | CustomDistrict. value | System Administration > Resources > District Information > State District ID |
type | Reports the Program Type from the short description based on the program the student participates. See the Program Types table in the Type/Description section below. Special Education:
Career and Technical Education:
Title I Part A:
Early Learning (EL):
| M | N/A | N/A |
name | The formal name of the program of instruction, training, services or benefits available through federal, state, or local agencies. Special Education:
CTE Program:
Title I Part A:
Early Learning (EL):
| M | N/A | N/A |
Type/Descriptors
This table describes the Ed-Fi Value mapped and reported for Program Types.
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Long Description |
---|---|---|
CTE Program | Career and Technical Education | Career and Technical Education |
SPED | SPED | SPED |
Title 1 Part A | Title 1 Part A | Title 1 Part A |
English as a Second Language (ESL) | English as a Second Language (ESL) | English as a Second Language (ESL) |
This table describes the Ed-Fi Value mapped and reported for Program Types.
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Long Description |
---|---|---|
CTE Program | Career and Technical Education | Career and Technical Education |
SPED | SPED | SPED |
Title 1 Part A | Title 1 Part A | Title 1 Part A |
English as a Second Language (ESL) | English as a Second Language (ESL) | English as a Second Language (ESL) |
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. Logic reports the Ed-Fi Code value from the Instructional Setting selected on the course section being reported. If NULL, do not report This element does not report in Wyoming. | O | Section. instructionalSetting | Scheduling > Course > Section > Instructional Setting | |
mediumO fInstructionType | The media through which teachers provide instruction to students and students and teachers communicate about instructional matters. This element is optional and does not report. | 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. This reports when the following are added:
This element does not report in Wyoming. | 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. 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/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 | |
---|---|---|---|
Report the Ed-Fi Code Value when the Attendance and/or Positive Attendance is checked on the course | 01 | Attendance Tracked | Attendance Tracked |
Report the Ed-Fi Code Value when the Course has a grading task assigned to the course | 02 | Graded Credit | Graded Credit Available |
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 | |
---|---|---|---|
Report the Ed-Fi Code Value when the Attendance and/or Positive Attendance is checked on the course | 01 | Attendance Tracked | Attendance Tracked |
Report the Ed-Fi Code Value when the Course has a grading task assigned to the course | 02 | Graded Credit | Graded Credit Available |
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 marked as Exclude.
Action | Trigger |
---|---|
Post | When a new Term Schedule 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.
|
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. |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
Reports Sessions for the scope year the 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 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. This element reports the Schedule Structure + Term Name with a - separating the names (e.g., Main - Term 1). | 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:
Code | Name | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
CO | Continuous | Continuous | Continuous | Continuous |
1S | Fall Semester | Fall Semester | Fall Semester | Fall Semester |
2S | Spring Semester | Spring Semester | Spring Semester | Spring Semester |
SS | Summer Semester | Summer Semester | Summer Semester | Summer Semester |
1T | First Trimester | First Trimester | First Trimester | First Trimester |
2T | Second Trimester | Second Trimester | Second Trimester | Second Trimester |
3T | Third Trimester | Third Trimester | Third Trimester | Third Trimester |
FY | Full Year | Full Year | Full Year | Full Year |
MT | MiniTerm | MiniTerm | MiniTerm | MiniTerm |
1Q | First Quarter | First Quarter | First Quarter | First Quarter |
2Q | Second Quarter | Second Quarter | Second Quarter | Second Quarter |
3Q | Third Quarter | Third Quarter | Third Quarter | Third Quarter |
4Q | Fourth Quarter | Fourth Quarter | Fourth Quarter | Fourth Quarter |
OT | Other | Other | Other | Other |
8M | Eighth MiniTerm | Eighth MiniTerm | Eighth MiniTerm | Eighth MiniTerm |
11M | Eleventh MiniTerm | Eleventh MiniTerm | Eleventh MiniTerm | Eleventh MiniTerm |
5M | Fifth MiniTerm | Fifth MiniTerm | Fifth MiniTerm | Fifth MiniTerm |
1M | First MiniTerm | First MiniTerm | First MiniTerm | First MiniTerm |
4M | Fourth MiniTerm | Fourth MiniTerm | Fourth MiniTerm | Fourth MiniTerm |
9M | Ninth MiniTerm | Ninth MiniTerm | Ninth MiniTerm | Ninth MiniTerm |
2M | Second MiniTerm | Second MiniTerm | Second MiniTerm | Second MiniTerm |
7M | Seventh MiniTerm | Seventh MiniTerm | Seventh MiniTerm | Seventh MiniTerm |
6M | Sixth MiniTerm | Sixth MiniTerm | Sixth MiniTerm | Sixth MiniTerm |
10M | Tenth MiniTerm | Tenth MiniTerm | Tenth MiniTerm | Tenth MiniTerm |
3M | Third MiniTerm | Third MiniTerm | Third MiniTerm | Third MiniTerm |
12M | Twelfth MiniTerm | Twelfth MiniTerm | Twelfth MiniTerm | Twelfth MiniTerm |
Staff Cohort Association
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.
|
Put | When the end date is updated on the Program Sessions tab. |
Delete/Post | When any part of the Natural Key changes. |
Delete | When the Program Session is deleted. |
Delete | When staff is removed from the "Instructor" field. |
Object Data Elements
This table describes data elements sent within the Staff 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 (educationOrganizationId contained in this property) | Reports the the Natural Key of the Cohort resource. | M | district.number | System Admin > Resources > District Information > District Detail > State District Number |
staffreference | Reports the the Natural Key of the Staff resource. | M | ||
beginDate | The month, day, and year on which the Staff was first identified as part of the Cohort. Reports the Start Date the staff is assigned to the Program Session. | O | programSession.startdate | Programs Admin > Programs > Program Sessions > Start Date |
endDate | The month, day, and year on which the Staff was removed as part of the Cohort.
| O | programSession.enddate | Programs Admin > Programs > Program Sessions > End Date |
studentRecordAccess | 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 |
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 checkbox checked and a District Assignment Code populated. OR When a person has a District Assignment record and the District Staff checkbox is not checked. |
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 | If there are two District Assignment records that create the same natural Key and 1 is Deleted, the remaining record will be posted. |
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 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. edFiOrgTitle | Census > People> District Employment > Ed-Fi Org Title > Ed-Fi 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 this 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.
The Data Dictionary for Ed Org Title/Staff Classification is an unlocked list that is managed by the districts.
To create a new or modify an existing Ed-Fi Org Title Code:
- When Ed-Fi Org Title Code on District Employment is not null, a record will be sent for that employee.
- When Ed-Fi Org Title Code on District Employment is null, a record will not be sent for that employee
Field Logic :
- When Ed-Fi Org Title's Standard code = 000, the educationOrganizationReference will report 000.
- When Ed-Fi Org Title's Standard code = NA, the Position Title will report blank. Else, Position Title will report the ED-Fi Short description which is the Name field in the data dictionary.
Staff Education Organization Employment Association
This association indicates the education organization an employee, contractor, volunteer or other service provider is formally associated with typically indicated by which organization the staff member has a services contract with or receives compensation from.
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 When a person has a District Assignment record and the District Staff check box is not checked. |
Do NOT report a record if any one of the following scenarios are true:
| |
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 | If there are two District Assignment records that create the same natural Key and 1 is Deleted, the remaining record will be posted. |
Delete | When a District Assignment record is deleted. |
Delete | When a District Employment record is deleted. |
Delete | When a District Employment record > District Staff checkbox is removed, 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. |
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. |
Object Data Elements
This table describes data elements sent within the Staff Education Organization Employment 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 | Logic first looks to District Employment > District Employment > Ed-Fi Org Title droplist. When District Employment > Ed-Fi Org Title's Standard Code = 000, report EdOrgRef with District Number.
| M | N/A | System Administration> Resources> District Information> State District Number OR System Administration> Resources> School> State School Number |
staffReference | Reports the data that is part of the Natural Key for the Staff resource:
| M | N/A | N/A |
employmentStatus Descriptor | This descriptor defines the type of employment or contract.
| M | Employment assignment.type | Census > People > District Assignment > Type |
hireDate | The month, day, and year on which a contract between an individual and a governing authority specifies that employment is to begin (or the date on which the agreement is made valid).
| M | Employment assignment.startDate | Census > People > District Assignment > Start Date |
endDate | The month, day, and year on which a contract between an individual and a governing authority ends or is terminated under the provisions of the contract (or the date on which the agreement is made invalid).
| O | Employment assignment.endDate | Census > People > District Assignment > End Date |
separationType | The type of employment separation (e.g., Voluntary separation, Involuntary separation, Mutual agreement, Other, etc). This is not collected within Campus and is not reported. | O | N/A | N/A |
separationReason Descriptor | This descriptor defines the reasons for terminating the employment. This is not collected within Campus and is not reported. | O | N/A | N/A |
department | The department or su-organization the employee/contractor is associated with in the Education Organization. This is not collected within Campus and is not reported. | O | N/A | N/A |
fullTimeEquivalency | The ratio between the hours of work expected in a position and the hours of work normally expected in a full-time position in the same setting. This is not collected within Campus and is not reported. | O | N/A | N/A |
offerDate | Date at which the staff member was made an official offer for this employment. This is not collected within Campus and is not reported. | O | N/A | N/A |
hourlyWage | Hourly wage associated with the employment position being reported. This is not collected within Campus and 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 Employment Status Descriptors:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
Probationary | Probationary | Probationary |
Contractual | Contractual | Contractual |
Substitute/temporary | Substitute/temporary | Substitute/temporary |
Tenured or permanent | Tenured or permanent | Tenured or permanent |
Volunteer/no contract | Volunteer/no contract | Volunteer/no contract |
Employed or affiliated with outside organization | Employed or affiliated with outside organization | Employed or affiliated with outside organization |
Non-contractual | Non-contractual | Non-contractual |
Employed part-time | Employed part-time | Employed part-time |
Employed or affiliated with outside agency part-time | Employed or affiliated with outside agency part-time | Employed or affiliated with outside agency part-time |
Other | Other | Other |
Staff Education Organization Identity Associations
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 if any one of the following scenarios are true:
|
Put | When any data is edited for the person in the Data Elements fields below. |
Put | When the person’s employment assignment record is changed. |
Put | When the person’s employment record is changed. |
Delete | We will not send any deletes for this resource. |
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 |
Report when a staff has an active District Assignment or District Employment 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 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 Staff Education Organization Identity Associations 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. | M | N/A | System Administration > Resources > District Info > District Editor > District Detail > State District Number System Administration > Resources > School > Entity ID | |
staffReference/staffUniqueId | A reference to the related Staff resource. | M | N/A | N/A | |
electronicMailAddress | The electronic mail (e-mail) address listed for an individual or organization. | M | N/A | Census > People > Demographics > Personal Contact Info > Email | |
telephones | An unordered collection of staffEducationOrganizationIdentityAssociationTelephones. The 10-digit telephone number, including the area code, for the person. | O | N/A | N/A | |
TelephoneNumberType | The type of communication number listed for an individual or organization. Only report when the applicable UI field is NOT = Null:
| M | N/A | Census > People > Demographics > Personal Contact Info | |
TelephoneNumber | The telephone number including the area code, and extension, if applicable. | M | N/A | Census > People > Demographics > Personal Contact Info | |
OrderOfPriority | Optional and does not report | O | N/A | N/A | |
TextMessageCapabilityIndicator | 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 |
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. OR When a person has a District Assignment record that overlaps the configured year and they have an Ed-Fi ID. |
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 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 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 form 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 form 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 form 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 Types 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 Census> People> Demographics> Secondary Email | |
electronicMailType | This element reports the Electric Mail mapping. The Email (primary) address reports as 'Work'. The Secondary Email address reports as 'Home/Personal'. | 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 Census> People> Demographics> Secondary 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. This element reports the State Staff ID and/or the License Number form the District Employment record. If License Number on the District Employment record is null, the License Number form the Credentials tab is reported if is a value of Licensure/Certification. If the Local Staff Number is populated, this value is reported. Scope Year logic is used to determine the Scope Year to post or update. See the Staff Identification System Type 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 | N/A | Census > People >Demographics > State Staff ID and/or Census > People > District Employment > License or Credentials > License Number | |
Staff Identification System Type | This element reports the short description from the Staff Identification Code mapping described in the table and section below. | M | N/A | N/A | |
Assigning Organization Identification Code | The organization code or name assigning the Staff Identification Code. | 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 | N/A | N/A | |
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 |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Level of Education Descriptors:
Code in Campus | Name in Campus | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
HS | High School Diploma | N | None | None |
GED | GED or Equivalent | N | None | None |
A | Associates | A | Associates | Associates Degree (two years or more) |
AA | Associate of Arts (A.A.) | A | Associates | Associates Degree (two years or more) |
AS | Associate of Science (A.S.) | A | Associates | Associates Degree (two years or more) |
AAS | Associate of Applied Science (A.A.S.) | A | Associates | Associates Degree (two years or more) |
B | Bachelors | B | Bachelor's | Bachelor's |
BA | Bachelor of Arts (B.A.) | B | Bachelor's | Bachelor's |
BS | Bachelor of Science (B.S.) | B | Bachelor's | Bachelor's |
BFA | Bachelor of Fine Arts (B.F.A.) | B | Bachelor's | Bachelor's |
BBA | Bachelor of Business Administration (B.B.A.) | B | Bachelor's | Bachelor's |
BED | Bachelor of Education (B.Ed.) | B | Bachelor's | Bachelor's |
FPD | First Professional Degree | M | Master's | Master's |
M | Masters | M | Master's | Master's |
MA | Master of Arts (M.A.) | M | Master's | Master's |
MS | Master of Science (M.S.) | M | Master's | Master's |
MED | Master of Education (M.Ed.) | M | Master's | Master's |
MBA | Master of Business Administration (M.B.A.) | M | Master's | Master's |
CAGS | Certificate in Advanced Graduate Study | B | Bachelor's | Bachelor's |
JD | Juris Doctor | D | Doctorate | Doctorate |
EDD | Educational Doctorate (Ed.D.) | D | Doctorate | Doctorate |
EDS | Educational Specialist (Ed.S.) | D | Doctorate | Doctorate |
PHD | Doctor of Philosophy (Ph.D.) | D | Doctorate | Doctorate |
MD | Doctor of Medicine (MD) | D | Doctorate | Doctorate |
PSD | Doctor of Psychology (Psy.D.) | D | Doctorate | Doctorate |
This table describes the Ed-Fi Value mapped and reported for Level of Education Descriptors (District Employment):
Code in Campus | Campus Name | Ed-Fi Code | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
1 | Doctorate | D | Doctorate | Doctorate |
2 | Master's degree 30+ semester hrs | M | Masters | Masters |
3 | Master's degree | M | Masters | Masters |
4 | Bachelor's degree 30+ semester hrs | B | Bachelors | Bachelors |
5 | Bachelor's degree | B | Bachelors | Bachelors |
6 | Less than bachelor's degree | N | None | None |
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:
| |
Put | N/A, a delete and insert occurs when any field is edited and saved. |
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 default value of Regular Education is reported if no program name is assigned. See the Program Assignment Descriptors table in the Type/Descriptor section below. | 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 | N/A | N/A |
gradeLevels | An unordered collection of staffSchoolAssociationGradeLevels. This association indicates the school(s) to which a teacher provides instructional services. | 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 Program Assignment Descriptors:
Ed-Fi Code | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
Bilingual/English as a Second Language | Bilingual/English as a Second Language | Bilingual/English as a Second Language |
Regular Education | Regular Education | Regular Education |
Other | Other | Other |
Title I-Non-Academic | Title I-Non-Academic | Title I-Non-Academic |
Special Education | Special Education | Special Education |
Title I-Academic | Title I-Academic | Title I-Academic |
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.
|
Delete | 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 check boxes 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. |
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 | ||
---|---|---|---|---|---|
N/Aid | 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. Reports the end year for the transcript record being reported | 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. This is optional and does not report. | 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. This is optional and does not report. | O | N/A | N/A | |
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 Term Descriptor:
Code | Name | Ed-Fi Code | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
1Q | First Quarter | First Quarter | First Quarter | First Quarter |
2Q | Second Quarter | Second Quarter | Second Quarter | Second Quarter |
3Q | Third Quarter | Third Quarter | Third Quarter | Third Quarter |
4Q | Fourth Quarter | Fourth Quarter | Fourth Quarter | Fourth Quarter |
1S | Fall Semester | Fall Semester | Fall Semester | Fall Semester |
2S | Spring Semester | Spring Semester | Spring Semester | Spring Semester |
SS | Summer Semester | Summer Semester | Summer Semester | Summer Semester |
1T | First Trimester | First Trimester | First Trimester | First Trimester |
2T | Second Trimester | Second Trimester | Second Trimester | Second Trimester |
3T | Third Trimester | Third Trimester | Third Trimester | Third Trimester |
FY | Full Year | Full Year | Full Year | Full Year |
MT | MiniTerm | MiniTerm | MiniTerm | MiniTerm |
CO | Continuous | Continuous | Continuous | Continuous |
OT | Other | Other | Other | Other |
8M | Eighth MiniTerm | Eighth MiniTerm | Eighth MiniTerm | Eighth MiniTerm |
11M | Eleventh MiniTerm | Eleventh MiniTerm | Eleventh MiniTerm | Eleventh MiniTerm |
5M | Fifth MiniTerm | Fifth MiniTerm | Fifth MiniTerm | Fifth MiniTerm |
1M | First MiniTerm | First MiniTerm | First MiniTerm | First MiniTerm |
4M | Fourth MiniTerm | Fourth MiniTerm | Fourth MiniTerm | Fourth MiniTerm |
9M | Ninth MiniTerm | Ninth MiniTerm | Ninth MiniTerm | Ninth MiniTerm |
2M | Second MiniTerm | Second MiniTerm | Second MiniTerm | Second MiniTerm |
7M | Seventh MiniTerm | Seventh MiniTerm | Seventh MiniTerm | Seventh MiniTerm |
6M | Sixth MiniTerm | Sixth MiniTerm | Sixth MiniTerm | Sixth MiniTerm |
10M | Tenth MiniTerm | Tenth MiniTerm | Tenth MiniTerm | Tenth MiniTerm |
3M | Third MiniTerm | Third MiniTerm | Third MiniTerm | Third MiniTerm |
12M | Twelfth MiniTerm | Twelfth MiniTerm | Twelfth MiniTerm | Twelfth MiniTerm |
Student Cohort Association
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 in the configured year and they have a valid Student School Association in the current scoped year.
|
Put | When the end date is updated on the Student's Programs tab. |
Delete/Post | When 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 | When the Program Participation record is deleted. |
Object Data Elements
This table describes data elements sent within the Staff 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 (educationOrganizationId contained in this property) | Reports the the Natural Key of the Cohort resource. | M | district.number | System Admin > Resources > District Information > District Detail > State District Number |
studentreference | Reports the the Natural Key of the Studentresource. | M | ||
beginDate | The month, day, and year on which the student was first identified as part of the Cohort. Reports the Start Date the student was assigned to 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 | 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 |
Student CTE Program Association
This association represents the CTE program(s) that a student participates in or from which the student receives services.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When a Career Tech Program is assigned to the student and the record Start Date is not after the student's enrollment End Date in the current calendar.
|
Post/Delete | When the Program Name or careerPathwayType or the Start Date values are changed, the old record must be deleted, and a new Post must occur |
Put | When the cipCode for the reporting CTE record is changed. |
Put | Update the record if the endDate value in this resource is changed. |
Delete | When all enrollments for a calendar in which that student has a Career Tech Program record are deleted. |
Delete | When the Career Tech Program record is deleted. |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
When a new Career Tech Program record is assigned to the student, the record will post to the scope year(s) that the overlapping enrollments are in. |
Data will only send for the years that have valid configuration |
Object Data Elements
This table describes data elements sent within the Student CTE Program Association resource.
Data Element | Description | Campus Database Field | Campus GUI Location | ||
---|---|---|---|---|---|
id | The unique identifier of the resource. | O | N/A | N/A | |
studentReference | A unique alpha-numeric code assigned to a student | M | studentReference. studentUniqueId | Census > People > Demographics > EdFi ID | |
programReference | A reference to the related Student resource. | M | N/A | N/A | |
educationOrganization Reference | The education organization where the student is participating in or receiving the program services. | M | District.number | System Administration > Resources > District Info > State District Number | |
beginDate | The month, day, and year on which the student first received services. | M | N/A | Student Information > Academic Planning > Programs > Career Tech Program > Career Tech Program Detail > Start Date | |
endDate | The month, day, and year on which the student exited the program or stopped receiving services. Logic reports as follows:
| C | N/A | Student Information > Academic Planning > Programs > Career Tech Program > Career Tech Program Detail > End Date | |
ctePrograms | The career cluster representing the career path of the Vocational/Career Tech concentrator. | C | N/A | N/A | |
careerPathwayType | The career cluster representing the career path of the Vocational/Career Tech concentrator.
| C | N/A | Program Admin > Programs > Career Tech Programs > Cluster | |
cipCode | Number and description of the CIP Code associated with the student s CTE program.
| O | N/A | Program Admin > Programs > Career Tech Programs > Career Tech Program Detail > State Code (CIP) |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Career Pathway Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
Agriculture, Food and Natural Resources | Agriculture, Food and Natural Resources | Agriculture, Food and Natural Resources |
Architecture and Construction | Architecture and Construction | Architecture and Construction |
Arts, A/V Technology and Communications | Arts, A/V Technology and Communications | Arts, A/V Technology and Communications |
Business, Management and Administration | Business, Management and Administration | Business, Management and Administration |
Education and Training | Education and Training | Education and Training |
Finance | Finance | Finance |
Government and Public Administration | Government and Public Administration | Government and Public Administration |
Health Science | Health Science | Health Science |
Hospitality and Tourism | Hospitality and Tourism | Hospitality and Tourism |
Human Services | Human Services | Human Services |
|
|
|
Law, Public Safety, Corrections and Security | Law, Public Safety, Corrections and Security | Law, Public Safety, Corrections and Security |
Manufacturing | Manufacturing | Manufacturing |
Marketing, Sales and Service | Marketing, Sales and Service | Marketing, Sales and Service |
Science, Technology, Engineering and Mathematics | Science, Technology, Engineering and Mathematics | Science, Technology, Engineering and Mathematics |
Transportation, Distribution and Logistics | Transportation, Distribution and Logistics | Transportation, Distribution and Logistics |
Other | Other | Other |
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. | O | N/A | N/A | |
Behavior Descriptor | This descriptor holds the categories of behavior describing a discipline incident.
| O | N/A | Behavior > Behavior Management > Event Type | |
Detailed Description | Specifies a more granular level of detail of a behavior involved in the incident. 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. | 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:
State Code | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|
Offender | Perpetrator | Perpetrator | Perpetrator |
Participant | Perpetrator | Perpetrator | Perpetrator |
This table describes the Ed-Fi Value mapped and reported for Behavior Descriptors:
State Code | Name | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
ALC | ALCOHOL | State Offense | State Offense | State Offense |
ARS | ARSON | State Offense | State Offense | State Offense |
BAT | BATTERY | State Offense | State Offense | State Offense |
BRK | BREAKING AND ENTERING/BURGLARY | State Offense | State Offense | State Offense |
BUL | BULLYING | State Offense | State Offense | State Offense |
CBL | CYBER BULLYING | State Offense | State Offense | State Offense |
DOC | DISORDERLY CONDUCT | School Code of Conduct | School Code of Conduct | School Code of Conduct |
DRG | DRUGS-EXCLUDING ALCOHOL | State Offense | State Offense | State Offense |
FIT | FIGHTING | State Offense | State Offense | State Offense |
HAR | HARASSMENT | State Offense | State Offense | State Offense |
HOM | HOMICIDE | State Offense | State Offense | State Offense |
KID | KIDNAPPING (ABDUCTION) | State Offense | State Offense | State Offense |
MVT | MOTOR VEHICLE THEFT | State Offense | State Offense | State Offense |
OMC | OTHER MAJOR OFFENSES/UNCLASSIFIED | Other | Other | Other |
ROB | ROBBERY | State Offense | State Offense | State Offense |
STL | LARCENY/THEFT | State Offense | State Offense | State Offense |
SXB | SEXUAL BATTERY | State Offense | State Offense | State Offense |
SXH | SEXUAL HARASSMENT | State Offense | State Offense | State Offense |
SXO | SEX OFFENSES | State Offense | State Offense | State Offense |
TBC | TOBACCO | State Offense | State Offense | State Offense |
TRE | THREAT/INTIMIDATION | State Offense | State Offense | State Offense |
TRS | TRESPASSING | State Offense | State Offense | State Offense |
VAN | VANDALISM | State Offense | State Offense | State Offense |
WPO | WEAPONS POSSESSION | State Offense | State Offense | State Offense |
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 check box is checked on the Relationships tab.
|
Put | When the relationship type is changed |
Delete | When the Guardian check box is unchecked, relationship is end dated or deleted.
|
Delete | Records will 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 check boxes are checked. 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.
See the Relationship Type table in the section below for the Ed-Fi value that is reported. | O | N/A | N/A |
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 Short Description | Ed-Fi Description |
---|---|
Aunt | Aunt |
Brother | Brother |
BrotherInLaw | BrotherInLaw |
CourtAppointedGuardian | CourtAppointedGuardian |
Cousin | Cousin |
Daughter | Daughter |
DaughterInLaw | DaughterInLaw |
Employer | Employer |
Father | Father |
Father, step | Father, step |
FathersSignificantOther | FathersSignificantOther |
FathersCivilPartner | FathersCivilPartner |
FatherInLaw | FatherInLaw |
Fiance | Fiance |
Fiancee | Fiancee |
Foster parent | Foster parent |
Friend | Friend |
Grandfather | Grandfather |
Grandmother | Grandmother |
Great aunt | Great aunt |
Great uncle | Great uncle |
Great Grandparent | Great Grandparent |
Husband | Husband |
MothersSignificantOther | MothersSignificantOther |
Mother | Mother |
Mother, step | Mother, step |
MothersCivilPartner | MothersCivilPartner |
Nephew | Nephew |
Niece | Niece |
Other | Other |
SignificantOther | SignificantOther |
Sister | Sister |
Son | Son |
Unknown | Unknown |
Uncle | Uncle |
Ward | Ward |
Wife | Wife |
Student Program Association
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 student has a EL Program Status = EL or Exited EL, and the record overlaps the configured year. |
Put | When the student is given an EL Exit Date. |
Delete/Post | When part of the record's Natural Key changes. |
Delete | When a student's EL record is deleted or when the record no longer overlaps the configured year. |
Delete | When the record no longer overlaps the configured year. |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
Includes all programs being reported in the Programs resource. Need to update this page to include all programs. |
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 Label | Business Requirement | M, C or O | Data Source GUI Path | Database Field |
---|---|---|---|---|
id | The unique identifier of the resource. | M | ||
educationOrganizationReference | A reference to the related EducationOrganization resource.
| M | ||
programReference | A reference to the related Program resource.
| M | ||
ProgramReference/educationalOrganizationId |
| M | ||
ProgramReference/Type |
| M | ||
ProgramReference/Name |
| M | ||
studentReference | A reference to the related Student resource.
| M | ||
services | An unordered collection of studentProgramAssociationServices. Indicates the services being provided to the student by the program. | M | ||
services/ServiceDescriptor |
See Descriptors section below. | M | ||
services/beginDate | The month, day, and year on which the Student first received services.
| M | Student Information> English Learners> Identified Date | lep.identifieddate |
services/endDate | The month, day, and year on which the Student exited the Program or stopped receiving services.
| C | Student Information> English Learners> Exit Date | lep.exitdate |
reasonExitedDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table.
| C | Student Information> English Learner > Exit Reason | EarlyLearning.exitReason |
servedOutsideOfRegularSession | Indicates whether the student received services during the summer session or between sessions. This element is optional and does not report. | O | ||
enrollmentStatus | This element is optional and does not report. | O |
Type/Descriptor
This table describes the Ed-Fi Value mapped and reported for Service Descriptor:
Ed-Fi Code | Short Description | Description |
---|---|---|
MS | Medical Services | Medical Services |
PT | Physical therapy | Physical therapy |
OM | Orientation and Mobility | Orientation and Mobility |
OT | Occupational therapy | Occupational therapy |
CS | Counseling | Counseling services |
PS | Psychological services | Psychological services |
RE | Recreation | Recreation services |
AU | Audiological Services | Audiological Impairment |
EI | Educational Interpreting | Educational Interpreting |
LS | Speech/Language Services | Speech/Language Services |
OY | Other | Other |
PC | Parent Counseling and Training | Parent Counseling and Training |
RC | Rehabilitation Counseling | Rehabilitation Counseling |
SH | School Health Services | School Health Services |
SN | School Nurse | School Nurse |
SW | Social Work Services | Social Work Services |
TR | Special Transportation | Special Transportation |
This table describes the Ed-Fi Value mapped and reported for Reason Exited Descriptor:
Ed-Fi Code | Short Description | Description |
---|---|---|
DO | Dropped out | Dropped out |
GC | Graduated with other certificate or diploma | Graduated with other certificate or diploma |
GD | Graduated with regular diploma | Graduated with regular diploma |
Moved out of state | Moved out of state | Moved out of state |
RP | Returned to regular program | Returned to regular program |
Other | Other | Other |
MA | Reached maximum age | Reached maximum age |
MN | Normal Matriculation | Normal Matriculation |
Suspended or expelled from school | Suspended or expelled from school | Suspended or expelled from school |
TO | Transferred to another district or school | Transferred to another district or school |
Unknown reason | Unknown reason | Unknown reason |
PE | Parental Exit | Parental Exit |
DE | Deceased | Deceased |
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 State Exclude check box 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 State Exclude check boxes are checked
|
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. The end year of the calendar year is reported. | 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 | N/A |
entryTypeDescriptor | 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. 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. This is optional and does not report. | O | N/A | N/A |
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. This is optional and does not report. | O | N/A | N/A |
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 | The circumstances under which the student exited from membership in an educational institution. 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. This is optional and does not report. | O | N/A | N/A |
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. | 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:
Code in Campus | Name in Campus | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
CP | Court Placed | Other | Other | Other |
D | In District Transfer | Transfer | Transfer | Transfer |
DP | District Placed | New to education system | New to education system | New to education system |
E | Enrolled | Re-entry | Re-entry | Re-entry |
FE | Foreign Exchange Student | Other | Other | Other |
FTE | Schedule FTE Change | Other | Other | Other |
HS | Home School | Other | Other | Other |
I | In State Transfer | Transfer | Transfer | Transfer |
O | Out of State Transfer | Transfer | Transfer | Transfer |
PR | Promoted | Re-entry | Re-entry | Re-entry |
RD | Returned | Re-entry | Re-entry | Re-entry |
RT | Retained | Other | Other | Other |
Z | First Day in District | New to education system | New to education system | New to education system |
This table describes the Ed-Fi Value mapped and reported for Exit Withdrawal Type Descriptor:
Code in Campus | Name in Campus | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
108 | Grad. with WY Reg. Diploma and College Crs Study | 108 | Graduated with college bound course | Graduated with a Wyoming regular high school diploma with college bound course |
124 | Grad. with WY Reg. Diploma W/O College Crs Study | 124 | Graduated without college bound course | Graduated with a Wyoming regular high school diploma without college bound course |
132 | Completed school and received an other credential | 132 | Completed school | Completed school and received an "other" credential |
140 | Dropped out | 140 | Dropout | Dropout |
159 | Discontinued Schooling for GED or other ED | 159 | Enrolled in a GED or other training program | Enrolled in a GED or other training program |
167 | Expelled or involuntarily withdrawn | 167 | Expelled | Expelled |
175 | Reached max age for services | 175 | Reached maximum age | Reached maximum age |
183 | Withdrawn due to significant illness | 183 | Significant Illness | Significant Illness |
205 | Permanent incapacitation | 205 | Deceased | Deceased |
213 | Deceased | 213 | Deceased | Deceased |
248 | Enrolled in a foreign exchange program (Return) | 248 | Enrolled in a foreign exchange program | Enrolled in a foreign exchange program; student expected to return |
256 | Foreign Exchange student returned to home country | 256 | Foreign student returned to home country | Foreign student returned to home country following completion of foreign exchange program in the United States |
264 | Emigrated to another country | 264 | Emigrated to another country | Emigrated to another country |
280 | Mid-year change in the same school | 280 | Mid-year change in the same school to grade level | Mid-year change in the same school to grade level, concurrent enrollment status, or home school status |
302 | End of concurrent or home school enrollment | 302 | End of a concurrent or home school enrollment at a school at any time | End of a concurrent or home school enrollment at a school at any time during the year, including end of year |
310 | Attendance through EOY; grade level advanced | 310 | Attendance through end-of-year; grade level advanced | Attendance through end-of-year; grade level advanced |
329 | Attendance through EOY; grade level retained | 329 | Attendance through end-of-year; retained in grade level | Attendance through end-of-year; retained in grade level |
345 | In District Transfer - mid year (public) | 345 | Transferred mid-year to a different public school in the same Wyoming dist | Transferred mid-year to a different public school in the same Wyoming district |
361 | Out of District Transfer (public) | 361 | Transferred to a public school in a different Wyoming district | Transferred to a public school in a different Wyoming district |
396 | Out of State Transfer (public) | 396 | Transferred to a public school in a different state | Transferred to a public school in a different state |
418 | In State Transfer (private) | 418 | Transferred to a private school in Wyoming | Transferred to a private school in Wyoming |
426 | Out of State Transfer (private) | 426 | Transferred to a private school in a different state | Transferred to a private school in a different state |
450 | Transferred to home schooling | 450 | Transferred to home schooling as the primary educational setting | Transferred to home schooling as the primary educational setting |
469 | Transferred to an educational institution | 469 | Transferred to an institution that has an educational program | Transferred to an institution that has an educational program |
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 the Attendance Status + Attendance Excuse combination is mapped to an Ed-Fi code. OR When a student has a Positive Attendance record and 'Positive Attendance' is mapped to an Ed-Fi code.
|
Put | N/A - only deletes and posts are sent for this Resource.
|
Delete | Delete attendance record if all attendance is removed for the day for that Attendance Event Category Descriptor. |
Delete | When an enrollment is deleted or the No Show or State Exclude check boxes 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:
| 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 | Reports when a student has a verified attendance status/excuse combination that is mapped to an Ed-Fi code. | M | N/A | N/A |
attendanceEventReason | The reported reason for a student's absence.
| O | attendance.comments | |
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
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 |
---|---|---|
Excused Absence | Excused Absence | Excused Absence |
Unexcused Absence | Unexcused Absence | Unexcused Absence |
Tardy | Tardy | Tardy |
Exempt Absence | Exempt Absence | Exempt Absence |
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. |
Put | When the course homeroom field is changed. |
Put | When the section homeroom field is changed. |
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.
|
Delete | Delete the record if a student's roster start date is changed. |
This resource will not push data for Courses marked as Inactive or State Exclude.
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. This element reports a value of True if the Homeroom checkbox is marked on the section or the course the section is assigned to. | 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 and the Attendance Status + Attendance Excuse combination is mapped to an Ed-Fi code.
|
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 check boxes 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 status/excuse combination that is mapped to an Ed-Fi code. Reports when a student is given a positive attendance record for the course section and it is mapped to an Ed-Fi Code. | M | N/A | N/A |
attendanceEventReason | The reported reason for a student's absence. Reports the first 40 characters from the Comments entered in the Attendance being reported for that day.
| O | attendance.comments | |
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/Descriptor
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 |
---|---|---|
Excused Absence | Excused Absence | Excused Absence |
Unexcused Absence | Unexcused Absence | Unexcused Absence |
Tardy | Tardy | Tardy |
Exempt Absence | Exempt Absence | Exempt Absence |
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 | Derson.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 | |
cityOfBirth | The set of elements that capture relevant data regarding a person's birth, including birth date and place of birth. This element is currently not reported or collected. | O | N/A | N/A | |
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 CodeType | The name of the country in which an individual was born. This element is optional and is not reported. | 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 Disadvantaged | 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 EligibilityDescriptor | 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 System Administration > Resources > School > School History > USDA Programs | |
limitedEnglish ProficiencyDescriptor | 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 | N/A | |
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 | |
internationalProvince OfBirth | For students born outside of the US, the Province or jurisdiction in which an individual is born. 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 | Reflects important characteristics of the student's home situation: Immigrant, Migrant, Single Parent, and Unaccompanied Youth.
| M | Enrollment.immigrant Enrollment.migrant Enrollment.singleParent Enrollment. | Student Information > General > Enrollments > State Reporting Field | |
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 | The disability condition(s) that best describes an individual's impairment.
| O | Enrollment.disability1 Enrollment.disability2 Enrollment.disability3 | Student Information > General > Enrollments > Special Ed Fields | |
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. nativeLanguage | Census > People > Identities > Native Language | |
uses | An unordered collection of studentLanguageUses. Language(s) the individual uses to communicate. This element is not collected or reported. | 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 currently not reported or collected. | 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:
Reporting Logic | Code in Campus | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|
Reports when the student has an active Eligibility with a State Eligibility Code = F: Eligible for Free Lunch | F | Free | Free |
Reports when the student has an active Eligibility with a State Eligibility Code = P: Paid OR When a student does not have an active Eligibility record | N | Full price | Full price |
Reports when the student has an active Eligibility with a State Eligibility Code = R: Reduced | R | Reduced price | Reduced price |
Non-reimbursable - does not report |
This table describes the Ed-Fi Value mapped and reported for Limited English Proficiency Descriptor:
Reporting Logic | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|
Report "Y" when:
| Y | Limited | Limited |
Report "R" when:
| R | Refusal | Refusal |
Report "1" when:
| 1 | Limited Monitored 1 | Limited Monitored 1 |
Report "2" when:Student's LEP record with the most recent Identified Date has the following:
| 2 | Limited Monitored 2 | Limited Monitored 2 |
Otherwise, report "N" | N | Not Limited | Not Limited |
This table describes the Ed-Fi Value mapped and reported for Student Characteristic Descriptors:
Characteristic | Logic | Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|---|---|
Immigrant | If student is marked Immigrant = Checked, add Immigrant to the array Otherwise do not report Student Information > General > Enrollment > Immigrant | Immigrant | Immigrant | Immigrant |
Migrant | If student is marked Migrant Indicator = Checked, add Migrant to the array Otherwise do not report Student Information > General > Enrollment > Migrant | Migrant | Migrant | Migrant |
Single Parent | If student is marked Single Parent = Checked, add Single Parent to the array Otherwise do not report Student Information > General > Enrollment > Single Parent | Single Parent | Single Parent | Single Parent |
Unaccompanied Youth | If student is marked Unaccompanied Youth = Checked, add Unaccompanied Youth to the array Otherwise do not report Student Information > General > Enrollment > Unaccompanied Youth | Unaccompanied Youth | Unaccompanied Youth | Unaccompanied Youth |
This table describes the Ed-Fi Value mapped and reported for Disability Descriptors:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
AT | Autism | Autism |
DB | Deaf-Blindness | Deaf-Blindness |
HI | Hearing Impairment | Hearing Impairment |
DD | Developmental Delay | Developmental Delay |
LD | Specific Learning Disability | Specific Learning Disability |
HL | Other Health Impairment | Other Health Impairment |
OI | Orthopedic Impairment | Orthopedic Impairment |
SL | Speech or Language Impairment | Speech or Language Impairment |
BI | Traumatic Brain Injury | Traumatic Brain Injury |
VI | Visual Impairment | Visual Impairment |
CD | Cognitive Disability | Cognitive Disability |
ED | Serious Emotional Disability | Serious Emotional Disability |
MU | Multiple Disabilities | Multiple Disabilities |
Student Special Education Program Association
This resource reports the Special Education data for a student.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post |
AND WHEN:
|
If the student has multiple enrollments that are overlapping in the same school, report based on primacy of Service Type:
| |
| |
Post | When a new enrollment is created for a student that has an active, locked "WY" IEP (Print format must start with "WY")
|
Delete/Post | When any part of the natural key is changed.
|
Delete/Post | When any field that is not part of the natural key is changed, including the following:
|
Delete | The locked "WY" IEP is deleted or unlocked for a student |
Delete | A Sped Entry Date is changed for a student |
Delete | All overlapping enrollments are deleted for a school |
Delete | Student Information > General > Enrollments > Special Ed Fields > Service Start Date in the enrollment that has an active IEP in its date range is set to Null |
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
When a new, locked "WY" print format IEP is created, the record will post to the school years that the overlapping enrollments are in. |
When the record is triggered from enrollments, the record posts to the school years that the overlapping enrollments are in |
Data will only send for the years that have valid configuration |
Object Data Elements
This table describes data elements sent within the Student Special Education Program Association resource.
Data Element | Description | Campus Database Field | Campus GUI Location | ||
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | N/A | N/A | |
studentReference | A unique alpha-numeric code assigned to a student | M | studentReference. studentUniqueId | Census > People > Demographics > EdFi ID | |
programReference | A reference to the related Student resource. | M | N/A | N/A | |
beginDate | The month, day, and year on which the Student first received services. Logic will report the date in Student Information > General > Enrollments > Special Ed Fields > Service Start Date from the most recent (latest Start Date) Primary enrollment with enrollment Start Date <= Effective Date. | M | N/A | Student Information > General > Enrollments > Special Ed Fields > Service Start Date | |
educationOrganization Reference | The education organization where the student is participating in or receiving the program services. | M | District.number | System Administration > Resources > District Information > State District Number | |
endDate | The month, day, and year on which the student exited the program or stopped receiving services.
| C | N/A | Student Information > General > Enrollment > Special Ed > Exit Date | |
specialEducation SettingDescriptor | Reports the Special Education setting for the student.
| O | N/A | N/A | |
services | An unordered collection of studentProgramAssociationServices. This association represents the Special Education program(s) that a student participates in or receives services from. | O | N/A | N/A | |
serviceDescriptor | Report the Ed-Fi code from the locked "WY" IEP in the year> SPED Services> Service selection, AND also from the locked "WY" IEP in the year> Related Services > Service selection When Ed-Fi code = Null, or when no Service/Related Service exists, do not report. Report only those services belonging to an IEP with Start Date <= the effective date. | M | N/A | Student Information > Special Ed > SPED Services > Service Student Information > Special Ed > Related Services > Service | |
primaryIndicator | This is optional and does not report | O | N/A | N/A | |
serviceBeginDate | Report the Start Date value of the service being reported | O | N/A | Student Information > Special Ed > SPED Services > Start Date Student Information > Special Ed > Related Services > Start Date | |
serviceEndDate | Report the End Date value of the service being reported | O | N/A | Student Information > Special Ed > SPED Services > End Date Student Information > Special Ed > Related Services > End Date |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported for Special Education Setting Descriptor:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
SC | Inside regular class less than 40% of the day | Inside regular class less than 40% of the day |
RR | Inside regular class no more than 79% of dy and no less than 40% of the day | Inside regular class no more than 79% of dy and no less than 40% of the day |
PP | Parentally-placed in Private Schools | Parentally-placed in Private Schools |
RE | Inside regular class 80% or more of the day | Inside regular class 80% or more of the day |
HH | Homebound/Hospital | Homebound/Hospital |
PH | Homeschool | Homeschool |
CF | Correctional Facility | Correctional Facility |
RF | Residential Facility | Residential Facility |
SS | Separate School | Separate School |
CP | Court Placed | Court Placed |
Student Title 1 Part A Program Association
This resource represents the Title I Part A program(s) that a student participates in or from which the student receives services
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When a student has Title 1 = Checked on any enrollment |
Only report a single record per school, per student, per enrollment Start Date | |
If the student has > 1 enrollment, where Title 1 checkbox = Checked, and the start date is the same, report based on the following hierarchy:
| |
If there are multiple enrollments that qualify, with the same Service Type and enrollment Start Date, report the highest enrollmentID | |
Do not report if the student's Enrollment has any of the following indicated:
| |
Post | If the service type is being changed for the enrollment record being reported in this resource, report a new record for the new properly reported enrollment, if previously not the reporting enrollment. |
Post | When any field part of the natural key is updated |
Put | Update the record if any other fields in this resource are changed that are not part of the natural key |
Delete | If the service type is being changed for the enrollment record being reported in this resource, delete the record if the enrollment is no longer the reported enrollment. |
Delete | When any field part of the natural key is updated |
Delete | When any enrollment record that previously had the Title 1 checkbox selected & saved, and the enrollment record is subsequently deleted, delete the record. |
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 Title 1 Part A Program Association resource.
Data Element | Description | Campus Database Field | Campus GUI Location | ||
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | N/A | N/A | |
studentReference | A unique alpha-numeric code assigned to a student. | M | StudentReference. studentUniqueId | Census > People > Demographics > EdFi ID | |
programReference | A reference to the related Student resource. | M | N/A | N/A | |
beginDate | The month, day, and year on which the student first received services | M | N/A | Student Information > General > Enrollments > Start Date | |
educationOrganization Reference | The education organization where the student is participating in or receiving the program services. | M | District.number | System Administration > Resources > District Information > State District Number | |
endDate | The month, day, and year on which the student exited the program or stopped receiving services. | M | N/A | Student Information > General > Enrollments > 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 element 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 element 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:
Logic will report as follows:
| M | N/A | System Administration > Resources > School > Title 1 |
Type/Descriptor
The highlighted column indicates the reported value.
This table describes the Ed-Fi Value mapped and reported Title I Part A Participant Type:
Ed-Fi Code Value | Ed-Fi Short Description | Ed-Fi Description |
---|---|---|
Public Targeted Assistance Program | Public Targeted Assistance Program | Public Targeted Assistance Program |
Public Schoolwide Program | Public Schoolwide Program | Public Schoolwide Program |
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.
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 resynch on the Schedule Data to verify all sections have a Room number. |
AzEDS