Pearson
Always Learning

API Group: 

During the early stages of a course, users (especially students) will be added and dropped as their course schedule takes shape. In LearningStudio, users dropped from a course are not deleted from the enrollments, instead they have a role type of DROP in that course and are excluded from all other rosters. This API provides the list of users that are dropped from the selected course. E



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 /courses/{courseId}/droppedUsers{.format}
  • Retrieves an array of user information for users dropped from the 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

None

Request Body

None

API Response

Response Header

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

{
  "droppedUsers":[{
    "id":"{userId}",
    "firstName":"{userFirstName}",
    "lastName":"{userLastName}",
    "emailAddress":"{userEmail}",
    "links":[{
      "href":"https://api.learningstudio.com/users/{userId}",
      "rel":"related"
      }]
    },
    {
    "id":"{userId}",
    "firstName":"{userFirstName}",
    "lastName":"{userLastName}",
    "emailAddress":"{userEmail}",
    "links":[{
      "href":"https://api.learningstudio.com/users/{userId}",
      "rel":"related"
      }]
    }]
}

Parameter Descriptions

Name Description
{userId} LearningStudio user Id.
{userFirstName} First name of user.
{userLastName} Last name of user.

Examples

Request

GET /courses/1234/droppedUsers

Response

{
  "droppedUsers":[{
    "id":9703031,
    "firstName":"Jeffrey",
    "lastName":"Thomas",
    "emailAddress":"jefferyt@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/9703031",
      "rel":"related"
      }]
    },
    {
    "id":9703032,
    "firstName":"Jane",
    "lastName":"Handcock",
    "emailAddress":"janeh@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/9703032",
      "rel":"related"
      }]
    }]
}
3082 reads
Always Learning
Pearson