Pearson
Always Learning

Retrieves an aggregation of the different activities that occurred across all courses for a given user. By default, the activities in this feed span across all the user's courses.

A user can access their own What's Happening feed, or a Professor who is also enrolled in the same course(s) as the user can access the feed. If the user is enrolled in at least one course in which the Professor is not enrolled, then the Professor is not authorized to view the What's Happening feed unless the courseId query string parameter is specified on the request (and both the user and the Professor are enrolled in that course).

This API is being replaced by Version 2 and will be deprecated in the near future. Please consider switching to the new version soon.



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 /users/{userId}/whatshappeningfeed{.format}
  • Retrieves the What's Happening activity for the specified 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)
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query String Parameters

By default, the entire set of What's Happening Feed results is returned for the request. You can filter the list of results using these query parameters; these parameters can be combined to further filter results.

Best Practice: Use the additional parameters to intelligently limit results to either a course or a date range, depending on where you are using the data.

Query Parameter Name Description Valid Values
courseid Limit the results to the activity of particular course ID. Multiple IDs can be specified, separated by commas. If not set, activity from all of the user's courses will be included. Note, this parameter is mutually exclusive with ccn; only use one or the other. Example:
courseid=123456 or courseid=123456,78901
A valid LearningStudio Course ID. (Call Number overloads are not supported here.)
ccn Limit the results to the activity of particular call number. If not set, activity from all of the user's courses will be included. Note, this parameter is mutually exclusive with courseid; only use one or the other. Example:
ccn=MATH101FallTermA
A valid Call Number as set by your SIS system.
types Limit the results to the type of activity. Multiple types can be specified, separated by commas. If not set, all activity will be included. Example:
types=thread-post or types=thread-post,thread-topic
thread-post
thread-topic
grade
dropbox-submission
exam-submission
remark
since Only includes activity from after this date. A timestamp in this format::
MM/DD/YYYY
useSourceDomain Include a full URL for any linked resources in content (such as images stored in LearningStudio). true if specifying this parameter, otherwise false or don't include this parameter.

API Response

HTTP Status Codes & Headers

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

Body

Format

 
{
  "activityStream": {
    "title": "{activityStreamTitle}",
    "items": [{
      "id": "http://api.learningstudio.com/courses/{courseId}/dropboxbaskets/{dropbasketId}/messages/{messageId}",
      "postedTime": "{postedDateTime}",
      "actor": {
        "role": "{userRole}",
        "referenceId": {referenceId},
        "id": "http://api.learningstudio.com/users/{userId}",
        "title": "{userName}",
        "objectType": "{actorObjectType}"
      },
      "verb": "{verb}",
      "object": {
        "courseId": {courseId},
        "attachments": [],
        "referenceId": {referenceId},
        "id": "http://api.learningstudio.com/courses/{courseId}/dropboxbaskets/{dropbasketId}messages/{messageId}",
        "summary": "{summaryText}",
        "objectType": "{objectObjectType}"
      },
      "target": {
        "courseId": {courseId},
        "referenceId": {referenceId},
        "id": "http://api.learningstudio.com/courses/{courseId}/dropboxbaskets/{dropbasketId}",
        "title": "{targetTitle}",
        "objectType": "{targetObjectType}"
      }
    }],
    "lang": "{language}",
    "id": "http://api.learningstudio.com/users/{userId}/whatshappeningfeed",
    "subject": {
      "referenceId": {referenceId},
      "id": "http://api.learningstudio.com/users/{userId}",
      "title": "{userName}",
      "objectType": "http://activitystrea.ms/schema/1.0/person"
    }
  }
}

Property Descriptions

Each activity item contains one of each of the following properties:

  • actor - user for which the activity happened.
  • object - type of activity that happened.
  • target - location where activity happened.
Name Description Valid Values
{activityStreamTitle} Title for the activity stream.
id Link to related resources.
{postedDateTime} Date and time the activity feed was created.
{userRole} Specifies the user's role in the course in which the activity happened.
  • PROF - Professor
  • TAST - Teaching Assistant
  • STUD - Student
  • DROP -
{referenceId} ID of the item refered to in the objectType.
{userName} Username of the actor (user).
{actorObjectType} The type of actor (user) for which the activity is recorded.
{verb} The action that ocurred.
{courseId} LearningStudio course ID in which the activity took place.
{summaryText} Summary text associated with the object.
{objectObjectType} The type of object in which the activity took place.
  • dropbox-submission - Also includes the attachments property
  • thread-topic
  • thread-post
  • grade - Also includes the letter grade and pointsAchieved properties.
  • remark
  • exam-submission
{targetTitle} Title of the a target referred to in the objectType.
{targetObjectType} The type of target in which the activity took place.
  • dropbox-basket
  • thread-topic
  • gradable-item - Also includes the itemType and pointsPossible properties.
  • exam - Also includes the courseitemId property.
  • course
{language} Language associated with the feed.

Example

Request

Endpoint

GET /users/123456/whatshappeningfeed

Response

Body

 
{
  "activityStream": {
    "title": "Activity Feed for John Smith",
    "items": [{
      "id": "http://api.learningstudio.com/courses/123456/dropboxbaskets/4989/messages/895",
      "postedTime": "2011-02-24T21:16:17Z",
      "actor": {
        "role": "STUD",
        "referenceId": 456456,
        "id": "http://api.learningstudio.com/users/456456",
        "title": "Jane Doe",
        "objectType": "enrolled-user"
      },
      "verb": "submit",
      "object": {
        "courseId": 123456,
        "attachments": [],
        "referenceId": 895,
        "id": "http://api.learningstudio.com/courses/123456/dropboxbaskets/4989/messages/895",
        "summary": "Here is my submission.",
        "objectType": "dropbox-submission"
      },
      "target": {
        "courseId": 123456,
        "referenceId": 4989,
        "id": "http://api.learningstudio.com/courses/123456/dropboxbaskets/4989",
        "title": "Assignment 1",
        "objectType": "dropbox-basket"
      }
    }, {
      "id": "/remarks/4d63f608b68ded7e9c0e2c4f",
      "postedTime": "2011-02-22T17:44:40Z",
      "actor": {
        "role": "STUD",
        "referenceId": 456456,
        "id": "http://api.learningstudio.com/users/456456",
        "title": "Jane Doe",
       "objectType": "enrolled-user"
      },
      "verb": "post",
      "object": {
        "referenceId": "4d63f608b68ded7e9c0e2c4f",
        "courseId": 123456,
        "id": "http://remarksdev.petdev.com/remarks/4d63f608b68ded7e9c0e2c4f",
        "summary": "I think this class is grrrrreat!",
        "objectType": "remark"
      },
      "target": {
      "referenceId": 123456,
      "id": "http://api.learningstudio.com/courses/123456",
      "title": "English 101",
      "objectType": "course"
      }
    }, {
      "id": "http://api.learningstudio.com/courses/123456/threadeddiscussions/1003241860/topics/6624",
      "postedTime": "2011-02-21T16:50:37Z",
      "actor": {
        "role": "PROF",
        "referenceId": 654321,
        "id": "http://api.learningstudio.com/users/654321",
        "title": "John Smith",
        "objectType": "enrolled-user"
      },
      "verb": "post",
      "object": {
        "courseId": 123456,
        "referenceId": 6624,
        "id": "http://api.learningstudio.com/courses/123456/threadeddiscussions/1003241860/topics/6624",
        "title": "Topic 1",
        "summary": "Please post your thoughts about topic 1.",
        "objectType": "thread-topic"
      },
      "target": {
        "referenceId": 123456,
        "id": "http://api.learningstudio.com/courses/123456",
        "title": "English 101",
        "objectType": "course"
      }
    }, {
      "id": "http://api.learningstudio.com/courses/123456/examsubmissions/4996",
      "postedTime": "2011-02-18T22:12:57Z",
      "actor": {
        "role": "PROF",
        "referenceId": 654321,
        "id": "http://api.learningstudio.com/users/654321",
        "title": "John Smith",
        "objectType": "enrolled-user"
      },
      "verb": "post",
      "object": {
        "courseId": 123456,
        "referenceId": 4996,
        "id": "/examsubmissions/4996",
        "title": "exam item no start end due date",
        "objectType": "exam-submission"
      },
      "target": {
        "referenceId": 419099,
        "courseId": 123456,
        "courseItemId": 987654,
        "id": "/courses/123456/exams/10032418639",
        "title": "Weekly Exam",
        "objectType": "exam"
      }
    }],
    "lang": "en-us",
    "id": "http://api.learningstudio.com/users/654321/whatshappeningfeed",
    "subject": {
      "referenceId": 654321,
      "id": "http://api.learningstudio.com/users/654321",
      "title": "John Smith",
      "objectType": "http://activitystrea.ms/schema/1.0/person"
    }
}
1823 reads
Always Learning
Pearson