View Company Admins

An overview of the View Company Admins endpoint

Endpoint Description

This endpoint provides detailed information about the administrators aligned to a specific company within the R1 Discover platform. It is essential for managing and overseeing admin roles and permissions across different segments of your organization.

HTTP Method

GET /api/v1/view-company-admins/{companyId}/{page}/{limit}

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. This parameter is required to specify which company's admins are being queried.

• page (integer): The page number in the pagination sequence. 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.

Data Dictionary for Response Fields

The response for the "View Company Admins" endpoint contains detailed information about each admin associated with the specified company. Below is a breakdown of each field in the response data:

• id (Integer): The unique identifier assigned to the admin within the R1 Discover system. This identifier is used internally to reference the admin across various API endpoints.

• email (String): The email address associated with the admin's account. This is used for admin logins and communications.

• username (String): The username assigned to the admin in the R1 Discover platform. This is a unique identifier used for admin login and identification within the system.

• unique_id (String): A shared identifier between R1 Discover and external integration systems that uniquely identifies the admin across different platforms.

• location_name (String): The name of the location or office where the admin is based. This helps in identifying the admin's operational base within the organization.

• status (String): Indicates whether the admin is currently active or inactive within the R1 Discover system. This status can be used to manage access and permissions.

Request Examples

Bash

curl -X GET 'https://api.r1learning.com/api/v1/view-company-admins/1/1/50' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {token}'

JavaScript

const url = new URL('https://api.r1learning.com/api/v1/view-company-admins/1/1/50');
const headers = {
  "Content-Type": "application/json",
  "Accept": "application/json",
  "Authorization": "Bearer {token}"
};

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

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.r1learning.com/api/v1/view-company-admins/1/1/50");
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": "",
  "companyId": "1",
  "page": "2",
  "limit": "50",
  "data": [
    {
      "id": 4164,
      "email": "[email protected]",
      "username": "admin1",
      "unique_id": "Admin-1",
      "status": "active",
      "location_name": "R1 Learning Loc #1"
    },
    {
      "id": 4165,
      "email": "[email protected]",
      "username": "admin2",
      "unique_id": "Admin-2",
      "status": "active",
      "location_name": "R1 Learning Loc #1"
    }
  ]
}

401: Unauthorized

{
  "message": "Unauthentiated"
}

404: Not Found

{
  "error": "Company not found",
  "details": "The specified company ID does not exist."
}

Notes

• Ensure that the Authorization header contains a valid Bearer token; otherwise, a 401 Unauthorized status will be returned.*

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

This endpoint description provides a comprehensive guide on how to effectively retrieve administrator details for a specific company, including handling potential errors and managing large amounts of data through pagination.