netexCloud - Web Services API | Groups Web services | Create group
Last modified:
Create a group.
- URL: /integration/ws/management/rest/groups
- Method: POST
- Headers:
- Accept: version/format header
- X-Cloud-Auth-Token*: authorization header
- X-Cloud-Synchronization: synchronization type(default async).
- Content-Type*: application/json
- Parameters:
- group*: group to be created (group parameter id is ignored during creation)
- name*: group name
- description: group description
- codGroup*: group code (external identifier)
- parentId: parent group identifier (internal or external). If parent group is not found, this parameter is ignored.
- image: group image. Can be::
- url: image url ({"url": "image_url"})
- base64: image data ({"base64Image": "image_data", "mimeType": "image_mimeType"})
- roles: group roles as a map. Allowed values are:
- management: user, groupadmin, admin
- training: user, trainer, groupadmin, admin
- social: user, admin
- play: user, author, validator, admin
- talent: admin, employee
- content: author, manager, reviewer, projectowner
- extra:
- isOrganization (*): Enable group as organization in customer
- group*: group to be created (group parameter id is ignored during creation)
- Responses:
- 200: OK. Content:
- status: general status
- location: resource generic location (if any)
- message: generic message, success or error (if any)
- responsePlatforms: response by platform, with:
- status: plataform status
- location: platform resource location (if any)
- message: plataform success or error message (if any)
- 200: OK. Content:
- Request example:
- POST
http://<tenant>.pre.learningcloud.me/integration/ws/management/rest/groups
- Payload: {"group":{"codGroup":"teachers","description":"Users included in this group will have LMS trainer role.","extra":{},"image":{"url":null},"name":"Teachers group","parentId":"8a80807d5ab3d79f015ab3dcb2110000","roles":{"training":["trainer"]}}}
- POST
- Response example:
- Header: Location:
- Payload: {"location":null,"message":"","responsePlatforms":{"management":{"location":null,"message":null,"status":201}},"status":201}
(*) Field "isOrganization" only applies in customers with multiorganización enabled