View Company Practitioners

An overview of the view company practitioners endpoint.

Endpoint Description

This endpoint retrieves a list of practitioners who are registered as administrators within a specific company in the R1 Discover system. Practitioners play a crucial role in managing user engagements and activities, making it essential for administrative users to access this data for user creation and management tasks.

HTTP Method

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

Headers

• Content-Type: application/json - Indicates the media type of the resource.

• Accept: application/json - Specifies that the client expects to receive JSON data.

• Authorization: Bearer {token} - A valid authorization token is required to authenticate the request.

URL Parameters

• companyId (integer): The unique identifier for the company. This ID is essential to retrieve practitioners associated with a specific company.

• page (integer): Specifies the page number of the results to be displayed. Helps in paginating the result set.

• limit (integer): The maximum number of records to return in a single request. This helps in managing the data load and enhances performance.

Data Dictionary

The response from the "View Company Practitioners" endpoint includes several fields detailed in the data dictionary below, helping users understand each piece of information returned:

• id (Integer): The unique identifier for each practitioner within the R1 Discover system.

• practitioner_name (String): The full name of the practitioner. This is the name used within the R1 Discover platform for administrative and identification purposes.

• practitioner_email (String): The email address associated with the practitioner's account, used for login and communication.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/view-company-practitioners/1/1/50" \
    --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-practitioners/1/1/50"
);

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-practitioners/1/1/50");
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": "Success",
  "companyId": "1",
  "page": "1",
  "limit": "50",
  "data": [
    {
      "id": 3857,
      "practitioner_name": "Test Admin1",
      "practitioner_email": "[email protected]"
    },
    {
      "id": 3924,
      "practitioner_name": "Test Admin2",
      "practitioner_email": "[email protected]"
    }
  ]
}

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.