API Documentation

Get Client Supervisor

The Get Client Supervisor API retrieves the list of supervisors associated with the specified client. This API is used to identify and fetch supervisor records configured under a client within the QEval system.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetSupervisorListByClientId
Method POST
Sub Domains “app” or “ai”

1. API Headers

Every API call must include two-factor authentication by providing the following headers:

Header Type Description
Authorisation String Bearer <Generated_Token> (generated after successful login)
X-API-KEY String

<Your_Unique_API_Key> (generated after successful login)

Note: If unavailable, email Qeval@etechtexas.com.

2. Response Examples

Success 

</> JSON 
[
    {
        "Selected": false,
        "Text": "7324 Harris(7324)",
        "Value": 7324
    },
    {
        "Selected": false,
        "Text": "4280 Walker(4280)",
        "Value": 4280
    }
]

Status Codes

Code Status Description
200 Success Returns the list of supervisors successfully

Response Parameters

S.No Name Type Description
1 Selected Boolean Indicates whether the supervisor is selected by default
2 Text String Display name of the supervisor along with the supervisor ID
3 Value String Unique identifier of the supervisor

Failure

</> JSON 
[
    {
        "Message": "The request is invalid"
    }
]

Status Codes

Code Status Description
401 Unauthorised Client ID not found
403 Forbidden Invalid or missing API key
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Unexpected server error occurred

Notes

  • Authentication is mandatory for accessing this API.
  • The API returns supervisors associated with the specified client.
  • The Text field displays the supervisor name along with the supervisor ID.
  • The Value field represents the unique supervisor identifier used in subsequent API requests.
  • Ensure a valid Client ID is provided to retrieve supervisor records successfully.

    ×

    Contact Us