API Documentation

Get Role

The Get Role API retrieves the list of user roles available in the QEval system. This API is used to populate role selections and obtain role-related information for user management activities.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetRoles
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": true,
        "Text": "Select Role Name",
        "Value": 0
    },
    {
        "Selected": false,
        "Text": "Admin",
        "Value": 7
    }
]

Status Codes

Code Status Description
200 Success Returns the list of available roles (VP, SuperAdmin, and Uploader roles are excluded)

Response Parameters

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

Failure

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

Status Codes

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

Notes

  • Authentication is mandatory for accessing this API.
  • The API returns the roles available to the authenticated user.
  • VP, SuperAdmin, and Uploader roles are excluded from the response.
  • The “Text” field represents the role name displayed in the application.
  • The “Value” field represents the unique role identifier used in subsequent API requests.

    ×

    Contact Us