Pearson
Always Learning

This API retrieves a link to the gradable item for a particular content item. It's particularly useful if you are working with the content structure APIs and want to know if the item is graded and get that gradebook detail. It can also be useful if you are a third party and you are entering a grade for the content item in which your product is shown, but you don't know specifically where it appears in the gradebook.

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,

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/items/{itemId}/gradebookItem{.format}
  • Retrieves the gradable item for a content item, if it exists.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{itemId} LearningStudio Content Item ID. Numeric ID issued by LearningStudio.
{.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 HTTP Status Codes and Headers

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

If the specified content item does not have a gradable item, this API returns only an HTTP Status Code of 404 - Not Found.

Response Body

Format

{
  "gradebookItem": {
    "links":[{
      "href":"{gradableItemHref}",
      "rel":"self"
    }]
  }
}

Property Descriptions

Name Description
{gradableItemHref} A link to the gradable item detail. Important: you should not parse this URL to find or store the IDs. Instead, use a GET request against this complete URL to retrieve the gradable item. Learn more.

Example

Request

Endpoint

GET /courses/123456/items/100123456789/gradebookItem

Response

Body

{
  "gradebookItem": {
    "links":[{
      "href":"https://api.learningstudio.com/courses/123456/gradebookItems/a24e4de6-ABCD-1234-XYZF-123456789000",
      "rel":"self"
    }]
  }
}
2395 reads
Always Learning
Pearson