POST api/V3/Employee/AddFieldUser
Add a field user
Request Information
URI Parameters
None.
Body Parameters
V3.FieldUserName | Description | Type | Additional information |
---|---|---|---|
ParentErpId |
Erp Id of parent |
string |
None. |
UserRole |
role of user |
PortalUserRole |
None. |
Name |
name of user |
string |
None. |
ErpId |
Erp Id of User |
string |
None. |
Email od User |
string |
None. |
|
Mobile |
Number od user |
string |
None. |
DistributorErpId |
ErpId of distributor |
string |
None. |
RegionErpId |
Region ErpId of user |
string |
None. |
HQ |
Head quaters of user |
string |
None. |
Designation |
Designation of user |
string |
None. |
DateOfJoining |
Date of Joining of user |
date |
None. |
PositionCode |
Position code of user |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ParentErpId": "sample string 1", "UserRole": "ClientEmployee", "Name": "sample string 2", "ErpId": "sample string 3", "Email": "sample string 4", "Mobile": "sample string 5", "DistributorErpId": "sample string 6", "RegionErpId": "sample string 7", "HQ": "sample string 8", "Designation": "sample string 9", "DateOfJoining": "2025-04-04T05:04:33.4366617+00:00", "PositionCode": "sample string 10" }
application/xml, text/xml
Sample:
<FieldUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3"> <DateOfJoining>2025-04-04T05:04:33.4366617+00:00</DateOfJoining> <Designation>sample string 9</Designation> <DistributorErpId>sample string 6</DistributorErpId> <Email>sample string 4</Email> <ErpId>sample string 3</ErpId> <HQ>sample string 8</HQ> <Mobile>sample string 5</Mobile> <Name>sample string 2</Name> <ParentErpId>sample string 1</ParentErpId> <PositionCode>sample string 10</PositionCode> <RegionErpId>sample string 7</RegionErpId> </FieldUser>
Response Information
Resource Description
ApiResponseMessageName | Description | Type | Additional information |
---|---|---|---|
ERPId |
ERPID of the Requested insertion/updation |
string |
None. |
Message |
Error Message for the indicated ERPID |
string |
None. |
ResponseStatus |
Status of the action requested from Api |
ResponseStatus |
None. |
GUID |
GUID of the database Entry with respect to the ERP Id Provided |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ERPId": "sample string 1", "Message": "sample string 2", "ResponseStatus": "Failure", "GUID": "sample string 3" }
application/xml, text/xml
Sample:
<ApiResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common"> <ERPId>sample string 1</ERPId> <GUID>sample string 3</GUID> <Message>sample string 2</Message> <ResponseStatus>Failure</ResponseStatus> </ApiResponseMessage>