Pearson
Always Learning

API Group: 

Retrieves the roster of instructors enrolled in the course; these are those users with a role type of PROF. Courses can have more than one instructor.



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

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

{
  "instructors":[{
    "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 instructor (see above), the format is the same but with just one object in the instructors array.

Property Descriptions

Name Description
{userId} LearningStudio user Id.
{userFirstName} First name of instructor.
{userLastName} Last name of instructor.
{userEmail} Email address of instructor.

Example

Request

Endpoint

GET /courses/1234/instructors

Response

Body

{
  "instructors":[{
    "id":511512,
    "firstName":"John",
    "lastName":"Smith",
    "emailAddress":"johnsmith@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/511512",
      "rel":"related"
      }]
    },{
    "id":511513,
    "firstName":"John",
    "lastName":"Caruthers",
    "emailAddress":"caruth@university.edu",
    "links":[{
      "href":"http://api.learningstudio.com/users/511513",
      "rel":"related"
      }]
    }]
}
2821 reads
Always Learning
Pearson