Organigramme (Lära et Via HTML)

Table des matières

ORGANIGRAMME (BRANCH)
    Branch : branch/get
    Branch : branch/getlist
    Branch : branch/create
    Branch : branch/edit
    Branch : branch/delete
    Branch : branch/adduser
    Branch : branch/edituser
    Branch : branch/removeuser
    Branch : branch/getuserlist
    Description des codes d’erreurs de branche

ORGANIGRAMME (BRANCH)

Branch : branch/get

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

/branch/get (request) - Requête d’une branche par identifiant

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/branch/get (response) - Retourne un objet représentant une branche

{
"id" : “DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d”,
"parentId": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"name": {
"texts": [{
"text": "test2",
"languageId": 3
}
]
},
"creationDate": "2017-07-04T11:58:48.227",
"createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d"
}

Branch : branch/getlist

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

/branch/getlist (request) - Requête une liste de branches

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

Le paramètre de filtre par date est obligatoire 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)

/branch/getlist (response) - Retourne une liste d'objets représentant chacune des branches

(Manque CODE)

Branch : branch/create

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

/branch/create (request) – Crée une branche

{
"parentId": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"name": {
"texts": [{
"text": "test2",
"languageId": 3
}
]
}
}

/branch/create (response) - Retourne l’identifiant de la branche créée

{
"id": "9LB0KeSzFP7GNLmueeLHaA%3d%3d"
}

Branch : branch/edit

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

/branch/edit (request) – Modifie une branche

{
"id": "9LB0KeSzFP7GNLmueeLHaA%3d%3d",
"parentId": "BzEm1iKI2qP86aUK38RlVg%3d%3d",
"name": {
"texts": [{
"text": "test2",
"languageId": 3
}
]
}
}

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 de la branche sur laquelle faire une modification (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.

parentId

 

Identifiant unique de la branche parent (Type string) 

Si cette valeur est vide, la branche sera créée sous la branche racine. 

name

      text

      languadeId

 

Text : Nom de la branche tel que vu par les utilisateurs dans le système. (Type string <= 50 caractères)

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.

 /branch/edit (reponse) – Retourne l’identifiant de la branche modifiée

{
"id": "9LB0KeSzFP7GNLmueeLHaA%3d%3d"
}

Branch : branch/delete

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

/branch/delete (request) - Supprime une branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/branch/delete (response) - Retourne l'identifiant de la branche supprimée

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Branch : branch/adduser

https://www.domaine.com/lmsapi/branch/adduser

/branch/adduser (request) – Ajoute un utilisateur à une branche avec la permission donnée

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d",
"permissionId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

/branch/adduser (response) - Retourne un objet représentant un utilisateur d’une branche

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d",
"permissionId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}

Description des champs

Nom

Obligatoire

Commentaires/description

userId

Identifiant unique de l’utilisateur qu’on veut ajouter à une branche (Type string) 

branchId

Identifiant unique de la branche à laquelle on veut ajouter l’utilisateur (Type string) 

permissionId

Identifiant unique de la permission qu’on veut assigner à l’utilisateur qu’on veut ajouter à la branche. (Type string)

Branch : branch/edituser

https://www.domaine.com/lmsapi/branch/edituser

/branch/edituser (request) – Modifie la permission d’un utilisateur dans une branche

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d",
"permissionId": "ZP8QuKCp1lvGwyjiTn8SPw%3d%3d"
}

/branch/edituser (response) - Retourne un objet représentant un utilisateur d’une branche

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d",
"permissionId": "ZP8QuKCp1lvGwyjiTn8SPw%3d%3d"
}

Branch : branch/removeuser

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

/branch/removeuser (request) – Retire un utilisateur d’une branche

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

/branch/removeuser (response) - Retourne un objet représentant l’utilisateur retiré

{
"userId": "lszsxaexC98pYf0znnz0Ig%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Branch : branch/getuserlist

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

/branch/getuserlist (request) – Requête la liste des utilisateurs d’une branche

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/branch/getuserlist (response) - Retourne une liste d'objets représentant les utilisateurs d’une branche

[  {
"userId": "/UtsC30QAPbKKJCD7cUkJA==",
"permissionID": "BzEm1iKI2qP86aUK38RlVg==",
"branchID": "nWJ7HZLyI8l2otoNsxuXgA=="
}, {
"userId": "WuIhUdVX9u+fXyU3N4Zmzg==",
"permissionID": "BzEm1iKI2qP86aUK38RlVg==",
"branchID": "nWJ7HZLyI8l2otoNsxuXgA=="
}
]

Description des codes d’erreurs de branche

Numéro

Message

Commentaires/description

200

Required id

Vous devez fournir un identifiant pour la branche. 

201

Invalid id

L’identifiant fourni pour la branche est invalide.

202

Invalid parentId

L’identifiant fourni pour la branche parent est invalide.

203

Required name

Vous devez fournir un nom de branche.

204

Invalid name length

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

205

Required userId

Vous devez fournir un identifiant pour l’utilisateur.

206

Invalid userId

L’identifiant fourni pour l’utilisateur est invalide.

207

Required branchID

Vous devez fournir un identifiant pour la branche.

208

Invalid branchID

L’identifiant fourni pour la branche est invalide.

209

Required permissionID

Vous devez fournir un identifiant pour la permission.

210

Invalid permissionID

L’identifiant fourni pour la permission est invalide.

211

User already in branch

L’utilisateur que vous tentez d’ajouter à la branche en fait déjà parti.

212

Branch still linked

La branche ne peut pas être supprimée si elle a des sous-branches ou si elle est associée à un utilisateur, un portail ou un fournisseur.

213

User must be in at least one branch

L’utilisateur doit appartenir à au moins une branche.

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.