Pearson
Always Learning

This API retrieves the start and end access dates for a term, the start and end dates for courses in that term, and the census date for courses in that term. Some schools allow students early or additional access to courses in a term, even if the course itself is not started or already finished. 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 /terms/{termId}/termschedules{.format}
  • Returns the dates for a term.

Parameters

Parameter Description Valid Values
{termId} LearningStudio Term ID. 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

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

{
  "termSchedules": [{
	"termId": "{termId}",
	"termName": "{termName}",
	"schedule":{
		"termAccessStartDateTime": "{termAccessStartDateTime}",
		"termAccessEndDateTime": "{termAccessEndDateTime}",
		"courseStartDateTime": "{courseStartDateTime}",
		"courseEndDateTime": "{courseEndDateTime}",
		"censusDateTime": "{censusDateTime}"},
	"links":[{
		"href":"{href}",
		"rel":"related"
         }]
   }]
}

Property Descriptions

Element Description
{termId} LearningStudio ID for the term
{termName} Name of the Term as configured in LearningStudio.
{termAccessStartDateTime} The access start date for courses in the term, when students may start to access the term and courses in it; in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{termAccessEndDateTime} The access end date for courses in the term, the last day in which students may access the term and courses in it; in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{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 term, in ISO-8601 format. E.g. YYYY-MM-DDTHH:MM:SSZ.
{href} Direct link to access the term information.

Example

Request

Endpoint

GET https://api.learningstudio.com/terms/123456/termSchedules

Response

Body

{
   "termSchedules":[{
	"termId":34920,
	"termName":"termtest",
	"schedule":{
		"termAccessStartDateTime":"2012-01-01T07:00:00Z",
		"termAccessEndDateTime":"2018-01-01T07:00:00Z",
		"courseStartDateTime":"2012-01-01T07:00:00Z",
		"courseEndDateTime":"2012-11-01T06:00:00Z",
		"censusDateTime":"2012-01-01T07:00:00Z"
        },
	"links":[{
		"href":"http://api.learningstudio.com/terms/34920",
		"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.
2793 reads
Always Learning
Pearson