Browse Articles

Browse Articles

Reach 360: API de grupos

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este punto final de API

Con la API de grupos, puede crear o eliminar un grupo y actualizar su nombre. Los administradores ven estos cambios reflejados en la pestaña Personas. También se utiliza este punto final para recuperar una lista de grupos o los detalles de un grupo específico.

Puntos finales

  • POST /groups- crear un grupo nuevo
  • GET /groups- enumerar grupos
  • GET /groups/{groupId}- obtener detalles de un grupo por identificador de grupo
  • PUT /groups/{groupId}- actualizar un grupo por identificador de grupo
  • DELETE /groups/{groupId}- eliminar un grupo por identificador de grupo

Objeto de grupo

  • id(cadena): el identificador único del grupo
  • membersUrl(cadena): URL para enumerar los miembros del grupo desde la API
  • reportersUrl(string): URL para incluir a los reporteros del grupo desde la API
  • managersUrl(string): URL para enumerar los administradores del grupo desde la API
  • name(cadena): el nombre del grupo
  • url(cadena): URL para obtener los detalles del grupo desde la API

Crear grupo

POST /groups

Parámetros de solicitud (JSON)

  • name(cadena, obligatorio): el nombre del grupo

Ejemplo de respuesta

{
«id»: «example-group-id», 
 «membersURL»: "https://api.reach360.com/groups/example-group-id/users «, «reportersURL»: "https://api.reach360.com/groups/example-group-id/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id/managers 
 «, «name»: «Ejemplo de grupo», 
 «url»: "https://api.reach360.com/groups/example-group-id"}

Códigos de error específicos de Endpoint

  • code: 'duplicate_name'- no se puede crear un grupo porque ya existe un grupo con lo especificado name

Listar grupos

GET /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)
  • name(cadena, opcional): devuelve grupos con el nombre especificado.

Ejemplo de respuesta

{
«groups»: [
{
«id»: «example-group-id-1", 
 «membersURL»: "https://api.reach360.com/groups/example-group-id/users «, «reportersURL»: "https://api.reach360.com/groups/example-group-id-1/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id-1/managers «, 
 «name»: «Ejemplo de grupo» «url»: "https://api.reach60.com/groups/example-group-id-1"},
... 
 
 
], «nextURL»: "https://url-for-next-page-of-results"}

Recuperar el grupo por ID

GET /groups/{groupId}

Ejemplo de respuesta

{
«id»: «example-group-id», 
 «membersURL»: "https://api.reach360.com/groups/example-group-id/users «, «reportersURL»: "https://api.reach360.com/groups/example-group-id/reporters 
 «, «managersURL»: "https://api.reach360.com/groups/example-group-id/managers 
 «, «name»: «Ejemplo de grupo» «url»: "https://api.reach360.com/groups/example-group-id"}

Códigos de error específicos de Endpoint

  • group_not_found- no se puede recuperar el grupo porque el grupo no existe

Actualizar el grupo por ID

PUT /groups/{groupId}

Parámetros de solicitud (JSON)

  • name(cadena, obligatorio): el nombre del grupo

Respuesta de éxito

204 «Sin contenido»

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

  • group_not_found- no se puede actualizar el grupo porque el grupo no existe
  • read_only_group- no puede realizar cambios en el grupo especificado (ejemplo: no puede modificar el grupo «Todos»)

Eliminar grupo por ID

DELETE /groups/{groupId}

Respuesta de éxito

204 «Sin contenido»

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

  • group_not_found- no se puede eliminar el grupo porque el grupo no existe
  • read_only_group- no se puede eliminar el grupo especificado (ejemplo: no se puede modificar el grupo «Todos»)