Pearson
Always Learning

This API returns the binary content of the original Microsoft® Office® (MS Office) document that was uploaded to create an 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 retrieve that HTML with the HTML Content API or use this API to get the original document.



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}/originalDocument
  • Retrieves the binary 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

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 set to the appropriate MIME type of the original file, for example, application/msword.

Response Body

The response will be binary content. You will need to capture this data and render or save it, using the Content-Type header, as appropriate.

Examples

Request

Endpoint

GET /courses/123456/msOfficeDocuments/12345678/originalDocument

Response

HTTP Headers (Partial)

Content-Type: application/vnd.ms-powerpoint

Body

{The content of the the file being served.}

2493 reads
Always Learning
Pearson