Always include the absolute score in the results from Get Column Grades

Idea created by Peter Love on Jun 11, 2019
    Open for voting
    Score1
    • Peter Love

    Include a field in the response from Get Column Grades (/learn/api/public/v2/courses/{courseId}/gradebook/columns/{columnId}/users) that always contains the gradebook absolute score.

     

    displayGrade.score currently contains this unless the scaleType is percent.  In this case the value returned is the percent score.  Unless the score has been overridden, this means that if you need the absolute score you need to check the scale type and calculate the absolute score using the maximum value.  If you do not know the maximum value, you need to make a column call to get it and cache it if making multiple calls.

     

    To be consistent with the other scale types (eg., Tabular, CompleteIncomplete) it may have been better to return the percent in displayGrade.text and absolute in displayGrade.score.  Or perhaps there were issues around doing that.

     

    This would be consistent with the overridden grade fields where the score is always the absolute score, regardless of scale type.

     

    Perhaps the score field that is returned when a grade is overridden could always be returned and the overridden field could be used to indicate if its actually an override.  The docs already say this is null if the grade isn't overridden.

    Product Version (if applicable):0