GET {clientId}/Config/Programs

Retrieve all Programs.

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

ConfigProgramResult

Name	Description	Type	Additional information
Programs		Collection of ConfigProgram	None.

Response Formats

application/json, text/json

Sample:

{
  "Programs": [
    {
      "Description": "sample string 1",
      "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"
        }
      ],
      "Link": 1,
      "Name": "sample string 2",
      "DefaultLocaleID": "sample string 3",
      "DisplayOrder": 4,
      "ProgramType": "sample string 5",
      "OptInPreferenceCount": 6,
      "OptOutPreferenceCount": 7,
      "CustomProperties": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Locales": [
        {
          "DisplayTags": [
            {
              "Key": "sample string 1",
              "Value": "sample string 2"
            }
          ],
          "ID": "sample string 1"
        }
      ],
      "ReadOnly": true,
      "ID": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<ConfigProgramResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <Programs>
    <ConfigProgram>
      <ID>sample string 9</ID>
      <CustomProperties>
        <ConfigKeyValue>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </ConfigKeyValue>
      </CustomProperties>
      <DefaultLocaleID>sample string 3</DefaultLocaleID>
      <Description>sample string 1</Description>
      <DisplayOrder>4</DisplayOrder>
      <Link>1</Link>
      <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 2</Name>
      <OptInPreferenceCount>6</OptInPreferenceCount>
      <OptOutPreferenceCount>7</OptOutPreferenceCount>
      <ProgramType>sample string 5</ProgramType>
      <ReadOnly>true</ReadOnly>
      <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>
    </ConfigProgram>
  </Programs>
</ConfigProgramResult>