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

Get group

Returns group data by id or group code.

• URL: /integration/ws/management/rest/groups/<id_grupo_o_codGroup>
• Method: GET
• Headers:
  • Accept: version/format header
  • X-Cloud-Auth-Token*: authorization header
• Responses:
  • 200: OK. Content: group data as JSON.

• Request example:
  
  • GET (id):

    http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/8a80807d5ab3d79f015ab3dcb2110000

  • GET (group code):

    http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/teachers

• Response example:
  
  • Payload: {"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","parentId":"root","roles":{"training":["trainer"]}}

* Field "isOrganization" only applies in customers with multiorganización enabled