Pearson
Always Learning

LearningStudio tracks whether every user reads each thread post. This information is reported through our Enterprise Reporting product and many institutions use this information as part of their student success or requirements tracking. This API exposes whether the specified user has read the thread post before, but more importantly, it allows you to update that setting in LearningStudio.

Best Practice: Simply retrieving a thread post via the API does not change its read status. In most cases, your application should update the read/unread status when user views a complete thread post.



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

Note: Users can only retrieve or update their own status

API Request

API Endpoints

HTTP Verbs and URIs

GET /users/{userId}/courses/{courseId}/threadeddiscussions/{contentItemId}/topics/{topicId}/responses/{postId}/readStatus{.format}
  • Retrieves the read/unread status of a post for a user.
PUT /users/{userId}/courses/{courseId}/threadeddiscussions/{contentItemId}/topics/{topicId}/responses/{postId}/readStatus{.format}
  • Updates the read/unread status of a post for a user.

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}
{contentItemId} LearningStudio Content Item ID of the threaded discussion. Numeric ID issued by LearningStudio
{topicId} LearningStudio Topic ID. Numeric ID issued by LearningStudio
{postId} LearningStudio Thread Post 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

For GET and DELETE Requests

None.

For PUT Requests

{
  "readStatus": {
    "markedAsRead":{markedAsReadFlag}
  }
}

Property Descriptions

Name Description Valid Values
{markedAsReadFlag} Boolean that indicates whether the post has been read by the user.
  • true
  • false

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.

When updating an item, the API will return a status code of 204 - No Content with no response body.

Response Body

Format

{
  "readStatus":{
    "markedAsRead":{markedAsReadFlag}
  }
}

Property Descriptions

Name Description
{markedAsReadFlag} Boolean that indicates whether the response has been read by the user.

Example: Get Response Read Status

Request

Endpoint

GET /courses/123456/threadeddiscussions/10012345678/topics/8000055/responses/800100222/readStatus

Response

Body

{
  "readStatus":{
    "markedAsRead":false
  }
}

Example: Set Response Read Status

Request

Endpoint

PUT /courses/123456/threadeddiscussions/10012345678/topics/8000055/responses/800100222/readStatus

Body

{
  "readStatus": {
    "markedAsRead": true
  }
}

Response

HTTP Status Code

204 No Content
2874 reads
Always Learning
Pearson