Browse Articles

Browse Articles

Reach 360: API de membresías grupales

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este terminal de API

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

También puedes 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

  • GET /groups/{groupId}/users- enumera 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 pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«users»: [
{
«id»: «example-user-id-1",
 «email»: "foo@example.com «,
 «groupsURL»: «< https://api.reach360.com/users/example-user-id-1/groups >»,
 «role»: «alumno»,
 «Nombre»: «Nombre de ejemplo 1",
 «apellido de ejemplo 1", «LastActiveAT»:
 «2021-10-28T 20:39:52 .659Z»,
 «learnerReportl»: «» < https://api.reach360.com/reports/learners/example-user-id-1 >, «url»:
 «< https://api.reach360.com/users/example-user-id-1 >»
 «Articulate360User»: falso 
},... 
],
 «URL siguiente»: «< https://url-for-next-page-of-results >»
}

Códigos de error específicos de endpoints:

  • 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 pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 100 (el valor predeterminado es 50)

Ejemplo de respuesta

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

Códigos de error específicos de endpoints:

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

Agregar usuario al grupo

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

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints:

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

Eliminar usuario del grupo

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

Respuesta de éxito

204 «Sin contenido»

Códigos de error específicos de endpoints:

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