Méthode « GET /openapi/v1/groups »

19 avril 2024

ID 242751

Obtention d'une liste des groupes disponibles pour cette entreprise.

Demande

En-tête :

  • Autorisation : le jeton API de l'entreprise.

Réponse

  • total : un nombre – le nombre de groupes disponibles dans l'entreprise.
  • result : un tableau – un tableau d'objets contenant des données sur les groupes disponibles.
    • id : une chaîne – l'identifiant du groupe.
    • name : une chaîne – le nom du groupe.
    • isStarted : un booléen – indique si la formation a commencé dans le groupe.

Exemple de réponse :

{

    total: 1,

    result: [{

        id: '627d5c63f0672a10fbac23bb',

        name: 'Faible risque',

        isStarted: true

    }]

}

Erreurs possibles :

  • 401 : common-unauthorized – il y a eu une erreur d'authentification.
  • 404 : groups-not-found – aucun groupe associé à ce jeton n'a été trouvé pour l'entreprise.
  • 429 : too-many-requests – les demandes ont été trop nombreuses.
  • 500 : internal-server-error – une erreur de serveur interne s'est produite.

Cet article vous a-t-il été utile ?
Que pouvons-nous améliorer ?
Merci de nous faire part de vos commentaires. Vous nous aidez à nous améliorer.
Merci de nous faire part de vos commentaires. Vous nous aidez à nous améliorer.