API Documentation

Delete User

The Delete User API removes an existing user from the QEval system. This API is used to delete user accounts based on the Employee Serial ID associated with the user.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/DeleteUser
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 
{
    "EmpSrId": 1023
}

Description for Request Parameters

S.No Name Type Description Is Required?
1 EmpSrId Integer Employee Serial ID generated during user creation Yes

Validation Rules

Field Validation Rule
EmpSrId Required and must reference an existing active user
EmpSrId Cannot be blank or null
EmpSrId Cannot refer to a previously deleted user

3. Response Examples

Success

</> JSON 
{
    "Data": true,
    "Message": "User deleted successfully."
}

Status Codes

Code Status Description
200 Success User deleted successfully

Request Parameters

S.No Name Type Description
1 Data Boolean Indicates whether the delete operation was successful
2 Message String Status message returned by the API

Failure 

</> JSON 
User Already Deleted

{
  "Message": "Employee Already Deleted."
}
</> JSON 
Delete Failed

{
  "Data": false,
  "Message": "Failed to delete user."
}
</> JSON 
Invalid Request

{
  "Message": "The request is invalid.",
  "ModelState": {
    "user.EmpSrId": [
      "An error has occurred."
    ]
  }
}

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.
  • EmpSrId is required to identify the user record to be deleted.
  • Only active user records can be deleted.
  • If the specified user has already been deleted, the API returns the message “Employee Already Deleted.”
  • A successful response returns Data = true.
  • A failed delete operation returns Data = true along with an appropriate error message.
  • Ensure the correct Employee Serial ID is provided before executing the delete operation, as deleted users cannot be recovered through this API.

    ×

    Contact Us