Update group Updates group data by id or group code. URL: /integration/ws/management/rest/groups/ Method: PUT Headers: Accept: version/format header X-Cloud-Auth-Token*: authorization header X-Cloud-Synchronization : synchronization type(default async ). Content-Type*: application/json Parameters: id or codGroup, included in URL. group*: group to be updated (id, codGroup and parentId are ignored): name*: group name description: group description 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 Responses: 200: OK. Content: status: plataform status location: platform resource location (if any) message: plataform success or error message (if any) status: general status location: resource generic location (if any) message: generic message, success or error (if any) responsePlatforms: response by platform, with: Request example: PUT (id):  http://.learningcloud.me/integration/ws/management/rest/groups/8a80807d5ab3d79f015ab3dcb2110000 PUT (group code):  http://.learningcloud.me/integration/ws/management/rest/groups/teachers 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"]}}} Response example: Payload: {"codGroup":"teachers","description":"Users included in this group will have LMS trainer role.","isOrganization":true,"extra":{},"id":"ff8081815bcff9b5015bd28672f50009","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Teachers group","parentId":"8a80807d5ab3d79f015ab3dcb2110000","roles":{"training":["trainer"]}} (*) Field "isOrganization" only applies in customers with multiorganización enabled and root groups

Delete group Deletes a group by id or codeGroup. URL: /integration/ws/management/rest/groups/ Method: DELETE Headers: Accept: version/format header X-Cloud-Auth-Token*: authorization header X-Cloud-Synchronization : synchronization type(default async ). Parameters: id or codGroup, included in URL. Responses: 200: OK. Contenido: 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) Request example: DELETE (id):  http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/8a80807d5ab3d79f015ab3dcb2110000 DELETE (group code): http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/teachers Response example: Payload: {"location":null,"message":"","responsePlatforms":{"management":{"location":null,"message":null,"status":204}},"status":204}

Get root groups Returns a list with root groups. URL: /integration/ws/management/rest/groups.roots Method: GET Headers: Accept: version/format header X-Cloud-Auth-Token*: authorization header Parameters:  startIndex: index of the first group to list count: maximum number of group to list (default and limit 500) Responses: 200: OK. Content: JSON array with root groups data. Request example: GET :  http://netex.dev.learningcloud.me/integration/ws/management/rest/groups.roots Response example: Payload: [{"codGroup":"RootX","description":null,"extra":{},"id":"8a80807d5af0355e015af03acd580000","image":{"url":null},"name":"RootX","parentId":null,"roles":{}},{"codGroup":"Root2X","description":null,"extra":{},"id":"8a80807d5af0355e015af0408fac0002","image":{"url":null},"name":"Root2X","parentId":null,"roles":{"management":["user"]}}] (*) Field "isOrganization" only applies in customers with multiorganización enabled and root groups

Group searcher Search groups by name, description and codeGroup. A group list is returned. URL: /integration/ws/management/rest/groups.search Method: GET Headers: Accept: version/format header X-Cloud-Auth-Token*: authorization header Parameters:  q: search term (string). max: max number of groups that are returned, from those included in the search result (int). offset: index of the first returned group that is included in the search result (int). order: order type [ asc | desc ]. Asc, by default, always by codGroup. startIndex: index of the first group to list (same as offset) count: maximum number of groups to list with default and limit 500. Responses: 200: OK. Content: JSON array with groups data. Request example: GET : http:// .pre.learningcloud.me/integration/ws/management/rest/groups.search?q=UX&max=100 Response example: Payload: [{"codGroup":"UX","description":"Lorem Ipsum es simplemente el texto de relleno de las imprentas y archivos de texto. Lorem Ipsum ha sido el texto de relleno estándar de las industrias desde el año 1500, cuando un impresor (N. del T. persona que se dedica a la imprenta) desconocido usó una galería de textos y los mezcló de tal manera que logró hacer un libro de textos especimen. No sólo sobrevivió 500 años, sino que tambien ingresó como texto de relleno en documentos electrónicos, quedando esencialmente igual al original. Fue popularizado en los 60s con la creación de las hojas \"Letraset\", las cuales contenian pasajes de Lorem Ipsum, y más recientemente con software de autoedición, como por ejemplo Aldus PageMaker, el cual incluye versiones de Lorem Ipsum.","extra":{},"id":"ff8081815adc5b33015adc5dd5f10000","image":{"url":"/opt/cloud//netex/2017/03/20/2a46f2fd-97f3-4740-891e-18e4ef1a9d16.png"},"name":"UX","parentId":null,"roles":{"management":["admin"],"training":["admin","trainer"],"social":["user"],"play":["user"]}},{"codGroup":"UX 2.1","description":null,"extra":{},"id":"ff8081815aec10a0015aec4680f00003","image":{"url":null},"name":"UX 2.1","parentId":"UX","roles":{}},{"codGroup":"UX2","description":null,"extra":{},"id":"ff8081815adc5b33015adc6d015e0001","image":{"url":null},"name":"UX2","parentId":"UX","roles":{"management":["admin","user"],"social":["admin"],"play":["admin"]}},{"codGroup":"UX3","description":null,"extra":{},"id":"ff8081815adc5b33015adc6d89e00002","image":{"url":null},"name":"UX3","parentId":"UX2","roles":{"training":["user"]}},{"codGroup":"UX4","description":null,"extra":{},"id":"ff8081815adc5b33015adc6e6b800003","image":{"url":null},"name":"UX4","parentId":"UX3","roles":{}},{"codGroup":"UX5","description":null,"extra":{},"id":"ff8081815adc5b33015adc6edcbb0004","image":{"url":null},"name":"UX5","parentId":"UX4","roles":{}}] (*) Field "isOrganization" only applies in customers with multiorganización enabled and root groups

Get children groups Get direct subgroups of the selected group. URL: /integration/ws/management/rest/groups//children 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://netex.dev.learningcloud.me/integration/ws/management/rest/groups/root1/children 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":{}}]

Get ancestor groups Get ancestor groups of the selected group. URL: /integration/ws/management/rest/groups//ancestors Method: GET Headers: Accept: version/format header X-Cloud-Auth-Token*: authorization header 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 groups data. Request example: GET : http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/teachers33/ancestors Response example: Payload: [{"codGroup":"root1","description":"bla bla bla bla bla bla bla bla bla bla balb bla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla balbbla bla bla bla bla bla bla bla bla bla bal","extra":{},"id":"8a80807d5ab3d79f015ab3dcb2110000","image":{"url":null},"name":"Baloncesto","parentId":null,"roles":{}},{"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"]}}] (*) Field "isOrganization" only applies in customers with multiorganización enabled and root groups

Get subgroups Get subgroups of the selected group. URL: /integration/ws/management/rest/groups//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://.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":{}}]

Get direct group users Get users directly added to group. URL: /integration/ws/management/rest/groups//users 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 user to list count: maximum number of users to list (default and limit 500) Responses: 200: OK. Content: JSON array with users data. Request example: GET : http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/root1/users Response example: Payload: [{"aboutMe":null,"email":"antonio@fernandez.com","enabled":true,"extra":{},"id":"ff80818158aafc3b0158abbca6b00002","image":{"url":"/opt/cloud//netex/2017/04/03/933e70bb-7519-4c96-a15a-24b9356ea5cb.png"},"interests":null,"language":"en","location":null,"mobilePhone":null,"name":"Antonio","officePhone":null,"password":"$2a$10$2gXmvim41SwmNzLjFVxCH.3z7Tk7sL89px4peD2b7iQekMCjJMND2","roles":{"management":["admin","user"],"training":["admin","user"]},"extendedFields": {"Department": "IT", "Level": "24"},"surname":"Fernández","timezone":"Europe/Paris","username":"Antonio"},{"aboutMe":null,"email":"mailtesting@kubbe.es","enabled":true,"extra":{},"id":"ff8081815b335e20015b339a8ef37d2b","image":{"url":"/opt/cloud//netex/2017/04/03/b8824db4-3918-479f-88dc-0bb11ddb9318.png"},"interests":null,"language":"en","location":"IN310","mobilePhone":"929929","name":"firstName10312","officePhone":"929929","password":"$2a$10$Jk1h6Je9yxlDVtNhI8Fshu76.mhLPtyRH/lDnqhBuMPCQ7nF21pja","roles":{"training":["user"],"management":["user"]},"extendedFields": {"Department": "HR", "Level": "14"},"surname":"lastName10312","timezone":"Europe/London","username":"paul.mcanallen@capita.co.uk"}]

Add users to group Add users to selected group. URL: /integration/ws/management/rest/groups//users.add 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: id or codGroup, included in URL. Body: usernames (limit 500) Responses: 200: OK. Content: json with result details. 404: Bad Request. Content: json with result details. Request example: POST  http://.pre.learningcloud.me/integration/ws/management/rest/groups/root1/users.add Payload:{"userIds": ["rivera", "ff80818158906584015890ea0d8a0008", "lemmy"]} Response example: Payload: {"location":null,"message":"","responsePlatforms":{"management":{"location":null,"message":null,"status":204}},"status":204

Remove users from group Remove users from selected group. URL: /integration/ws/management/rest/groups//users.remove 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: id or codGroup, included in URL. Body: usernames (limit 500) Responses: 200: OK. Content: json with result details 404: Bad Request. Content: json with result details. Request example: POST http://netex.dev.learningcloud.me/integration/ws/management/rest/groups/root1/users.remove Payload:{"userIds": ["rivera", "ff80818158906584015890ea0d8a0008", "lemmy"]} Response example: Payload: {"location":null,"message":"","responsePlatforms":{"management":{"location":null,"message":null,"status":204}},"status":204}