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:
- Authorization: Bearer <Generated_Token>
- The Bearer Token is generated upon a successful login.
- 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”: “David_Paul57”,
“password”: “David@123456”,
“empId”: “David57”,
“firstName”: “David”,
“middleName”: “P”,
“lastName”: “Paul”,
“supervisorId”: “3332”,
“empType”: “FTE”,
“roleId”: 1,
“email”: “david.paul57@etechtexas.com”,
“campaignId”: 32506,
“locationID”: 2946,
“isSupervisor”: false,
“isAccessLocationBased”: false,
“isAccessIPBased”: false,
“partnerId”: 0,
“isPartnerAllowed”: false
}
2. Description for Request Parameters–
|
S.No |
Name |
Type |
Description |
|
1 |
UserName |
String |
Name of the user |
|
2 |
Password |
String |
The password of the user |
|
3 |
EmpId |
String |
ID of Employee |
|
4 |
FirstName |
String |
First name of the employee |
|
5 |
LastName |
String |
Last name of the employee |
|
6 |
SupervisorId |
String |
Id of Supervisor |
|
7 |
EmpType |
String |
Type of employee |
|
8 |
RoleId |
Int |
Role ID of the employee |
|
9 |
|
String |
Email of user |
|
10 |
CampaignId |
Int |
Id of Campaign |
|
11 |
LocationID |
Int |
Location Id of user |
|
12 |
IsSupervisor |
Bit |
Is the user supervisor or not |
|
13 |
IsAccessLocationBased |
Bit |
Is the access location-based or not |
|
14 |
IsAccessIPBased |
Bit |
IP-based login restriction required or not |
|
15 |
PartnerId |
Int |
Id of partner |
|
16 |
IsPartnerAllowed |
Bit |
Is partner allowed or not |
3. Response Example–
Success–
[
{
“Message”: “User Added successfully.”,
“Data”: {
“EmpId”: “David57”,
“EmpSrId”: 137937,
“FirstName”: “David”,
“MiddleName”: “P”,
“LastName”: “Paul”,
“SupervisorId”: “3332”,
“UserId”: null,
“EmpType”: “FTE”,
“RoleId”: 1,
“ClientId”: 2910,
“Email”: “david.paul57@etechtexas.com”,
“IsActive”: true,
“CampaignId”: 32506,
“LocationID”: 2946,
“IsSupervisor”: false,
“IsCampaignBased”: true,
“IsAccessLocationBased”: false,
“PartnerId”: 0
}
}
]
Fail–
{“Message”: “The request is invalid”}
Video