netexCloud - API de Web Services | Web services de grupo | Actualización del grupo

Última modificación: hace 7 meses

Actualiza un grupo mediante el id o código de grupo.

URL: /integration/ws/management/rest/groups/<id_grupo_o_codGroup>
Method: PUT
Headers:
- Accept: encabezado de versión/formato
- X-Cloud-Auth-Token*: encabezado de autorización
- Content-Type*: application/json
Parameters:
- group*: grupo que se va a actualizar (los parámetros id, codGroup y parentId se ignoran al no ser campos modificables):
  - name: nombre del grupo
  - description: descripción del grupo
  - image: imagen del grupo. Puede ser especificada como:
    - url: url en la que se encuentra la imagen ({"url": "image_url"})
    - base64: datos de la imagen ({"base64Image": "image_data", "mimeType": "image_mimeType"})
  - roles: roles de grupo especificados como un mapa con la sección como clave y la lista de rol como valor. Los valores permitidos son:
    - 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 (*): Habilita que el grupo sea considerado como una organización en el cliente.
Responses:
- 200: OK. Contenido:
  - status: estado genérico
  - location: ubicación genérica del recurso resultante (si lo hubiere)
  - message: mensaje genérico de “éxito” o “error” (si lo hubiere).
  - responsePlatforms: respuesta para cada platafroma a la que afecta. Cada una con el contenido:
    - status: estado en la plataforma (si lo hubiere)
    - location: localización del recurso resultante en la plataforma (si lo hubiere)
    - message: mensaje de “éxito” o “error” en la plataforma (si lo hubiere)
Ejemplo de petición
- PUT por el id de grupo: http://<tenant>.learningcloud.me/integration/ws/management/rest/groups/8a80807d5ab3d79f015ab3dcb2110000
- PUT por el código de grupo: http://<tenant>.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"]}}}
Ejemplo de respuesta:
- Payload: {"codGroup":"teachers","description":"Users included in this group will have LMS trainer role.","isOrgnaization":true,"extra":{},"id":"ff8081815bcff9b5015bd28672f50009","image":{"url":"http://zblogged.com/wp-content/uploads/2015/11/17.jpg"},"name":"Teachers group","parentId":"8a80807d5ab3d79f015ab3dcb2110000","roles":{"training":["trainer"]}}

(*) El campo isOrganization solo se permite en los grupos raíz de los clientes con multiorganización activada