API Documentation

Get Client Programs

The Get Client Programs API retrieves the list of programs associated with the specified client. This API is used to fetch program records configured under a client within the QEval system.

URL

https://{Subdomain}.qevalpro.com/api/ManageUser/GetProgramnListByClientId
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. Sample Request (Payload)

</> JSON 
[
    {
        "ClientId": 0
    }
]

Description for Request Parameters

S.No Name Type Description Is Required?
1 ClientId Integer Client ID for which program records need to be retrieved. Use “0” to retrieve all accessible programs. Yes

3. Response Examples

Success

</> JSON 
[
    {
        "Selected": true,
        "Text": "Select Program Name",
        "Value": 0
    },
    {
        "Selected": false,
        "Text": "ADSL_CPNIO_Nac",
        "Value": 31
    }
]

Status Codes

Code Status Description
200 Success Returns the list of programs successfully

Response Parameters

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

Failure

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

Status Codes

Code Status Description
401 Unauthorised Token missing, expired, or invalid
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 programs associated with the specified client.
  • Use ClientId = 0 to retrieve all accessible programs.
  • The Text field represents the program name displayed in the application.
  • The Value field represents the unique program identifier used in subsequent API requests.
  • A successful response may contain one or more program records depending on the client configuration.

    ×

    Contact Us