GET api/v1/groups/{nodeId}/children?siteService={siteService}&recursive={recursive}

Retrieves child headers for a specified group node

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 1

    CygNet Bridge API license type: Base

Request Information

URI Parameters

NameDescriptionTypeAdditional information
nodeId

Parent group node ID

 string

Required
siteService

CygNet site and service (Site.Service) of the Group Service (GRP)

 string

Required
recursive

If set to true, returns all the child nodes (including non-leaf nodes)

 boolean

Default value is False

Body Parameters

None

Response Information

Resource Description

List of group node headers that are children of the specified node ID

NameDescriptionTypeAdditional information
nodes

List of group headers

 Collection of GroupHeaderDTO

None

Response Formats

application/json, text/json

Sample: 
{
  "nodes": [
    {
      "id": 485,
      "type": "StandardGroup",
      "category": "SubGroup",
      "description": "Austin"
    },
    {
      "id": 486,
      "type": "StandardGroup",
      "category": "SubGroup",
      "description": "San Antonio"
    }
  ]
}