GET {clientId}/Filters/{filterId}

Retrieve a Filter.

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
filterId	A filterId that is associated with your clientId. A 404 is returned if this value is invalid.	string	Required

Body Parameters

None.

Response Information

Response Codes

NotFound (404)
Unauthorized (401)

Resource Description

A wrapper that contains extraneous results information as well as the Filter information within.

FilterResult

Name	Description	Type	Additional information
Filters		Collection of ChannelHeader	None.

Response Formats

application/json, text/json

Sample:

{
  "Filters": [
    {
      "Link": 1,
      "ChannelID": "sample string 2",
      "ProgramID": "sample string 3",
      "ID": "sample string 4",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "DefaultPreferenceValue": 7,
      "DefaultLocaleID": "sample string 8",
      "CustomProperties": [
        {
          "Link": 1,
          "Key": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "Locales": [
        {
          "ID": "sample string 1",
          "DisplayTags": [
            {
              "Link": 1,
              "Key": "sample string 2",
              "Value": "sample string 3"
            }
          ]
        }
      ],
      "FrequencyLocales": [
        {
          "ID": "sample string 1",
          "Frequencies": [
            {
              "ID": "sample string 1",
              "DisplayName": "sample string 2",
              "Description": "sample string 3",
              "IsDefault": true,
              "DisplayOrder": 5
            }
          ]
        }
      ],
      "PreferenceAttributes": [
        {
          "Link": 1,
          "ID": "sample string 2",
          "DisplayText": "sample string 3",
          "Description": "sample string 4",
          "PreferenceAttributeType": "sample string 5",
          "DisplayOrder": 6,
          "IsRequired": true,
          "PreferenceAttributeConstraints": [
            {
              "ConstraintType": "sample string 1",
              "Detail": "sample string 2"
            }
          ],
          "DisplayTextLocales": [
            {
              "LocaleLink": 1,
              "Locale": "sample string 2",
              "Name": "sample string 3",
              "Description": "sample string 4"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<FilterResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <Filters xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:ChannelHeader>
      <d2p1:ChannelID>sample string 2</d2p1:ChannelID>
      <d2p1:CustomProperties>
        <d2p1:Attribute>
          <d2p1:Key>sample string 2</d2p1:Key>
          <d2p1:Link>1</d2p1:Link>
          <d2p1:Value>sample string 3</d2p1:Value>
        </d2p1:Attribute>
      </d2p1:CustomProperties>
      <d2p1:DefaultLocaleID>sample string 8</d2p1:DefaultLocaleID>
      <d2p1:DefaultPreferenceValue>7</d2p1:DefaultPreferenceValue>
      <d2p1:Description>sample string 6</d2p1:Description>
      <d2p1:FrequencyLocales>
        <d2p1:FrequencyLocale>
          <d2p1:Frequencies>
            <d2p1:Frequency>
              <d2p1:Description>sample string 3</d2p1:Description>
              <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
              <d2p1:DisplayOrder>5</d2p1:DisplayOrder>
              <d2p1:ID>sample string 1</d2p1:ID>
              <d2p1:IsDefault>true</d2p1:IsDefault>
            </d2p1:Frequency>
          </d2p1:Frequencies>
          <d2p1:ID>sample string 1</d2p1:ID>
        </d2p1:FrequencyLocale>
      </d2p1:FrequencyLocales>
      <d2p1:ID>sample string 4</d2p1:ID>
      <d2p1:Link>1</d2p1:Link>
      <d2p1:Locales>
        <d2p1:Locale>
          <d2p1:DisplayTags>
            <d2p1:Attribute>
              <d2p1:Key>sample string 2</d2p1:Key>
              <d2p1:Link>1</d2p1:Link>
              <d2p1:Value>sample string 3</d2p1:Value>
            </d2p1:Attribute>
          </d2p1:DisplayTags>
          <d2p1:ID>sample string 1</d2p1:ID>
        </d2p1:Locale>
      </d2p1:Locales>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:PreferenceAttributes>
        <d2p1:PreferenceAttribute>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:DisplayOrder>6</d2p1:DisplayOrder>
          <d2p1:DisplayText>sample string 3</d2p1:DisplayText>
          <d2p1:DisplayTextLocales xmlns:d6p1="http://schemas.datacontract.org/2004/07/PossibleNow.PNEnterprise.Domain2.Models">
            <d6p1:LocalizedField>
              <d6p1:Description>sample string 4</d6p1:Description>
              <d6p1:Locale>sample string 2</d6p1:Locale>
              <d6p1:LocaleLink>1</d6p1:LocaleLink>
              <d6p1:Name>sample string 3</d6p1:Name>
            </d6p1:LocalizedField>
          </d2p1:DisplayTextLocales>
          <d2p1:ID>sample string 2</d2p1:ID>
          <d2p1:IsRequired>true</d2p1:IsRequired>
          <d2p1:Link>1</d2p1:Link>
          <d2p1:PreferenceAttributeConstraints>
            <d2p1:PreferenceAttributeConstraint>
              <d2p1:ConstraintType>sample string 1</d2p1:ConstraintType>
              <d2p1:Detail>sample string 2</d2p1:Detail>
            </d2p1:PreferenceAttributeConstraint>
          </d2p1:PreferenceAttributeConstraints>
          <d2p1:PreferenceAttributeType>sample string 5</d2p1:PreferenceAttributeType>
        </d2p1:PreferenceAttribute>
      </d2p1:PreferenceAttributes>
      <d2p1:ProgramID>sample string 3</d2p1:ProgramID>
    </d2p1:ChannelHeader>
  </Filters>
</FilterResult>