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

Catalogues (Lära)

Miro Lagueux
Modifié le : Jeu, 22 Févr., 2024 à 3:32 H

TABLE DES MATIÈRES
Catalog/get
Catalog/getlist
Catalog/create
Catalog/edit
Catalog/delete
Catalog/adduser
Catalog/removeuser
Catalog/getuserlist
Catalog/addbranch
Catalog/removebranch
Catalog/getbranchlist
Catalog/addgroup
Catalog/removegroup
Catalog/getgrouplist
Catalog/addworkspace
Catalog/removeworkspace
Catalog/getworkspacelist
Description des codes d’erreurs de catalogue

Catalogues

Les « catalogues » servent à présenter l'offre de formation de votre environnement à vos utilisateurs, et sont nommées « catalog » dans l'API.

Catalog/get

Permet d'obtenir des informations sur un catalogue de votre environnement.
Adresse de l'appel API : https://.../lmsapi/catalog/get

Requête

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

{"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête des informations d'un catalogue :

{  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d",  "name": {    "texts": [{        "text": "CATALOG-FR",        "languageId": 1      }, {        "text": "CATALOG-EN",        "languageId": 2      }, {        "text": "CATALOG-ES",        "languageId": 3      }    ]  },  "creationDate": "2017-11-30T10:52:24.34",  "createdByUserID": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"}
HTML

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

name
- texts
- text
- languageId

Text : Titre du catalogue.
(Type string)

languageId : Le titre peut être multilingue : 

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

(Type Number)

creationDate

Date et heure de la création du catalogue.

(String YYYY-MM-DDTHH:MM:SSZ)

createdByUserID

Identifiant unique de l'utilisateur ayant créé le catalogue.
(Type String)

Catalog/getlist

Permet d'obtenir des informations sur une liste des catalogue de votre environnement.
Adresse de l'appel API : https://.../lmsapi/catalog/getlist

Requête

Exemple de contenu d'appel de requête des informations d'une liste des catalogues :

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

Description des champs

Nom

Obligatoire

Commentaires/description

filterDateX

Date de création des catalogues. L'appel retourne la liste des objets qui ont été créés après la date passée comme filtre.
(String YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple du contenu d'appel de réponse de requête des informations d'une liste de catalogues :

[    {        "id": "n8%2fYjDQpXpCCzeBXIJuS7w%3d%3d",        "name": {            "texts": [                {                    "text": "Défaut",                    "languageId": 1                },                {                    "languageId": 2                },                {                    "languageId": 3                },                {                    "languageId": 4                }            ],            "ErrorID": 0        },        "creationDate": "2019-06-18T11:44:10.697",        "createdByUserID": "5EJOaP8xOZr0tq%2fLtdU3Og%3d%3d"    },    {        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",        "name": {            "texts": [                {                    "text": "Pilotage",                    "languageId": 1                },                {                    "languageId": 2                },                {                    "languageId": 3                },                {                    "languageId": 4                }            ],            "ErrorID": 0        },        "creationDate": "2022-09-26T14:36:25.427",        "createdByUserID": "hyKnH0JSL7De3ohq7FSvPg%3d%3d"    }}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

name
- texts
- text
- languageId

Text : Titre du catalogue.
(Type string)

languageId : Le titre peut être multilingue : 

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

(Type Number)

creationDate

Date et heure de la création du catalogue.

(String YYYY-MM-DDTHH:MM:SSZ)

createdByUserID

Identifiant unique de l'utilisateur ayant créé le catalogue.
(Type String)

Catalog/create

Permet de créer un catalogue.
Adresse de l'appel API : https://.../lmsapi/catalog/create

Requête

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

{  "name": {    "texts": [{        "text": "test2",        "languageId": 1      }    ]  }}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

name
- texts
- text
- languageId		X

Text : Titre du catalogue.
(Type string)

languageId : Le titre peut être multilingue : 

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

(Type Number)

Réponse

Exemple du contenu d'appel de réponse de requête de création d'un catalogue :

{  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue créé.
(Type String)

Catalog/edit

Permet de modifier un catalogue. Seuls les champs mis à jour seront modifiés.
Adresse de l'appel API : https://.../lmsapi/catalog/edit

Requête

Exemple de contenu d'appel de requête de modification d'un catalogue :

{  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"    "name": {    "texts": [{        "text": "Mon nouveau nom de catalogue",        "languageId": 1      }    ]  }}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue à modifier.
(Type String)

name
- texts
- text
- languageId

Text : Titre du catalogue.
(Type string)

languageId : Le titre peut être multilingue : 

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

(Type Number)

Réponse

Exemple du contenu d'appel de réponse de requête de modification d'un catalogue :

{  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue modifié.
(Type String)

Catalog/delete

Permet de supprimer un catalogue.
Adresse de l'appel API : https://.../lmsapi/catalog/delete

Requête

Exemple de contenu d'appel de requête de supression d'un catalogue :

{"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue à supprimer.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de suppression d'un catalogue :

{  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue supprimé.
(Type String)

Catalog/adduser

Permet d'assigner un catalogue à un utilisateur.
Adresse de l'appel API : https://.../lmsapi/catalog/adduser

Requête

Exemple de contenu d'appel de requête d'assignation d'un catalogue à un utilisateur :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

userIdXIdentifiant unique de l'utilisateur.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'assignation d'un catalogue à un utilisateur :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

userId
Identifiant unique de l'utilisateur.
(Type String)

Catalog/removeuser

Permet de retirer l'assignation d'un catalogue à un utilisateur.
Adresse de l'appel API : https://.../lmsapi/catalog/removeuser

Requête

Exemple de contenu d'appel de requête de retrait d'assignation d'un catalogue à un utilisateur :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

userIdXIdentifiant unique de l'utilisateur.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de retrait d'assignation d'un catalogue à un utilisateur :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

userId
Identifiant unique de l'utilisateur.
(Type String)

Catalog/getuserlist

Permet d'obtenir la liste des utilisateurs à qui un catalogue est associé.
Adresse de l'appel API : https://.../lmsapi/catalog/getuserlist

Requête

Exemple de contenu d'appel de requête de la liste des utilisateurs à qui un catalogue est associé :

{"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête la liste des utilisateurs à qui un catalogue est associé :

[    {        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",        "userId": "RrHd5EmYmSgXzC8AegdDeA%3d%3d"    },    {        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",        "userId": "3j5BmPY5d5FmUuFDrOo8Ug%3d%3d"    }[
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

userId
Identifiant unique de l'utilisateur.
(Type String)

Catalog/addbranch

Permet d'associer un catalogue aux utilisateurs d'une branche de l'organigramme.
Adresse de l'appel API : https://.../lmsapi/catalog/addbranch

Requête

Exemple de contenu d'appel de requête d'association d'un catalogue aux utilisateurs d'une branche :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

branchIdX

Identifiant unique de la branche.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'association d'un catalogue aux utilisateurs d'une branche :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

branchId
Identifiant unique de la branche.
(Type String)

Catalog/removebranch

Permet de dissocier un catalogue des utilisateurs d'une branche de l'organigramme.
Adresse de l'appel API : https://.../lmsapi/catalog/removebranch

Requête

Exemple de contenu d'appel de requête de désassociation d'un catalogue des utilisateurs d'une branche :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

branchIdX

Identifiant unique de la branche.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de désassociation d'un catalogue des utilisateurs d'une branche :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

branchId
Identifiant unique de la branche.
(Type String)

Catalog/getbranchlist

Permet une liste des branches de l'organigramme associées auxquelles un catalogue est associé.
Adresse de l'appel API : https://.../lmsapi/catalog/getbranchlist

Requête

Exemple de contenu d'appel de requête de la liste des branches d'utilisateurs auxquelles un catalogue est associé :

{     "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des branches d'utilisateurs auxquelles un catalogue est associé :

[  {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "branchId": "edFrrvGGeT9KI0783Dznkw%3d%3d"  },   {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"   }]
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

branchId
Identifiant unique de la branche.
(Type String)

Catalog/addgroup

Permet d'associer un catalogue aux utilisateurs d'un groupe d'utilisateurs de l'organigramme.
Adresse de l'appel API : https://.../lmsapi/catalog/addgroup

Requête

Exemple de contenu d'appel de requête d'association d'un catalogue aux utilisateurs d'un groupe :

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

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

groupIdX

Identifiant unique du groupe d'utilisateurs.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'association d'un catalogue aux utilisateurs d'un groupe :

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

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

groupId
Identifiant unique du groupe d'utilisateurs.
(Type String)

Catalog/removegroup

Permet de dissocier un catalogue des utilisateurs d'un groupe.
Adresse de l'appel API : https://.../lmsapi/catalog/removegroup

Requête

Exemple de contenu d'appel de requête de désassociation d'un catalogue des utilisateurs d'un groupe :

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

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

groupIdX

Identifiant unique du groupe.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de désassociation d'un catalogue des utilisateurs d'un groupe :

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

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

groupId
Identifiant unique du groupe.
(Type String)

Catalog/getgrouplist

Permet d'obtenir la liste des groupes d'utilisateurs auxquels un catalogue est associé.
Adresse de l'appel API : https://.../lmsapi/catalog/getgrouplist

Requête

Exemple de contenu d'appel de requête de la liste des groupes d'utilisateurs auxquels un catalogue est associé :

{     "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des groupes d'utilisateurs auxquels un catalogue est associé :

[  {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "groupId": "edFrrvGGeT9KI0783Dznkw%3d%3d"  },   {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"   }]
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

groupId
Identifiant unique du groupe.
(Type String)

Catalog/addworkspace

Permet d'associer une formation à un catalogue.
Adresse de l'appel API : https://.../lmsapi/catalog/addworkspace

Requête

Exemple de contenu d'appel de requête d'association d'une formation à un catalogue :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

workspaceIdX

Identifiant unique de la formation.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'association d'une formation à un catalogue :

{  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",  "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"}
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

workspacepId
Identifiant unique de la formation.
(Type String)

Catalog/removeworkspace

Permet de retirer une formation d'un catalogue.
Adresse de l'appel API : https://.../lmsapi/catalog/removeworkspace

Requête

Exemple de contenu d'appel de requête de retrait d'une formation d'un catalogue :

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

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

workspaceIdX

Identifiant unique de la formation.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de retrait d'une formation d'un catalogue :

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

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

workspaceId
Identifiant unique de la formation.
(Type String)

Catalog/getworkspacelist

Permet d'obtenir la liste des formation d'un catalogue.
Adresse de l'appel API : https://.../lmsapi/catalog/getworkspacelist

Requête

Exemple de contenu d'appel de requête de la liste des formations d'un catalogue :

{     "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"}
Generic

Description des champs

Nom

Obligatoire

Commentaires/description

idX

Identifiant unique du catalogue.
(Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des formations d'un catalogue :

[  {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "workspaceId": "edFrrvGGeT9KI0783Dznkw%3d%3d"  },   {    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",    "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"   }]
Generic

Description des champs

Nom 

Obligatoire

Commentaires/description

id


Identifiant unique du catalogue.
(Type String)

workspaceId
Identifiant unique de la formation.
(Type String)

Description des codes d’erreurs de catalogue

Numéro

Message

Commentaires/description

700

Required id

Vous devez fournir un identifiant pour le catalogue.

701

Invalid id

L’identifiant fourni pour le catalogue est invalide.

702

Required name

Vous devez fournir un nom pour le catalogue.

703

Invalid name length

Le nom fourni doit contenir entre 3 et 50 caractères inclusivement.

704

Branch already in catalog

La branche est déjà associée au catalogue.

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