API Documentation

Get User List

The Service URL of the module is given by the following link-

https://{domain}.qevalpro.com/api/ManageUser/GetUserList

The domain can be: “app” or “ai”.

  • Method- Post
  • JSON Formats-

1. Code snippet for Web Service Use

{

Headers

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

  1. Authorization: Bearer <Generated_Token>
    • The Bearer Token is generated upon a successful login.
  2. X-API-KEY: <Your_Unique_API_Key>
    • Note: This key is assigned by the QEval team. If not available, you can request it via email at Qeval@etechtexas.com

  “PageNumber”   : 1,

  “EmpId”        : “0”,

  “EmpSrId”      : “0”,

  “SupervisorId” : “-1”,

  “RoleId”       : “-1”,

  “Status”       : true,

  “LocationId”   : “0”,

  “PartnerId”    : null,

  “UserName”     : null,

  “Email”        : “0”,

  “PageSize”     : 10

}

2. Field Descriptions:

Sr. No.  Name Description
1. PageNumber Page index for pagination (starts at 1)
2. EmpId Filter by Employee ID (“0” means all)
3. EmpSrId Filter by Employee Serial ID
4. SupervisorId Filter by Supervisor ID (“-1” means all supervisors)
5. RoleId Filter by Role ID (“-1” means all roles)
6. Status true for active users only
7. LocationId Filter by location (“o” means all locations)
8. PartnerId Optional, filter by partner
9. UserName Optional, filter by username
10. Email Filter by email (“0” means all)
11. PageSize Number of records per page

  

3. Expected Response:

An array of user objects with the following fields:

– TotalRecordsCount

– Supervisor

– Location

– Role

– Partner

– AlternateID

– UserName

– EmpSRId

 

4. Usage Notes:

– This API uses JSON input and returns JSON output.

– Make sure to include valid API Key and Authorization headers.

    ×

    Contact Us