Fonctions communes:API - LIST - WIDGET : Différence entre versions

De Logilys
Aller à : navigation, rechercher
(Page créée avec « {{Entete_TOC}}<br> == LIST : WIDGET == <br><br> {{BasPage_Fonctions_communes}} »)
 
Ligne 1 : Ligne 1 :
 
{{Entete_TOC}}<br>  
 
{{Entete_TOC}}<br>  
  
== LIST : WIDGET  ==
+
== Afficher la liste des widgets  ==
 
+
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.
 +
* 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)
 +
<br>Informations retournées :
 +
<pre>
 +
 +
  "Widget":[ 
 +
    { 
 +
      "Code":"SOMTAC",
 +
      "Name":"Sommaire des tâches",
 +
      "Description":"Affiche le nombre de tâches en retard, dans les délais et en avance.",
 +
      "Type":"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"
 +
    }
 +
  ]
 +
}
 +
</pre>
 +
'''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.
 +
* Type : Description textuel du type de widget.
 +
* 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:23

API - LIST - WIDGET


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.",
      "Type":"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.
  • Type : 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