Pearson
Always Learning

This simple API returns the total number of points available to a student in a course, and the total extra points available. It does not return the total points achieved, for that see Grade to Date.



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}/gradebook/userGradebookItemsTotals{.format}
  • Retrieve total points and extra credit available for the student.

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 Headers

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

{
  "userGradebookItemTotals": {
	"pointsPossible": {pointsPossible},
	"extraCredit": {extraCredit}
  }
}

Property Descriptions

Name Description
{pointsPossible} Number of total points available to the student for all gradable items in a course.
{extraCredit} Number of possible extra credit points the user could obtain in the course.

Example

Request

Endpoint

GET /me/courses/123456/gradebook/userGradebookItemsTotals

Response

Body

{
  "userGradebookItemTotals":{
	"pointsPossible": 435.00,	
	"extraCredit": 0
  }
}
2575 reads
Always Learning
Pearson