Organigramme (Lära et Via HTML)

Miro Lagueux

Modifié le : Mer, 13 Sept., 2023 à 10:54 H

TABLE DES MATIÈRES
Branch/get
Branch/getlist
Branch/create
Branch/edit
Branch/delete
Branch/adduser
Branch/addusers
Branch/edituser
Branch/removeuser
Branch/getuserlist
Description des codes d’erreurs de branche

Branches

Les « branches de l'organigramme » servent à isoler les utilisateurs dans leur contexte avec un profil de droits spécifique à ce contexte. Une branche dans l'API est nommée « branch », et un profil de droits est nommé « permission ».

Branch/get

Retourne l’ensemble des informations relatives à une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/get

Requête

Exemple de contenu d'appel de requête des informations pour une branche :

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

Description des champs

Nom	Obligatoire	Commentaire/description
id	X	Identifiant unique de la branche de l'organigramme. (Type string)

Réponse

Exemple d'un contenu d'appel de réponse des informations pour une branche de l'organigramme :

{
    "id": "SvnzGVvIvvzqXXlxA30Xtg%3d%3d",
    "parentId": "61%2bwMxJmDOvWFQrEjS4p4g%3d%3d",
    "name": {
        "texts": [
            {
                "text": "Public",
                "languageId": 2
            }
        ],
        "ErrorID": 0
    },
    "creationDate": "2021-11-08T08:40:50.23",
    "createdByUserID": "U0mBRsCQcngrir2ZUs6%2bhw%3d%3d",
    "organizationalUnitId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la branche de l'organigramme ciblée.
parentId		Identifiant unique de la branche parente, ou « supérieure ».
name		Nom de la branche affiché aux administrateurs. texts: nom de la branche affiché aux administrateurs pour chaque langue. text : nom languageId : langue d'affichage. 1 = Français (Canada) 2 = Anglais 3 = Espagnol 4 = Allemand ErrorId :
creationDate		Date de la création de la branche. Ce champ est généré automatiquement à la création.
createdByUserID		Identifiant unique de l’utilisateur qui a créé la branche. Ce champ est généré automatique à la création.
organizationalUnitId		Identifiant unique de l'unité organisationnelle.

Branch/getlist

Retourne l’ensemble des informations relatives aux branches de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/getlist

Requête

Exemple de contenu d'appel de requête des informations relatives aux branches de l'organigramme de votre environnement :

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

Description des champs

Nom	Obligatoire	Commentaire/description
filterDate		La méthode retourne la liste des branches qui ont été créés après la date passée comme filtre. (Type String, YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple d'un contenu d'appel de réponse des informations relatives aux branches de l'organigramme de votre environnement :

[    {        "id": "HAwToYn4CzS208NIAwBVEQ%3d%3d",        "name": {            "texts": [                {                    "text": "Administration",                    "languageId": 1                },                {                    "text": "Administration",                    "languageId": 2                },                {                    "languageId": 3                },                {                    "languageId": 4                }            ],            "ErrorID": 0        },        "creationDate": "2021-10-07T14:05:55.177",        "createdByUserID": "xuoXIHCPJSCLJu0bIleTlg%3d%3d"    },    {        "id": "z483Dd2vcBB98EfY%2fovklA%3d%3d",        "parentId": "KCnXY9Tmr7Edkyn5EHvobQ%3d%3d",        "name": {            "texts": [                {                    "text": "Public",                    "languageId": 1                },                {                    "text": "Public",                    "languageId": 2                },                {                    "languageId": 3                },                {                    "languageId": 4                }            ],            "ErrorID": 0        },        "creationDate": "2022-05-18T08:18:10.297",        "createdByUserID": "npx3BF6FKYVE4SX0Ltve2Q%3d%3d"    }]

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la branche de l'organigramme.
parentId		Identifiant unique de la branche parente, ou « supérieure ».
name		Nom de la branche affiché aux administrateurs : texts: nom de la branche. languageId : Le nom de la branche peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol ErrorId :
creationDate		Date de la création de la branche. Ce champ est généré automatiquement à la création.
createdByUserID		Identifiant unique de l’utilisateur qui a créé la branche. Ce champ est généré automatique à la création.
organizationalUnitId		Identifiant unique de l'unité organisationnelle.

Branch/create

Permet de créer une branche sur l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/create

Requête

Exemple de contenu d'appel de requête de création d'une branche sur l'organigramme de votre environnement :

{  "parentId": "HAwToYn4CzS208NIAwBVEQ%3d%3d",  "name": {            "texts": [                {                    "text": "Public",                    "languageId": 1                },                {                    "text": "Public",                    "languageId": 2                },                {                    "text": "público",                    "languageId": 3                }    ]  },  "organisationalUnitId" : "7IoopVM73nHZMhUaQ3JvWw%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
parentId		Identifiant unique de la branche parente, ou « supérieure ». Si aucune valeur n'est fournie, la branche sera créée sous la branche racine, soit la branche par défaut de l'organigramme. (Type String)
name		Nom de la branche affiché aux administrateurs : texts: nom de la branche. languageId : Le nom de la branche peut être multilingue. (Type Number) 1 = Français (Canada) 2 = Anglais 3 = Espagnol
creationDate		Date de la création de la branche. Ce champ est généré automatiquement à la création.
createdByUserID		Identifiant unique de l’utilisateur qui a créé la branche. Ce champ est généré automatique à la création.
organizationalUnitId		Identifiant unique de l'unité organisationnelle.

Réponse

Exemple d'un contenu d'appel de réponse de création d'une branche sur l'organigramme de votre environnement. Le système retourne l'identifiant de la branche créée :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de la branche de l'organigramme créée.

Branch/edit

Permet de modifier une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/edit

Requête

Exemple de contenu d'appel de requête de modification d'une branche de l'organigramme de votre environnement :

{  "id": "uoGcjyx1IWiArobopJMBlg%3d%3d",  "parentId": "HAwToYn4CzS208NIAwBVEQ%3d%3d",  "name": {            "texts": [                {                    "text": "Public",                    "languageId": 1                },                {                    "text": "Public",                    "languageId": 2                },                {                    "text": "público",                    "languageId": 3                }    ]  }}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la branche à modifier. Les autres champs sont facultatifs et sont mis à jour si une nouvelle valeur est spécifiée. (Type String)
parentId		Identifiant unique de la branche parente, ou « supérieure ». Si aucune valeur n'est fournie, la branche demeurera au même endroit. (Type String)
name		Nom de la branche affiché aux administrateurs : texts: nom de la branche. languageId : Le nom de la branche peut être multilingue. (Type Number) 1 = Français (Canada) 2 = Anglais 3 = Espagnol
organizationalUnitId		Identifiant unique de l'unité organisationnelle.

Réponse

Exemple d'un contenu d'appel de réponse de modification d'une branche de l'organigramme de votre environnement. Le système retourne l'identifiant de la branche modifiée :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de la branche de l'organigramme modifiée.

Branch/delete

Permet de supprimer une branche l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/delete

Requête

Exemple de contenu d'appel de requête de suppression d'une branche de l'organigramme de votre environnement :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la branche à supprimer. (Type String)

Réponse

Exemple d'un contenu d'appel de réponse de suppression d'une branche de l'organigramme de votre environnement. Le système retourne l'identifiant de la branche supprimée :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de la branche de l'organigramme supprimée.

Branch/adduser

Permet d'ajouter un utilisateur avec un profil de droits sur une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/adduser

Requête

Exemple de contenu d'appel d'ajout d'un utilisateur sur une branche de l'organigramme de votre environnement :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId	X	Identifiant unique de l'utilisateur à ajouter à la branche spécifiée. (Type String)
branchId	X	Identifiant unique de la branche sur laquelle ajouter l'utilisateur avec le profil de droits spécifié. (Type String)
permissionId	X	Identifiant unique du profil de droits à octroyer à l'utilisateur sur la branche spécifiée. (Type String)

Réponse

Exemple d'un contenu d'appel d'ajout d'un utilisateur sur une branche de l'organigramme de votre environnement. Le système retourne les informations relative à l'opération :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId		Identifiant unique de l'utilisateur ajouté à la branche spécifiée.
branchId		Identifiant unique de la branche sur laquelle a été ajouté l'utilisateur avec le profil de droits spécifié.
permissionId		Identifiant unique du profil de droits octroyé à l'utilisateur sur la branche spécifiée.

Branch/addusers

Permet d'ajouter plusieurs utilisateurs sur une branche l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/addusers

Requête

Exemple de contenu d'appel d'ajout d'utilisateurs sur une branche de l'organigramme de votre environnement :

{  "id": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",  "users" : [        "2Peiqp5iO09nXXnwfjGPxA%3d%3d",        "fAb4yjum64Tv74bQ4%2bGeGg%3d%3d"    ]}

Description des champs

Nom	Obligatoire	Commentaires/description
Id	X	Identifiant unique de la branche sur laquelle déposer les utilisateurs. (Type String)
users	X	users : liste des identifiants uniques des utilisateurs à ajouter sur la branche spécifié. (Type String)

Réponse

Exemple d'un contenu d'appel d'ajout d'utilisateurs sur une branche de l'organigramme de votre environnement. Le système retourne les informations relative à l'opération :

{  "id": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",  "users" : [        "2Peiqp5iO09nXXnwfjGPxA%3d%3d",        "fAb4yjum64Tv74bQ4%2bGeGg%3d%3d"    ]}

Description des champs

Nom	Obligatoire	Commentaires/description
Id		Identifiant unique de la branche sur laquelle déposer les utilisateurs.
users		users : liste des identifiants uniques des utilisateurs à ajouter sur la branche spécifié.

Branch/edituser

Permet de modifier le profil de droit d'un utilisateur sur une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/edituser

Requête

Exemple de contenu d'appel de modification du profil de droits d'un utilisateur sur une branche de l'organigramme de votre environnement :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId	X	Identifiant unique de l'utilisateur dont le profil de droit est à modifier sur la branche spécifiée. (Type String)
branchId	X	Identifiant unique de la branche sur laquelle modifier le profil de droits de l'utilisateur spécifié. (Type String)
permissionId	X	Identifiant unique du profil de droits à octroyer à l'utilisateur sur la branche spécifiée. (Type String)

Réponse

Exemple d'un contenu d'appel de modification du profil de droits d'un utilisateur sur une branche de l'organigramme de votre environnement. Le système retourne les informations relative à l'opération :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId		Identifiant unique de l'utilisateur dont le profil de droit est à modifier sur la branche spécifiée.
branchId		Identifiant unique de la branche sur laquelle modifier le profil de droits de l'utilisateur spécifié.
permissionId		Identifiant unique du profil de droits à octroyer à l'utilisateur sur la branche spécifiée.

Branch/removeuser

Permet de retirer un utilisateur d'une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/removeuser

Requête

Exemple de contenu d'appel de retrait d'un utilisateur d'une branche de l'organigramme de votre environnement :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId	X	Identifiant unique de l'utilisateur à retirer de la branche spécifiée. (Type String)
branchId	X	Identifiant unique de la branche de laquelle retirer l'utilisateur spécifié. (Type String)

Réponse

Exemple d'un contenu d'appel de retrait d'un utilisateur d'une branche de l'organigramme de votre environnement. Le système retourne les informations relative à l'opération :

{    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",    "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
userId		Identifiant unique de l'utilisateur retiré de la branche spécifiée.
branchId		Identifiant unique de la branche de laquelle l'utilisateur spécifié a été retiré.

Branch/getuserlist

Permet de consulter une liste des utilisateur associés à une branche de l'organigramme de votre environnement.
Adresse de l'appel API : https://.../lmsapi/branch/getuserlist

Requête

Exemple de contenu d'appel de requête de liste d'utilisateur d'une branche de l'organigramme de votre environnement :

{    "Id":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"}

Description des champs

Nom	Obligatoire	Commentaires/description
Id	X	Identifiant unique de la branche. (Type String)

Réponse

Exemple d'un contenu d'appel de réponse de liste d'utilisateur d'une branche de l'organigramme de votre environnement. Le système retourne les informations relative à l'opération :

[    {        "userId": "fAb4yjum64Tv74bQ4+GeGg==",        "permissionID": "pJlqyk0x52S/5ZZGxAITFw==",        "branchID": "5vZqv7xWJ1HQb84/hKf0Tg=="    },    {        "userId": "2Peiqp5iO09nXXnwfjGPxA==",        "permissionID": "pJlqyk0x52S/5ZZGxAITFw==",        "branchID": "5vZqv7xWJ1HQb84/hKf0Tg=="    }]

Description des champs

Nom	Obligatoire	Commentaires/description
userId		Identifiant unique de l'utilisateur.
branchId		Identifiant unique de la branche.
permissionId		Identifiant unique du profil de droits de l'utilisateur sur la branche spécifiée.

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 à 250 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.
214	Required users	Vous devez fournir une liste d'utilisateurs.
215	Invalid organizationalUnitId	L’identifiant fourni pour l'unité organisationnelle parent est invalide
216	This action cannot be done because the organizational unit has purchases	Vous ne pouvez modifier l'unité organisationelle d'une branche si elle a des achats d'effectué

French

Branches

Branch/get

Requête

Description des champs

Réponse

Description des champs

Branch/getlist

Requête

Description des champs

Réponse

Description des champs

Branch/create

Requête

Description des champs

Réponse

Description des champs

Branch/edit

Requête

Description des champs

Réponse

Description des champs

Branch/delete

Requête

Description des champs

Réponse

Description des champs

Branch/adduser

Requête

Description des champs

Réponse

Description des champs

Branch/addusers

Requête

Description des champs

Réponse

Description des champs

Branch/edituser

Requête

Description des champs

Réponse

Description des champs

Branch/removeuser

Requête

Description des champs

Réponse

Description des champs

Branch/getuserlist

Requête

Description des champs

Réponse

Description des champs

Description des codes d’erreurs de branche

Related Articles