GET {clientId}/Config/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	The ID of the Filter to be returned.	string	Required

Body Parameters

None.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)
BadRequest (400)

Resource Description

ConfigFilterResult

Name	Description	Type	Additional information
Filters		Collection of ConfigFilter	None.

Response Formats

application/json, text/json

Sample:

{
  "Filters": [
    {
      "ChannelID": "sample string 1",
      "ProgramID": "sample string 2",
      "Description": "sample string 3",
      "Name": "sample string 1",
      "DefaultLocaleID": "sample string 2",
      "DefaultPreferenceValue": 3,
      "OptInPreferenceCount": 4,
      "OptOutPreferenceCount": 5,
      "OptInCustomerExpirationDays": 6,
      "OptOutCustomerExpirationDays": 7,
      "OptInNonCustomerExpirationDays": 8,
      "OptOutNonCustomerExpirationDays": 9,
      "CustomProperties": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Locales": [
        {
          "DisplayTags": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2"
            }
          ],
          "ID": "sample string 1"
        }
      ],
      "FrequencyLocales": [
        {
          "Frequencies": [
            {
              "Description": "sample string 1",
              "ID": "sample string 1",
              "DisplayName": "sample string 2",
              "IsDefault": true,
              "DisplayOrder": 4
            }
          ],
          "ID": "sample string 1"
        }
      ],
      "PreferenceAttributes": [
        {
          "DisplayOrder": 1,
          "IsRequired": true,
          "ID": "sample string 3"
        }
      ],
      "RequiredPreferenceConsents": [
        {
          "TypeName": "sample string 2",
          "DisplayOrder": 3
        }
      ],
      "Link": 10,
      "ID": "sample string 11"
    }
  ]
}

application/xml, text/xml

Sample:

<ConfigFilterResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <Filters>
    <ConfigFilter>
      <ID>sample string 11</ID>
      <Link>10</Link>
      <ChannelID>sample string 1</ChannelID>
      <CustomProperties>
        <ConfigKeyValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ConfigKeyValue>
      </CustomProperties>
      <DefaultLocaleID>sample string 2</DefaultLocaleID>
      <DefaultPreferenceValue>3</DefaultPreferenceValue>
      <Description>sample string 3</Description>
      <FrequencyLocales>
        <ConfigFilterFrequencyLocale>
          <ID>sample string 1</ID>
          <Frequencies>
            <ConfigFilterFrequency>
              <Description>sample string 1</Description>
              <DisplayName>sample string 2</DisplayName>
              <DisplayOrder>4</DisplayOrder>
              <ID>sample string 1</ID>
              <IsDefault>true</IsDefault>
            </ConfigFilterFrequency>
          </Frequencies>
        </ConfigFilterFrequencyLocale>
      </FrequencyLocales>
      <Locales>
        <ConfigLocaleDisplayTags>
          <ID>sample string 1</ID>
          <DisplayTags>
            <ConfigKeyValue>
              <Key>sample string 1</Key>
              <Value>sample string 2</Value>
            </ConfigKeyValue>
          </DisplayTags>
        </ConfigLocaleDisplayTags>
      </Locales>
      <Name>sample string 1</Name>
      <OptInCustomerExpirationDays>6</OptInCustomerExpirationDays>
      <OptInNonCustomerExpirationDays>8</OptInNonCustomerExpirationDays>
      <OptInPreferenceCount>4</OptInPreferenceCount>
      <OptOutCustomerExpirationDays>7</OptOutCustomerExpirationDays>
      <OptOutNonCustomerExpirationDays>9</OptOutNonCustomerExpirationDays>
      <OptOutPreferenceCount>5</OptOutPreferenceCount>
      <PreferenceAttributes>
        <ConfigPreferenceAttribute>
          <ID>sample string 3</ID>
          <DisplayOrder>1</DisplayOrder>
          <IsRequired>true</IsRequired>
        </ConfigPreferenceAttribute>
      </PreferenceAttributes>
      <ProgramID>sample string 2</ProgramID>
      <RequiredPreferenceConsents>
        <ConfigConsent>
          <ConsentTypeLink>1</ConsentTypeLink>
          <DisplayOrder>3</DisplayOrder>
          <TypeName>sample string 2</TypeName>
        </ConfigConsent>
      </RequiredPreferenceConsents>
    </ConfigFilter>
  </Filters>
</ConfigFilterResult>