Pearson
Always Learning

API Group: 

Retrieves the roster of students enrolled in the course; these are those users with a role type of STUD. This is only the active students in the course; anyone who dropped the course is not included in these results (see the Dropped Users API). Note that student roles (in OAuth 2) cannot use this API; instead, refer to the Classmates or the Course Roster API.



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}/students{.format}
  • Retrieves an array of user information for students for the course.
GET /courses/{courseId}/students/{userId}{.format}
  • Retrieves the user information for a specific student.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID. Numeric ID issued by LearningStudio. Note this API does not support course overloads.
{userId} LearningStudio User ID. Numeric ID issued by LearningStudio.
{.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

{
  "students":[{
    "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"
      }]
    }]
}

Note: If retrieving the information for a specific student (see above), the format is the same but with just one object in the students array.

Property Descriptions

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

Example

Request

Endpoint

GET /courses/1234/students

Response

Body

{
  "students":[{
    "id":411411,
    "firstName":"Mary",
    "lastName":"Jones",
    "emailAddress":"maryjones@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/411411",
      "rel":"related"
      }]
    },{
    "id":411412,
    "firstName":"Sam",
    "lastName":"Smith",
    "emailAddress":"ssmith@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/411412",
      "rel":"related"
      }]
    }]
}
2467 reads
Always Learning
Pearson