netexCloud - Web Services API | Groups Web services | Get subgroups

Get subgroups

Get subgroups of the selected group.

• URL: /integration/ws/management/rest/groups/<id_grupo_o_codGroup>/descendants
• Method: GET
• Headers:
  • Accept: version/format header (more info)
  • X-Cloud-Auth-Token*: authorization header (more info)
• Parameters:
  • id or codGroup, included in URL
  • startIndex: index of the first group to list
  • count: maximum number of groups to list (default and limit 500)
• Responses:
  • 200: OK. Content: JSON array with subgroups data.

• Request example:
  
  • GET : http://<tenant>.learningcloud.me/integration/ws/management/rest/groups/root1/descendants
• Response example:
  
  • Payload: [{"codGroup":"teachers3","description":"Users included in this group will have LMS trainer role.","extra":{},"id":"8a80807d5bd29c2f015bd30bded00001","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Teachers group aaaaa","parentId":"root1","roles":{"training":["trainer"]}},{"codGroup":"uuuuu","description":null,"extra":{},"id":"ff8081815aed4b3b015af0315fb70003","image":{"url":null},"name":"uuuuu","parentId":"root1","roles":{}},{"codGroup":"teachers2","description":"Users included in this group will have LMS trainer role.","extra":{},"id":"8a80807d5bd29c2f015bd2d44b0f0000","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Teachers group 2","parentId":"root1","roles":{"training":["trainer"]}},{"codGroup":"teachers","description":"Users included in this group will have LMS trainer role.","extra":{},"id":"ff8081815bcff9b5015bd28672f50009","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Teachers group mod 2","parentId":null,"roles":{"training":["trainer"]}},{"codGroup":"subroot","description":null,"extra":{},"id":"ff8081815ad2cd43015ad2d5e6400000","image":{"url":null},"name":"subroot","parentId":"root1","roles":{}},{"codGroup":"teachers33","description":"Subsitude teachers.","extra":{},"id":"ff8081815bd80d2b015bd830af3e0104","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Subsitude teachers","parentId":"teachers3","roles":{}}]