Pearson
Always Learning

This API retrieves the current grades to date for all students in a course, up to 30. If there are more than 30 students in a course, you can filter the results by user ID or paginate the results over several API calls.

Note: When comparing this API's result with that of its student-specific counterpart, the results may be different because this API includes all grades recorded for a student regardless of visibility restrictions. The other API excludes grades that the student is not yet permitted to see.

Note: This API will return the current pagination information and total number of results available in an Response HTTP Header, see below.



Supported Roles and Authentication Protocols

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

API Request

API Endpoints

HTTP Verbs and URIs

GET /users/{userId}/courses/{courseId}/courseGradeToDate{.format}
  • Retrieves up to 30 students' current grades in a course.

Parameters

Parameter Description Valid Values
{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

Query Parameter Name Description Valid Values
offset Defines the number of records to skip, used when paginating the results and there are more than 30 students in the course. Must be combined with the limit parameter. Any integer less than the number of students in a course.
limit Defines the number of records to return, used when paginating the results and there are more than 30 students in the course. Must be combined with the offset parameter. Any integer 0 - 30.
student.id Limits the results to only the user IDs specified here. Include multiple user IDs (up to 30) by separating them with commas. Numeric IDs issued by LearningStudio, separated with commas.

Request Body

None

API Response

Response Header

This API returns the standard HTTP Status Codes used by the LearningStudio APIs.

Additionally, the API will return an HTTP Header named Content-Range that provides the current pagination information and total number of results, in the following format:

Content-Range: items {beginNum}-{endNum}/{total}
Parameter Name Description
{beginNum} Beginning of the range of retrieved student grades.
{endNum} End of the range of retrieved student grades.
{total} Total number of student grades available to be retrieved.

Response Body

Format

{
  "rosterCourseGradesToDate" : [{
    "student" : {
      "firstName" : "{firstName}",
      "lastName" : "{lastName}",
      "id" : {userId},
      "links" : [{
        "href" : "{userHref}",
        "rel" : "https://api.learningstudio.com/user"
        }
      ]
    },
    "courseGradeToDate" : {
      "average" : {gradeAverage},
      "earned" : {pointsEarned},
      "possible" : {pointsPossible},
      "extraCredit" : {extraCredit,
      "isWeightingOn" : {weightingFlag},
      "letterGrade" : {
        "letterGrade" : "{letterGrade}",
        "comments" : "{commentText}"
        },
      "shareWithStudent" : {shareWithStudentFlag},
      "links" : [{
        "href" : "https://api.learningstudio.com/users/{userId}/courses/{courseId}/gradebook/courseGradeToDate",
        "rel" : "https://api.learningstudio.com/user/course/gradebook/courseGradeToDate"
        }
      ]
    }
  }]
}

Property Descriptions

Name Description
{firstName} First name of student.
{lastName} Last name of student.
{userId} User Id of student.
{userHref} Link to related user detail.
{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 student grade weighting is enabled for this student. 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 whether it is appropriate to share the grade-to-date information with the student. Value is boolean true or false.

Example: Get Paginated Student Results

This example is showing how to retrieve a page 3 with 15 students in it.

Request

Endpoint

GET /courses/808080/gradebook/rostercoursegradestodate?offset=30&limit=15

Response

HTTP Header

Content-Range: items 30-45/60

Body

This example body is truncated

 
{
  "rosterCourseGradesToDate" : [{
	"student" : {
    	"firstName" : "Jolene",
      	"lastName" : "Redd",
      	"id" : 9999999,
      	"links" : [{
        	"href" : "http://api.learningstudio.com/users/9999999",
        	"rel" : "http://api.learningstudio.com/user"
        	}]
    	},
    "courseGradeToDate" : {
      	"average" : 55.33,
      	"earned" : 217.00,
      	"possible" : 394.00,
      	"extraCredit" : 1.00,
      	"isWeightingOn" : false,
      	"letterGrade" : {
        	"letterGrade" : "B+",
        	"comments" : "This is not the comment you are looking for"
      		},
      	"shareWithStudent" : true,
      	"links" : [{
        	"href" : "http://api.learningstudio.com/users/9999999/courses/808080/gradebook/courseGradeToDate",
        	"rel" : "http://api.learningstudio.com/user/course/gradebook/courseGradeToDate"
        	}]
    	}
  },{
	"student" : {
    	"firstName" : "Nathan",
      	"lastName" : "Dell",
      	"id" : 373737,
      	"links" : [{
        	"href" : "http://api.learningstudio.com/users/373737",
        	"rel" : "http://api.learningstudio.com/user"
        	}]
    	},
    "courseGradeToDate" : {
      	"average" : 89.9,
      	"earned" : 354.00,
      	"possible" : 394.00,
      	"extraCredit" : 1.00,
      	"isWeightingOn" : false,
      	"letterGrade" : {
        	"letterGrade" : "A-",
        	"comments" : "Squeaked by but good job"
      		},
      	"shareWithStudent" : true,
      	"links" : [{
        	"href" : "http://api.learningstudio.com/users/373737/courses/2026884/gradebook/courseGradeToDate",
        	"rel" : "http://api.learningstudio.com/user/course/gradebook/courseGradeToDate"
        	}]
    	}
  },
	(...truncated...)
  ]
}
2266 reads
Always Learning
Pearson