Data Requirements
Data requirements for the Starter Kit are provided below.
- Elements listed as optional should be provided when available: while their absence will not cause issues with the starter kit visualizations, their presence will enhance the capabilities of the starter kit.
- Descriptors (values suffixed with "Descriptor" below) must be consistent with
the standard values provided as part of Ed-Fi Data
Standard
- Links to specific sets are provided below in Ed-Fi XML format; (see the section "Descriptors" to understand how these look in JSON format for transit).
- Descriptor values marked as "deprecated" must not be used
- Note on IDs (for entities like students, staff, parents, schools and the district itself): these must be the local district identifiers, which are the ones that typically appear by default in the SIS. They must not be state, federal or others identifiers (if those are different).
Note that the ODS database information (where the data lands in the Ed-Fi ODS platform) is provided to the right, as this information can be very helpful to you as you develop, if you are using a local Ed-Fi ODS to test against.
Helpful Links
- Ed-Fi Data Handbook (v.3.2.0) Corresponds to ODS/API v.5.2.x and provides easy lookup of elements plus data definitions.
- API Reference for ODS v.5.2
| API Resource | API Resource Field | Required / Optional | Constraints | ODS Database Table | ODS Database Column |
|---|---|---|---|---|---|
| /calendarDates | |||||
| calendarDates | date | Required | edfi.CalendarDateCalendarEvent | Date | |
| /cohorts | |||||
| cohorts | cohortDescription | Optional | edfi.Cohort | CohortDescription | |
| courses | academicSubjectDescriptor | Optional | Must be an Ed-Fi value as defined in AcademicSubjectDescriptor | edfi.Course | AcademicSubjectDescriptorId |
| courses | courseTitle | Optional | edfi.Course | CourseTitle | |
| /disciplineIncident | |||||
| disciplineIncident | incidentIdentifier | Required | edfi.DisciplineIncident | IncidentIdentifier | |
| disciplineIncident | schoolReference.schoolId | Required | edfi.DisciplineIncident | SchoolId | |
| /studentDisciplineIncidentAssociation | |||||
| studentDisciplineIncidentAssociation | disciplineIncidentReference.incidentIdentifier | Required | edfi.StudentDisciplineIncidentAssociation | IncidentIdentifier | |
| studentDisciplineIncidentAssociation | disciplineIncidentReference.schoolId | Required | edfi.StudentDisciplineIncidentAssociation | SchoolId | |
| studentDisciplineIncidentAssociation | disciplineIncidentReference.studentReference. studentUniqueId | Required | edfi.StudentDisciplineIncidentAssociation | StudentUSI | |
| /disciplineActions | |||||
| disciplineActions | disciplines.disciplineDescriptor | Required | Must be an Ed-Fi value as defined in DisciplineDescriptor | edfi.DisciplineAction | Discipline |
| disciplineActions | studentDisciplineIncidentAssociations. studentDisciplineIncidentAssociationReference. studentUniqueId | Required | edfi.DisciplineAction | StudentUSI | |
| disciplineActions | studentDisciplineIncidentAssociations. studentDisciplineIncidentAssociationReference. incidentIdentifier | Required | edfi.DisciplineAction | IncidentIdentifier | |
| disciplineActions | studentDisciplineIncidentAssociations. studentDisciplineIncidentAssociationReference. schoolId | Required | edfi.DisciplineAction | SchoolId | |
| disciplineActions | disciplineActionIdentifier | Required | edfi.DisciplineAction | DisciplineActionIdentifier | |
| disciplineActions | disciplineDate | Required | edfi.DisciplineAction | DisciplineDate | |
| disciplineActions | staffs.staffUniqueId | Required | edfi.DisciplineActionStaff | StaffUSI | |
| /feederSchoolAssociations | |||||
| feederSchoolAssociations | feederSchoolReference.SchoolId | Required | edfi.FeederSchoolAssociation | FeederSchoolId | |
| feederSchoolAssociations | schoolReference.SchoolId | Required | edfi.FeederSchoolAssociation | SchoolId | |
| /grades | |||||
| grades | numericGradeEarned | Required | edfi.Grade | NumericGradeEarned | |
| /parents | |||||
| parents | addresses.postalCode | Required | edfi.ParentAddress | PostalCode | |
| /programs | |||||
| programs | educationOrganizationReference. educationOrganizationId | Required | edfi.Program | EducationOrganizationId | |
| programs | programName | Required | edfi.Program | ProgramName | |
| programs | programTypeDescriptor | Required | Must be an Ed-Fi value as defined in ProgramTypeDescriptor | edfi.ProgramTypeDescriptor | CodeValue |
| /schools | |||||
| schools | schoolId | Required | edfi.School | SchoolId | |
| schools | nameOfInstitution | Required | edfi.School | SchoolName | |
| /studentEducationOrganizationAssociations | |||||
| studentEducationOrganizationAssociations | races.raceDescriptor | Required | Must be an Ed-Fi value as defined in RaceDescriptor | edfi.StudentEducationOrganizationAssociationRace | RaceDescriptorID |
| studentEducationOrganizationAssociations | sexDescriptor | Optional | Must be an Ed-Fi value as defined in SexDescriptor | edfi.Student | SexType |
| /studentSchoolFoodServiceProgramAssociations | |||||
| studentSchoolFoodServiceProgramAssociations | schoolFoodServiceProgramServices. schoolFoodServiceProgramServiceDescriptor | Required | Must be an Ed-Fi value as defined in SchoolFoodServiceProgramServiceDescriptor | edfi.StudentSchoolFoodServiceProgramAssociation | SchoolFoodServiceProgramService |
| /sections | |||||
| sections | courseOfferingReference.localCourseCode | Required | edfi.Section | LocalCourseCode | |
| sections | courseOfferingReference.schoolyear | Required | edfi.Section | SchoolYear | |
| sections | sectionName | Optional | edfi.Section | SectionName | |
| sections | courseOfferingReference.sessionName | Required | edfi.Section | SessionName | |
| /students | |||||
| students | birthData.birthDate | Optional | edfi.Student | BirthDate | |
| students | firstName | Required | edfi.Student | FirstName | |
| students | lastSurname | Required | edfi.Student | LastSurname | |
| students | middleName | Optional | edfi.Student | MiddleName | |
| students | studentUniqueId | Required | Must be the local SIS identifier (i.e., not the state or other ID) | edfi.Student | StudentUniqueId |
| /studentProgramAssociations | |||||
| studentProgramAssociations | beginDate | Required | StudentProgramAssociation | BeginDate | |
| /studentSchoolAssociations | |||||
| studentSchoolAssociations | entryGradeLevelDescriptor | Optional | Must be an Ed-Fi value as defined in GradeLevelDescriptor | edfi.StudentSchoolAssociation | EntryGradeLevelDescriptorId |
| studentSchoolAssociations | schoolId | Required | edfi.StudentSchoolAssociation | SchoolId | |
| studentSchoolAssociations | studentUniqueId | Required | edfi.StudentSchoolAssociation | StudentUniqueId | |
| /studentSectionAssociations | |||||
| studentSectionAssociations | beginDate | Required | edfi.StudentSectionAssociation | BeginDate | |
| studentSectionAssociations | endDate | Required | edfi.StudentSectionAssociation | EndDate | |
| studentSectionAssociations | localCourseCode | Required | edfi.StudentSectionAssociation | LocalCourseCode | |
| studentSectionAssociations | sectionReference.sectionIdentifier | Required | edfi.StudentSectionAssociation | SectionIdentifier | |
| studentSectionAssociations | sectionReference.courseOffering.sessionName | Required | edfi.StudentSectionAssociation | SessionName |