Pearson
Always Learning

API Group: 

This API retrieves a list of the terms in which a user is enrolled. Users are enrolled in terms when they are enrolled in a course in that term, there is no special term enrollment workflow required. See LearningStudio Data Models.

Best Practice: Cache this information at the system level; it doesn't change often.



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

API Request

API Endpoints

HTTP Verbs and URIs

GET /users/{userId}/terms{.format}
  • Retrieves list of terms for the user.

Parameters

Parameter Description Valid Values
{userId} LearningStudio User ID or the /me overload. Note, this API does not support the "loginid" user overload.
  • Numeric ID issued by LearningStudio
  • or replace /users/{userId} with /me
    (OAuth 2 only)
{.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

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

Format

{
  "terms": [{
    "description": "{termDescription}",
    "id": {termId},
    "name": "{termName}",
    "startDateTime": "{startDateTime}",
    "endDateTime": "{endDateTime}"
  }]
}

Property Descriptions

Name Description
{termDescription} Description for the term (entering a description is optional)./td>
{termId} LearningStudio Term ID.
{termName} Name of the term.
{startDateTime} Start date and time for the term. Format is ISO-8601, e.g., YYYY-MM-DDTHH:MM:SSZ.
{endDateTime} End date and time for the term. Format is ISO-8601, e.g., YYYY-MM-DDTHH:MM:SSZ.

Example

Request

Endpoint

GET /me/terms

Response

Body

{
  "terms": [{
    "description": "",
    "id": 83523,
    "name": "Fall 2010",
    "startDateTime": "2010-09-12T00:00:00Z",
    "endDateTime": "2010-12-15T00:00:00Z"
  },
  {
    "description": "",
    "id": 83568,
    "name": "Spring 2011",
    "startDateTime": "2011-01-15T00:00:00Z",
    "endDateTime": "2011-05-12T00:00:00Z"
  }]
}
2240 reads
Always Learning
Pearson