The complete Aeries API documentation is also available in this Knowledge Base. Click here.


School-Related API End Points

Data Area URL Quick Note
School Information
/api/v3/schools/{SchoolCode}
{SchoolCode} is optional
School Terms
/api/v3/schools/{SchoolCode}/terms
Data already in School Information End Point
School Calendar
/api/v3/schools/{SchoolCode}/calendar
{SchoolCode} is required.
Track Holidays might be a blank data element if the School.Tracks field is 0.
Bell Schedule
/api/v3/schools/{SchoolCode}/BellSchedule
/api/v3/schools/{SchoolCode}/BellSchedule/day/{CalendarDayNumber}
CalendarDayNumber of 0 represents the "default" bell schedule.  Records with a value other than 0 represent the bell schedule for a specific day/date.
Absence Codes
/api/v3/schools/{SchoolCode}/AbsenceCodes/{AbsenceCode}
{AbsenceCode} is optional
Code Sets
/api/v3/codes/{Table}/{Field}
{Table} is the Aeries table code or object name.
{Field} is the Aeries field code or data element name.


Student-Related API End Points

Data Area URL Quick Note
Student Information
/api/v3/schools/{SchoolCode}/students/{StudentID}
/api/v3/schools/{SchoolCode}/students/grade/{GradeLevel}
/api/v3/schools/{SchoolCode}/students/sn/{StudentNumber}
{StudentID} is optional
Student Information Extended
/api/v3/schools/{SchoolCode}/students/{StudentID}/extended
/api/v3/schools/{SchoolCode}/students/grade/{GradeLevel}/extended
/api/v3/schools/{SchoolCode}/students/sn/{StudentNumber}/extended
{StudentID} is optional
Student Data Changes
/api/v2/StudentDataChanges/{DataArea}/{year}/{month}/{day}/{hour}/{minute}
"student", "contact", "program", "test", "class", "enrollment"
Contacts
/api/v3/schools/{SchoolCode}/contacts/{StudentID}
{StudentID} is optional
Programs
/api/v3/schools/{SchoolCode}/students/{StudentID}/programs
{StudentID} = 0 for all students
Query String Parameter to limit to program code
Ex: ?code=144
Test Scores
/api/v2/students/{StudentID}/tests
{StudentID} is REQUIRED
Update Test Scores
/api/v2/testing/UpdateScores
POST
College Test Scores
/api/v3/schools/{SchoolCode}/CollegeTestScores/{StudentID}
{StudentID} is optional
Assertive Discipline
/api/v3/schools/{SchoolCode}/AssertiveDiscipline/{StudentID}
{StudentID} is optional
District Supplemental Student Data
/api/v3/schools/{SchoolCode}/DistrictSupplemental/{StudentID}
{StudentID} is optional
School Supplemental Student Data
/api/v3/schools/{SchoolCode}/SchoolSupplemental/{StudentID}
{StudentID} is optional
Fees and Fines
/api/v3/schools/{SchoolCode}/fees/{StudentID}
{StudentID} is optional
Student Picture
/api/v3/schools/{SchoolCode}/StudentPictures/{StudentID}
{StudentID} is optional
Student Groups /api/v3/schools/{SchoolCode}/StudentGroups For all schools, pass {SchoolCode} = "all". Otherwise, pass numeric school code.


Attendance & Enrollment API End Points

Data Area URL Quick Note
Enrollment History
/api/v3/enrollment/{StudentID}
/api/v3/enrollment/{StudentID}/year/{AcademicYear}
/api/v3/schools/{SchoolCode}/enrollment/{StudentID}
/api/v3/schools/{SchoolCode}/enrollment/{StudentID}/year/{AcademicYear}
{StudentID} can be 0 for all students
{AcademicYear} format: yyyy
Student Attendance
/api/v3/schools/{SchoolCode}/attendance/{StudentID}
{StudentID} is optional
Query String Parameters:
StartDate=YYYYMMDD
&EndDate=YYYYMMDD
Attendance History Summary
/api/v3/schools/{SchoolCode}/AttendanceHistory/summary/{StudentID}
/api/v3/schools/{SchoolCode}/AttendanceHistory/summary/year/{year}
{SchoolCode} limits to the students in that school
{StudentID} is optional
{year} format: yyyy-yyyy
Attendance History Details
/api/v3/schools/{SchoolCode}/AttendanceHistory/details/{StudentID}
/api/v3/schools/{SchoolCode}/AttendanceHistory/details/year/{year}
Attendance History Attendance Codes
/api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes
/api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes/year/{year}


Student Grades API End Points

Data Area URL Quick Note
Student GPA
/api/v3/schools/{SchoolCode}/gpas/{StudentID}
{StudentID} is optional
Student Report Cards
/api/v3/schools/{SchoolCode}/ReportCard/{StudentID}
{StudentID} is optional
School Report Card Marking Periods
/api/v3/schools/{SchoolCode}/ReportCardMarkingPeriods

School Graduation Requirements
/api/v3/schools/{SchoolCode}/GraduationRequirements

Student Graduation Status Summary
/api/v3/schools/{SchoolCode}/GraduationStatusSummary/{StudentID}
/api/v3/schools/{SchoolCode}/GraduationStatusSummary/grade/{GradeLevel}
{StudentID} is optional
Student Transcripts
/api/v3/schools/{SchoolCode}/Transcript/{StudentID}
{StudentID} is optional


Scheduling API End Points

Data Area URL Quick Note
Student Class Schedule
/api/schools/{SchoolCode}/classes/{StudentID}
{StudentID} is optional
Course Information
/api/courses/{CourseID}
{CourseID} is optional
Course Data Changes
/api/v2/CourseDataChanges/{year}/{month}/{day}/{hour}/{minute}

Staff Data
/api/v3/staff/{StaffID}
{StaffID} is optional
QueryString conditions can be included to filter results on any staff object field.
Staff Classes/Sections
/api/v3/staff/{StaffID}/classes
{StaffID} is required
Staff Data Changes
/api/v2/StaffDataChanges/{year}/{month}/{day}/{hour}/{minute}

Teacher Information
/api/schools/{SchoolCode}/teachers/{TeacherNumber}
{TeacherNumber} is optional
Staff-Teacher Information
/api/v2/staff/{StaffID}/teachers
This end point will return a list of teacher records associated with the given Staff ID.
Section Information
/api/v3/schools/{SchoolCode}/sections/{SectionNumber}
{SectionNumber} is optional
Section Data Changes
/api/v2/SectionDataChanges/{year}/{month}/{day}/{hour}/{minute}

Section Class Roster
/api/v1/schools/{SchoolCode}/sections/{SectionNumber}/students
{SectionNumber} is REQUIRED
Section Class Roster Data Changes
/api/v2/SectionRosterDataChanges/{year}/{month}/{day}/{hour}/{minute}


Gradebook API End Points

Data Area URL Quick Note
Gradebook Data
/api/v3/staff/{StaffID}/gradebooks
/api/v3/schools/{SchoolCode}/sections/{SectionNumber}/gradebooks
/api/v3/gradebooks/{GradebookNumber}

Assignments
/api/v3/gradebooks/{GradebookNumber}/assignments
/api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
/api/v3/gradebooks/Assignments/{UniqueID}

Updating Assignment Information
/api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
/api/v3/gradebooks/Assignments/{UniqueID}
POST
Inserting a New Assignment
/api/v3/gradebooks/{GradebookNumber}/InsertAssignment
POST
Final Mark Ranges
/api/v3/gradebooks/{GradebookNumber}/FinalMarks

Gradebook Students
/api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students
/api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students/{StudentID}

Assignment Scores
/api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/scores
/api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/scores/{StudentID}
/api/v3/gradebooks/assignments/{UniqueID}/scores
/api/v3/gradebooks/assignments/{UniqueID}/scores/{StudentID}

Updating Assignment Scores
/api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/UpdateScores
/api/v3/gradebooks/assignments/{UniqueID}/UpdateScores
POST


Pagination Support

The following sets of end points support paginating the result set:

  • Student Information
  • Student Extended
  • Student GPA
  • Student Pictures
  • Graduation Status Summary
  • Student Transcripts

To request a specific set of records, include a set of Query String Parameters in the URL for "StartingRecord" and "EndingRecord".


Previous School Years

If a district configures their environment properly, you can access prior year databases through the V3 API by including a query string parameter of "DatabaseYear" in the format of "?DatabaseYear=CCYY" with the "year" at the start of the school year (e.g., "2017" for the "2017-2018" school year).  If the database exists on the server you are hitting, it will return data from that year.  Otherwise, it will return data from the current school year – so be careful.