GET {clientId}/Config/NestedProgramGroups

Retrieve all Nested 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

Collection of ConfigProgramGroupHierarchy

Name	Type	Additional information
ParentProgramGroupID	string	Required Min length: 1
NestedProgramGroupID	string	Required Min length: 1
RelationshipTypeNbr	integer	Required Range: inclusive between 1 and 2

Name

Description

Type

Additional information

ParentProgramGroupID

string

Required

Min length: 1

NestedProgramGroupID

string

Required

Min length: 1

RelationshipTypeNbr

integer

Required

Range: inclusive between 1 and 2

Response Formats

application/json, text/json

Sample:

[
  {
    "ParentProgramGroupID": "sample string 1",
    "NestedProgramGroupID": "sample string 2",
    "RelationshipTypeNbr": 3
  }
]

application/xml, text/xml

Sample:

<ArrayOfConfigProgramGroupHierarchy xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <ConfigProgramGroupHierarchy>
    <NestedProgramGroupID>sample string 2</NestedProgramGroupID>
    <ParentProgramGroupID>sample string 1</ParentProgramGroupID>
    <RelationshipTypeNbr>3</RelationshipTypeNbr>
  </ConfigProgramGroupHierarchy>
</ArrayOfConfigProgramGroupHierarchy>