POST api/Target/CreateTarget

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TargetDetails	Collection of NewTargetDetails	None.
ItemIds	string	None.
RoleId	integer	None.
AgentIds	string	None.
TargetPeriodId	integer	None.
ValidFrom	string	None.
ValidTo	string	None.
DistributorTypeId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "TargetDetails": [
    {
      "TargetTypeId": 1,
      "TargetValue": 2.0
    },
    {
      "TargetTypeId": 1,
      "TargetValue": 2.0
    }
  ],
  "ItemIds": "sample string 1",
  "RoleId": 2,
  "AgentIds": "sample string 3",
  "TargetPeriodId": 4,
  "ValidFrom": "sample string 5",
  "ValidTo": "sample string 6",
  "DistributorTypeId": 7
}

application/xml, text/xml

Sample:

<CreateTargetDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <AgentIds>sample string 3</AgentIds>
  <DistributorTypeId>7</DistributorTypeId>
  <ItemIds>sample string 1</ItemIds>
  <RoleId>2</RoleId>
  <TargetDetails>
    <NewTargetDetails>
      <TargetTypeId>1</TargetTypeId>
      <TargetValue>2</TargetValue>
    </NewTargetDetails>
    <NewTargetDetails>
      <TargetTypeId>1</TargetTypeId>
      <TargetValue>2</TargetValue>
    </NewTargetDetails>
  </TargetDetails>
  <TargetPeriodId>4</TargetPeriodId>
  <ValidFrom>sample string 5</ValidFrom>
  <ValidTo>sample string 6</ValidTo>
</CreateTargetDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 17:19:06",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>