 | TABLE DES MATIÈRES |
Catégories
Les « catégories » servent à diviser l'offre de formation des catalogues de votre environnement en sujets, et sont nommées « category » dans l'API. |  |
Category/get
 | Permet d'obtenir des informations sur une catégorie de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'une catégorie :
{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la catégorie. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une catégorie :
{
"id": "lp4DfdbpK095czV%2fCsyi1w%3d%3d",
"name": {
"texts": [
{
"text": "* Programmes de formation",
"languageId": 1
}
],
"ErrorID": 0
},
"color": "C41230",
"creationDate": "2019-07-09T13:33:11.51",
"createdByUserID": "hyKnH0JSL7De3ohq7FSvPg%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Identifiant unique de la catégorie. | |
| name - texts - text - languageId | Text : Titre de la catégorie. (Type string) languageId : Le titre peut être multilingue :
(Type Number) | |
| color | Code hexadécimal (sans #) représentant la couleur de la catégorie affichée au catalogue. | |
| creationDate | Date et heure de la création de la catégorie. (String YYYY-MM-DDTHH:MM:SSZ) | |
| createdByUserID | Identifiant unique de l'utilisateur ayant créé la catégorie. |
Category/getlist
 | Permet d'obtenir des informations sur une liste de catégories de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'une liste de catégorie :
{
"filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}Description des champs
Nom | Obligatoire | Commentaires/description |
| filterDate | Date de création de la catégorie. L'appel retournera toutes les catégories créées après ce moment. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une liste de catégories :
[
{
"id": "ruZdIJb9quVdLecBHCr3XQ%3d%3d",
"name": {
"texts": [
{
"text": "Typographie",
"languageId": 1
},
{
"languageId": 2
},
{
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"color": "005D63",
"creationDate": "2019-07-09T13:33:43.427",
"createdByUserID": "hyKnH0JSL7De3ohq7FSvPg%3d%3d"
},
{
"id": "zPX7k7Km0Do8l2VO6H0fHQ%3d%3d",
"name": {
"texts": [
{
"text": "Linguistique",
"languageId": 1
},
{
"languageId": 2
},
{
"languageId": 3
},
{
"languageId": 4
}
],
"ErrorID": 0
},
"color": "E0E622",
"creationDate": "2019-07-09T13:34:12.333",
"createdByUserID": "hyKnH0JSL7De3ohq7FSvPg%3d%3d"
}
]Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Identifiant unique de la catégorie. | |
| name - texts - text - languageId | Text : Titre de la catégorie. (Type string) languageId : Le titre peut être multilingue :
(Type Number) | |
| color | Code hexadécimal (sans #) représentant la couleur de la catégorie affichée au catalogue. | |
| creationDate | Date et heure de la création de la catégorie. (String YYYY-MM-DDTHH:MM:SSZ) | |
| createdByUserID | Identifiant unique de l'utilisateur ayant créé la catégorie. |
Category/create
 | Permet de créer une catégorie. |
Requête
Exemple de contenu d'appel de requête de création d'une catégorie :
{
"id": "lp4DfdbpK095czV%2fCsyi1w%3d%3d",
"name": {
"texts": [
{
"text": "Linguistique",
"languageId": 1
}
],
},
"color": "C41230",
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la catégorie. |
| name - texts - text - languageId | X | Text : Titre de la catégorie. (Type string) languageId : Le titre peut être multilingue :
(Type Number) |
| color | X | Code hexadécimal (sans #) représentant la couleur de la catégorie affichée au catalogue. |
Réponse
Exemple du contenu d'appel de réponse de requête de création d'une catégorie :
{
"id": "XWjS%2bHvCeZXlK7Tt7Lfoxg%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Identifiant unique de la catégorie. |
Category/edit
 | Permet de modifier une catégorie. |
Requête
Exemple de contenu d'appel de requête de modification d'une catégorie :
{
"id": "lp4DfdbpK095czV%2fCsyi1w%3d%3d",
"name": {
"texts": [
{
"text": "Linguistique",
"languageId": 1
}
],
},
"color": "C41230",
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la catégorie. |
| name - texts - text - languageId | X | Text : Titre de la catégorie. (Type string) languageId : Le titre peut être multilingue :
(Type Number) |
| color | Code hexadécimal (sans #) représentant la couleur de la catégorie affichée au catalogue. |
Réponse
Exemple du contenu d'appel de réponse de requête de modification d'une catégorie :
{
"id": "XWjS%2bHvCeZXlK7Tt7Lfoxg%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Identifiant unique de la catégorie. |
Category/delete
 | Permet de supprimer une catégorie. |
Requête
Exemple de contenu d'appel de requête de suppression d'une catégorie :
{
"id": "lp4DfdbpK095czV%2fCsyi1w%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la catégorie. |
Réponse
Exemple du contenu d'appel de réponse de requête de suppression d'une catégorie :
{
"id": "lp4DfdbpK095czV%2fCsyi1w%3d%3d"
}Description des champs
Nom | Obligatoire | Commentaires/description |
| id | Identifiant unique de la catégorie. |
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 | Required name | Vous devez fournir un nom pour la catégorie. |
804 | Invalid name length | Le nom fourni doit contenir entre 3 et 150 caractères inclusivement. |