GET api/users/customer/{customerDID}/Attribute?localeID={localeID}

Returns the collection of Comp Attributes for the given customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerDID

The customer identification.

 string

Required
localeID

Optional. Locale identifier to get translated descriptions.

 integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerCompAttributeValueViewModel
NameDescriptionTypeAdditional information
ID

Unique ID for the compensation attribute.

 integer

None.
Description

The description of the compensation attribute.

 string

None.
CompAttributeValueID

Unique ID for the compensation attribute value.

 integer

None.
Value

The value of the compensation attribute for the given customer.

 string

None.
DropdownValueLabel

Only returned if the attribute is a Drop Down data type. This is the label of the stored value.

 string

None.
Start Period

The starting period for the attribute being active for the given customer.

 string

None.
End Period

The ending period for the attribute being active for the given customer.

 string

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfCustomerCompAttributeValueViewModel>
  <CustomerCompAttributeValueViewModel>
    <ID>1</ID>
    <Attribute>sample string 2</Attribute>
    <CompAttributeValueID>3</CompAttributeValueID>
    <Value>sample string 4</Value>
    <DropdownValueLabel>sample string 5</DropdownValueLabel>
    <StartPeriod>sample string 6</StartPeriod>
    <EndPeriod>sample string 7</EndPeriod>
  </CustomerCompAttributeValueViewModel>
  <CustomerCompAttributeValueViewModel>
    <ID>1</ID>
    <Attribute>sample string 2</Attribute>
    <CompAttributeValueID>3</CompAttributeValueID>
    <Value>sample string 4</Value>
    <DropdownValueLabel>sample string 5</DropdownValueLabel>
    <StartPeriod>sample string 6</StartPeriod>
    <EndPeriod>sample string 7</EndPeriod>
  </CustomerCompAttributeValueViewModel>
</ListOfCustomerCompAttributeValueViewModel>

application/json, text/json

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