View Company Taken Activity Questions & Answers

An overview of the View Company Taken Activity Questions & Answers endpoint.

Endpoint Description

The View Company Taken Activity Questions & Answers endpoint allows for the aggregation of responses from all users within a company.

HTTP Method

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

Headers

• Content-Type: application/json

• Accept: application/json

• Authorization: Bearer {token}

URL Parameters

• companyId (integer): The unique identifier of the company. This parameter is required to specify the company whose activity question and answer data is being queried.

• page (integer): The current page number in the pagination sequence. This parameter helps in retrieving a specific set of results.

• limit (integer): The number of records to retrieve per page. This parameter helps in controlling the volume of data returned.

• maxDays (integer, optional): The maximum number of days to look back from the current date to get records updated within this time frame.

Data Dictionary for Response Fields

The response for the "View Company Taken Activity Questions & Answers" endpoint includes detailed information about each question and the corresponding user response across all activities within the company. Below is a breakdown of each field in the response data:

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

• user_id (integer): Unique identifier for the user.

• company_id (integer): Identifier for the company.

• questions (array): Collection of questions and answers for a particular user activity.

  • question_id (integer): Unique identifier for a question within the activity. Distinct to activity, not across the system.

  • question_type (string): The format a question is presented to the user. This influences the structure of the response data.

  • question (string): The question asked to the user.

  • answer (string): The user response to the question, can be a string or an array containing strings.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/view-company-taken-activity-questions-answers/11/1/50/10" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

C# - Http

Response Examples

200: OK

{
  "error": 0,
  "message": "",
  "companyId": 11,
  "page": 1,
  "limit": 50,
  "maxDays": 10,
  "data": {
    "user_activity_id": 1170,
    "user_id": 1178,
    "company_id": 11,
    "questions": [
      {
        "question_id": 1,
        "question": "What substance did you examine in this activity?",
        "question_type": "radio",
        "answer": "Alcohol - beer, wine, liquor, hard cider, hard seltzer"
      },
      {
        "question_id": 2,
        "question": "As you think about what you've learned and your results, which stage do you think you are in right now?",
        "question_type": "radio",
        "answer": "Contemplation"
      },
      {
        "question_id": 3,
        "question": "How long do you think you have been in this stage?",
        "question_type": "radio",
        "answer": "1 year"
      },
      {
        "question_id": 4,
        "question": "What will be the benefit for you and others as you change your pattern of behavior?",
        "question_type": "textarea",
        "answer": "not sure"
      },
      {
        "question_id": 5,
        "question": "What individuals, groups, or resources can you turn to for help and support?",
        "question_type": "textarea",
        "answer": "not sure"
      }
    ]
  }
}

401: Unauthorized

Notes

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

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