Qué hace este punto final de API

Con la API de membresías a grupos, puedes agregar y eliminar usuarios de un grupo. Los administradores ven esto reflejado en la pestaña Personas, en el registro de usuario individual o de grupo. Todos los cursos asignados al grupo aparecerán en la biblioteca del usuario.

También puede usar esta API para recuperar una lista de los miembros de un grupo o de los grupos en los que está inscrito un usuario individual.

• Puntos finales
• Listar los miembros de un grupo
• Listar los grupos de un usuario
• Añadir un usuario a un grupo
• Eliminar un usuario de un grupo

Puntos finales

• GET /groups/{groupId}/users- enumerar los miembros de un grupo
• GET /users/{userId}/groups - enumerar los grupos de un usuario
• PUT /groups/{groupId}/users/{userId} - agregar un usuario a un grupo
• DELETE /groups/{groupId}/users/{userId}- eliminar un usuario de un grupo

Listar los miembros de un grupo

GET /groups/{groupId}/users

Parámetros de solicitud (cadena de consulta)

• limit(entero, opcional): el número máximo de resultados que se devolverán en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)

Ejemplo de respuesta

< https://api.reach360.com/reports/learners/example-user-id-1 > < https://api.reach360.com/users/example-user-id-1 >{ 
 «users»: [
{
«id»: «example-user-id-1", «email»: "foo@example.com 
 «, «groupURL»: «», «< https://api.reach360.com/users/example-user-id-1/groups > role»: 
 «learner», «firstName»: 
 «Ejemplo de nombre 1", «lastName»: 
 «Ejemplo de apellido 1", «lastActiveAT»: 
 «2021-10-28T 20:39:52 .659 Z», 
 «learnerReportUrl»: «», «url»: «» «Articulate360User»: falso 
 
 
 
},... 
< https://url-for-next-page-of-results >], 
 «nextUrl»: «»} 

Códigos de error específicos del punto final:

• group_not_found- no puede enumerar los usuarios porque el grupo no existe

Listar los grupos de un usuario

GET /users/{userId}/groups

Parámetros de solicitud (cadena de consulta)

• limit(entero, opcional): el número máximo de resultados que se devolverán en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)

Ejemplo de respuesta

< https://api.reach360.com/groups/example-group-id-1 >{ 
 «groups»: [
{
«id»: «example-group-id-1", 
 «membersURL»: «», «< https://api.reach360.com/groups/example-group-id/users > name»: «Grupo de ejemplo», 
 «url»: «»},
... 
 
< https://url-for-next-page-of-results >], «nextURL»: «»} 
 

Códigos de error específicos del punto final:

• user_not_found- no puede enumerar los grupos de usuarios porque el usuario no existe

Añadir usuario al grupo

PUT /groups/{groupId}/users/{userId}

Respuesta exitosa

204 «Sin contenido»

Códigos de error específicos del punto final:

• group_not_found- no se puede agregar el usuario al grupo porque el grupo no existe
• user_not_found- no se puede agregar un usuario al grupo porque el usuario no existe

Eliminar usuario del grupo

DELETE /groups/{groupId}/users/{userId}

Respuesta exitosa

204 «Sin contenido»

Códigos de error específicos del punto final:

• group_not_found- no se puede eliminar el usuario del grupo porque el grupo no existe
• user_not_found- no puede eliminar el usuario del grupo porque el usuario no existe