GET {clientId}/Config/ProgramGroup
Retrieve all Program Groups.
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
ConfigProgramGroupResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramGroup | Collection of ConfigProgramGroup |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProgramGroup": [
{
"Description": "sample string 1",
"Link": 1,
"ID": "sample string 2",
"Name": "sample string 3",
"DefaultLocaleID": "sample string 4",
"OptInPreferenceCount": 5,
"OptOutPreferenceCount": 6,
"CustomProperties": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"Locales": [
{
"DisplayTags": [
{
"Key": "sample string 1",
"Value": "sample string 2"
}
],
"ID": "sample string 1"
}
],
"Programs": [
{
"Description": "sample string 1",
"Filters": [
{
"ChannelID": "sample string 1",
"ProgramID": "sample string 2",
"Description": "sample string 3",
"ProgramGroupDefaultValue": 1,
"Name": "sample string 2",
"DefaultLocaleID": "sample string 3",
"DefaultPreferenceValue": 4,
"OptInPreferenceCount": 5,
"OptOutPreferenceCount": 6,
"OptInCustomerExpirationDays": 7,
"OptOutCustomerExpirationDays": 8,
"OptInNonCustomerExpirationDays": 9,
"OptOutNonCustomerExpirationDays": 10,
"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": 11,
"ID": "sample string 12"
}
],
"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:
<ConfigProgramGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
<ProgramGroup>
<ConfigProgramGroup>
<CustomProperties>
<ConfigKeyValue>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ConfigKeyValue>
</CustomProperties>
<DefaultLocaleID>sample string 4</DefaultLocaleID>
<Description>sample string 1</Description>
<ID>sample string 2</ID>
<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 3</Name>
<OptInPreferenceCount>5</OptInPreferenceCount>
<OptOutPreferenceCount>6</OptOutPreferenceCount>
<Programs>
<ConfigProgramProgramGroup>
<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>
<ConfigFilterProgramGroup>
<ID>sample string 12</ID>
<Link>11</Link>
<ChannelID>sample string 1</ChannelID>
<CustomProperties>
<ConfigKeyValue>
<Key>sample string 1</Key>
<Value>sample string 2</Value>
</ConfigKeyValue>
</CustomProperties>
<DefaultLocaleID>sample string 3</DefaultLocaleID>
<DefaultPreferenceValue>4</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 2</Name>
<OptInCustomerExpirationDays>7</OptInCustomerExpirationDays>
<OptInNonCustomerExpirationDays>9</OptInNonCustomerExpirationDays>
<OptInPreferenceCount>5</OptInPreferenceCount>
<OptOutCustomerExpirationDays>8</OptOutCustomerExpirationDays>
<OptOutNonCustomerExpirationDays>10</OptOutNonCustomerExpirationDays>
<OptOutPreferenceCount>6</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>
<ProgramGroupDefaultValue>1</ProgramGroupDefaultValue>
</ConfigFilterProgramGroup>
</Filters>
</ConfigProgramProgramGroup>
</Programs>
</ConfigProgramGroup>
</ProgramGroup>
</ConfigProgramGroupResult>