Company Activity List

An overview of the Company Activity List endpoint.

Endpoint Description

This endpoint retrieves a list of activities available to a company's users, sorted by topic, within the R1 Discover platform.

HTTP Method

GET /api/v1/company-activity-list

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

• N/A - This endpoint does not require any URL parameters to be passed.

Data Dictionary for Response Fields

The response from the "Company Activity List" endpoint includes a list of activities, each associated with a specific company and topic. Here’s the breakdown of each field in the response data:

• activity_list (Array): A collection of activities available to each company.

  • company_id (Integer): Identifier for the company.

  • topic_id (Integer): The Unique ID for the topic of the activity.

  • activities (Array): Collection of data describing the activity.

    • id (Integer): Unique ID of the activity in R1 Discover.

    • name (String): The name of the activity.

    • topic_id (Integer): The ID of the topic the activity is linked to.

    • type (String): Indicates the type of activity; currently two types are recognized— "sorting_cards" and "overview_definition_cards".

    • activity_url (String): The URL to remote login a user to take an activity via an IFrame.

Request Examples

Bash

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

JavaScript

Ruby

Response Examples

200: OK

{
  "error": 0,
  "message": "",
  "data": {
    "activity_list": [
      {
        "company_id": 1,
        "topic_id": 1,
        "activities": [
          {
            "id": 1,
            "name": "Identify My Stage of Change",
            "topic_id": 1,
            "type": "sorting_cards",
            "activity_url": "https://discover.r1learning.com/activity/identify-my-stage-of-change/start/?rlt={REMOTE_LOGIN_TOKEN}&rlt_uid={USER_ID}"
          },
          {
            "id": 38,
            "name": "Explore the Stages of Change Model",
            "topic_id": 1,
            "type": "overview_definition_cards",
            "activity_url": "https://discover.r1learning.com/activity/explore-the-stages-of-change-model/start/?rlt={REMOTE_LOGIN_TOKEN}&rlt_uid={USER_ID}"
          }
        ]
      }
    ]
  }
}

401: Unauthorized

Notes

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

• Response Handling: As this endpoint can potentially return a large volume of data, it is advisable to manage data effectively, possibly through appropriate client-side processing.