Pearson
Always Learning

This API retrieves a lit of all the Web Content Upload content items in a course. Each item contains the content item ID and the link URL to the Web Content Upload Content API where you can retrieve the version of the content that is displayed in the LearningStudio user interface.

Note this API is the only way to get the URL for the user interface content. That URI is not predictable. This is a two step process:

  1. Use this API to retrieve the content URL for Web Content Upload content items. (You can retrieve all of them or a single one by content item ID.)
  2. GET the URL provided in the contentUrl parameter from this response. That URL will be the Content API.

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}/webContentUploads{.format}
  • Retrieves a list of all the Web Content Upload content items in the course.
GET /courses/{courseId}/webContentUploads/{contentItemId}{.format}
  • Retrieves a list of all the Web Content Upload content items in the course.

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

{
  "webContentUploads":[{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/webContentUploads/{contentItemId}/content/{contentPath}.html"
  },{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/webContentUploads/{contentItemId}/content/{contentPath}.html"
  },{
    "id":"{contentItemId}",	
    "contentUrl":"http://api.learningstudio.com/courses/{courseId}/webContentUploads/{contentItemId}/content/{contentPath}.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 Web Content Upload user interface content. No additional detail or content is available via this API.

Note: If you are requesting a single Web Content Upload item (see Endpoints, above), the format is the same but there is only one item in the webContentUploads array.

Note: If the content item exists but no document has yet been uploaded to it, the contentUrl property will be empty.

Example

Request

Endpoint

GET /courses/123456/webContentUploads

Response

{
  "webContentUploads": [
    {
      "id": 123456789,
      "contentUrl": "https://api.learningstudio.com/courses/123456/webContentUploads/123456789/content/14142534-d846-2422-ad7b-b733f0852d22.htm"
    },
    {
      "id": 987654321,
      "contentUrl": "https://api.learningstudio.com/courses/123456/webContentUploads/987654321/content/some-file.pdf"
    }
  ]
}
2975 reads
Always Learning
Pearson