Catégories (Lära)

Table des matières

CATÉGORIES
    Catégories  : category/get
    Catégories  : category/getlist
    Catégories  : category/create
    Catégories  : category/edit
    Catégories  : category/delete
    Description des codes d’erreurs de catégorie

CATÉGORIES

Catégories  : category/get

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

/category/get (request)  - Requête d’une catégorie par identifiant

}
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" (Obligatoire)
}

/category/get (response) – Retourne le détail d'une catégorie

{
"id": "vBW5xMw1VQ2A8DFaNy22zA",
"name": {
"texts": [{
"text": "MaCatégorie",
"languageId": 3
}
]
},

"color": "0EE000",
}

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 de la catégorie (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 de la catégorie tel que vu par les utilisateurs dans le système. (Type string)

languageId : Le nom peut être multilingue : 

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

 (Type Number)

color

Choix de couleur de la catégorie. (Type string)

Ce champ est obligatoire à la création.

Catégories  : category/getlist

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

Retourne l’ensemble des catégories de votre portail

/category/getlist (request) - Requête de la liste des catégories de votre compte portail

{
"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)

/category/getlist (response) - Retourne une liste d'objets catégories

Catégories  : category/create

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

/category/create (request) - Requête de création d'une catégorie

{
"name": {
"texts": [{
"text": "MaCatégorie",
"languageId": 3
}
]
},
"color" : "0EE000"
}

/category/create (response) - Retourne l'identifiant de la catégorie créée

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

Catégories  : category/edit

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

/category/edit (request) - Requête d’édition d'une catégorie

{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"name": {
"texts": [{
"text": "MaCatégorie",
"languageId": 1
}
]
},

"color": "0FF000"
}

/category/edit (response) - Retourne l’identifiant de la catégorie modifiée

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

Catégories  : category/delete

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

/category/delete (request) - Requête de suppression d'une catégorie

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

/category/delete (response) - Retourne l'identifiant de la catégorie supprimée

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

Description des codes d’erreurs de catégorie

Numéro

Message

Commentaires/description

800

Required id

Vous devez fournir un identifiant pour la catégorie.

801

Invalid id

L’identifiant fourni pour la catégorie est invalide.

802

Required color

Vous devez fournir une couleur pour la catégorie.

803

Invalid color length

La couleur fourni doit être de 6 caractères exactement.

804

Invalid color format

Le format de la couleur doit être 6 caractères de 0 à 9 ou de a à f.

805

Required name

Vous devez fournir un nom pour la catégorie.

806

Invalid name length

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

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.