Browse Articles

Browse Articles

Reach 360 : API pour les groupes

Dernière mise à jour de l’article le

Cet article s'applique à :

Reach 360

Ce que fait ce point de terminaison d'API

L'API Groupes vous permet de créer ou de supprimer un groupe et de mettre à jour son nom. Les administrateurs voient ces modifications se refléter dans l'onglet Personnes. Vous utilisez également ce point de terminaison pour récupérer la liste des groupes ou les détails d'un groupe spécifique.

Points de terminaison

  • POST /groups- créer un nouveau groupe
  • GET /groups- groupes de listes
  • GET /groups/{groupId}- obtenir les détails d'un groupe par identifiant de groupe
  • PUT /groups/{groupId}- met à jour un groupe par identifiant de groupe
  • DELETE /groups/{groupId}- supprimer un groupe par identifiant de groupe

Objet de groupe

  • id(chaîne) - l'identifiant unique du groupe
  • membersUrl(string) - URL pour répertorier les membres du groupe à partir de l'API
  • name(chaîne) - le nom du groupe
  • url(string) - URL pour récupérer les détails du groupe depuis l'API

Créer un groupe

POST /groups

Paramètres de demande (JSON)

  • name(chaîne, obligatoire) - le nom du groupe

Exemple de réponse

{
« id » : « example-group-id »,
 « MembersURL » : "https://api.reach360.com/groups/example-group-id/users «,
 « name » : « Exemple de groupe »,
 « url » : "https://api.reach360.com/groups/example-group-id"
}

Codes d'erreur spécifiques aux terminaux

  • code: 'duplicate_name'- impossible de créer un groupe car un groupe avec le nom spécifié existename déjà

Lister les groupes

GET /groups

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 100 (50 par défaut)
  • name(chaîne, facultatif) - Renvoie les groupes portant le nom spécifié.

Exemple de réponse

{
« groupes » : [
{
« id » : « example-group-id-1",
 « MembersURL » : "https://api.reach360.com/groups/example-group-id/users «,
 « name » : « Exemple de groupe »
 « url » : "https://api.reach60.com/groups/example-group-id-1"
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Récupérer un groupe par identifiant

GET /groups/{groupId}

Exemple de réponse

{
« id » : « example-group-id »,
 « MembersURL » : "https://api.reach360.com/groups/example-group-id/users «,
 « name » : « Exemple de groupe »
 « url » : "https://api.reach360.com/groups/example-group-id"
}

Codes d'erreur spécifiques aux terminaux

  • group_not_found- Impossible de récupérer le groupe car le groupe n'existe pas

Mettre à jour le groupe par ID

PUT /groups/{groupId}

Paramètres de demande (JSON)

  • name(chaîne, obligatoire) - le nom du groupe

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au terminal :

  • group_not_found- Impossible de mettre à jour le groupe car le groupe n'existe pas
  • read_only_group- impossible de modifier le groupe spécifié (Exemple : vous ne pouvez pas modifier le groupe « Tout le monde »)

Supprimer le groupe par identifiant

DELETE /groups/{groupId}

Réponse réussie

204 « Aucun contenu »

Codes d'erreur spécifiques au terminal :

  • group_not_found- Impossible de supprimer le groupe car le groupe n'existe pas
  • read_only_group- impossible de supprimer le groupe spécifié (Exemple : vous ne pouvez pas modifier le groupe « Tout le monde »)