View Taken Activity Details

An overview of the View Taken Activity Details endpoint.

Endpoint Description

This endpoint provides detailed information about a specific activity taken by a user, including the topic & activity name, status, and timestamps.

HTTP Method

GET /api/v1/view-taken-activity-details/{userActivityId}

Headers

• Content-Type: application/json - Specifies that the request body format is JSON.

• Accept: application/json - Indicates that the client expects a JSON response.

• Authorization: Bearer {token} - A valid Bearer token must be provided to authenticate the request.

URL Parameters

• userActivityId (integer): The unique ID of the user activity. Example: 20

Data Dictionary for Response Fields

The response for the "View Taken Activity Details" endpoint contains detailed information about a specific activity taken by a user. Below is a breakdown of each field in the response data:

• user_activity_id (integer): The unique identifier for the user activity.

• user_id (integer): The unique identifier for the user.

• data (object): A collection of fields describing the activity.

  • activity_type (string): The type of activity being completed (currently two types). Example: Sorting Cards

  • topic_name (string): The name of the topic the activity is completed in. Example: Career Interests

  • activity_name (string): The name of the activity that was completed. Example: Identify My Career/Work Interests

  • created_at (string): Timestamp indicating when the activity was created (formatted as a date-time (UTC)). Example: 2024-01-08T04:10:12.000000Z

  • updated_at (string): Timestamp indicating when the activity was last updated (formatted as a date-time (UTC)). Example: 2024-01-08T04:16:42.000000Z

  • completed_status (string): The current status of the activity. Example: Activity Completed

    • Activity Stated: The activity was started, but card activity wasn’t completed. No Card/question data available.

    • Cards Completed: The card portion of the activity was completed. No question data is available.

    • Activity Completed: The activity was completed. Card & Question data are available.

  • completed_date (string): Timestamp indicating when the activity was completed (formatted as a date-time (UTC)). Example: 2024-01-07T23:16:42.000000Z

  • report_url (string): URL link leading to the activity report.* Example: https://discover.r1learning.com/career-interests-1/identify-my-careerwork-interests/report/9648

  • video_completed (boolean): Indication if the video component of the activity was completed. Example: true

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/view-taken-activity-details/20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v1/view-taken-activity-details/20"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.r1learning.com/api/v1/view-taken-activity-details/20");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer ••••••");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response Examples

200: OK

{
  "error": 0,
  "message": "",
  "userActivityId": "9648",
  "data": {
    "id": 9648,
    "user_id": 3862,
    "activity_type": "Sorting Cards",
    "topic_name": "Career Interests",
    "activity_name": "Identify My Career/Work Interests",
    "created_at": "2024-01-08T04:10:12.000000Z",
    "updated_at": "2024-01-08T04:16:42.000000Z",
    "completed_status": "Activity Completed",
    "completed_date": "2024-01-07T23:16:42",
    "report_url": "https://discover.r1learning.com/career-interests-1/identify-my-careerwork-interests/report/9648",
    "video_completed": true
  }
}

401: Unauthorized

{
  "message": "Unauthentiated"
}

Notes

• Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the activity details.

• Response Handling: Handle responses appropriately to manage and display detailed activity information to users.