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

De Logilys
Aller à : navigation, rechercher
Ligne 14 : Ligne 14 :
 
<br>
 
<br>
 
== Informations retournées  ==
 
== Informations retournées  ==
 +
Les informations retournées changeront d'un widget à l'autre. Voici un exemple pour le widget SOMTAC :
 
<pre>
 
<pre>
 
{   
 
{   
 
   "Widget":[   
 
   "Widget":[   
 
     {   
 
     {   
−
       "Params":"
+
       "Red":"10",
−
<Param Name="OcaUID" Label="Occasion(s)" TypeID="6" TypeDesc="Liste de cases à cocher" LookupKey="OcaUID" LookupDesc="OcaDesc">
+
      "Yellow":"2",
−
  <LookupItems>
+
      "Green":"5"
−
    <Oca OcaUID="558" OcaDesc="Abonnement L'Oratoire 2009" />
 
−
    <Oca OcaUID="498" OcaDesc="Bal masqué" />
 
−
    <Oca OcaUID="23" OcaDesc="Bourse" />
 
−
    ...
 
−
  </LookupItems>
 
−
</Param>
 
−
<Param Name="MinDate" Label="Du" TypeID="3" TypeDesc="Date/Heure" SubTypeID="4" SubTypeDesc="Date" />
 
−
<Param Name="MaxDate" Label="au" TypeID="3" TypeDesc="Date/Heure" SubTypeID="4" SubTypeDesc="Date" />
 
−
<Param Name="WidgetName" Label="Nom du widget" TypeID="2" TypeDesc="Texte" />"
 
 
     }
 
     }
 
   ]
 
   ]
Ligne 35 : Ligne 27 :
 
</pre>
 
</pre>
 
'''Widget''' :  
 
'''Widget''' :  
−
* Params : XML contenant la liste des paramètres. Voici les informations sur le XML.
+
* Red : Nombre de tâches en retard.
−
** Name : Nom du paramètre. Sera utilisé lors de la récupération des données du widget.
+
* Yellow : Nombre de tâches dans les délais.
−
** Label : Libellé du paramètre.
+
* Green : Nombre de tâches en avance.
−
** TypeID : Numéro du type de paramètre.
 
−
**# Numérique
 
−
**# Texte
 
−
**# Date/Heure
 
−
**# Oui/Non
 
−
**# Liste déroulante
 
−
**# Liste de cases à cocher
 
−
**# Texte long
 
−
** TypeDesc : Description textuel du type de paramètre.
 
−
** SubTypeID : Numéro du sous-type de paramètre.
 
−
**# Quantité (Numérique)
 
−
**# Monétaire (Numérique)
 
−
**# Pourcentage (Numérique)
 
−
**# Date (Date/Heure)
 
−
**# Date et heure (Date/Heure)
 
−
**# Heure (Date/Heure)
 
−
**# Case à cocher (Oui/Non)
 
−
**# Liste déroulante (Oui/Non)
 
−
** SubTypeDesc : Description textuel du sous-type de paramètre.
 
−
** LookupKey : Si le TypeID contient 5 (Liste déroulante) ou 6 (Liste de cases à cocher), représente le nom de l'attribut devant être utilisé comme valeur parmi les sous-noeuds de LookupItems.
 
−
** LookupDesc : Si le TypeID contient 5 (Liste déroulante) ou 6 (Liste de cases à cocher), représente le nom de l'attribut devant être utilisé pour l'affichage parmi les sous-noeuds de LookupItems.
 
−
** LookupItems : Contient la liste des items devant servir à remplir la liste déroulante ou la liste de cases à cocher.
 
 
<br><br>
 
<br><br>
 
{{BasPage_Fonctions_communes}}
 
{{BasPage_Fonctions_communes}}

Version du 24 janvier 2018 à 10:12

API - RESULT - WIDGET

Informations envoyées

Retourne les informations nécessaire à l'affichage du widget.

DemAction : RESULT
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)
  • WidgetCode : Code du widget. Récupérer à partir de LIST / WIDGET.
  • Params : XML listant les valeurs pour les différents paramètres. Le XML devra être formaté comme ceci :
<Param Name="OcaUID" Value="18">
<Param Name="MinDate" Value="2017-01-01">
<Param Name="MaxDate" Value="2017-12-31">


Informations retournées

Les informations retournées changeront d'un widget à l'autre. Voici un exemple pour le widget SOMTAC : 

{  
  "Widget":[  
    {  
      "Red":"10",
      "Yellow":"2",
      "Green":"5"
    }
  ]
}

Widget :

  • Red : Nombre de tâches en retard.
  • Yellow : Nombre de tâches dans les délais.
  • Green : Nombre de tâches en avance.



Nom du document : Fonctions communes:API - RESULT - WIDGET

Récupérée de « http://wikifr.logilys.com/index.php?title=Fonctions_communes:API_-_RESULT_-_WIDGET&oldid=17973 »