getProgramGroups

Deprecated

Example Query

query ExampleQuery($programGroupId: String, $country: String, $locale: String) {
  getProgramGroups(programGroupId: $programGroupId, country: $country, locale: $locale) {
    link
    id
    name
    description
    defaultLocaleId
    locales {
      id
      displayTags
    }
    programGroups
    programs {
      link
      id
      name
      description
      defaultLocaleId
      locales
      customProperties
      programType
      displayOrder
      filters
    }
    customProperties {
      link
      key
      value
    }
  }
}

Variables

{
  "programGroupId": "example",
  "country": "example",
  "locale": "example"
}

Example response

{
  "data": {
    "getProgramGroups": {
      "link": 0,
      "id": "example",
      "name": "example",
      "description": "example",
      "defaultLocaleId": "example",
      "locales": [
        {
          "id": "example",
          "displayTags": [
            {
              "link": null,
              "key": null,
              "value": null
            }
          ]
        }
      ],
      "programGroups": [
        null
      ],
      "programs": [
        {
          "link": 0,
          "id": "example",
          "name": "example",
          "description": "example",
          "defaultLocaleId": "example",
          "locales": [
            {
              "id": null,
              "displayTags": null
            }
          ],
          "customProperties": [
            {
              "link": null,
              "key": null,
              "value": null
            }
          ],
          "programType": "example",
          "displayOrder": 0,
          "filters": [
            {
              "link": null,
              "channelId": null,
              "programId": null,
              "id": null,
              "name": null,
              "description": null,
              "defaultPreferenceValue": null,
              "defaultLocaleId": null,
              "customProperties": null,
              "locales": null
            }
          ]
        }
      ],
      "customProperties": [
        {
          "link": 0,
          "key": "example",
          "value": "example"
        }
      ]
    }
  }
}

Deprecated: Deprecated to comply with GraphQL API standard naming conventions. Use ‘programGroups’ query instead.

Arguments

programGroupIdStringOptional

countryStringOptional

localeStringOptional

Returns

an optional ProgramGroups

linkIntegerOptional

Link number of the program group.

idStringOptional

Identifier of the program group.

nameStringOptional

Name of the program group.

descriptionStringOptional

Description of the program group.

defaultLocaleIdStringOptional

Default locale id of the program group.

localeslist of optional LocalesOptional

Locales of the program group.

programGroupslist of optional ProgramGroupsOptional

Program groups under the program group.

programslist of optional ProgramsOptional

Programs under the program group.

customPropertieslist of optional CustomPropertiesOptional

Custom properties of the program group.