Soumettre un ticket Mes tickets
Bienvenue
Connexion  S'inscrire
a
  1. Mon Assistance SVIeSolutions
  2. Accueil des solutions
  3. Guides API
  4. Lära LMS et Via HTML

Groupes (Lära et Via HTML)

Miro Lagueux
Modifié le : Mer, 26 Août, 2026 à 1:35 H

TABLE DES MATIÈRES

Groupes : group/get
Groupes : group/getlist
Groupes : group/create
Groupes : group/edit
Groupes : group/delete
Groupes : group/adduser
Groupes : group/removeuser
Groupes : group/getuserlist
Groupes : group/getgrouplist
Groupes : group/addgroup
Groupes : group/removegroup
Groupes : group/addbranch
Groupes : group/removebranch
Groupes : group/getbranchlist
Groupes : group/getuserlistrecursive
Groupes : group/getusergroups
Description des codes d’erreurs de groupe

GROUPES

Les « groupes » permettent de regrouper des utilisateurs, des sous-groupes et des branches afin de faciliter la gestion des accès et des inscriptions de votre environnement. Un groupe dans l'API est nommé « group ».

Groupes : group/get

https://www.domaine.com/lmsapi/group/get

Retourne l’ensemble des informations relatives à un groupe de votre environnement.
Adresse de l'appel API : https://.../lmsapi/group/get

Requête

Exemple de contenu d'appel de requête des informations pour un groupe :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse des informations pour un groupe :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA",
  "name": {
    "texts": [{
        "text": "Mon groupe",
        "languageId": 1
      }
    ]
  },
  "creationDate": "2018-02-08T15:02:45.73",
  "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
nameNom du groupe tel que vu par les utilisateurs dans le système, sous forme de textes multilingues (texts).
  • text : nom du groupe affiché pour la langue précisée. (Type string)
  • languageId : langue d'affichage.
    • 1 = Français (Canada)
    • 2 = Anglais
    • 3 = Français (France)
    • 4 = Espagnol
  • (Type Number)
creationDateDate de la création du groupe.
Ce champ est généré automatiquement à la création.
createdByUserIDIdentifiant unique de l’utilisateur qui a créé le groupe.
Ce champ est généré automatiquement à la création.

ATTENTION : En modification, les méthodes nécessitent uniquement la valeur « id » comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.

Groupes : group/getlist

https://www.domaine.com/lmsapi/group/getlist

Retourne la liste de l’ensemble des groupes de votre portail.
Adresse de l'appel API : https://.../lmsapi/group/getlist

Retourne l’ensemble des groupes de votre portail

Requête

Exemple de contenu d'appel de requête de la liste des groupes :

{
  "filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}

Description des champs

Nom
Obligatoire
Commentaires/description
filterDate Paramètre optionnel correspondant à la date de création de l’élément. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre.
Type : String (YYYY-MM-DDTHH:MM:SSZ)

Réponse

ATTENTION : Le paramètre de filtre par date est optionnel et correspond à la date de création de l’élément. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre. 

(Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)

Exemple de contenu d'appel de réponse de la liste des groupes :

[
    {
    "id": "vBW5xMw1VQ2A8DFaNy22zA",
    "name": {
      "texts": [{
          "text": "Mon groupe",
          "languageId": 1
        }
      ]
    },
    "creationDate": "2018-02-08T15:02:45.73",
    "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d"
    }
  ]

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
nameNom du groupe tel que vu par les utilisateurs dans le système, sous forme de textes multilingues (texts).
  • text : nom du groupe affiché pour la langue précisée. (Type string)
  • languageId : langue d'affichage.
    • 1 = Français (Canada)
    • 2 = Anglais
    • 3 = Français (France)
    • 4 = Espagnol
  • (Type Number)
creationDateDate de la création du groupe.
Ce champ est généré automatiquement à la création.
createdByUserIDIdentifiant unique de l’utilisateur qui a créé le groupe.
Ce champ est généré automatiquement à la création.

Groupes : group/create

https://www.domaine.com/lmsapi/group/create

Permet de créer un groupe dans votre environnement.
Adresse de l'appel API : https://.../lmsapi/group/create

Requête

Exemple de contenu d'appel de requête de création d'un groupe :

{
  "name": {
    "texts": [{
        "text": "Nouveau groupe",
        "languageId": 1
      }]
  }
}

Description des champs

Nom
Obligatoire
Commentaires/description
name
X
Nom du groupe tel que vu par les utilisateurs dans le système, sous forme de textes multilingues (texts).
  • text : nom du groupe affiché pour la langue précisée. (Type string)
  • languageId : langue d'affichage.
    • 1 = Français (Canada)
    • 2 = Anglais
    • 3 = Français (France)
    • 4 = Espagnol
  • (Type Number)

Réponse

Exemple de contenu d'appel de réponse de création d'un groupe :

{
  "id": "%2fq%2bUa3gORVJDR8DdOZ2CYA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe créé.
(Type string)

Groupes : group/edit

https://www.domaine.com/lmsapi/group/edit

Permet de modifier un groupe existant.
Adresse de l'appel API : https://.../lmsapi/group/edit

Requête

Exemple de contenu d'appel de requête d'édition d'un groupe :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA",
  "name": {
    "texts": [{
        "text": "Mon groupe",
        "languageId": 1
      }
    ]
  }
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
name Nom du groupe tel que vu par les utilisateurs dans le système, sous forme de textes multilingues (texts).
  • text : nom du groupe affiché pour la langue précisée. (Type string)
  • languageId : langue d'affichage.
    • 1 = Français (Canada)
    • 2 = Anglais
    • 3 = Français (France)
    • 4 = Espagnol
  • (Type Number)

Réponse

Exemple de contenu d'appel de réponse d'édition d'un groupe :

{
  "id": "%2fq%2bUa3gORVJDR8DdOZ2CYA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe modifié.
(Type string)

Groupes : group/delete

https://www.domaine.com/lmsapi/group/delete

Permet de supprimer un groupe existant.
Adresse de l'appel API : https://.../lmsapi/group/delete

Requête

Exemple de contenu d'appel de requête de suppression d'un groupe :

{
  "id": "%2fq%2bUa3gORVJDR8DdOZ2CYA%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de suppression d'un groupe :

{
  "id": "%2fq%2bUa3gORVJDR8DdOZ2CYA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe supprimé.
(Type string)

Groupes : group/adduser

https://www.domaine.com/lmsapi/group/AddUser

Permet d'ajouter un utilisateur à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/adduser

Requête

Exemple de contenu d'appel de requête d'ajout d'un utilisateur à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "userId": "4zwet3FOX5xXfHX7YFuR8w%3d%3d"

}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
userId
X
Identifiant unique de l’utilisateur.
(Type string)

Réponse

Exemple de contenu d'appel de réponse d'ajout d'un utilisateur à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "userId": "4zwet3FOX5xXfHX7YFuR8w%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
userIdIdentifiant unique de l’utilisateur.
(Type string)

Groupes : group/removeuser

https://www.domaine.com/lmsapi/group/removeuser

Permet de retirer un utilisateur d'un groupe.
Adresse de l'appel API : https://.../lmsapi/group/removeuser

Requête

Exemple de contenu d'appel de requête de suppression d'un utilisateur d'un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "userId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
userId
X
Identifiant unique de l’utilisateur.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de suppression d'un utilisateur d'un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
"userId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
userIdIdentifiant unique de l’utilisateur.
(Type string)

Groupes : group/getuserlist

https://www.domaine.com/lmsapi/group/getuserlist

Retourne la liste des utilisateurs associés à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/getuserlist

Requête

Exemple de contenu d'appel de requête de la liste des utilisateurs associés à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des utilisateurs associés à un groupe :

[  {
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "userId":"4QQXEdQX%2b7gBIY5XZnf8wA%3d%3d"
  }, 
{
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "userId":"pzyzfI5r15GwFhURAZB8pQ%3d%3d"
  }
]

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
userIdIdentifiant unique de l’utilisateur.
(Type string)

Groupes : group/getgrouplist

https://www.domaine.com/lmsapi/group/getgrouplist

Retourne la liste des sous-groupes associés à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/getgrouplist

Requête

Exemple de contenu d'appel de requête de la liste des sous-groupes associés à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des sous-groupes associés à un groupe :

[  {
    "id":"tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId":"4QQXEdQX%2b7gBIY5XZnf8wA%3d%3d"
  },
{
    "id":"tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId":"pzyzfI5r15GwFhURAZB8pQ%3d%3d"
  }
]

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
groupIdIdentifiant unique du sous-groupe.
(Type string)

Groupes : group/addgroup

https://www.domaine.com/lmsapi/group/addgroup

Permet d'ajouter un sous-groupe à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/addgroup

Requête

Exemple de contenu d'appel de requête d'ajout d'un sous-groupe à un groupe :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
groupId
X
Identifiant unique du sous-groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse d'ajout d'un sous-groupe à un groupe :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
groupIdIdentifiant unique du sous-groupe.
(Type string)

Groupes : group/removegroup

https://www.domaine.com/lmsapi/group/removegroup

Permet de retirer un sous-groupe d'un groupe.
Adresse de l'appel API : https://.../lmsapi/group/removegroup

Requête

Exemple de contenu d'appel de requête de retrait d'un sous-groupe d'un groupe :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
groupId
X
Identifiant unique du sous-groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de retrait d'un sous-groupe d'un groupe :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
groupIdIdentifiant unique du sous-groupe.
(Type string)

Groupes : group/addbranch

https://www.domaine.com/lmsapi/group/AddBranch

Permet d'ajouter une branche à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/addbranch

Requête

Exemple de contenu d'appel de requête d'ajout d'une branche à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
branchId
X
Identifiant unique de la branche.
(Type string)

Réponse

Exemple de contenu d'appel de réponse d'ajout d'une branche à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
branchIdIdentifiant unique de la branche.
(Type string)

Groupes : group/removebranch

https://www.domaine.com/lmsapi/group/removebranch

Permet de retirer une branche d'un groupe.
Adresse de l'appel API : https://.../lmsapi/group/removebranch

Requête

Exemple de contenu d'appel de requête de retrait d'une branche d'un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)
branchId
X
Identifiant unique de la branche.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de retrait d'une branche d'un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
branchIdIdentifiant unique de la branche.
(Type string)

Groupes : group/getbranchlist

https://www.domaine.com/lmsapi/group/getbranchlist

Retourne la liste des branches associées à un groupe.
Adresse de l'appel API : https://.../lmsapi/group/getbranchlist

Requête

Exemple de contenu d'appel de requête de la liste des branches associées à un groupe :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des branches associées à un groupe :

[  
{
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "branchId":"9LB0KeSzFP7GNLmueeLHaA%3d%3d"
  }, 
{
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "branchId":"nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
  }
]

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
branchIdIdentifiant unique de la branche.
(Type string)

Groupes : group/getuserlistrecursive

https://www.domaine.com/lmsapi/group/getuserlistrecursive

Retourne la liste des utilisateurs associés récursivement à un groupe, incluant ceux de ses sous-groupes.
Adresse de l'appel API : https://.../lmsapi/group/getuserlistrecursive

Requête

Exemple de contenu d'appel de requête de la liste des utilisateurs associés récursivement à un groupe :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique du groupe.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des utilisateurs associés récursivement à un groupe :

[  {
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "userId":"4QQXEdQX%2b7gBIY5XZnf8wA%3d%3d"
  }, 
{
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "userId":"pzyzfI5r15GwFhURAZB8pQ%3d%3d"
  }
]

Description des champs

NomCommentaires/description
idIdentifiant unique du groupe.
(Type string)
userIdIdentifiant unique de l’utilisateur.
(Type string)

Groupes : group/getusergroups

https://www.domaine.com/lmsapi/group/getusergroups

Retourne la liste des groupes auxquels un utilisateur est associé.
Adresse de l'appel API : https://.../lmsapi/group/getusergroups

Requête

Exemple de contenu d'appel de requête de la liste des groupes d'un utilisateur :

{
  "id": "DTUvbcrKNN3szXg6aQY%2fSg%3d%3d" 
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de l’utilisateur.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des groupes d'un utilisateur :

[  {
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "groupId":"4QQXEdQX%2b7gBIY5XZnf8wA%3d%3d"
  }, 
{
    "id":"DTUvbcrKNN3szXg6aQY%2fSg%3d%3d",
    "groupId":"pzyzfI5r15GwFhURAZB8pQ%3d%3d"
  }
]

Description des champs

NomCommentaires/description
userIdIdentifiant unique de l’utilisateur.
(Type string)
groupIdIdentifiant unique du sous-groupe.
(Type string)

Description des codes d’erreurs de groupe

Numéro

Message

Commentaires/description

900

Required id

Vous devez fournir un identifiant pour le groupe.

901

Invalid id

L’identifiant fourni pour le groupe est invalide.

902

Required name

Vous devez fournir un nom pour le groupe.

903

Invalid name length

Le nom fourni doit contenir de 3 à 50 caractères inclusivement.

904

Group already associated

Vous ne pouvez pas ajouter un groupeX dans un groupeY si le groupeY fait partie du GroupeX.

905

User already in group

L’utilisateur que vous tentez d’ajouter au groupe en fait déjà parti.

906

User not in group

L’utilisateur que vous tentez de retirer du groupe n’en fait pas parti.

907

Branch already in group

La branche que vous tentez d’ajouter au groupe en fait déjà parti.

908

Branch not in group

La branche que vous tentez de retirer du groupe n’en fait pas parti.

909

Group already in group

Le groupe que vous tentez d’ajouter au groupe en fait déjà parti.

910

Group not in group

Le groupe que vous tentez de retirer du groupe n’en fait pas parti.

911

Required user id

Vous devez fournir un identifiant pour l’utilisateur

912

Invalid user id

L’identifiant fourni pour l’utilisateur est invalide.

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Désolés de n'avoir pu vous être utile. Aidez-nous à améliorer cet article en nous faisant part de vos commentaires.

Related Articles