Pearson
Always Learning

This API stops the user activity timer that was started with the Begin Tracking Time API. Refer to that API for additional details.

Important: There must be an active clock timer for this API to work correctly.

Note: If the user is moving between content items, it is not necessary to stop the clock and then restart it. Starting the clock on a new content item will be sufficient. However if the user logs out or times out of your application, you should call this API to stop the clock. If you don't, the clock runs for 45 minutes which has undesirable results for institution reporting.



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

POST /users/{userId}/courses/{courseId}/items/{contentItemId}/activity/endping{.format}
  • Starts the activity tracking clock.

Parameters

Parameter Description Valid Values
{userId} LearningStudio User ID or /me overload. Note: The "loginid" overload does not work with this API.
  • 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
{contentItemId} LearningStudio Content Item ID the user is accessing via your application. Time is recorded against content. 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

Response Headers

This API returns the standard HTTP Status Codes used by the LearningStudio APIs. There are no special headers returned by the API.

The API returns a 204 - No Content error code on success.

Response Body

No response body is returned by this API.

Examples

Request

Endpoint

POST /users/1234/courses/888888/items/10070707070/activity/endping

Response

HTTP Status Code

204 - No Content
2181 reads
Always Learning
Pearson