Pearson
Always Learning

This API retrieves a list of all the Text/Multimedia content items in a course. Each item in the response contains the content item ID and the link URL to the content API where you can retrieve the content. (These links are also included in the content structure APIs that list course content items.)

Note: The order of the items in the response is not guaranteed to match the order of the content in the LearningStudio user interface.



Supported Roles and Authentication Protocols

Type Supported Values
Authentication Protocols OAuth 2.0
Valid for Roles (OAuth 2): Professor, Teaching Assistant, Student

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/textMultimedias{.format}
  • Retrieves a list of all the Text/Multimedia content items in the course.
GET /courses/{courseId}/textMultimedias/{contentItemId}{.format}
  • Displays the detail of a single Text/Multimedia content item.

Parameters

Name Description Valid Values
{courseId} LearningStudio Course ID. Numeric ID issued by LearningStudio. Note this API does not support course overloads.
{contentItemId} ID of the Content Item. 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

{
  "textMultimedias":[{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/textMultimedias/{contentItemId}/content.html"
  },{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/textMultimedias/{contentItemId}/content.html"
  },{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/textMultimedias/{contentItemId}/content.html"
  }]
}

Description

Each item in the response contains the content item ID (which matches those returned by the content structure APIs) and the path of the API to retrieve the Text/Multimedia content. No additional detail or content is available via this API.

Note: If you are requesting a single text/multimedia item (see Endpoints, above), the format is the same but there is only one item in the textMultimedias array.

Example

Request

Endpoint

GET /courses/1234/textMultimedias

Response

Body

{
  "textMultimedias":[{
    "id":12345678,
    "contentUrl":"https://api.learningstudio.com/courses/1234/textMultimedias/12345678/content.html"
  },
  {
    "id":12345679,
    "contentUrl":"https://api.learningstudio.com/courses/1234/textMultimedias/12345679/content.html"
  }]
}
2762 reads
Always Learning
Pearson