Pearson
Always Learning

This API returns the name, ID, and email address of the author of a thread post.

Note: This API does not return the user's role in the course. For that you should use the composite post and author detail 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, Student, Administrator

Note: [Add any role-specific caveats here, like "Student roles can only do XXXX"]

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/threadeddiscussions/{contentItemId}/topics/{topicId}/responses/{postId}/responseAuthor{.format}
  • Retrieves details about the author of a thread post.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{contentItemId} LearningStudio Content Item ID of the threaded discussion. Numeric ID issued by LearningStudio
{topicId} LearningStudio Topic ID. Numeric ID issued by LearningStudio
{postId} LearningStudio Thread Post 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 Headers

This API returns the standard HTTP Status Codes used by the LearningStudio APIs. There are no special headers returned by the API.

Format

{
  "responseAuthor":{
    "id":{userId},
    "firstName":"{firstName}",
    "lastName":"{lastName}",
    "email":"{email}"
  }
}

Property Descriptions

Name Description
{userId} LearningStudio User ID.
{firstName} First name of the user.
{lastName} Last name of the user.
{email} Email address for the user.

Example

Request

Endpoint

GET /courses/123456/threadeddiscussions/10012345678/topics/80000555/responses/800100222/responseAuthor

Response

Body

{
  "responseAuthor": {
    "id": 88888888,
    "firstName": "Avis",
    "lastName": "Gorby",
    "email": "teacher@fakeemail.com"
  }
}
2526 reads
Always Learning
Pearson