Pearson
Always Learning

This API supports updating the display sort order of thread topics within existing threaded discussion content items.


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

PUT /courses/{courseId}/threadedDiscussions/{contentItemId}/topics/{topicId}/next{.format}
  • Moves the indicated thread topic up in the sort order list of thread topics within the given threaded discussion item.
PUT /courses/{courseId}/threadedDiscussions/{contentItemId}/topics/{topicId}/previous{.format}
  • Moves the indicated thread topic down in the sort order list of thread topics within the given threaded discussion item.

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
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Request Body

For PUT Requests to Move Up The Identified Thread Topic Within The Sort Order

 {
    "next": {
        "id": "{threadTopicID}",
        "title": "{threadTitle}",
        "description": "{threadDescription}"
    }
}

For PUT Requests to Move Down The Identified Thread Topic Within The Sort Order

 {
    "previous": {
        "id": "{threadTopicID}",
        "title": "{threadTitle}",
        "description": "{threadDescription}"
    }
}

Property Descriptions

Name Description Valid Values
{threadTopicID} Indicates the ID of the thread topic to move the topic ID specified in route ahead of ("next") or behind ("previous"). Valid numerical value of an existing thread topic.
{threadTitle} Designates the thread topic title for the associated thread topic. If no changes are requested, the text in the PUT request will need to match the current thread title text. Any string of text
{threadDescription} Designates the thread topic description for the associated thread topic. If no changes are requested, the text in the PUT request will need to match the current thread title description. Any string of text

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.

Response Body

None

Example: Move Up Specified Thread Topic Within Sort Order

Request

Endpoint

PUT /courses/11223344/threadedDiscussions/111679070805/topics/7056009872119/next

Body

{
    "next": {
        "id": "8761106572118",
        "title": "Thread Topic Example Title",
        "description": "Thread Topic Description Example"
    }
}

Response

Body

None

Example: Move Down Specified Thread Topic Within Sort Order

Request

Endpoint

PUT /courses/11223344/threadedDiscussions/111679070805/topics/7056009872119/previous

Body

{
    "previous": {
        "id": "8761106572118",
        "title": "Thread Topic Example Title",
        "description": "Thread Topic Description Example"
    }
}

Response

Body

None

2522 reads
Always Learning
Pearson