Aeries API Quick Reference Guide Last Updated 7 ... - Google Groups

Aeries API Quick Reference Guide School-Related API End Points

Last Updated 7/13/2016

Data Area School Information School Terms School Calendar

URL /api/v3/schools/{SchoolCode} /api/v3/schools/{SchoolCode}/terms /api/v3/schools/{SchoolCode}/calendar

Bell Schedule

/api/v3/schools/{SchoolCode}/BellSchedule /api/v3/schools/{SchoolCode}/BellSchedule/day/{CalendarDayNumber}

Absence Codes Code Sets

/api/v3/schools/{SchoolCode}/AbsenceCodes/{AbsenceCode} /api/codes/{Table}/{Field}

Student-Related API End Points Data Area Student Information

Quick Note {SchoolCode} is optional Data already in School Information End Point {SchoolCode} is required. Track Holidays might be a blank data element if the School.Tracks field is 0. CalendarDayNumber of 0 represents the "default" bell schedule. Records with a value other than 0 represent the bell schedule for a specific day/date. {AbsenceCode} is optional {Table} is the Aeries table code or object name. {Field} is the Aeries field code or data element name.

Student Data Changes

URL /api/v3/schools/{SchoolCode}/students/{StudentID} /api/v3/schools/{SchoolCode}/students/grade/{GradeLevel} /api/v3/schools/{SchoolCode}/students/sn/{StudentNumber} /api/v3/schools/{SchoolCode}/students/{StudentID}/extended /api/v3/schools/{SchoolCode}/students/grade/{GradeLevel}/extended /api/v3/schools/{SchoolCode}/students/sn/{StudentNumber}/extended /api/v2/StudentDataChanges/{DataArea}/{year}/{month}/{day}/{hour}/{minute}

Contacts Programs

/api/schools/{SchoolCode}/contacts/{StudentID} /api/v2/schools/{SchoolCode}/students/{StudentID}/programs

Student Information Extended

Test Scores College Test Scores Assertive Discipline District Supplemental Student Data School Supplemental Student Data Fees and Fines Student Picture

/api/v2/students/{StudentID}/tests /api/v3/schools/{SchoolCode}/CollegeTestScores/{StudentID} /api/v3/schools/{SchoolCode}/AssertiveDiscipline/{StudentID} /api/v3/schools/{SchoolCode}/DistrictSupplemental/{StudentID} /api/v3/schools/{SchoolCode}/SchoolSupplemental/{StudentID} /api/v3/schools/{SchoolCode}/fees/{StudentID} /api/v3/schools/{SchoolCode}/StudentPictures/{StudentID}

Quick Note {StudentID} is optional {StudentID} is optional "student", "contact", "program", "test", "class", "enrollment" {StudentID} is optional {StudentID} = 0 for all students {StudentID} is REQUIRED {StudentID} is optional {StudentID} is optional {StudentID} is optional {StudentID} is optional {StudentID} is optional {StudentID} is optional

Attendance & Enrollment API End Points Data Area Enrollment History

Student Attendance Attendance History Summary Attendance History Details Attendance History Attendance Codes

URL /api/v3/enrollment/{StudentID} /api/v3/enrollment/{StudentID}/year/{AcademicYear} /api/v3/schools/{SchoolCode}/enrollment/{StudentID} /api/v3/schools/{SchoolCode}/enrollment/{StudentID}/year/{AcademicYear} /api/v3/schools/{SchoolCode}/attendance/{StudentID} /api/v3/schools/{SchoolCode}/AttendanceHistory/summary/{StudentID} /api/v3/schools/{SchoolCode}/AttendanceHistory/summary/year/{year} /api/v3/schools/{SchoolCode}/AttendanceHistory/details/{StudentID} /api/v3/schools/{SchoolCode}/AttendanceHistory/details/year/{year} /api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes/{StudentID} /api/v3/schools/{SchoolCode}/AttendanceHistory/AbsenceCodes/year/{year}

Student Grades API End Points

Data Area Student GPA Student Report Cards School Report Card Marking Periods School Graduation Requirements Student Graduation Status Summary Student Transcripts

Scheduling API End Points

Quick Note {StudentID} can be 0 for all students {AcademicYear} format: yyyy {StudentID} is optional Query String Parameters: StartDate=YYYYMMDD &EndDate=YYYYMMDD {SchoolCode} limits to the students in that school {StudentID} is optional {year} format: yyyy-yyyy

URL /api/v3/schools/{SchoolCode}/gpas/{StudentID} /api/v3/schools/{SchoolCode}/ReportCard/{StudentID} /api/v3/schools/{SchoolCode}/ReportCardMarkingPeriods /api/v3/schools/{SchoolCode}/GraduationRequirements /api/v3/schools/{SchoolCode}/GraduationStatusSummary/{StudentID} /api/v3/schools/{SchoolCode}/GraduationStatusSummary/grade/{GradeLevel} /api/v3/schools/{SchoolCode}/Transcript/{StudentID}

Data Area Student Class Schedule Course Information Course Data Changes Staff Data

URL /api/schools/{SchoolCode}/classes/{StudentID} /api/courses/{CourseID} /api/v2/CourseDataChanges/{year}/{month}/{day}/{hour}/{minute} /api/v3/staff/{StaffID}

Staff Classes/Sections Staff Data Changes Teacher Information Staff-Teacher Information

/api/v3/staff/{StaffID}/classes /api/v2/StaffDataChanges/{year}/{month}/{day}/{hour}/{minute} /api/schools/{SchoolCode}/teachers/{TeacherNumber} /api/v2/staff/{StaffID}/teachers

Section Information Section Data Changes

/api/v3/schools/{SchoolCode}/sections/{SectionNumber} /api/v2/SectionDataChanges/{year}/{month}/{day}/{hour}/{minute}

Quick Note {StudentID} is optional {StudentID} is optional {StudentID} is optional

{StudentID} is optional

Quick Note {StudentID} is optional {CourseID} is optional {StaffID} is optional QueryString conditions can be included to filter results on any staff object field. {StaffID} is required {TeacherNumber} is optional This end point will return a list of teacher records associated with the given Staff ID. {SectionNumber} is optional

Data Area Section Class Roster Section Class Roster Data Changes

Gradebook API End Points Data Area Gradebook Data Assignments Final Mark Ranges Gradebook Students Assignment Scores

Updating Assignment Scores Inserting a New Assignment

URL /api/v1/schools/{SchoolCode}/sections/{SectionNumber}/students /api/v2/SectionRosterDataChanges/{year}/{month}/{day}/{hour}/{minute}

Quick Note {SectionNumber} is REQUIRED

URL /api/v3/staff/{StaffID}/gradebooks /api/v3/schools/{SchoolCode}/sections/{SectionNumber}/gradebooks /api/v3/gradebooks/{GradebookNumber} /api/v3/gradebooks/{GradebookNumber}/assignments /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber} /api/v3/gradebooks/Assignments/{UniqueID} /api/v3/gradebooks/{GradebookNumber}/FinalMarks /api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students /api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students/{StudentID} /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} /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/UpdateScores /api/v3/gradebooks/assignments/{UniqueID}/UpdateScores /api/v3/gradebooks/{GradebookNumber}/InsertAssignment

Pagination Support:

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

Student Information Student Extended Student GPA Student Pictures Graduation Status Summary

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

Quick Note

POST

POST