POST api/V3/Employee/UpdateFieldUser

Update Level 1 Field Users Api

Request Information

URI Parameters

None.

Body Parameters

Field Users to be Updated (Max 100)

Collection of V3.FieldUser
NameDescriptionTypeAdditional 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

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:08:38.7569612+00:00",
    "PositionCode": "sample string 10"
  },
  {
    "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:08:38.7569612+00:00",
    "PositionCode": "sample string 10"
  }
]

application/xml, text/xml

Sample:
<ArrayOfFieldUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <FieldUser>
    <DateOfJoining>2025-04-04T05:08:38.7569612+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>
  <FieldUser>
    <DateOfJoining>2025-04-04T05:08:38.7569612+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>
</ArrayOfFieldUser>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

string

None.

ResponseList

List of Errors

Collection of ApiResponseMessage

None.

Response

Enum Indicating the Response status

ResponseStatus

None.

ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>