Pearson
Always Learning

API Group: 

This API returns a list of all the courses in a particular term. You will need to know the Term ID; see the Terms API.

Best Practice: Try to cache these results at the application level (not just at the user level). Some terms can have a very large number of courses, but once a term is set up, the course list doesn't change much or often.


Supported Roles and Authentication Protocols

Type Supported Values
Authentication Protocols OAuth 1.0a, OAuth 2.0
Valid for Roles (OAuth 2): Administrator

API Request

API Endpoints

HTTP Verbs and URIs

GET /terms/{termId}/courses{.format}
  • Retrieves the courses associated with the specified 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

{
  "courses":[
    {
    "id":{courseId},
    "displayCourseCode":"{courseCallNumber}",
    "title":"{courseTitle}",
    "callNumbers":["{callNumber_X}","{callNumber_X}"],
    "links":[{
      "href":"http://api.learningstudio.com/terms/{termId}",
      "rel":"http://api.learningstudio.com/rels/term"}]
    },
    {
    "id":{courseId},
    "displayCourseCode":"{displayCourseCode}",
    "title":"{courseTitle}",
    "callNumbers":["{callNumber_X}","{callNumber_X}"],
    "links":[{
      "href":"http://api.learningstudio.com/terms/{termId}",
      "rel":"http://api.learningstudio.com/rels/term"}]
    }
  ]
 }

Property Descriptions

Name Description
{courseId} LearningStudio course ID.
{displayCourseCode} The vernacular course code for the course, such as MATH-101. This is determined by the institution and may be repeated between many courses.
{courseTitle} Title of the course.
{callNumber_X} An array of call numbers assigned to the course by the institution.
{termId} The LearningStudio ID of the term to which this course is assigned. Important: you should not parse this URL to find the ID. Instead, use a GET request against this complete URL to retrieve Term details. Learn more.

Example

Request

Endpoint

GET /terms/58459/courses

Response

Body

{
  "courses":[
    {
    "id":1234567,
    "displayCourseCode":"Business",
    "title":"Business Law 6540",
    "callNumbers":["BUSN6540","LAWBIZ660"],
    "links":[{
      "href":"http://api.learningstudio.com/terms/58459",
      "rel":"http://api.learningstudio.com/rels/term"}]
    },
    {
    "id":1234568,
    "displayCourseCode":"BusinessAccounting",
    "title":"Business Accounting",
    "callNumbers":["BUSN6530","MATH500"],
    "links":[{
      "href":"http://api.learningstudio.com/terms/58459",
      "rel":"http://api.learningstudio.com/rels/term"}]
    },
    {
    "id":1234569,
    "displayCourseCode":"Statistics",
    "title":"Statistics For Beginners",
    "callNumbers":[],
    "links":[{
      "href":"http://api.learningstudio.com/terms/58459",
      "rel":"http://api.learningstudio.com/rels/term"}]
    }
  ]
 }
1337 reads
Always Learning
Pearson