Table des matières
CATALOGUES
Catalogues : catalog/get
Catalogues : catalog/getlist
Catalogues : catalog/create
Catalogues : catalog/edit
Catalogues : catalog/delete
Catalogues : catalog/adduser
Catalogues : catalog/removeuser
Catalogues : catalog/getuserlist
Catalogues : catalog/addbranch
Catalogues : catalog/removebranch
Catalogues : catalog/getbranchlist
Catalogues : catalog/addgroup
Catalogues : catalog/removegroup
Catalogues : catalog/getgrouplist
Catalogues : catalog/addworkspace
Catalogues : catalog/removeworkspace
Catalogues : catalog/getworkspacelist
Description des codes d’erreurs de catalogue
CATALOGUES
Catalogues : catalog/get
https://www.domaine.com/lmsapi/catalog/get
/catalog/get (request) - Requête d'un catalogue par identifiant
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}
/catalog/get (response) - Retourne un objet représentant 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"
}
Catalogues : catalog/getlist
https://www.domaine.com/lmsapi/catalog/getlist
/catalog/getlist (request) - Requête de la liste de l’ensemble des catalogues
{
"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)
/catalog/getlist (response) - Retourne une liste d'objets représentant chacun des catalogues
Catalogues : catalog/create
https://www.domaine.com/lmsapi/catalog/create
/catalog/create (request) - Requête de création d'un catalogue
{
"name": {
"texts": [{
"text": "test2",
"languageId": 1
}
]
}
}
/catalog/create (response) - Retourne l'identifiant du catalogue créé
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%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 catalogue (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 catalogue tel que vu par les utilisateurs dans le système. (Type string) languageId : Le nom peut être multilingue :
(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. |
Catalogues : catalog/edit
https://www.domaine.com/lmsapi/catalog/edit
/catalog/edit (request) - Requête de modification d’un catalogue
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d",
"name": {
"texts": [{
"text": "test3",
"languageId": 1
}
]
}
}
/catalog/edit (response) – Retourne un objet représentant le catalogue modifié
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}
Catalogues : catalog/delete
https://www.domaine.com/lmsapi/catalog/delete
/catalog/delete (request) - Requête de suppression d’un catalogue
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}
/catalog/delete (response) - Retourne l'identifiant du catalogue supprimé
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}
Catalogues : catalog/adduser
https://www.domaine.com/lmsapi/catalog/adduser
/catalog/adduser (request) - Requête d’ajout d’un utilisateur au catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}
/catalog/adduser (response) - Retourne l'identifiant du catalogue et de l’utilisateur ajouté
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}
Catalogues : catalog/removeuser
https://www.domaine.com/lmsapi/catalog/removeuser
/catalog/removeuser (resquest) – Retire un utilisateur du catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}
/catalog/removeuser (response) - Retourne l'identifiant du catalogue et de l’utilisateur retiré
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}
Catalogues : catalog/getuserlist
https://www.domaine.com/lmsapi/catalog/getuserlist
/catalog/getuserlist (request) - Requête de la liste des utilisateurs d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}
/catalog/getuserlist (response) - Retourne une liste d'objets d’identifiant de catalogue et utilisateur
Catalogues : catalog/addbranch
https://www.domaine.com/lmsapi/catalog/addbranch
/catalog/addbranch (resquest) - Requête d’ajout d’une branche au catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}
/catalog/addbranch (response) - Retourne l'identifiant du catalogue et de la branche ajoutée
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}
Catalogues : catalog/removebranch
https://www.domaine.com/lmsapi/catalog/removebranch
/catalog/removebranch (request) - Retire une branche d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}
/catalog/removebranch (response) - Retourne l'identifiant du catalogue et de la branche retirée
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}
Catalogues : catalog/getbranchlist
https://www.domaine.com/lmsapi/catalog/getbranchlist
/catalog/getbranchlist (request) - Requête de la liste des branches d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}
/catalog/getbranchlist (response) - Retourne une liste d'objets d’identifiant de catalogue et de branche
[{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
}, {
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}
]
Catalogues : catalog/addgroup
https://www.domaine.com/lmsapi/catalog/addgroup
/catalog/addgroup (request) - Requête d’ajout d’un groupe dans un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}
/catalog/addgroup (response) - Retourne l'identifiant du catalogue et du groupe ajouté
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}
Catalogues : catalog/removegroup
https://www.domaine.com/lmsapi/catalog/removegroup
/catalog/removegroup (request) – Retire un groupe d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}
/catalog/removegroup (response) - Retourne l'identifiant du catalogue et du groupe retiré
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}
Catalogues : catalog/getgrouplist
https://www.domaine.com/lmsapi/catalog/getgrouplist
/catalog/getgrouplist (request) - Requête de la liste des groupes d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}
/catalog/getgrouplist (response) - Retourne une liste d'objets d’identifiant de catalogue et de groupe
[{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "Ej1w%2flaWRrB8V5JBIxl7Cg%3d%3d"
}, {
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"groupId": "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
}
]
Catalogues : catalog/addworkspace
https://www.domaine.com/lmsapi/catalog/addworkspace
/catalog/addworkspace (request) - Requête d’ajout d’une formation ou événement au catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}
/catalog/addworkspace (response) - Retourne l'identifiant du catalogue et de la formation/événement ajouté
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}
Catalogues : catalog/removeworkspace
https://www.domaine.com/lmsapi/catalog/removeworkspace
/catalog/removeworkspace (request) – Retire une formation ou événement du catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}
/catalog/removeworkspace (response) - Retourne l'identifiant du catalogue et de la formation ou événement retiré
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}
Catalogues : catalog/getworkspacelist
https://www.domaine.com/lmsapi/catalog/getgrouplist
/catalog/getworkspacelist (request) - Requête de la liste des formations ou événements d’un catalogue
{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}
/catalog/getworkspacelist (response) - Retourne une liste d'objets d’identifiant de catalogue et de formation ou événement
[{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "BzEm1iKI2qP86aUK38RlVg%3d%3d"
}, {
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
"workspaceId": "eSLZD6T4RLI7xzud7a%2bhOA%3d%3d"
}
]
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. |