Fonctions communes:API - LIST - WIDGET : Différence entre versions
Ligne 1 : | Ligne 1 : | ||
{{Entete_TOC}}<br> | {{Entete_TOC}}<br> | ||
− | == | + | == Informations envoyées == |
Retourne la liste des widgets incluant le nom, la description, le type et la dimension.<br><br>DemAction : LIST<br>DemCat : WIDGET<br>DemOptions : | Retourne la liste des widgets incluant le nom, la description, le type et la dimension.<br><br>DemAction : LIST<br>DemCat : WIDGET<br>DemOptions : | ||
* NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON. | * 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 [[Fonctions_communes:API_-_SELECT_-_LOGIN|SELECT / LOGIN]]. | * OrgUID : Numéro de l'organisme auquel l'utilisateur accède en ce moment. Retourné par le [[Fonctions_communes:API_-_SELECT_-_LOGIN|SELECT / LOGIN]]. | ||
* LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | * LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | ||
− | <br>Informations retournées | + | <br> |
+ | == Informations retournées == | ||
<pre> | <pre> | ||
{ | { |
Version du 24 janvier 2018 à 11:15
API - LIST - WIDGET |
Informations envoyées
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 : Numéro indiquant le type de widget.
- Thermomètre
- Sommaire
- Graphique en anneaux
- Graphique en secteurs
- Histogramme
- Graphique en courbes
- Graphique à barres
- Graphique en aires
- Nuage de points
- Page web
- 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