View Company Taken Activity Details

An overview of the View Company Taken Activity Details endpoint.

Endpoint Description

This endpoint retrieves detailed information about all activities taken by users within a specific company, including activity status, type, and timestamps.

HTTP Method

GET /api/v1/view-company-taken-activity-details/{companyId}/{page}/{limit}/{maxDays?}

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

• companyId (integer): The unique identifier for the company. Example: 13

• page (integer): The current page number. Example: 1

• limit (integer): The number of records to retrieve per page. Example: 50

• maxDays (integer, optional): The maximum number of days for which records should be retrieved. Example: 10

Data Dictionary for Response Fields

The response for the "View Company Taken Activity Details" endpoint contains detailed information about all activities taken by users within a specific company. Below is a breakdown of each field in the response data:

• company_id (integer): The unique identifier for the company.

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

  • id (integer): The unique identifier for the user activity (commonly referred to as user_activity_id).

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

  • activity_id (string): The unique ID of the activity on R1 Discover (Ties to Company Activity List ID).

  • 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 Started: 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-company-taken-activity-details/13/1/50/10" \
    --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-company-taken-activity-details/13/1/50/10"
);

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-company-taken-activity-details/13/1/50/10");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
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": "",
  "companyId": "1",
  "page": 1,
  "limit": 50,
  "maxDays": 10,
  "data": {
    "user_activity_list": [
      {
        "id": 9656,
        "user_id": 3862,
        "activity_id": 39,
        "activity_name": "Explore the Values Model",
        "company_id": 1,
        "completed_status": "Activity Completed",
        "completed_date": "2024-01-08 09:28:58",
        "created_at": "2024-01-08T14:28:16.000000Z",
        "updated_at": "2024-01-08T14:28:58.000000Z",
        "topic_name": "Values",
        "report_url": "https://discover.r1learning.com/values/Explore the Values Model/overview-and-definition/report/9656",
        "video_completed": false
      }
    ]
  }
}

401: Unauthorized

{
  "message": "Unauthentiated"
}

Notes

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

• Response Handling: Paginate responses to manage data effectively, especially when dealing with large datasets.