POST api/V3/Distributor/DistributorToUserMappings

Add Distributor to User Mappings

Request Information

URI Parameters

None.

Body Parameters

Collection of V3.DistributorToUserMapping
NameDescriptionTypeAdditional information
DistributorErpId

Erp Id of Distributor

string

Required

UserErpId

string

None.

PositionCodeId

List of Position Code Ids

string

None.

Action

Attach/Detach

string

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "DistributorErpId": "sample string 1",
    "UserErpId": "sample string 2",
    "PositionCodeId": "sample string 3",
    "Action": "sample string 4"
  },
  {
    "DistributorErpId": "sample string 1",
    "UserErpId": "sample string 2",
    "PositionCodeId": "sample string 3",
    "Action": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDistributorToUserMapping xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.V3">
  <DistributorToUserMapping>
    <Action>sample string 4</Action>
    <DistributorErpId>sample string 1</DistributorErpId>
    <PositionCodeId>sample string 3</PositionCodeId>
    <UserErpId>sample string 2</UserErpId>
  </DistributorToUserMapping>
  <DistributorToUserMapping>
    <Action>sample string 4</Action>
    <DistributorErpId>sample string 1</DistributorErpId>
    <PositionCodeId>sample string 3</PositionCodeId>
    <UserErpId>sample string 2</UserErpId>
  </DistributorToUserMapping>
</ArrayOfDistributorToUserMapping>

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>