Pearson
Always Learning

API Group: 

This API retrieves a list of terms for the specified client institution. This can be a very large payload, so query string parameters allow for filtering.

Note: Terms can only be retrieved from across the entire institution, that is, at the client string level. It cannot retrieve terms only associated with a particular node. (See LearningStudio Data Models for explanation of nodes.)

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): Administrator

API Request

API Endpoints

HTTP Verbs and URIs

GET /clients/{clientString}/terms{.format}
  • Retrieves a list of terms for the institution.

Parameters

Parameter Description Valid Values
{clientString} LearningStudio Client String for the institution. See LearningStudio Data Models. Note, client sort strings (i.e., node strings) cannot be used. String ID issued by LearningStudio
{.format} Desired format of response data. See Response Formats. .json , .xml , or Blank

Query String Parameters

Query Parameter Name Description Valid Values
termEndDateRange By default the API will return all terms in the client regardless of date range. This parameter opts to include only the terms with an ending date in the specified range. {startdate}-{enddate}
or Blank
Dates must be in this format:
MM/DD/YYYY
activeOnly By default the API will return all terms in the client regardless of date range. This parameters opts to include only active terms (those where today falls between the terms' start and end dates). true or Blank

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}"
  },{
    "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 /clients/strata/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"
  }]
}
1204 reads
Always Learning
Pearson