Fonctions communes:API - LIST - WIDGET : Différence entre versions
Ligne 33 : | Ligne 33 : | ||
* Description : Description expliquant l'utilité du widget. | * Description : Description expliquant l'utilité du widget. | ||
* TypeID : | * TypeID : | ||
− | 1 | + | 1 = Thermomètre |
− | 2 | + | 2 = Sommaire |
− | 3 | + | 3 = Graphique en anneaux |
− | 4 | + | 4 = Graphique en secteurs |
− | 5 | + | 5 = Histogramme |
− | 6 | + | 6 = Graphique en courbes |
− | 7 | + | 7 = Graphique à barres |
− | 8 | + | 8 = Graphique en aires |
− | 9 | + | 9 = Nuage de points |
− | 10 | + | 10 = Page web |
− | 11 | + | 11 = Tableau |
* TypeDesc : Description textuel du type de widget. | * TypeDesc : Description textuel du type de widget. | ||
− | * Size : S = Petit | + | * Size : |
+ | S = Petit | ||
+ | M = Moyen | ||
+ | L = Grand | ||
+ | X = Très grand | ||
<br><br> | <br><br> | ||
{{BasPage_Fonctions_communes}} | {{BasPage_Fonctions_communes}} |
Version du 24 janvier 2018 à 10:35
API - LIST - WIDGET |
Sommaire
Afficher la liste des widgets
Retourne la liste des widgets incluant le nom, la description, le type et la dimension.
DemAction : LIST
DemCat : WIDGET
DemOptions :
- NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
- OrgUID : Numéro de l'organisme auquel l'utilisateur accède en ce moment. Retourné par le SELECT / LOGIN.
- LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
Informations retournées :
{ "Widget":[ { "Code":"SOMTAC", "Name":"Sommaire des tâches", "Description":"Affiche le nombre de tâches en retard, dans les délais et en avance.", "TypeID":"3", "TypeDesc":"Graphique en anneaux", "Size":"S" }, { "Code":"SOMCPG", "Name":"Thermomètre de campagne", "Description":"Affiche la progression d'une campagne en comparant les dons reçus et l'objectif.", "Type":"Thermomètre", "Size":"S" } ] }
Widget :
- Code : Code du widget. Nécessaire pour récupérer les paramètres et les données du widget.
- Name : Nom du widget.
- Description : Description expliquant l'utilité du widget.
- TypeID :
1 = Thermomètre 2 = Sommaire 3 = Graphique en anneaux 4 = Graphique en secteurs 5 = Histogramme 6 = Graphique en courbes 7 = Graphique à barres 8 = Graphique en aires 9 = Nuage de points 10 = Page web 11 = Tableau
- TypeDesc : Description textuel du type de widget.
- Size :
S = Petit M = Moyen L = Grand X = Très grand
Nom du document : Fonctions communes:API - LIST - WIDGET