Pearson
Always Learning

Retrieves the HTML content of the course syllabus, if one has been created.

Important: LearningStudio has a tool that aids in creating a syllabus. It appears as a normal content item named Syllabus, but is not the same as a regular content item named Syllabus.



Supported Roles and Authentication Protocols

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

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/syllabus
  • Retrieves the HTML of the course syllabus.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}

Query String Parameters

Query Parameter Name Description Valid Values
useSourceDomain Include a full URL for any linked resources in content (such as images stored in LearningStudio). true if specifying this parameter, otherwise false or don't include this parameter.

Request Body

None

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

This API 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/syllabus

Response

Body

<div class="pageTitle">Syllabus</div>
<br /><br /><p>This is an example syllabus</p>
2227 reads
Always Learning
Pearson