Gradebook Information

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/staff/{StaffID}/gradebooks
    • StaffID (required) – the Aeries District Staff ID (numeric)
  • /api/v3/schools/{SchoolCode}/sections/{SectionNumber}/gradebooks
    • SchoolCode (required) – the Aeries School Code. This is normally 1-999.
    • SectionNumber (required) – the school-based Aeries section number.
  • /api/v3/gradebooks/{GradebookNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • Note: This can be used if you already have pulled a list of gradebooks for a teacher or section and want to refresh a specific gradebook's information. Returns a single “Gradebook” object rather than an “ArrayOfGradebook”.

Notes:

  • A method of retrieving ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system to generate a user interface.
  • Documentation on the Aeries Gradebook can be found here

Example Gradebook Information Results:

https://demo.aeries.net/aeries/api/v3/staff/994605/gradebooks

<ArrayOfGradebook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Gradebook>
    <AssignmentCategories>
      <AssignmentCategory>
        <Code>0</Code>
        <Color>6666ff</Color>
        <Description>Homework</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>10</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>2</Code>
        <Color>33ffff</Color>
        <Description>Test</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>25</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>3</Code>
        <Color>336699</Color>
        <Description>Quiz</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>20</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>4</Code>
        <Color>00ff66</Color>
        <Description>Presentations</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>25</PercentageOfGrade>
      </AssignmentCategory>
      <AssignmentCategory>
        <Code>5</Code>
        <Color>000000</Color>
        <Description>Reports</Description>
        <GradebookNumber>4366926</GradebookNumber>
        <PercentageOfGrade>20</PercentageOfGrade>
      </AssignmentCategory>
    </AssignmentCategories>
    <Comment></Comment>
    <EndDate>2017-08-28T00:00:00</EndDate>
    <GradebookNumber>4366926</GradebookNumber>
    <GradebookType></GradebookType>
    <LinkedGroup>1</LinkedGroup>
    <Name>IBHstAm2/HEcCv</Name>
    <Period>1</Period>
    <SchoolCode>994</SchoolCode>
    <Sections>
      <GradebookSection>
        <GradebookNumber>4366926</GradebookNumber>
        <SchoolCode>994</SchoolCode>
        <SectionNumber>1038</SectionNumber>
      </GradebookSection>
    </Sections>
    <Settings>
      <AddDropStudentsAutomatically>false</AddDropStudentsAutomatically>
      <ApplyRangeToStudent>false</ApplyRangeToStudent>
      <CountCompletedNow>true</CountCompletedNow>
      <CountHi>999</CountHi>
      <CountLo>1</CountLo>
      <CountMaxDate>2016-08-28T00:00:00</CountMaxDate>
      <CountMinDate>2015-08-04T00:00:00</CountMinDate>
      <DoingFormativeSummativeWeight>false</DoingFormativeSummativeWeight>
      <DoingMinMaxAssignmentValues>false</DoingMinMaxAssignmentValues>
      <DoingRubric>false</DoingRubric>
      <DoingWeight>true</DoingWeight>
      <FilterAssignmentsBy>AssignmentDueDate</FilterAssignmentsBy>
      <FormativePercentage>0</FormativePercentage>
      <GradebookNumber>4366926</GradebookNumber>
      <HideDroppedStudents>false</HideDroppedStudents>
      <HideOverallScore>false</HideOverallScore>
      <HideOverallScoreFromParentStudent>true</HideOverallScoreFromParentStudent>
      <MaxAssignmentValue>0</MaxAssignmentValue>
      <MinAssignmentValue>0</MinAssignmentValue>
      <ShowFinalMark>true</ShowFinalMark>
      <ShowFinalMarkToParentStudent>true</ShowFinalMarkToParentStudent>
      <ShowHi>999</ShowHi>
      <ShowLo>1</ShowLo>
      <ShowMaxDate>2016-08-28T00:00:00</ShowMaxDate>
      <ShowMinDate>2015-08-04T00:00:00</ShowMinDate>
      <ShowPointRatio>false</ShowPointRatio>
      <SingleTermGradebook>false</SingleTermGradebook>
      <SummativePercentage>0</SummativePercentage>
    </Settings>
    <StartDate>2016-08-04T00:00:00</StartDate>
    <TeacherEmailAddress>Teacher605@example.com</TeacherEmailAddress>
    <TeacherName>Acosta</TeacherName>
    <TeacherNumber>605</TeacherNumber>
    <Terms>
      <Term>
        <Code>F</Code>
        <EndDate>2016-12-23T00:00:00</EndDate>
        <GradebookNumber>4366926</GradebookNumber>
        <Name>Fall</Name>
        <StartDate>2016-07-11T00:00:00</StartDate>
      </Term>
      <Term>
        <Code>S</Code>
        <EndDate>2017-08-04T00:00:00</EndDate>
        <GradebookNumber>4366926</GradebookNumber>
        <Name>Spring</Name>
        <StartDate>2017-01-02T00:00:00</StartDate>
      </Term>
    </Terms>
  </Gradebook>
  …
  …
</ArrayOfGradebook>
XML


Field Documentation:

Gradebook

NameAeries Table.ColumnDescription
CommentGBK.COA comment associated with the gradebook for reference by the teacher.
EndDateGBK.D2The ending date of the gradebook. Usually the last day of the term associated with the gradebook.
GradebookNumberGBK.GNThe specific Aeries Gradebook Number. This is a unique number that is assigned at the time the gradebook is created and should not change.
GradebookTypeGBK.TY(not currently used)
LinkedGroupGBK.AGLinked Gradebooks group number. Gradebooks with the same number are considered linked together. A value of 0 is considered Ungrouped.
NameGBK.NMThe name of the gradebook as displayed throughout the system. This is typically the Course name; however, the teacher can modify the name.
PeriodGBK.PDThe period associated with this gradebook.
SchoolCodeGBK.SCThe Aeries school code
StartDateGBK.D1The starting date of the gradebook. Usually the first day of the term associated with the gradebook.
TeacherEmailAddressTCH.EMThe teacher’s email address
TeacherNameTCH.TEThe display name of the teacher. It may be different than teacher’s actual first and last name.
TeacherNumberGBK.TNThe school-based Aeries teacher number


Assignment Category

NameAeries Table.ColumnDescription
CodeGBT.ATAssignment Category Type. A code representing the gradebook assignment category. This is an internal code not normally displayed to our users.
ColorGBT.CLA hexadecimal color value. The teacher can choose to color-code each assignment category. The colors display in Aeries on the Scores By Class page.
DescriptionGBT.TDAssignment Category description (ex. Homework, Classwork, Class Participation, etc.). Category descriptions can be changed by teachers.
GradebookNumberGBT.GNThe specific Aeries Gradebook Number
PercentageOfGradeGBT.PGThis is used to weight categories. Valid values are 0-100. For example, Homework category may be worth 10% of the overall grade.


Gradebook Section

NameAeries Table.ColumnDescription
GradebookNumberGBE.GNThe specific Aeries Gradebook Number
SchoolCodeGBE.SCThe Aeries school code
SectionNumberGBE.SEThe school-based Master Schedule section number of the section associated with this gradebook. In an elementary school without a master schedule, this will match the Teacher Number instead.


Settings

NameAeries Table.ColumnDescription
AddDropStudentsAutomatically

All come from the GBO table. GBO.OPN is the name, and GBO.OV is the value

Students will be automatically added to and dropped from the gradebook based on changes to the section class roster
ApplyRangeToStudent(no longer used, but may be populated on older gradebooks)
CountCompletedNowScores entered into the gradebook apply immediately to the overall grade (essentially overrides the “Grading Completed” property of individual assignments).
CountHi(no longer used, but may be populated on older gradebooks)
CountLo(no longer used, but may be populated on older gradebooks)
CountMaxDate(no longer used, but may be populated on older gradebooks)
CountMinDate(no longer used, but may be populated on older gradebooks)
DoingFormativeSummativeWeightAllows the teacher to assign a percentage to summative assignments and a percentage to formative assignments.
DoingMinMaxAssignmentValuesWhen calculating the total grade, each assignment's score will be scaled to be within the defined min/max range.
DoingRubricThis gradebook is doing Rubric grading, meaning the total grade will be calculated by using trend analysis.
DoingWeightThis gradebook has percentages assigned to each assignment category.
FilterAssignmentsBy(no longer used, but may be populated on older gradebooks)
FormativePercentageIf DoingFormativeSummativeWeight is turned on, this is the percentage to weight Formative assignments.
GradebookNumberGBO.IDThe specific Aeries Gradebook Number
HideDroppedStudents

All come from the GBO table. GBO.OPN is the name, and GBO.OV is the value

If True, students who have been dropped from the gradebook will be hidden on the various “Scores By” pages. If False, dropped students instead display on a colored background at the bottom of the list.
HideOverallScoreDo not show the student’s overall score/percentage when a teacher or other staff is viewing the gradebook
HideOverallScoreFromParentStudentDo not show the student’s overall score/percentage when a parent or student is viewing the gradebook
MaxAssignmentValueIf DoingMinMaxAssignmentValues is turned on, this is the max value.
MinAssignmentValueIf DoingMinMaxAssignmentValues is turned on, this is the min value.
ShowFinalMarkDisplay the student’s overall mark (e.g., A, B, F) when a teacher or other staff is viewing the gradebook
ShowFinalMarkToParentStudentDisplay the student’s overall mark (e.g., A, B, F) when a parent or student is viewing the gradebook
ShowHi(no longer used, but may be populated on older gradebooks)
ShowLo(no longer used, but may be populated on older gradebooks)
ShowMaxDate(no longer used, but may be populated on older gradebooks)
ShowMinDate(no longer used, but may be populated on older gradebooks)
ShowPointRatioShows the overall point ratio to the teacher on the scores by class page. Example 300/1000.
SingleTermGradebookAllows a teacher to associate the gradebook to a single year-long term, instead of being restricted to the school defined Terms.
SummativePercentageIf DoingFormativeSummativeWeight is turned on, this is the percentage to weight Summative assignments.

 

Term

NameAeries Table.ColumnDescription
CodeGBR.CDThe code of the term; e.g., S = Spring, 1 = Trimester 1, etc. For Single Term Gradebooks, this value will be Y.
EndDateGBR.EDThe end date of the specified term.
GradebookNumberGBR.GNThe specific Aeries Gradebook Number
NameGBR.NMThe Term Description of the term; e.g., Spring, Fall, Trimester 1, etc. This value can be specified by the teacher if they are using a single term gradebook.
StartDateGBR.SDThe start date of the specified term.


Assignment Information

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (optional) – the specific Assignment Number
  • /api/v3/gradebooks/Assignments/{UniqueID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • A method of retrieving assignments for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system to generate a user interface.
  • If AssignmentNumber or UniqueID is passed, a single “Assignment” object is returned rather than an “ArrayOfAssignment”.

Example Assignment Information Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/assignments

<ArrayOfAssignment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Assignment>
    <AeriesAnalyticsExamID>0</AeriesAnalyticsExamID>
    <AeriesAnalyticsExamTestAdmin>0</AeriesAnalyticsExamTestAdmin>
    <AllowStudentDropBox>false</AllowStudentDropBox>
    <AssignmentCategory>
      <Code>0</Code>
      <Color>6666ff</Color>
      <Description>Homework</Description>
      <GradebookNumber>4366926</GradebookNumber>
      <PercentageOfGrade>10</PercentageOfGrade>
    </AssignmentCategory>
    <AssignmentNumber>2</AssignmentNumber>
    <Comment>Read Chapter 1, Section 1.</Comment>
    <DateAssigned>2016-08-04T00:00:00</DateAssigned>
    <DateDue>2016-08-06T00:00:00</DateDue>
    <Description>Ch 1-1</Description>
    <DueTime>0001-01-01T00:00:00</DueTime>
    <ExternalID></ExternalID>
    <FormativeSummativeIndicator>F</FormativeSummativeIndicator>
    <GradebookNumber>4366926</GradebookNumber>
    <GradingCompleted>true</GradingCompleted>
    <InputScoresByStandard>true</InputScoresByStandard>
    <NarrativeGradeSet>
      <NarrativeGrade>
        <Mark>AD</Mark>
        <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
        <PercentValue>95.0000</PercentValue>
      </NarrativeGrade>
      <NarrativeGrade>
        <Mark>BA</Mark>
        <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
        <PercentValue>75.0000</PercentValue>
      </NarrativeGrade>
      …
      …
    </NarrativeGradeSet>
    <NarrativeGradeSetID>1640411</NarrativeGradeSetID>
    <NumberCorrectPossible>10</NumberCorrectPossible>
    <PointsPossible>10</PointsPossible>
    <RubricAssignment>false</RubricAssignment>
    <ScoresVisibleToParents>true</ScoresVisibleToParents>
    <Standards>
      <AssignmentStandard>
        <AcademicBenchmarkId>F74BB748-3CFF-11D9-8407-9AE6FB2C8371</AcademicBenchmarkId>
        <AssignmentNumber>2</AssignmentNumber>
        <GradebookNumber>4366926</GradebookNumber>
        <NumberCorrectPossible>10</NumberCorrectPossible>
        <StandardDescription>Students distinguish valid arguments from fallacious….</StandardDescription>
        <StandardId>SHA.H.1</StandardId>
      </AssignmentStandard>
    </Standards>
    <UniqueID>76289310-6ACF-4124-9A42-057684DCE9F2</UniqueID>
    <VisibleToParents>true</VisibleToParents>
  </Assignment>
  …
  …
</ArrayOfAssignment>
XML


Field Documentation:

Assignment

NameAeries Table.ColumnDescription
AeriesAnalyticsExamIDGBA.EID(no longer used)
AeriesAnalyticsExamTestAdminGBA.ETA(no longer used)
AllowStudentDropBoxGBA.ADBIf turned on, this allows students to upload a document to this particular assignment via the Aeries Student Portal.
AssignmentNumberGBA.ANThe specific Assignment Number
CommentGBA.COMThis is a longer description of the assignment
DateAssignedGBA.DAThe date the assignment was assigned
DateDueGBA.DDThe date the assignment is due.
DescriptionGBA.ADThe name of the assignment as displayed throughout the system
DueTimeGBA.DUTUsed in conjunction with the AllowStudentDropBox option. The document can only be uploaded until this time.
ExternalIDGBA.EIThis is used to identify an assignment in third party systems such as Google Classroom.
FormativeSummativeIndicatorGBA.TYDefines an assignment as either Formative or Summative.
GradebookNumberGBA.GNThe specific Aeries Gradebook Number
GradingCompletedGBA.GCThis is a flag that notes whether the teacher is finished grading this assignment. Once the flag is turned on, the scores count toward students’ overall grade and will be considered “missing” if not yet scored.
InputScoresByStandardGBA.IBSThis denotes that the assignment is Input by Standard. Teachers will enter multiple scores per assignment, one for each standard.
NarrativeGradeSetIDGBA.CIDIf a narrative grading scale is in use on this assignment, this denotes which one is being used. A narrative grade set allows the teacher to choose from a list of marks rather than enter a numeric score for each student. Each narrative grade mark then corresponds to a certain percentage correct.
NumberCorrectPossibleGBA.NPThe number of questions (or points) possible for this assignment.
PointsPossibleGBA.MXThe maximum number of points that can be earned on this assignment.
RubricAssignmentGBA.RAIndicates whether this assignment is using Rubric Grading
ScoresVisibleToParentsGBA.SVPThe score is visible to parents and students in the Aeries Parent/Student Portal. Parents may see the assignment but not the score.
UniqueIDGBA.UIThe District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.
VisibleToParentsGBA.VPThe assignment is visible to parents and students in the Aeries Parent/Student Portal. Neither the score nor the assignment will be shown if this is False.

 

Assignment Category documentation is the same as that provided above.


Narrative Grade

NameAeries Table.ColumnDescription
MarkGBM.MKThe mark for the narrative grading scale. A teacher can use any number of letters, numbers, or symbols here.
NarrativeGradeSetIDGBM.CIDAn ID assigned to the narrative grade set by Aeries. Not typically displayed to the user.
PercentValueGBM.PMThe percentage associated with the mark.

 

Assignment Standard

NameAeries Table.ColumnDescription
AcademicBenchmarkIdSTN.BIDA specific ID used to relate Aeries standards to specific standards third party systems.
AssignmentNumberGBN.ANThe specific Assignment Number
GradebookNumberGBN.GNThe specific Aeries Gradebook Number
NumberCorrectPossibleGBN.NPThe maximum number of points attributed to this particular standard that can be earned on this assignment.
StandardDescriptionSTN.TIThe specific description of the Aeries Standard.
StandardIdGBN.SDThe specific ID of the Aeries Standard.


Updating Assignment Information 

Security Area:

  • "Gradebook Data" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
  • /api/v3/gradebooks/Assignments/{UniqueID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • This end point returns an “ArrayOfAssignment” container of “Assignment” objects similar to the regular Assignment Information end point; however, it contains only those records which were updated by the current Update request. The result is an array because the Assignment with the same Assignment Number will be updated in all Linked Gradebooks if the UpdateLinkedGradebooksToo option is set to “true” or omitted (defaults to “true”). Linked Gradebooks are all a teacher’s Gradebooks in the same school code with equal, nonzero values for “LinkedGroup” (see the Gradebook Information end point)

POST Payload Object:

  • “AssignmentUpdate” object

“AssignmentUpdate” Object Definition:

NameData TypeNotes
DescriptionStringMax length: 255. The title/description of the assignment.
AssignmentCategoryCodeStringMax length: 1. Must match an existing Assignment Category Code in the current Gradebook
DateAssignedDateThe date the assignment is assigned to students
DateDueDateThe date the assignment is due
NumberCorrectPossibleDecimalThe number of questions (or points) possible for this assignment. If omitted or the value is 0, then the value of PointsPossible will be used.
PointsPossibleDecimalREQUIRED The maximum number of points that can be earned on this assignment.
GradingCompletedBoolean(true or false. DEFAULT false if omitted) Indicates whether the teacher has finished grading this assignment and it should therefore count towards students’ overall grades
CommentStringA comment or note to provide additional information about the assignment. Though this field is optional, if it is omitted or blank, then any existing Comment will be overwritten with an empty string.
FormativeSummativeIndicatorStringValid values are “F” or “S”. Indicates whether this assignment is Formative or Summative.
RubricAssignmentBoolean(true or false. DEFAULT false if omitted) Indicates whether this assignment uses Rubric grading. Note: If this is true, then both NumberCorrectPossible and PointsPossible will automatically be set to 0 regardless of what values are passed. This option only works if the overall Gradebook is set to allow Rubric grading. If not, this field will automatically be interpreted as “false”
ExternalIDStringAn identifier for this assignment in an external system such as a Learning Management System (LMS).
UpdateLinkedGradebooksTooBoolean(true or false. DEFAULT true if omitted) Option to update the same assignment in any of the teacher’s Linked Gradebooks.


Example Payload:

{  
"Description":"Test the Aeries API",  
"AssignmentCategoryCode":"T",  
"DateAssigned":"2017-01-27",  
"DateDue":"2017-02-17",  
"NumberCorrectPossible":50,  
"PointsPossible":50,  
"GradingCompleted":false, 
"Comment":"Make sure the Gradebook end points work", 
"FormativeSummativeIndicator":"S",  
"RubricAssignment":false, 
"ExternalID":null,  
"UpdateLinkedGradebooksToo":true
}
Text


Inserting a New Assignment 

Security Area:

  • "Gradebook Data" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/InsertAssignment
    • GradebookNumber (required) – the specific Aeries Gradebook Number

Notes:

  • This end point returns an “ArrayOfAssignment” container of “Assignment” objects similar to the regular Assignment Information end point; however, it contains only those records which were added by the current Insert request. The result is an array because the new Assignment will be added in all Linked Gradebooks if the CreateInLinkedGradebooksToo option is set to “true” or omitted (defaults to “true”). Linked Gradebooks are all a teacher’s Gradebooks in the same school code with equal, nonzero values for “LinkedGroup” (see the Gradebook Information end point)

POST Payload Object:

  • “AssignmentInsert” object

“AssignmentInsert” Object Definition:

NameData TypeNotes
DescriptionStringREQUIRED Max length: 255. The title/description of the assignment. Empty string is allowed (though not encouraged), but field cannot be omitted or null.
AssignmentCategoryCodeStringMax length: 1. Must match an existing Assignment Category Code in the current Gradebook. If invalid or omitted, the first Assignment Category Code in the Gradebook will be used by default.
DateAssignedDateThe date the assignment is assigned to students. If omitted or null, the DateDue will be used. If both are omitted or null, today’s date will be used.
DateDueDateThe date the assignment is due. If omitted or null, the DateAssigned will be used. If both are omitted or null, today’s date will be used.
NumberCorrectPossibleDecimalThe number of questions (or points) possible for this assignment. If omitted or the value is 0, then the value of PointsPossible will be used.
PointsPossibleDecimalThe maximum number of points that can be earned on this assignment.
CommentStringA comment or note to provide additional information about the assignment.
FormativeSummativeIndicatorStringValid values are “F” or “S”. Indicates whether this assignment is Formative or Summative. If omitted or invalid, “S” will be used by default.
RubricAssignmentBoolean(true or false. DEFAULT false if omitted) Indicates whether this assignment uses Rubric grading. Note: If this is true, then both NumberCorrectPossible and PointsPossible will automatically be set to 0 regardless of what values are passed. This option only works if the overall Gradebook is set to allow Rubric grading. If not, this field will automatically be interpreted as “false”
ExternalIDStringAn identifier for this assignment in an external system such as a Learning Management System (LMS).
CreateInLinkedGradebooksTooBoolean(true or false. DEFAULT true if omitted) Option to create the same assignment in the teacher’s Linked Gradebooks.


Example Payload:

{  
"Description":"Test the Aeries API",  
"AssignmentCategoryCode":"T", 
 "DateAssigned":"2017-01-27",  
"DateDue":"2017-02-17", 
 "NumberCorrectPossible":50,  
"PointsPossible":50,  
"Comment":"Make sure the Gradebook end points work",  
"FormativeSummativeIndicator":"S",  
"RubricAssignment":false,  "ExternalID":"",  
"CreateInLinkedGradebooksToo":true
}
Text


Final Mark Ranges 

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/FinalMarks
    • GradebookNumber (required) – the specific Aeries Gradebook Number

Notes:

  • A method of retrieving final marks for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system.
  • In Aeries, the "Low Value" is used as a threshold. The "High Value" is informational only, except that if the High Value is 0 (zero), then the Final Mark is not being used.

Example Final Mark Ranges Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/FinalMarks

<ArrayOfFinalMark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <FinalMark>
    <HighValue>110.0000</HighValue>
    <LowValue>98.0000</LowValue>
    <Mark>A+</Mark>
  </FinalMark>
  <FinalMark>
    <HighValue>97.9900</HighValue>
    <LowValue>93.0000</LowValue>
    <Mark>A</Mark>
  </FinalMark>
  <FinalMark>
    <HighValue>92.9900</HighValue>
    <LowValue>90.0000</LowValue>
    <Mark>A-</Mark>
  </FinalMark>
  …
  …
</ArrayOfFinalMark>
XML


Field Documentation:

NameAeries Table.ColumnDescription
HighValueGTG.HIHigh Value (informational only see note above)
LowValueGTG.LOThe Low Value for this range.
MarkGTG.MKThe Mark assigned to this range ex. A, B+, etc.


Gradebook Student Information 

Security Area:

  • "Gradebook Data"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/{GradebookTerm}/students/{StudentID}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • GradebookTerm (required) – the Term Code from the Gradebook object (Gradebook à Terms à Term à Code)
    • StudentID (optional) - the Aeries Student District Permanent ID Number.
      • Note: This can be used if you already have pulled a list of students for a gradebook and want to refresh a specific student's information. Returns a single “Student” object rather than an “ArrayOfStudent”.

Notes:

  • A method of retrieving students for ALL gradebooks for a school or district is not possible. It is recommended that this API be called on the fly when needed by your system.
  • Also not available at this time is the ability to request a set of gradebooks for a specific student. This will be available in a future enhancement.

Example Gradebook Student Information Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4366926/F/students

<ArrayOfStudent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <Student>
    <CurrentMark>A-</CurrentMark>
    <CurrentPercentage>91.5384</CurrentPercentage>
    <CurrentTerm>F</CurrentTerm>
    <CustomSortOrder>1</CustomSortOrder>
    <EndDate>2017-08-04T00:00:00</EndDate>
    <HighAssignmentNumber>0</HighAssignmentNumber>
    <InactiveTag></InactiveTag>
    <LowAssignmentNumber>0</LowAssignmentNumber>
    <PermanentID>99400001</PermanentID>
    <SchoolCode>994</SchoolCode>
    <StartDate>2016-07-11T00:00:00</StartDate>
    <StudentFirstName>Allan</StudentFirstName>
    <StudentGradeLevel>12</StudentGradeLevel>
    <StudentLastName>Abbott</StudentLastName>
    <StudentMiddleName>James</StudentMiddleName>
    <StudentNumber>1</StudentNumber>
    <StudentSex>M</StudentSex>
  </Student>
  …
  …
</ArrayOfStudent>
XML


Field Documentation:

NameAeries Table.ColumnDescription
CurrentMarkGBV.MKThe student’s overall current mark for this gradebook.
CurrentPercentageGBV.PCThe student’s overall current percentage for this gradebook.
CurrentTermGBV.CDThe term that this mark applies to. Usually F, S, Y, 1, 2, 3, or 4.
CustomSortOrderGBU.SRTA custom sort order that a teacher can assign to sort students in their gradebook.
EndDateGBU.D2The student’s end date for this gradebook. Normally the last day of the term unless the student dropped the class at an earlier date.
HighAssignmentNumberGBU.HI(no longer used)
InactiveTagGBU.TGIs the student inactive in this gradebook
LowAssignmentNumberGBU.LO(no longer used)
PermanentIDSTU.IDThe Permanent ID of this student
SchoolCodeGBU.SCThe Aeries school code
StartDateGBU.D1The student’s beginning date for this gradebook. Normally the first day of the term unless the student enrolled in the class at a later date.
StudentFirstNameSTU.FNThe student’s first name
StudentGradeLevelSTU.GRThe student’s grade level
StudentLastNameSTU.LNThe student’s last name
StudentMiddleNameSTU.MNThe student’s middle name
StudentNumberGBU.SNThe school-based Student Number for this student
StudentSexSTU.SXThe student's sex or gender (May be M or F or another coded value for non-binary gender identifications)


Assignment Scores 

Security Area:

  • "Gradebook Scores"

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/scores/{StudentID}
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
    • StudentID (optional) – the Aeries Student District Permanent ID Number
      • Note: This can be used if you already have pulled a list of scores for an assignment and want to refresh a specific student’s information. Returns a single “AssignmentScore” object rather than an “ArrayOfAssignmentScore”.
  • /api/v3/gradebooks/assignments/{UniqueID}/scores/{StudentID}
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.
    • StudentID (optional) – the Aeries Student District Permanent ID Number
      • Note: This can be used if you already have pulled a list of scores for an assignment and want to refresh a specific student’s information. Returns a single “AssignmentScore” object rather than an “ArrayOfAssignmentScore”.

Notes:

  • A method of retrieving scores for ALL assignments in a gradebook is not possible. It is recommended that this API be called on the fly when needed by your system.
  • For Standards-based grades, the list of standards and the "Academic Benchmark Id" is available through the Assignment Information API.
  • Also for Standards-based grades, the Number Correct and Points Earned fields will always match.
  • For Rubric-based grades, the Number Correct Possible and Points Possible fields will be 0 (zero). Also, the Number Correct and Points Earned fields will match.

Example Assignment Scores Results:

https://demo.aeries.net/aeries/api/v3/gradebooks/4454703/assignments/80/scores

<ArrayOfAssignmentScore xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schemas.datacontract.org/2004/07/Aeries.API.v3.Public.Models.Gradebook">
  <AssignmentScore>
    <AssignmentNumber>80</AssignmentNumber>
    <DateCompleted>2017-02-06T00:00:00</DateCompleted>
    <GradebookNumber>4454703</GradebookNumber>
    <IsMissing>false</IsMissing>
    <IsRuleReplacingScore>false</IsRuleReplacingScore>
    <Mark>4.0000</Mark>
    <NumberCorrect>4</NumberCorrect>
    <NumberCorrectPossible>0</NumberCorrectPossible>
    <PercentCorrect>0</PercentCorrect>
    <PermanentID>99000007</PermanentID>
    <PointsEarned>4</PointsEarned>
    <PointsPossible>0</PointsPossible>
    <RuleNumberApplied>0</RuleNumberApplied>
    <RuleReplacedScore>0</RuleReplacedScore>
    <StandardScores>
      <AssignmentStandardScore>
        <Mark>4</Mark>
        <NumberCorrect>4.0000</NumberCorrect>
        <NumberCorrectPossible>0.0000</NumberCorrectPossible>
        <PercentCorrect>0.0000</PercentCorrect>
        <PointsEarned>4.0000</PointsEarned>
        <PointsPossible>0.0000</PointsPossible>
        <StandardId>CEL.4.L.5</StandardId>
      </AssignmentStandardScore>
      <AssignmentStandardScore>
        <Mark>4</Mark>
        <NumberCorrect>4.0000</NumberCorrect>
        <NumberCorrectPossible>0.0000</NumberCorrectPossible>
        <PercentCorrect>0.0000</PercentCorrect>
        <PointsEarned>4.0000</PointsEarned>
        <PointsPossible>0.0000</PointsPossible>
        <StandardId>CEL.4.RI.9</StandardId>
      </AssignmentStandardScore>
    </StandardScores>
  </AssignmentScore>
  …
  …
</ArrayOfAssignmentScore>
XML


Field Documentation:

Assignment Score

NameAeries Table.ColumnDescription
AssignmentNumberGBS.ANThe specific Assignment Number
DateCompletedGBS.DCThe date the student completed/submitted the assignment
GradebookNumberGBS.GNThe specific Aeries Gradebook Number
IsMissing
Indicates whether this counts as a missing assignment for the student. Typically, this will be true under the following conditions:
  • The student is not permanently excused from the assignment
  • The student has no mark entered on the assignment
  • The Grading Completed flag for the assignment is set to true
IsRuleReplacingScore
Indicates whether a Gradebook Rule will replace this student’s actual score in the overall grade calculation.
Gradebook Rules can be set by the teacher for each Gradebook. For example: drop the lowest score in the Quiz category and replace it with the average of remaining scores in the Quiz category.
MarkGBS.MKThe mark entered for the student on this assignment. Usually numeric, but there are special marks such as “NA” (not applicable; i.e., excused) and “TX” (temporarily excused). Also, if a Narrative Grade set is used, the mark from the Narrative Grade set will display here. Also, marks can be expressed as a percentage such as 95%.
NumberCorrectGBS.NCThe number of questions (or points) the student answered correctly.
NumberCorrectPossibleGBS.NPThe number of questions (or points) possible for this assignment for this student.
PercentCorrectGBS.PCThe percentage of possible points earned by the student.
PermanentIDSTU.IDThe Permanent ID of the student
PointsEarnedGBS.SCRThe number of points earned by the student
PointsPossibleGBS.MXThe maximum number of points the student could have earned
RuleNumberApplied
If a Gradebook Rule was applied to this score, this is the rule number. Note: There is currently no API end point that provides detailed information on Gradebook Rules
RuleReplacedScore
The percent score that will replace this student’s actual score due to a Gradebook Rule being applied. Expressed as a decimal (e.g., 0.9 = 90%)


Assignment Standard Score

NameAeries Table.ColumnDescription
MarkGBD.MKThe mark attributed to this particular standard entered for this student on this assignment
NumberCorrectGBD.NCThe number of points attributed to this particular standard earned by the student
NumberCorrectPossibleGBD.NPThe maximum number of points attributed to this particular standard that the student could have earned
PercentCorrectGBD.PCThe percentage of possible points attributed to this particular standard earned by the student
PointsEarnedGBD.SCRThe number of points attributed to this particular standard earned by the student
PointsPossibleGBD.MXThe maximum number of points attributed to this particular standard that the student could have earned
StandardIdGBD.SDThe specific Standard ID


Updating Assignment Scores 

Security Area:

  • "Gradebook Scores" - Update

URL(s):

  • /api/v3/gradebooks/{GradebookNumber}/assignments/{AssignmentNumber}/UpdateScores
    • GradebookNumber (required) – the specific Aeries Gradebook Number
    • AssignmentNumber (required) – the specific Assignment Number
  • /api/v3/gradebooks/assignments/{UniqueID}/UpdateScores
    • UniqueID (required) – The District-wide Unique ID for this assignment. The teacher has the ability to change the Assignment Number, but the Unique ID for an assignment will never change. Once the Unique ID is known, it can be used to guarantee that future API calls refer to the same assignment.

Notes:

  • This end point returns an “ArrayOfAssignmentScore” container of “AssignmentScore” objects similar to the regular Assignment Scores end point. Regardless of how many scores are updated, all scores for the selected assignment will be returned after the update is completed.
  • For Standards-based grades, the list of standards and the "Academic Benchmark Id" are available through the Assignment Information API.
  • For Rubric-based grades, send the numeric Rubric value for Number Correct.

POST Payload Object:

  • Array of “AssignmentScoreUpdate” object

“AssignmentScoreUpdate” Object Definition:

NameData TypeNotes
PermanentIDInt32Student District Permanent ID number
NumberCorrectDecimalThe number of questions (or points) earned on this assignment. Handles up to 4 decimal places. Do not populate if StandardScores are being sent.
DateCompletedDateOnly populate if you really want to put in a specific value. Otherwise, Aeries will automatically use the Due Date of the assignment.
StandardScoresArray of AssignmentStandardScoreUpdateThis is an array of custom objects. See below for details.


“AssignmentStandardScoreUpdate” Object Definition:

NameData TypeNotes
AeriesStandardIDStringEither this field or the AcademicBenchmarkID field must be populated. This needs to match information originally found in the "Assignment" object.
AcademicBenchmarkIDStringEither this field or the AeriesStandardID field must be populated. This needs to match information originally found in the "Assignment" object.
NumberCorrectDecimalThe number of questions (or points) earned on this standard, within the given assignment. Handles up to 4 decimal places.


Example Payload (for an assignment NOT using Input Scores By Standard):

[  
{    
 "PermanentID":99400001,    
 "NumberCorrect":20, 
 },  
{    
 "PermanentID":99400318,    
 "NumberCorrect":42,    
 "DateCompleted":"2017/02/17", 
 }
]
Text


Example Payload (for an assignment using Input Scores By Standard):

[ 
 {    
 "PermanentID":99000007,     "StandardScores":    
 [      
 {         
"AcademicBenchmarkID":"1C799626-9892-11E0-8388-5F489DFF4B22",         
"NumberCorrect":2       
},      
 {        
 "AeriesStandardID":"CEL.4.RI.9",        
 "NumberCorrect":4      
 }    
 ] 
 },  
{    
 "PermanentID":99000018,     
"DateCompleted":"2017/02/17",     
"StandardScores":     
[      
 {         
"AcademicBenchmarkID":"1C799626-9892-11E0-8388-5F489DFF4B22",         "NumberCorrect":4       
},       
{         
"AeriesStandardID":"CEL.4.RI.9",         
"NumberCorrect":4      
 }     
]  
}
]
Text