GET {clientId}/Config/Attributes

Retrieve all Preference Attributes.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

None.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)

Resource Description

Collection of ConfigAttribute

Name	Type	Additional information
OverwriteExisting	boolean	None.
Link	integer	None.
DisplayText	string	Required Min length: 1
PreferenceAttributeType	string	Required Min length: 1
PreferenceAttributeConstraints	Collection of ConfigAttributeConstraint	None.
DisplayTextLocales	Collection of LocalizedField	Required
ID	string	Required Max length: 20 Min length: 1
Description	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Description": "sample string 1",
    "OverwriteExisting": true,
    "Link": 2,
    "DisplayText": "sample string 3",
    "PreferenceAttributeType": "sample string 4",
    "PreferenceAttributeConstraints": [
      {
        "ConstraintType": "sample string 1",
        "Detail": "sample string 2"
      }
    ],
    "DisplayTextLocales": [
      {
        "LocaleLink": 1,
        "Locale": "sample string 2",
        "Name": "sample string 3",
        "Description": "sample string 4"
      }
    ],
    "ID": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigAttribute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigAttribute>
    <ID>sample string 5</ID>
    <Description>sample string 1</Description>
    <DisplayText>sample string 3</DisplayText>
    <DisplayTextLocales xmlns:d3p1="http://schemas.datacontract.org/2004/07/PossibleNow.PNEnterprise.Domain2.Models">
      <d3p1:LocalizedField>
        <d3p1:Description>sample string 4</d3p1:Description>
        <d3p1:Locale>sample string 2</d3p1:Locale>
        <d3p1:LocaleLink>1</d3p1:LocaleLink>
        <d3p1:Name>sample string 3</d3p1:Name>
      </d3p1:LocalizedField>
    </DisplayTextLocales>
    <Link>2</Link>
    <OverwriteExisting>true</OverwriteExisting>
    <PreferenceAttributeConstraints>
      <ConfigAttributeConstraint>
        <ConstraintType>sample string 1</ConstraintType>
        <Detail>sample string 2</Detail>
      </ConfigAttributeConstraint>
    </PreferenceAttributeConstraints>
    <PreferenceAttributeType>sample string 4</PreferenceAttributeType>
  </ConfigAttribute>
</ArrayOfConfigAttribute>