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

Mise en vedette

Michael Leblanc
Modifié le : Mer, 26 Août, 2026 à 2:13 H

TABLE DES MATIÈRES

Mise en vedette : catalogspotlight/get
Mise en vedette : catalogspotlight/getlist
Mise en vedette : catalogspotlight/create
Mise en vedette : catalogspotlight/edit
Mise en vedette : catalogspotlight/delete
Mise en vedette : catalogspotlight/setworkspaceinstances
Mise en vedette : catalogspotlight/getworkspaceinstances
Mise en vedette : catalogspotlight/setcohorts
Mise en vedette : catalogspotlight/getcohorts
Description des codes d’erreurs de mise en vedette

Mise en vedette

Les « mises en vedette » permettent de mettre en avant des sessions de formation ou des cohortes de programme dans les catalogues, au moyen d'une pastille colorée portant un titre et un libellé. Une mise en vedette dans l'API est nommée « catalogspotlight ».

Mise en vedette : catalogspotlight/get

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

Retourne un objet représentant une mise en vedette de votre environnement.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/get

Requête

Exemple de contenu d'appel de requête des informations pour une mise en vedette :

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

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse des informations pour une mise en vedette :

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "title": {
        "texts": [
            {
                "text": "API_CS_TITLE",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "label": {
        "texts": [
            {
                "text": "API_LABEL",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "color": "F40000"
}

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)
titleTitre de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le titre tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 150 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
labelLibellé de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le libellé tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 12 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
colorCouleur de la pastille de mise en vedette.
(Type string)

Mise en vedette : catalogspotlight/getlist

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

Retourne la liste de l’ensemble des mises en vedette de votre environnement.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/getlist

Requête

Exemple de contenu d'appel de requête de la liste des mises en vedette :

Description des champs

Nom
Obligatoire
Commentaires/description
  La méthode ne requiert aucun paramètre.

Réponse

Exemple de contenu d'appel de réponse de la liste des mises en vedette :

[
    {
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "API_CS_TITLE",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "label": {
            "texts": [
                {
                    "text": "API_LABEL",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "color": "F40000"
    },
    {
        "id": "k0gEJ48oDezizeIqAsmhmQ%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "CatalogSpotlightTitle",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "label": {
            "texts": [
                {
                    "text": "CSLabel",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "color": "FFFFFF"
    }
]

Description des champs

Chaque élément de la liste contient les mêmes champs que ceux retournés par catalogspotlight/get :

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)
titleTitre de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le titre tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 150 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
labelLibellé de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le libellé tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 12 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
colorCouleur de la pastille de mise en vedette.
(Type string)

Mise en vedette : catalogspotlight/create

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

Permet de créer une mise en vedette dans votre environnement.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/create

Requête

Exemple de contenu d'appel de requête de création d'une mise en vedette :

{
    "title": {
        "texts": [{
                "text": "CatalogSpotlightTitle",
                "languageId": 1
            }
        ]
    },
    "label": {
        "texts": [{
                "text": "CSLabel",
                "languageId": 1
            }
        ]
    },
    "color": "FFFFFF"
}

Description des champs

Nom
Obligatoire
Commentaires/description
title
X
Titre de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le titre tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 150 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
label
X
Libellé de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le libellé tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 12 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
color Couleur de la pastille de mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de création d'une mise en vedette :

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

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette créée.
(Type string)



Mise en vedette : catalogspotlight/edit

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

Permet de modifier une mise en vedette existante.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/edit

Requête

Exemple de contenu d'appel de requête de modification d'une mise en vedette :

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "title": {
        "texts": [{
                "text": "titleCS",
                "languageId": 1
            }
        ]
    },
    "label": {
        "texts": [{
                "text": "labelCS",
                "languageId": 1
            }
        ]
    },
    "color": "123456"
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)
title Titre de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le titre tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 150 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
label Libellé de la mise en vedette, sous forme de textes multilingues (texts).
  • text : le libellé tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 12 caractères)
  • languageId : langue d'affichage.
  • 1 = Français (Canada)
  • 2 = Anglais
  • 3 = Français (France)
  • 4 = Espagnol
(Type Number)
color Couleur de la pastille de mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de modification d'une mise en vedette :

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

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette modifiée.
(Type string)


Mise en vedette : catalogspotlight/delete

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

Permet de supprimer une mise en vedette existante.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/delete

Requête

Exemple de contenu d'appel de requête de suppression d'une mise en vedette :

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

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de suppression d'une mise en vedette :

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

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette supprimée.
(Type string)


Mise en vedette : catalogspotlight/setworkspaceinstances

https://www.domaine.com/lmsapi/catalogspotlight/setworkspaceinstances

Permet d'associer des sessions de formation à une mise en vedette.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/setworkspaceinstances

Requête

Exemple de contenu d'appel de requête d'association de sessions à une mise en vedette :

{  
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "spotlightAssociations": 
        [
            {
                "id" : "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d",      
                "activeFromDate": "2010-01-01T00:00:00",
                "activeUpToDate": "2031-01-01T00:00:00"
            },
            {
                "id" : "1odV3GTk6pHhgLNDBK1bnQ%3d%3d"
            }                    
        ]     
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)
spotlightAssociations
X
Contient la liste des sessions qui seront associées à la mise en vedette.
  • id : identifiant unique de la session. (Type string)
  • activeFromDate : date de début de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)
  • activeUpToDate : date de fin de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple de contenu d'appel de réponse d'association de sessions à une mise en vedette :

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

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)

Mise en vedette : catalogspotlight/getworkspaceinstances

https://www.domaine.com/lmsapi/catalogspotlight/getworkspaceinstances

Retourne la liste des sessions de formation associées à une mise en vedette.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/getworkspaceinstances

Requête

Exemple de contenu d'appel de requête de la liste des sessions associées à une mise en vedette :

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

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des sessions associées à une mise en vedette :

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "spotlightAssociations": [
        {
            "id": "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d",
            "activeFromDate": "2010-01-01T00:00:00",
            "activeUpToDate": "2031-01-01T00:00:00"
        },
        {
            "id": "1odV3GTk6pHhgLNDBK1bnQ%3d%3d",
            "activeFromDate": "0001-01-01T00:00:00",
            "activeUpToDate": "0001-01-01T00:00:00"
        },
        {
            "id": "C81F0WSGq7p505Q97UjFlQ%3d%3d",
            "activeFromDate": "0001-01-01T00:00:00",
            "activeUpToDate": "0001-01-01T00:00:00"
        }
    ]
}

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)
spotlightAssociationsContient la liste des sessions qui seront associées à la mise en vedette.
  • id : identifiant unique de la session. (Type string)
  • activeFromDate : date de début de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)
  • activeUpToDate : date de fin de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)

Mise en vedette : catalogspotlight/setcohorts

https://www.domaine.com/lmsapi/catalogspotlight/setcohorts

Permet d'associer des cohortes de programme à une mise en vedette.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/setcohorts

Requête

Exemple de contenu d'appel de requête d'association de cohortes à une mise en vedette :

{  
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "spotlightAssociations": 
        [
            {
                "id" : "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
                "activeFromDate": "2010-01-01T00:00:00",
                "activeUpToDate": "2021-01-01T00:00:00"
            }                 
        ]     
}

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)
spotlightAssociations
X
Contient la liste des cohortes qui seront associées à la mise en vedette.
  • id : identifiant unique de la cohorte. (Type string)
  • activeFromDate : date de début de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)
  • activeUpToDate : date de fin de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple de contenu d'appel de réponse d'association de cohortes à une mise en vedette :

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

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)

Mise en vedette : catalogspotlight/getcohorts

https://www.domaine.com/lmsapi/catalogspotlight/getcohorts

Retourne la liste des cohortes de programme associées à une mise en vedette.
Adresse de l'appel API : https://.../lmsapi/catalogspotlight/getcohorts

Requête

Exemple de contenu d'appel de requête de la liste des cohortes associées à une mise en vedette :

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

Description des champs

Nom
Obligatoire
Commentaires/description
id
X
Identifiant unique de la mise en vedette.
(Type string)

Réponse

Exemple de contenu d'appel de réponse de la liste des cohortes associées à une mise en vedette :

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "spotlightAssociations": [
        {
            "id": "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
            "activeFromDate": "2010-01-01T00:00:00",
            "activeUpToDate": "2021-01-01T00:00:00"
        }
    ]
}

Description des champs

NomCommentaires/description
idIdentifiant unique de la mise en vedette.
(Type string)
spotlightAssociationsContient la liste des cohortes qui seront associées à la mise en vedette.
  • id : identifiant unique de la cohorte. (Type string)
  • activeFromDate : date de début de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)
  • activeUpToDate : date de fin de l'association. (Type date YYYY-MM-DDTHH:MM:SSZ)

Description des codes d’erreurs de mise en vedette

NuméroMessageCommentaire/description
2201RequiredIDVous devez fournir un identifiant pour le catalogspotlight
2202InvalidIDVous devez fournir un identifiant valide pour le catalogspotlight
2203RequiredTitleVous devez fournir un titre
2204InvalidTitleLengthLa longueur du titre fourni est invalide
2205RequiredLabelVous devez fournir un libellé
2206InvalidLabelLengthLa longueur du libellé fourni est invalide
2207RequiredSpotlightAssociationIDVous devez fournir un identifiant pour l'objet d'association
2208InvalidSpotlightAssociationIDL'identifiant fourni à l'objet d'association est invalide
2209InvalidSpotlightAssociationDataLes données contenues dans l'objet d'association sont invalides
2210InvalidActiveFromDate
La date de début d'association n'est pas valide
2211InvalidActiveUpToDateLa date de fin d'association n'est pas valide
2212InvalidLanguageIDL'identifiant de langue n'est pas valide
2213UndefinedLanguageIDL'identifiant de langue ne correspond à aucune langue
2214DeleteHasFailedLa suppression a échoué
2215AssociationHasFailedL'association a échoué




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