API Documentation

Add User

This feature helps to add a user within the system. The Service URL of the module is given by the following link-

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

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

 “UserName”:”alanEtech”,

 “Password”:”alanEtech”,

 “EmpId”:”alanEtech”,

 “FirstName”:”Alan”,

 “MiddleName”:”A”,

 “LastName”:”Wilson”,

 “SupervisorId”:”ET00″,

 “EmpType”:”FTE”,

 “RoleId”:1,

 “Email”:”alan.wilson@etechtexas.com”,

 “CampaignId”:573,

 “LocationID”:135,

 “IsSupervisor”:false,

 “IsAccessLocationBased”:false,

 “IsAccessIPBased”:false,

  “PartnerId”:0,

 “IsPartnerAllowed”:false

}

2. Description for Request Parameters

S.No

Name

Type

Description

1

Token

String

Authentication token

2

UserName

String

Name of the user

3

Password

String

The password of the user

4

EmpId

String

ID of Employee

5

FirstName

String

First name of the employee

6

LastName

String

Last name of the employee

7

SupervisorId

String

Id of Supervisor

8

EmpType

String

Type of employee

9

RoleId

Int

Role ID of the employee

10

Email

String

Email of user

11

CampaignId

Int

Id of Campaign

12

LocationID

Int

Location Id of user

13

IsSupervisor

Bit

Is the user supervisor or not

14

IsAccessLocationBased

Bit

Is the access location-based or not

15

IsAccessIPBased

Bit

IP-based login restriction required or not

16

PartnerId

Int

Id of partner

17

IsPartnerAllowed

Bit

Is partner allowed or not

3. Response Example

Success

[

{

“Message”: “User Added successfully.”

}

]

Fail

{“Message”: “The request is invalid”}

    ×

    Contact Us