GET {clientId}/Programs/{programId}/{programGroupId}/Locale/{locale}

Retrieve a specific Program from a Program Group and only return text tags for the specified locale. This call will return the default preference values for the Filters as defined in the Program Group.

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
programGroupId	A programGroupId that is associated with your clientId. A 404 is returned if this value is invalid.	string	Required
programId	A programId that is associated with the provided programGroupId and clientId. A 404 is returned if this value is invalid.	string	Required
locale	A valid locale associated with the programId. A 400 is returned if the locale is invalid.	string	Required

Body Parameters

None.

Response Information

Response Codes

NotFound (404)
BadRequest (400)
Unauthorized (401)

Resource Description

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

ProgramResult

Name	Description	Type	Additional information
Programs		Collection of Program	None.

Response Formats

application/json, text/json

Sample:

{
  "Programs": [
    {
      "Link": 1,
      "ID": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "DefaultLocaleID": "sample string 5",
      "ProgramType": "sample string 6",
      "DisplayOrder": 7,
      "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"
            }
          ]
        }
      ],
      "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:

<ProgramResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <Programs xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:Program>
      <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 5</d2p1:DefaultLocaleID>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:DisplayOrder>7</d2p1:DisplayOrder>
      <d2p1:Filters>
        <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:d8p1="http://schemas.datacontract.org/2004/07/PossibleNow.PNEnterprise.Domain2.Models">
                <d8p1:LocalizedField>
                  <d8p1:Description>sample string 4</d8p1:Description>
                  <d8p1:Locale>sample string 2</d8p1:Locale>
                  <d8p1:LocaleLink>1</d8p1:LocaleLink>
                  <d8p1:Name>sample string 3</d8p1:Name>
                </d8p1: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>
      </d2p1:Filters>
      <d2p1:ID>sample string 2</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 3</d2p1:Name>
      <d2p1:ProgramType>sample string 6</d2p1:ProgramType>
    </d2p1:Program>
  </Programs>
</ProgramResult>