Pearson
Always Learning

This API returns a student's current grade in a course, up to today. Unlike it's class-wide counterpart, this returns the detail for only a single student.

When used by a student's OAuth 2 Access Token, the data used will be limited to grades for which the grade review date is before today. (Sometimes, grades will be entered into the gradebook in advance of when the student is allowed to see them; among other reasons this may give the teacher more time to adjust grade curves.) Also, a student's Access Token can only retrieve that student's own grades, not others'. Other Access Token roles can use this API with any student's User ID in the course.

Best Practice: When retrieving all students' grades for a teacher's dashboard view, use the class-wide counterpart API instead.

Note: When comparing this API's result with that of its class-wide counterpart, the results may be different because this API excludes grades that the student is not yet permitted to see, whereas the other does not exclude those grades.



Supported Roles and Authentication Protocols

Type Supported Values
Authentication Protocols OAuth 1.0a, OAuth 2.0
Valid for Roles (OAuth 2): Professor, Teaching Assistant, Student, Administrator

API Request

API Endpoints

HTTP Verbs and URIs

GET /users/{userId}/courses/{courseId}/courseGradeToDate{.format}
  • Retrieves the user's current grade in the course.
  • If requested using a student's OAuth 2 Access Token, the result excludes grades for which the review date has not yet passed.

Parameters

Parameter Description Valid Values
{userId} LearningStudio User ID or relevant user overload.
  • Numeric ID issued by LearningStudio
  • loginid={clientString}|{username}
  • or replace /users/{userId} with /me
    (OAuth 2 only)
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query String Parameters

No Query String Parameters are supported.

Request Body

None

API Response

Response Header

This API returns the standard HTTP Status Codes used by the LearningStudio APIs. There are no special headers returned by the API.

Response Body

Format

{
  "courseGradeToDate": {
    "average": {gradeAverage},
    "earned": {pointsEarned},
    "possible": {pointsPossible},
    "extraCredit": {extraCredit},
    "isWeightingOn": {weightingFlag},
    "letterGrade": {
      "letterGrade": "{letterGrade}",
      "comments": "{commentText}"
    },
    "shareWithStudent": {shareWithStudentFlag}
  }
}

Property Descriptions

Name Description
{gradeAverage} Grade point average earned to date by student.
{pointsEarned} Course points earned to date by student.
{pointsPossible} Total points possible in course.
{extraCredit} Number of extra credit items earned to date by student.
{weightingFlag} Designates whether grade weighting is enabled. Value is boolean true or false.
{letterGrade} Letter grade earned to date by student (for example, A, B+).
{commentText} Any comments related to the letter grade.
{shareWithStudentFlag} Designates grade-to-date information is shared with the student. Value is boolean true or false.

Example

Request

Endpoint

GET /users/790823/courses/989879/coursegradetodate

Response

Body

{
  "courseGradeToDate": {
    "average": 90,
    "earned": 180,
    "possible": 200,
    "extraCredit": 0,
    "isWeightingOn": false,
    "letterGrade": {
      "letterGrade": "A-",
      "comments": "Great job<br />\r\n"
    },
  "shareWithStudent": true
  }
}
1623 reads
Always Learning
Pearson