API Documentation

Get Evaluation Forms

The Get Evaluation Forms API retrieves the list of evaluation forms associated with the specified campaign. This API is used to fetch evaluation forms available for a particular campaign within the QEval system.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetEvalFormListByCampaignId
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 
[
    {
        "CampaignId": 0
    }
]

Description for Request Parameters

S.No Name Type Description Is Required?
1 CampaignId Integer Unique identifier of the campaign for which evaluation forms need to be retrieved. Yes

3. Response Examples

Success

</> JSON 
[
    {
        "Selected": true,
        "Text": "Select Eval Form Name",
        "Value": 0
    },
    {
        "Selected": false,
        "Text": "Test Form 1",
        "Value": 11111
    },
    {
        "Selected": false,
        "Text": "Test Form 2",
        "Value": 22222
    }
]

Status Codes

Code Status Description
200 Success Returns the list of evaluation forms successfully

Response Parameters

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

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 evaluation forms associated with the specified campaign.
  • A valid CampaignId must be provided to retrieve evaluation forms.
  • The Text field represents the evaluation form name displayed in the application.
  • The Value field represents the unique evaluation form identifier used in subsequent API requests.
  • A successful response may contain one or more evaluation forms depending on the campaign configuration.

    ×

    Contact Us