Pearson
Always Learning

This API retrieves the start and end dates for a course, and the census date for a course. These dates are determined by the term in which the course lives. Course scheduler is identified based on the Term access start date and Term access end date. Please note that course Start/End Dates added via Admin pages are not reflected in course schedule REST route. The census date for a term is the date at which the roster and certain other details of a course (such as dates) are locked (it is also the date at which LearningStudio ascertains final course enrollment for the purpose of billing clients per enrollment).



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, Admin

API Request

API Endpoints

HTTP Verbs and URIs

GET /courses/{courseId}/courseSchedules{.format}
  • Returns the course start date, end date, and census date.

Parameters

Parameter Description Valid Values
{courseId} LearningStudio Course ID or relevant course overload.
  • Numeric ID issued by LearningStudio
  • ccn={callNumber}
{.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

HTTP Status Codes & 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

Format

{
  "courseSchedules": [{
	"courseId": "{courseId}",
	"courseName": "{courseName}",
	"schedule":{
		"courseStartDateTime": "{courseStartDateTime}",
		"courseEndDateTime": "{courseEndDateTime}",
		"censusDateTime": "{censusDateTime}"},
	"links":[{
		"href":"{href}",
		"rel":"related"
                }]
    }]
}

Property Descriptions

Element Description
{courseId} LearningStudio ID for the course
{courseId} Name of the course as configured in LearningStudio. {courseStartDateTime} The scheduled start date for the course, in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{courseEndDateTime} The scheduled end date for the course, in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{censusDateTime} The census date of the course, in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{href} Direct link to access the course information.

Example

Request

Endpoint

GET https://api.learningstudio.com/courses/123456/courseSchedules

Response

Body

 
{
  "courseSchedules":[{
	"courseId":2026793,
	"courseTitle":"TestCourse",
	"schedule":{
		"courseStartDateTime":"2012-01-01T06:00:00Z",
		"courseEndDateTime":"2018-01-01T06:00:00Z",
		"censusDateTime":"2012-01-01T06:00:00Z"},
	"links":[{
		"href":"http://api.learningstudio.com/courses/2026793",
		"rel":"related"
                 }]
   }]
}

Known Issues

  • When requesting an XML payload, the timestamps may be missing the trailing "Z" which signifies the timestamp is in UTC. You should assume the timestamps are listed in UTC.
2710 reads
Always Learning
Pearson