Pearson
Always Learning

API Group: 

Retrieves an array of all users, including usernames, user roles, and persona IDs, enrolled in the course. This API differs from the Instructors,Teaching Assistants, and Students APIs because it does not include email addresses (and thus can be used by student roles in OAuth 2).



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

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/roster{.format}
  • Retrieves an array of user information for users enrolled in the course.
GET /courses/{courseId}/roster/{userId}{.format}
  • Retrieves an array of user information for the specified user enrolled in the course.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{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

No Query String Parameters are supported.

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

{
  "roster":[{
    "id":"{userId}",
    "personaId": "{personaId}",
    "loginId": "{username}",
    "firstName":"{firstName}",
    "lastName":"{lastName}",
    "roleType": "{roleType}",
    },
    {
    "id":"{userId}",
    "personaId": "{personaId}",
    "loginId": "{username}",
    "firstName":"{firstName}",
    "lastName":"{lastName}",
    "roleType": "{roleType}",
    }]
}

Property Descriptions

Name Description Valid Values
{userId} LearningStudio user ID.
{personaId} ID assigned to the user and leveraged when interacting with the Social API set referenced here.
{username} User's login ID/username as assigned by the institution.
{firstName} First name of user.
{lastName} Last name of user.
{roleType} Role type for the user in this course.
  • PROF - Professor.
  • TAST - Teaching Assistant.
  • STUD - Student.

Example

Request

Endpoint

GET /courses/1234/roster

Response

Body

{
  "roster": [{
    "id": 5678,
    "personaId": "prof_john"
    "loginId": "jsmith"
    "firstName": "John",
    "lastName": "Smith",
    "roleType": "PROF",
    }
  },
  {
    "id": 9012,
    "personaId": "smart_jane"
    "loginId": "jdoe"
    "firstName": "Jane",
    "lastName": "Doe",
    "roleType": "STUD",
    }
  }]
}
2936 reads
Always Learning
Pearson