Groupes (Lära et Via HTML)

Table des matières

GROUPES
    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

Groupes : group/get

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

/group/get (request)  - Requête d’une catégorie par identifiant

}
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" (Obligatoire)
}

/group/get (response) – Retourne le détail d’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

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.

Nom

Obligatoire

Commentaires/description

id

Identifiant unique du groupe(Type string) 

Ce paramètre doit être vide lorsque la méthode en mode création est utilisée, mais obligatoire pour appeler en mode édition.

name

      text

      languadeId

Text : Nom du groupe tel que vu par les utilisateurs dans le système. (Type string)

languageId : Le nom peut être multilingue : 

  • 1 = Français (Canada) 
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol

 (Type Number)

creationDate

 

Date de la création du groupe.

Ce champ est généré automatiquement à la création.

createdByUserID

 

Identifiant unique de l’utilisateur qui a créé le groupe.

Ce champ est généré automatique à la création.

Groupes : group/getlist

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

Retourne l’ensemble des groupes de votre portail

/group/getlist (request) - Requête de la liste des groupes de votre compte portail

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

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)

/group/getlist (response) - Retourne une liste d'objets groupes

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

Groupes : group/create

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

/group/create (request) - Requête de création d’un groupe

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

/group/create (response) - Retourne l'identifiant du groupe

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

Groupes : group/edit

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

/group/edit (request) - Requête d’édition d’un groupe

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

/group/edit (response) - Retourne l’identifiant du groupe modifié

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

Groupes : group/delete

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

/group/delete (request) - Requête de suppression d’un groupe

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

/group/delete (response) - Retourne l'identifiant du groupe supprimé

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

Groupes : group/adduser

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

/group/adduser (request) - Requête d’ajout d’un utilisateur à un groupe

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

}

/group/adduser (response) - Retourne l'identifiant de l’utilisateur ajouté

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

Groupes : group/removeuser

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

/group/removeuser (request) - Requête de suppression d’un utilisateur d’un groupe

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

/group/removeuser (response) - Retourne l'identifiant du groupe et de l’utilisateur supprimé

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

Groupes : group/getuserlist

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

/group/getuserlist (request) - Requête de la liste des utilisateurs associés à un groupe

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

/group/getuserlist (response) - Retourne une liste d'objets d’identifiant de groupe et utilisateur

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

Groupes : group/getgrouplist

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

/group/getgrouplist (request) - Requête de la liste des sous-groupes associés à un groupe

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

/group/getgrouplist (response) - Retourne une liste d'objets d’identifiant de sous-groupe et du groupe associé

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

Groupes : group/addgroup

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

/group/addgroup(resquest) - Requête d’ajout d’un sous-groupe au groupe

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

/group/addgroup (response) - Retourne l'identifiant du groupe et du sous-groupe ajouté

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

Groupes : group/removegroup

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

/group/removegroup (request) - Retire un sous-groupe d’un groupe

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

/group/removegroup (response) - Retourne l'identifiant du groupe et du sous-groupe retiré

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

Groupes : group/addbranch

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

/group/addbranch(resquest) - Requête d’ajout d’une branche au groupe

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

/group/addbranch (response) - Retourne l'identifiant du groupe et de la branche ajoutée

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

Groupes : group/removebranch

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

/group/removebranch (request) - Retire une branche d’un catalogue

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

/catalog/removebranch (response) - Retourne l'identifiant du catalogue et de la branche retirée

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

Groupes : group/getbranchlist

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

/group/getbranchlist (request) - Requête de la liste des branches associées à un groupe

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

/group/getbranchlist (response) - Retourne une liste d'objets d’identifiant de groupe et branche

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

Groupes : group/getuserlistrecursive

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

/group/getuserlistrecursive (request) - Requête de la liste des utilisateurs associés récursivement à un groupe

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

/group/getuserlistrecursive (response) - Retourne une liste d'objets d’identifiant de groupe et utilisateur

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

Groupes : group/getusergroups

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

/group/getusergroups (request) - Requête de la liste des groupes dans lesquels un utilisateur est associé

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

/group/getusergroups (response) - Retourne une liste d'objets d’identifiant d’utilisateur et de groupe

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

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
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.