Pearson
Always Learning

API Group: 

Retrieves the roster of teaching assistants enrolled in the course; these are those users with a role type of TAST.



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

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 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

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

Property Descriptions

Name Description
{userId} LearningStudio user Id.
{userFirstName} First name of teaching assistant.
{userLastName} Last name of teaching assistant.
{userEmail} Electronic mail address of teaching assistant.

Example

Request

Endpoint

GET /courses/1234/teachingAssistants

Response

Body

{
  "teachingAssistant":[{
    "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"
      }]
    }]
}
2694 reads
Always Learning
Pearson