Documentation for POST api/rep/{RepDID}/Attribute?BCDID={BCDID}

POST api/rep/{RepDID}/Attribute?BCDID={BCDID}

This API method will allow you to update the Comp Statuses of a Representative through Comp Attributes.

Request Information

URI Parameters

Name	Description	Type	Additional information
RepDID		string	Required
BCDID		integer	Default value is 1

Body Parameters

Collection of RepCompAttributeValueViewModel

Name	Description	Type	Additional information
ID	Unique ID for the Compensation Attribute	integer	None.
Description	The Description of the Attribute	string	None.
CompAttributeValueID	Unique ID for the Compensation Attribute Value	integer	None.
Value	The Value of the Attribute for the given Rep	string	None.
Start Period	The Starting Period for the Attribute being active for the given Rep	string	None.
End Period	The Ending Period for the Attribute being active for the given Rep	string	None.

Request Formats

application/xml, text/xml

Sample:

<ListOfRepCompAttributeValueViewModel>
  <RepCompAttributeValueViewModel>
    <ID>1</ID>
    <Attribute>sample string 2</Attribute>
    <CompAttributeValueID>3</CompAttributeValueID>
    <Value>sample string 4</Value>
    <StartPeriod>sample string 5</StartPeriod>
    <EndPeriod>sample string 6</EndPeriod>
  </RepCompAttributeValueViewModel>
  <RepCompAttributeValueViewModel>
    <ID>1</ID>
    <Attribute>sample string 2</Attribute>
    <CompAttributeValueID>3</CompAttributeValueID>
    <Value>sample string 4</Value>
    <StartPeriod>sample string 5</StartPeriod>
    <EndPeriod>sample string 6</EndPeriod>
  </RepCompAttributeValueViewModel>
</ListOfRepCompAttributeValueViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Description": "sample string 2",
    "CompAttributeValueID": 3,
    "Value": "sample string 4",
    "Start Period": "sample string 5",
    "End Period": "sample string 6"
  },
  {
    "ID": 1,
    "Description": "sample string 2",
    "CompAttributeValueID": 3,
    "Value": "sample string 4",
    "Start Period": "sample string 5",
    "End Period": "sample string 6"
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'IEnumerable`1'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.