Pearson
Always Learning

API Group: 

Because fully-online programs can have students in many different time zones, it is important to render timestamps in the user's local time. The user's default time zone is a stored property in LearningStudio. If the user has no associated time zone, retrieves the time zone information for the node to which the course belongs. The returned time zone does not include the offset for daylight savings.

Best Practice: This data is the most reliable way to ensure you are rendering timestamps in a manner acceptable to the institution. Relying on device time can create issues for some institutions, who mandate courses be set in a certain timezone regardless of the user's actual location.



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

API Request

API Endpoints

HTTP Verbs and URIs

GET /users/{userId}/courses/{courseId}/timeZone{.format}
  • Retrieves the time zone setting for a user in a particular course.

Parameters

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

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

{
  "timeZone":
  {
    "id":{zoneId},
    "zoneName":"{zoneName}",
    "title":"{zoneTitle}"
  }
}

Property Descriptions

Name Description
zoneId Time zone identifier.
{zoneName} User-friendly name of the time zone.
{zoneTitle} Standard title of the time zone. Does not include offset for daylight savings.

Examples

Request

Endpoint

GET /users/12345/courses/888888/timeZone

Endpoint with /me overload

GET /me/courses/2022690/timeZone

Response

Body

{
  "timeZone":
  {
    "id":7,
    "zoneName":"Mountain",
    "title":"(GMT-07:00) Mountain Time (US & Canada)"
  }
}
2916 reads
Always Learning
Pearson