Pearson
Always Learning

This API retrieves the HTML version of a Microsoft Office® (MS Office) Document content item. When a teacher creates a content item from a Word®, PowerPoint®, or Excel® document, LearningStudio creates an HTML version of it. You can use the Original Document API to download the original file.

Note that this API returns HTML content, and the final component of the URI is not predictable. Therefore you will need to use the List MSOfficeDocuments in a Course API to get this URI. This is a two-step process:

  1. Use the List MSOfficeDocuments in a Course API to retrieve the link to the content.
  2. GET the URL provided in the contentUrl parameter from that response. That URL will be this API.


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}/msOfficeDocuments/{contentItemId}/content/{contentPath}
  • Retrieves the content for a MS Office Document 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
{contentPath} Filename of the HTML content to return. This is not predictable, and can only be retrieved from this API call. A random string provided by LearningStudio

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. In addition, it also sends a Content-Type HTTP header, which is usually set to text/html.

Response Body

This API typically returns text-based content with HTML markup if it exists. There is no JSON or XML envelope, and the payload is suitable for immediate rendering to your application view, if applicable.

Example

Request

Endpoint

GET /courses/123456/msOfficeDocuments/12345678/content/f6de8898-61b8-4572-b300-98c72ff6cde8.html

Response

HTTP Headers (Partial)

Content-Type: text/html

Body

<meta name="Excel Workbook Frameset" /><meta http-equiv="Content-Type" content="text/html; charset=windows-1252" /> 
	{HTML CONTENT} 
3267 reads
Always Learning
Pearson