Skip to main content

Student Information Systems

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 v3.2.
    • 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.
  • A 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 other identifiers unless those are used by the district's SIS.

Note that the ODS database information (where the data lands in the Ed-Fi ODS platform) is provided in the rightmost columns. This information can be very helpful to you during development if you are using a local Ed-Fi ODS to test against.

API ResourceAPI Resouce FieldRequired/OptionalConstraintsODS Database TableODS Database Column
/schools
schoolsSchoolIdRequirededfi.SchoolSchoolId
schoolsnameOfInstitutionRequirededfi.SchoolSchoolName
/studentsMust provide all currently enrolled students in the current school year
studentsfirstNameRequirededfi.StudentFirstName
studentslastSurnameRequirededfi.StudentLastSurname
studentsmiddleNameOptionaledfi.StudentMiddleName
studentSchoolAssociationsSchoolIdRequirededfi.StudentSchoolAssociationSchoolId
studentSchoolAssociationsstudentUniqueIdRequiredMust be the local SIS identifier (i.e., not the state or other ID)edfi.StudentSchoolAssociationStudentUniqueId
/calendarDates
calendarDatesdateRequirededfi.CalendarDateCalendarEventDate
/studentSectionAssociations
studentSectionAssociationslocalCourseCodeRequirededfi.StudentSectionAssociationLocalCourseCode
/course
coursesacademicSubjectDescriptorRequiredMust be an Ed-Fi value as defined in AcademicSubjectDescriptoredfi.CourseAcademicSubjectDescriptorId
/staffs
staffsfirstNameRequirededfi.StaffFirstName
staffslastSurnameRequirededfi.StaffMiddleName
staffsmiddleNameOptionaledfi.StaffLastSurname
/sections
sectionssectionNameRequirededfi.SectionSectionName
sectionssessionNameRequirededfi.SectionSessionName
sectionsschoolIdRequirededfi.SectionSchoolId
sectionslocalCourseCodeRequirededfi.SectionLocalCourseCode
sectionsschoolYearRequirededfi.SectionSchoolYear
sectionssectionIdentifierRequirededfi.SectionSectionIdentifier
/studentSchoolAssociations
studentSchoolAssociationsstudentUniqueIdRequiredStudentSchoolAssociationStudentUniqueId
studentSchoolAssociationsschoolIdRequirededfi.StudentSchoolAssociationSchoolId
/studentEducationOrganizationAssociations
studentEducationOrganizationAssociationsdisabilities=>disabilityDescriptorRequiredMust be an Ed-Fi value as defined in DisabilityDescriptoredfi.StudentEducationOrganizationAssociationDisabilityDisabilityDescriptorId
studentEducationOrganizationAssociationsraces=>raceDescriptorRequiredMust be an Ed-Fi value as defined in RaceDescriptoredfi.StudentEducationOrganizationAssociationRaceRaceDescriptorId
studentEducationOrganizationAssociationsstudentCharacteristics=>studentCharacteristicDescriptorRequiredMust be an Ed-Fi value as defined in StudentCharacteristicedfi.StudentEducationOrganizationAssociationStudentCharacteristicStudentCharacteristicDescriptorId
/programs
programsprogramNameRequirededfi.StudentProgramAssociationProgramName
/studentProgramAssociations
studentProgramAssociationsstudentUniqueIdRequirededfi.StudentProgramAssociationStudentUniqueId
studentProgramAssociationsSchoolIdRequirededfi.StudentProgramAssociationSchoolId
/studentSectionAssociations
studentSectionAssociationsschoolIdRequirededfi.StudentSectionAssociationSchoolId
studentSectionAssociationslocalCourseCodeRequirededfi.StudentSectionAssociationLocalCourseCode
studentSectionAssociationsschoolYearRequirededfi.StudentSectionAssociationSchoolYear
studentSectionAssociationssectionIdentifierRequirededfi.StudentSectionAssociationSectionIdentifier
studentSectionAssociationssessionNameRequirededfi.StudentSectionAssociationSessionName