GET api/Preferences/DefinitionsList

Get a list of preference definitions (name, value, title, etc.)

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PreferencesGroupModel

Name	Description	Type	Additional information
Key	Group Key (suitable for use as an identifier / dictionary lookup)	string	None.
Title	Group Title (suitable for display)	string	None.
Preferences	Preference Items	Collection of PreferencesItemModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Key": "sample string 1",
    "Title": "sample string 2",
    "Preferences": [
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Value": 3
      },
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Value": 3
      }
    ]
  },
  {
    "Key": "sample string 1",
    "Title": "sample string 2",
    "Preferences": [
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Value": 3
      },
      {
        "Key": "sample string 1",
        "Title": "sample string 2",
        "Value": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPreferencesGroupModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.API.Models">
  <PreferencesGroupModel>
    <Key>sample string 1</Key>
    <Preferences>
      <PreferencesItemModel>
        <Key>sample string 1</Key>
        <Title>sample string 2</Title>
        <Value>3</Value>
      </PreferencesItemModel>
      <PreferencesItemModel>
        <Key>sample string 1</Key>
        <Title>sample string 2</Title>
        <Value>3</Value>
      </PreferencesItemModel>
    </Preferences>
    <Title>sample string 2</Title>
  </PreferencesGroupModel>
  <PreferencesGroupModel>
    <Key>sample string 1</Key>
    <Preferences>
      <PreferencesItemModel>
        <Key>sample string 1</Key>
        <Title>sample string 2</Title>
        <Value>3</Value>
      </PreferencesItemModel>
      <PreferencesItemModel>
        <Key>sample string 1</Key>
        <Title>sample string 2</Title>
        <Value>3</Value>
      </PreferencesItemModel>
    </Preferences>
    <Title>sample string 2</Title>
  </PreferencesGroupModel>
</ArrayOfPreferencesGroupModel>