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

De Logilys
Aller à : navigation, rechercher
(→‎Informations retournées)
 
(16 révisions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 
{{Entete_TOC}}<br>  
 
{{Entete_TOC}}<br>  
−
== Récupérer les données ==
+
== Informations envoyées ==
 
Retourne les informations nécessaire à l'affichage du widget.<br><br>DemAction : RESULT<br>DemCat : WIDGET<br>DemOptions :
 
Retourne les informations nécessaire à l'affichage du widget.<br><br>DemAction : RESULT<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]].
 
−
* LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
 
 
* WidgetCode : Code du widget. Récupérer à partir de [[Fonctions_communes:API_-_LIST_-_WIDGET|LIST / WIDGET]].
 
* WidgetCode : Code du widget. Récupérer à partir de [[Fonctions_communes:API_-_LIST_-_WIDGET|LIST / WIDGET]].
 
* Params : XML listant les valeurs pour les différents paramètres. Le XML devra être formaté comme ceci :
 
* Params : XML listant les valeurs pour les différents paramètres. Le XML devra être formaté comme ceci :
 
<pre>
 
<pre>
−
<Param Name="OcaUID" Value="18">
+
<Param Name="OcaUID" Value="18" />
−
<Param Name="MinDate" Value="2017-01-01">
+
<Param Name="MinDate" Value="2017-01-01" />
−
<Param Name="MaxDate" Value="2017-12-31">
+
<Param Name="MaxDate" Value="2017-12-31" />
 
</pre>
 
</pre>
−
<br>Informations retournées :
+
<br>
 +
 
 +
== Informations retournées ==
 +
Les informations retournées changeront d'un widget à l'autre. Voici un exemple pour le widget SOMTAC :
 
<pre>
 
<pre>
 
{   
 
{   
−
   "Widget":[   
+
   "Column":[
 +
    {
 +
      "FieldName":"Label",
 +
      "TypeID":"2",
 +
      "SubTypeID":"",
 +
      "DisplayLabel":"Libellé",
 +
      "DisplayFormat":""
 +
    },
 +
    {
 +
      "FieldName":"Value",
 +
      "TypeID":"1",
 +
      "SubTypeID":"1",
 +
      "DisplayLabel":"Qté",
 +
      "DisplayFormat":"FQ"
 +
    },
 +
    {
 +
      "FieldName":"Color",
 +
      "TypeID":"2",
 +
      "SubTypeID":"",
 +
      "DisplayLabel":"Couleur",
 +
      "DisplayFormat":""
 +
    }
 +
  ],
 +
  "Data":[ 
 +
    {  
 +
      "Label":"En retard",
 +
      "Value":"10",
 +
      "Color":"FF0000"
 +
    },
 +
    { 
 +
      "Label":"Dans les délais",
 +
      "Value":"20",
 +
      "Color":"FFFF00"
 +
    },
 
     {   
 
     {   
−
       "Params":"
+
       "Label":"En avance",
−
<Param Name="OcaUID" Label="Occasion(s)" TypeID="6" TypeDesc="Liste de cases à cocher" LookupKey="OcaUID" LookupDesc="OcaDesc">
+
      "Value":"30",
−
  <LookupItems>
+
      "Color":"00FF00"
−
    <Oca OcaUID="558" OcaDesc="Abonnement L'Oratoire 2009" />
+
     }
−
    <Oca OcaUID="498" OcaDesc="Bal masqué" />
+
  ],
−
     <Oca OcaUID="23" OcaDesc="Bourse" />
+
   Footer:[
−
    ...
+
    {
−
   </LookupItems>
+
      "RecordCount":"3",
−
</Param>
+
      "Value_Aggregate":"SUM",
−
<Param Name="MinDate" Label="Du" TypeID="3" TypeDesc="Date/Heure" SubTypeID="4" SubTypeDesc="Date" />
+
      "Value_Value":"60"
−
<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" />"
 
 
     }
 
     }
 
   ]
 
   ]
 
}
 
}
 
</pre>
 
</pre>
−
'''Widget''' :  
+
'''Column''' : Donne les informations sur les colonnes retournées par la paire Data.
−
* Params : XML contenant la liste des paramètres. Voici les informations sur le XML.
+
* FieldName : Nom de la paire
−
** Name : Nom du paramètre. Sera utilisé lors de la récupération des données du widget.
+
* TypeID : Numéro indiquant si la valeur est du texte, un nombre, une date, etc. (voir [[Fonctions_communes:API_-_CONFIG_-_WIDGET#TypeID|CONFIG / WIDGET]])
−
** Label : Libellé du paramètre.
+
* SubTypeID : Apporte une précision sur l'affichage pour les nombres et les dates. (voir [[Fonctions_communes:API_-_CONFIG_-_WIDGET#SubTypeID|CONFIG / WIDGET]])
−
** TypeID : Numéro du type de paramètre.
+
* DisplayLabel : Texte affiché pour ce champ
−
**# Numérique
+
* DisplayFormat : Format d'affichage de la date ou du nombre
−
**# Texte
+
'''Data''' : Informations propres au widget
−
**# Date/Heure
+
* Label : Statut de la tâche
−
**# Oui/Non
+
* Value : Nombre de tâches avec ce statut
−
**# Liste déroulante
+
* Color : Couleur pour le graphique
−
**# Liste de cases à cocher
+
'''Footer''' : Totaux
−
**# Texte long
+
* RecordCount : Nombre d'item dans Data.
−
** TypeDesc : Description textuel du type de paramètre.
+
* Value_Aggregate : Fonction d'aggrégat appliquée sur la colonne Value.
−
** SubTypeID : Numéro du sous-type de paramètre.
+
* Value_Value : Résultat de l'aggrégat pour la colonne Value.
−
**# 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 actuelle datée du 18 mars 2020 à 14:39

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.
  • 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 : 

{  
  "Column":[
    {
      "FieldName":"Label",
      "TypeID":"2",
      "SubTypeID":"",
      "DisplayLabel":"Libellé",
      "DisplayFormat":""
    },
    {
      "FieldName":"Value",
      "TypeID":"1",
      "SubTypeID":"1",
      "DisplayLabel":"Qté",
      "DisplayFormat":"FQ"
    },
    {
      "FieldName":"Color",
      "TypeID":"2",
      "SubTypeID":"",
      "DisplayLabel":"Couleur",
      "DisplayFormat":""
    }
  ],
  "Data":[  
    {  
      "Label":"En retard",
      "Value":"10",
      "Color":"FF0000"
    },
    {  
      "Label":"Dans les délais",
      "Value":"20",
      "Color":"FFFF00"
    },
    {  
      "Label":"En avance",
      "Value":"30",
      "Color":"00FF00"
    }
  ],
  Footer:[
    {
      "RecordCount":"3",
      "Value_Aggregate":"SUM",
      "Value_Value":"60"
    }
  ]
}

Column : Donne les informations sur les colonnes retournées par la paire Data.

  • FieldName : Nom de la paire
  • TypeID : Numéro indiquant si la valeur est du texte, un nombre, une date, etc. (voir CONFIG / WIDGET)
  • SubTypeID : Apporte une précision sur l'affichage pour les nombres et les dates. (voir CONFIG / WIDGET)
  • DisplayLabel : Texte affiché pour ce champ
  • DisplayFormat : Format d'affichage de la date ou du nombre

Data : Informations propres au widget

  • Label : Statut de la tâche
  • Value : Nombre de tâches avec ce statut
  • Color : Couleur pour le graphique

Footer : Totaux

  • RecordCount : Nombre d'item dans Data.
  • Value_Aggregate : Fonction d'aggrégat appliquée sur la colonne Value.
  • Value_Value : Résultat de l'aggrégat pour la colonne Value.



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=22415 »