• Student GPAs
• Student Grades
• Student Report Cards
• School Report Card Marking Periods
• School Graduation Requirements
• Student Graduation Status Summary
• Student Transcripts
• Valid Marks
• Standards-Based Valid Marks and Grades

Student GPAs

Security Area:

• "Student Data"

URL(s):

• /api/v5/schools/{SchoolCode}/gpas/{StudentID}
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • StudentID (optional) – The Aeries Student District Student ID Number.

Query String Filters:

• StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
• EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

• If Student ID is not passed, all students for the given school will be returned.

Example Student GPAs Results:

[
    {
        "StudentID": 99400001,
        "SchoolCode": 994,
        "ClassRank": 17,
        "ClassSize": 466,
        "ClassRank1012": 13,
        "GPA_CumulativeAcademic": 3.9691,
        "GPA_CumulativeTotal": 3.9725,
        "GPA_CumulativeAcademic1012": 4.0411,
        "GPA_CumulativeAcademicNonWeighted": 3.5773,
        "GPA_CumulativeTotalNonWeighted": 3.6239,
        "GPA_CumulativeAcademic1012NonWeighted": 3.5205,
        "GradePointsCumulative": 192.5000,
        "GPA_UC_Preliminary": 3.8300,
        "GPA_CSU_Preliminary": 3.8400,
        "GPA_CumulativeCitizenship": 0.0000,
        "GPA_GradeReportingCitizenship": 0.0000,
        "CreditsAttempted": 272.5000,
        "CreditsCompleted": 272.5000,
        "GPA_GradeReportingAcademic": 4.4000,
        "GPA_GradeReportingTotal": 4.4000,
        "GPA_GradeReportingAcademicNonWeighted": 3.8000,
        "GPA_GradeReportingTotalNonWeighted": 3.8000,
        "GradeReportingClassRank": 9,
        "GradeReportingClassSize": 463,
        "GradeReportingCreditsAttempted": 25.0000,
        "GradeReportingCreditsCompleted": 25.0000
    }
]

Field Documentation:

Student Grades ↑

Security Area:

• "Grades" – Update

URL(s):

• POST /api/v5/schools/{SchoolCode}/grades
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

• This end point allows POST to the following fields only for records that already existing in the Grades (GRD) table:
  • Grade Marks: GRD.M1 - M12
  • Comments ( GRD.C1 -C3)
  • Citizenship: (GRD.CI)
  • Work Habits:  GRD.WH
    
    
• Current Mark Restriction - The API enforces restrictions based on the current marking period (LOC.TM):
  • Comment1-3, Citizenship, WorkHabits: Only updated when the requested MarkNumber matches the current marking period
  • The Completion Status (GRD.TG): Only calculated/updated for the current marking period
  • Historical Marks: Mark values (M1-M12) can still be updated for any valid marking period
• Validation Rules
  • One Mark Per Request Item: Each item in the request updates one mark, identified by MarkNumber and MarkValue. If MarkNumber is omitted, nothing is updated, but the item is still reported as successful.
  • MarkNumber must be between 1-12 and configured in GRP table for the school
  • Mark Validation (M1-M12): Validates against GRC table (SC, MK, DEL=0). Empty marks allowed.
  • Comment Validation (C1-C3): All three comments are validated against the same comment code list in the COD table (TC='GRD', FC='C1', DEL=0)
  • Citizenship/Work Habits (CI, WH): Validates against COD table (TC='GRD', FC='CI'/'WH', DEL=0)
    
    Related Endpoints

    Endpoint	Description
    POST /api/v5/schools/{sc}/grades	Update grade reporting data (requires valid marks from this endpoint)

Example Student Grades Results:  


Field Documentation:

Student Report Cards ↑

Security Area:

• "Grades"

URL(s):

• /api/v5/schools/{SchoolCode}/ReportCard/{StudentID}
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • StudentID (optional) – The Aeries Student District Student ID Number.

Notes:

• If Student ID is not passed, all students for the given school will be returned.

Example Student Report Cards Results:

[
    {
        "StudentID": 89400002,
        "StudentReportCardCourses": [
            {
                "SchoolCode": 894,
                "CourseID": "0010",
                "CourseTitle": "PE 9",
                "Period": "5",
                "SectionNumber": 5065,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894607,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "A",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 0,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 73,
                        "TotalExcusedAbsences": 1,
                        "TotalUnExcusedAbsences": 0,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            },
            {
                "SchoolCode": 894,
                "CourseID": "0301",
                "CourseTitle": "English 9 Cp",
                "Period": "6",
                "SectionNumber": 6089,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894694,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "B+",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 1,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 73,
                        "TotalExcusedAbsences": 0,
                        "TotalUnExcusedAbsences": 1,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            },
            {
                "SchoolCode": 894,
                "CourseID": "0416",
                "CourseTitle": "Spanish I",
                "Period": "1 Flex",
                "SectionNumber": 1156,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894730,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "C",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 0,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 74,
                        "TotalExcusedAbsences": 0,
                        "TotalUnExcusedAbsences": 0,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            },
            {
                "SchoolCode": 894,
                "CourseID": "0645",
                "CourseTitle": "Adv Algebra CP",
                "Period": "4",
                "SectionNumber": 4009,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894725,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "A-",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 1,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 73,
                        "TotalExcusedAbsences": 0,
                        "TotalUnExcusedAbsences": 1,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            },
            {
                "SchoolCode": 894,
                "CourseID": "0674",
                "CourseTitle": "Phys Science,CP",
                "Period": "3 Flex",
                "SectionNumber": 3134,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894807,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "B",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 0,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 74,
                        "TotalExcusedAbsences": 0,
                        "TotalUnExcusedAbsences": 0,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            },
            {
                "SchoolCode": 894,
                "CourseID": "0968",
                "CourseTitle": "Leadership",
                "Period": "2 Flex",
                "SectionNumber": 2008,
                "TeacherNumber": 0,
                "MarkingPeriodGrades": [
                    {
                        "PrimaryStaffID": 894721,
                        "Hours": 0.0,
                        "AttendanceBasedGradesIndicator": "",
                        "MarkingPeriod": 1,
                        "Mark": "B+",
                        "Credit": 5.0,
                        "Comment1Code": "",
                        "Comment2Code": "",
                        "Comment3Code": "",
                        "CitizenshipCode": "",
                        "WorkHabitsCode": "",
                        "TotalAbsences": 0,
                        "TotalTardies": 0,
                        "TotalDaysEnrolled": 74,
                        "TotalDaysPresent": 74,
                        "TotalExcusedAbsences": 0,
                        "TotalUnExcusedAbsences": 0,
                        "TotalDaysOfSuspension": 0
                    }
                ]
            }
        ]
    }
]

Field Documentation:

Note: For the current marking period, the “GRD” table will be used instead of the “GRH” table, so all references in Field Documentation to “GRH will be replaced with “GRD”. The current marking period can be identified by calling the “School Report Card Marking Periods” API

For descriptions of the various coded values, use our Code Sets API: ~api/v5/codes/ReportCard/{ElementName}

School Report Card Marking Periods ↑

Security Area:

• "Grades"

URL(s):

• /api/v5/schools/{SchoolCode}/ReportCardMarkingPeriods
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

• This end point returns information about each Report Card Marking Period for the school and can be used to cross-reference with the “MarkingPeriod” number from the Student Report Cards API
• Only marking periods that have a heading set up in Aeries are returned.

Example School Report Card Marking Periods Results:

[
{
        "BeginningDate": "2020-07-06T00:00:00",
        "EndingDate": "2020-09-01T00:00:00",
        "StateReportingCode": "",
        "MarkingPeriod": 1,
        "ShortDescription": "1st PRG",
        "LongDescription": "First Progress",
        "IsCurrentMarkingPeriod": true
    },
    {
        "BeginningDate": "2020-07-06T00:00:00",
        "EndingDate": "2020-10-16T00:00:00",
        "StateReportingCode": "",
        "MarkingPeriod": 2,
        "ShortDescription": "1st Qtr",
        "LongDescription": "First Semester",
        "IsCurrentMarkingPeriod": false
    },
    {
        "BeginningDate": "2021-01-04T00:00:00",
        "EndingDate": "2020-03-26T00:00:00",
        "StateReportingCode": "",
        "MarkingPeriod": 3,
        "ShortDescription": "2d PRG",
        "LongDescription": "Second Progress",
        "IsCurrentMarkingPeriod": false
    }
]

Field Documentation:

School Graduation Requirements ↑

Security Area:

• "Graduation Requirements"

URL(s):

• /api/v5/schools/{SchoolCode}/GraduationRequirements
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

Example School Graduation Requirements Results:

[
 {
        "SubjectAreas": [
            {
                "SubjectAreaCode": "A",
                "SubjectAreaDescription": "English",
                "RequiredCreditFor12thGraders": 40.0000,
                "RequiredCreditFor11thGraders": 40.0000,
                "RequiredCreditFor10thGraders": 40.0000,
                "RequiredCreditFor9thGraders": 40.0000
            },
            {
                "SubjectAreaCode": "B",
                "SubjectAreaDescription": "Physical Education",
                "RequiredCreditFor12thGraders": 30.0000,
                "RequiredCreditFor11thGraders": 20.0000,
                "RequiredCreditFor10thGraders": 20.0000,
                "RequiredCreditFor9thGraders": 20.0000
            },
               ...
            {
                "SubjectAreaCode": "Z",
                "SubjectAreaDescription": "Electives",
                "RequiredCreditFor12thGraders": 55.0000,
                "RequiredCreditFor11thGraders": 55.0000,
                "RequiredCreditFor10thGraders": 45.0000,
                "RequiredCreditFor9thGraders": 45.0000
            }
        ],
        "SchoolCode": 994,
        "GraduationRequirementTrack": ""
    }
]

Field Documentation:

Student Graduation Status Summary ↑

Security Area:

• "Graduation Status"

URL(s):

• /api/v5/schools/{SchoolCode}/GraduationStatusSummary/{StudentID}
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • StudentID (optional) – the Aeries Student District Student ID Number.
• /api/v5/schools/{SchoolCode}/GraduationStatusSummary/grade/{GradeLevel}
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • GradeLevel (required) – the Academic grade level of the set of students to return.

Query String Filters:

• StartingRecord – (numeric) The Record-Count value of the first record to return (inclusive).
• EndingRecord – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

• If StudentID is not passed, all students in the selected school will be returned.

Example Student Graduation Status Summary Results:

{
        "StudentID": 99400001,
        "SubjectAreas": [
            {
                "SubjectAreaCode": "A",
                "SubjectAreaDescription": "English",
                "CreditsRequired": 40.00,
                "CreditsCompleted": 35.00,
                "CreditsCurrentlyEnrolled": 5.0,
                "CreditsNeeded": 0.00
            },
            {
                "SubjectAreaCode": "B",
                "SubjectAreaDescription": "Physical Education",
                "CreditsRequired": 30.00,
                "CreditsCompleted": 30.00,
                "CreditsCurrentlyEnrolled": 0.0,
                "CreditsNeeded": 0.00
            },
            {
                "SubjectAreaCode": "C",
                "SubjectAreaDescription": "Social Science",
                "CreditsRequired": 30.00,
                "CreditsCompleted": 30.00,
                "CreditsCurrentlyEnrolled": 0.0,
                "CreditsNeeded": 0.00
            },
            ...
      ],
        "SchoolCode": 994,
        "GraduationRequirementTrack": ""
    }

Field Documentation:

* These values are based on calculations for which the logic is too complex to detail in this document.

Note: Excess credits in a subject area are always allocated to the “Electives” subject area. Therefore, CreditsCompleted will never exceed CreditsRequired except possibly in the “Electives” subject area.

Student Transcripts ↑

Security Area:

• "Transcripts"

URL(s):

• /api/v5/schools/{SchoolCode}/Transcript/{StudentID}
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
  • StudentID (optional) – The Aeries Student District Student ID Number.

Query String Filters:

• StartingStudent – (numeric) The Record-Count value of the first record to return (inclusive).
• EndingStudent – (numeric) The Record-Count value of the last record to return (inclusive).

Notes:

• If StudentID is not passed, all students in the selected school will be returned.

Example Student Transcripts Results:

 {
        "StudentID": 99400001,
        "CourseGrades": [
            {
                "Hours": 0.0000,
                "RecordSourceCode": "",
                "DualEnrollmentCreditSchoolCode": 0,
                "DateOfCompletion": null,
                "CollegeCreditHours": 0.0000,
                "PassFailCreditCode": "",
                "CourseID": "100386",
                "TranscriptCourseTitle": "",
                "Mark": "B",
                "CreditAttempted": 0.0000,
                "CreditCompleted": 0.0000,
                "StudentGrade": 8,
                "Term": 1,
                "TermDescription": "Fall",
                "SchoolYear": "2016-2017",
                "SchoolTakenID": 993,
                "SchoolTakenName": "Bald Eagle Intermediate School",
                "SchoolTakenStateID": "65999999999993",
                "RepeatTagCode": "",
                "CitizenshipMark": "O",
                "SequenceNumber": 35,
                "TotalAbsences": 0,
                "TotalTardies": 0,
                "TotalDaysEnrolled": 89,
                "TotalDaysPresent": 89,
                "TotalExcusedAbsences": 0,
                "TotalUnExcusedAbsences": 0,
                "TotalDaysOfSuspension": 0,
                "SectionNumber": 0,
                "StaffID": 0
            },
       ...
       ...
     ],
        "SchoolCode": 994
    }
]

Field Documentation:

For descriptions of the Codes, use our "Code Sets" API: `/api/v5/codes/Transcript/{ElementName}

Valid Marks ↑

Security Area:

• "Grade Reporting:  Valid Marks"

URL(s):   

• /api/v5/schools/{SchoolCode}/validmarks
  • SchoolCode (required) – the Aeries School Code. This is normally 1-999.

Notes:

• This end point retrieves the Valid Marks (Grade Codes) from the GRC table. Deleted marks are not returned.
• Related Endpoints

  Endpoint	Description
  POST /api/v5/schools/{sc}/grades	Update grade reporting data (requires valid marks from this endpoint)

Example of Valid Mark Results:  

Field Documentation:

Standards-Based Valid Marks and Grades ↑

Security Area:

• "Standards Based Valid Marks" – Read (for the GET end point)
• "Standards Based Grades (write-back)" – Update (for the POST end point)

URL(s):

• GET /api/v5/schools/{SchoolCode}/standardsbasedvalidmarks
  • Returns the school’s Standards-Based Valid Marks.
• POST /api/v5/schools/{SchoolCode}/standardsbasedgrades
  • Updates standards-based marks and comments for existing student standards-based grade records.

Notes:

• The POST end point only updates existing records. Each record is identified by StudentID, StandardID, GradeLevel, MarkType, and ReportCardType, and must already be set up in Aeries; otherwise that item fails with “No SBG record exists for the specified key”.
• The request body is an array of update items. The response has the same format as the Student Grades POST: TotalCount, SuccessCount, FailureCount, and a Results list with Success and Errors for each item.

Standards-Based Valid Mark Fields:

Standards-Based Grade Update Fields: