API Resource | API Resouce Field | Required/Optional | Constraints | ODS Database Table | ODS Database Column |
---|
/schools |
|
|
|
|
|
---|
schools | SchoolId | Required |
| edfi.School | SchoolId |
schools | nameOfInstitution | Required |
| edfi.School | SchoolName |
/students |
|
| Must provide all currently enrolled students in the current school year |
|
|
---|
students | firstName | Required |
| edfi.Student | FirstName |
students | lastSurname | Required |
| edfi.Student | LastSurname |
students | middleName | Optional |
| edfi.Student | MiddleName |
studentSchoolAssociations | SchoolId | Required |
| edfi.StudentSchoolAssociation | SchoolId |
studentSchoolAssociations | studentUniqueId | Required | Must be the local SIS identifier (i.e., not the state or other ID) | edfi.StudentSchoolAssociation | StudentUniqueId |
/calendarDates |
|
|
|
|
|
---|
calendarDates | date | Required |
| edfi.CalendarDateCalendarEvent | Date |
/studentSectionAssociations |
|
|
|
|
|
---|
studentSectionAssociations | localCourseCode | Required |
| edfi.StudentSectionAssociation | LocalCourseCode |
/course |
|
|
|
|
|
---|
courses | academicSubjectDescriptor | Required | Must be an Ed-Fi value as defined in AcademicSubjectDescriptor | edfi.Course | AcademicSubjectDescriptorId |
/staffs |
|
|
|
|
|
---|
staffs | firstName | Required |
| edfi.Staff | FirstName |
staffs | lastSurname | Required |
| edfi.Staff | MiddleName |
staffs | middleName | Optional |
| edfi.Staff | LastSurname |
/sections |
|
|
|
|
|
---|
sections | sectionName | Required |
| edfi.Section | SectionName |
sections | sessionName | Required |
| edfi.Section | SessionName |
sections | schoolId | Required |
| edfi.Section | SchoolId |
sections | localCourseCode | Required |
| edfi.Section | LocalCourseCode |
sections | schoolYear | Required |
| edfi.Section | SchoolYear |
sections | sectionIdentifier | Required |
| edfi.Section | SectionIdentifier |
/studentSchoolAssociations |
|
|
|
|
|
---|
studentSchoolAssociations | studentUniqueId | Required |
| StudentSchoolAssociation | StudentUniqueId |
studentSchoolAssociations | schoolId | Required |
| edfi.StudentSchoolAssociation | SchoolId |
/studentEducationOrganizationAssociations |
|
|
|
|
|
---|
studentEducationOrganizationAssociations | disabilities=>disabilityDescriptor | Required | Must be an Ed-Fi value as defined in DisabilityDescriptor | edfi.StudentEducationOrganizationAssociationDisability | DisabilityDescriptorId |
studentEducationOrganizationAssociations | races=>raceDescriptor | Required | Must be an Ed-Fi value as defined in RaceDescriptor | edfi.StudentEducationOrganizationAssociationRace | RaceDescriptorId |
studentEducationOrganizationAssociations | studentCharacteristics=>studentCharacteristicDescriptor | Required | Must be an Ed-Fi value as defined in StudentCharacteristic | edfi.StudentEducationOrganizationAssociationStudentCharacteristic | StudentCharacteristicDescriptorId |
/programs |
|
|
|
|
|
---|
programs | programName | Required |
| edfi.StudentProgramAssociation | ProgramName |
/studentProgramAssociations |
|
|
|
|
|
---|
studentProgramAssociations | studentUniqueId | Required |
| edfi.StudentProgramAssociation | StudentUniqueId |
studentProgramAssociations | SchoolId | Required |
| edfi.StudentProgramAssociation | SchoolId |
/studentSectionAssociations |
|
|
|
|
|
---|
studentSectionAssociations | schoolId | Required |
| edfi.StudentSectionAssociation | SchoolId |
studentSectionAssociations | localCourseCode | Required |
| edfi.StudentSectionAssociation | LocalCourseCode |
studentSectionAssociations | schoolYear | Required |
| edfi.StudentSectionAssociation | SchoolYear |
studentSectionAssociations | sectionIdentifier | Required |
| edfi.StudentSectionAssociation | SectionIdentifier |
studentSectionAssociations | sessionName | Required |
| edfi.StudentSectionAssociation | SessionName |