Mise en vedette

Créé par Michael Leblanc, Modifié le Mer, 6 Avr., 2022 à 10:29 H par Jasmin Giroux

Table des matières
Mise en vedette
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

Mise en vedette

Mise en vedette : catalogspotlight/get

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

/catalogspotlight/get (request) - Requête d'une mise en vedette par identifiant

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

/catalogspotlight /get (response) - Retourne un objet représentant 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"
}

Mise en vedette : catalogspotlight/getlist

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

/catalogspotlight/getlist (request) - Requête de la liste de l'ensemble des CatalogSpotlights

Ne requiert pas de paramètres.

/catalogspotlight/getlist (response) - Retourne une liste d'objets représentant l'ensemble des CatalogSpotlights

[
    {
        "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"
    }
]

Mise en vedette : catalogspotlight/create

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

/catalogspotlight/create (request) - Requête de création d'un catalogspotlight

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

/catalogspotlight/create (response) - Retourne l'ID du catalogspotlight

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique du catalogspotlight (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
title text languageId		Text : le titre du catalogspotlight tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 150 caractères) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
label text languageId		Text : le libellé du catalogspotlight tel que vu par les utilisateurs dans le système. (Type string, entre 3 et 12 caractères) languageId : Le nom peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
color		Couleur de la pastille de mise en vedette (Type string)

Mise en vedette : catalogspotlight/edit

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

/catalogspotlight/edit (request) - Requête de modification d’un catalogspotlight

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

/catalogspotlight/edit (response) - Retourne l'identifiant du catalogspotlight

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

Mise en vedette : catalogspotlight/delete

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

/catalogspotlight/delete (request) - Requête de suppression d’un catalogspotlight

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

/catalogspotlight/delete (response) - Retourne l'identifiant du catalogspotlight

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

Mise en vedette : catalogspotlight/setworkspaceinstances

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

/catalogspotlight/setworkspaceinstances (request) - Requête d’association de sessions à un catalogspotlight

{  
        "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"
            }                    
        ]     
}

/catalogspotlight/setworkspaceinstances (response) - Retourne l'identifiant du catalogspotlight

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique du catalogspotlight (Type string)
spotlightAssociations id activeFromDate activeUpToDate		Contient la liste des sessions qui seront associées au catalogspotlight id : Identifiant unique de la session (Type string) activeFromDate : Date de début de l'association (Type string) activeUpToDate : Date de fin de l'association (Type string)

Mise en vedette : catalogspotlight/getworkspaceinstances

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

/catalogspotlight/getworkspaceinstances (request) - Requête de la liste des sessions associées à un catalogspotlight

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

/catalogspotlight/getworkspaceinstancesusers (response) - Retourne une liste d'objets contenant l'identifiant des sessions d'un catalogspotlight

{
    "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"
        }
    ]
}

Mise en vedette : catalogspotlight/setcohorts

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

/catalogspotlight/setcohorts (request) - Requête d’association de cohortes à un catalogspotlight

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

/catalogspotlight/setcohorts (response) - Retourne l'identifiant du catalogspotlight

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique du catalogspotlight (Type string)
spotlightAssociations id activeFromDate activeUpToDate		Contient la liste des cohortes qui seront associées au catalogspotlight id : Identifiant unique de la session (Type string) activeFromDate : Date de début de l'association (Type string) activeUpToDate : Date de fin de l'association (Type string)

Mise en vedette : catalogspotlight/getcohorts

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

/catalogspotlight/getcohorts (request) - Requête de la liste des sessions associées à un catalogspotlight

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

/catalogspotlight/getcohorts (response) - Retourne une liste d'objets contenant l'identifiant des cohortes associées au catalogspotlight

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

Description des codes d’erreurs des "Mise en vedette

Numéro	Message	Commentaire/description
2201	RequiredID	Vous devez fournir un identifiant pour le catalogspotlight
2202	InvalidID	Vous devez fournir un identifiant valide pour le catalogspotlight
2203	RequiredTitle	Vous devez fournir un titre
2204	InvalidTitleLength	La longueur du titre fourni est invalide
2205	RequiredLabel	Vous devez fournir un libellé
2206	InvalidLabelLength	La longueur du libellé fourni est invalide
2207	RequiredSpotlightAssociationID	Vous devez fournir un identifiant pour l'objet d'association
2208	InvalidSpotlightAssociationID	L'identifiant fourni à l'objet d'association est invalide
2209	InvalidSpotlightAssociationData	Les données contenues dans l'objet d'association sont invalides
2210	InvalidActiveFromDate	La date de début d'association n'est pas valide
2211	InvalidActiveUpToDate	La date de fin d'association n'est pas valide
2212	InvalidLanguageID	L'identifiant de langue n'est pas valide
2213	UndefinedLanguageID	L'identifiant de langue ne correspond à aucune langue
2214	DeleteHasFailed	La suppression a échouée
2215	AssociationHasFailed	L'association a échouée