Fonctions communes:API - CONFIG - WIDGET

API - CONFIG - WIDGET

Version imprimable

---

Informations envoyées

Retourne la liste des paramètres pour un widget.

DemAction : CONFIG
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 : Valeur des paramètres connus. Si des paramètres sont requis pour d'autres paramètres, CONFIG / WIDGET devra être appelé à répétition en passant à chaque fois la valeur de chaque paramètre documenté.

 Ex : <Param Name="GridCode" Value="CLI" />
      <Param Name="FilterUID" Value="" />

Informations retournées

{  
  "Widget":[  
    {  
      "Params":"
<Param ID="-2" Name="GridCode" Label="Emplacement" TypeID="5" TypeDesc="Liste déroulante" LookupKey="GridCode" LookupDesc="GridDesc" Value="CLI">
  <LookupItems>
    <Item GridCode="ADRESSE" GridDesc="Gestion des clients - Onglet « Clients/Adresses »"/>
    <Item GridCode="CLI" GridDesc="Gestion des clients - Onglet « Clients »"/>
    <Item GridCode="TAC" GridDesc="Gestion des tâches"/>
  </LookupItems>
</Param>
<Param ID="-3" Name="PushButtons" Label="Filtres rapides" TypeID="8" TypeDesc="Boutons de filtre rapide (PushButtons)" LookupKey="Name" LookupDesc="Label" Prerequisite="GridCode">
  <LookupItems>
    <Item Name="pbActif" Label="Actif" GroupIndex="1" ButtonIndex="1" AllowMultiSelect="1" AllowAllUp="1"/>
    <Item Name="pbInactif" Label="Inactif" GroupIndex="1" ButtonIndex="2" AllowMultiSelect="1" AllowAllUp="1"/>
  </LookupItems>
</Param>
<Param ID="-4" Name="Filter" Label="Filtre sauvegardé" TypeID="5" TypeDesc="Liste déroulante" LookupKey="FilterUID" LookupDesc="FilterName" Prerequisite="GridCode">
  <LookupItems>
    <Item FilterUID="372" FilterName="Clients anglophones" FilterDesc="[«Id Langue» est égal à "1"]"/>
    <Item FilterUID="376" FilterName="Clients francophones" FilterDesc="[«Id Langue» est égal à "0"]"/>
  </LookupItems>
</Param>
<Param ID="-5" Name="CrAnaUID" Label="Grille d'analyse" TypeID="5" TypeDesc="Liste déroulante" LookupKey="ID" LookupDesc="Name" Prerequisite="GridCode" Value="15">
  <LookupItems>
    <Item ID="15" Name="Âge min. et max. par région et genre" DynamicColumns="1"/>
    <Item ID="1" Name="Nombre de clients par ville" DynamicColumns="0"/>
  </LookupItems>
</Param>
<Param ID="-6" Name="GridOrChart" Label="Affichage" TypeID="5" TypeDesc="Liste déroulante" LookupKey="Code" LookupDesc="Desc" Prerequisite="CrAnaUID">
  <LookupItems>
    <Item Code="GRID" Desc="Grille"/>
  </LookupItems>
</Param>
<Param ID="-7" Name="Aggregate" Label="Calcul" TypeID="5" TypeDesc="Liste déroulante" LookupKey="ID" LookupDesc="Name" Prerequisite="CrAnaUID">
  <LookupItems>
    <Item CrAnaDetUID="16" CrAnaDetFieldLabel="MIN"/>
    <Item CrAnaDetUID="17" CrAnaDetFieldLabel="MAX"/>
  </LookupItems>
</Param>
    }
  ]
}

Widget :

• Params : XML contenant la liste des paramètres. Voici les informations sur le XML.
  • ID : ID unique du paramètre
  • Name : Nom du paramètre. Sera utilisé lors de la récupération des données du widget.
  • Label : Libellé du paramètre.
  • TypeID : Numéro du type de paramètre.
    1. Numérique
    2. Texte
    3. Date/Heure
    4. Oui/Non
    5. Liste déroulante
    6. Liste de cases à cocher
    7. Texte long
    8. Boutons de filtres rapides (PushButtons)
  • TypeDesc : Description textuel du type de paramètre.
  • SubTypeID : Numéro du sous-type de paramètre.
    1. Quantité (Numérique)
    2. Monétaire (Numérique)
    3. Pourcentage (Numérique)
    4. Date (Date/Heure)
    5. Date et heure (Date/Heure)
    6. Heure (Date/Heure)
    7. Case à cocher (Oui/Non)
    8. 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.
  • Prerequisite : Nom des paramètres prérequis avant d'afficher ce paramètre. Si plus d'un paramètre sont prérequis, leurs noms seront séparés par une virgule.
  • Value : Valeur du paramètre

---

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

Version imprimable