Fonctions communes:API - CONFIG - WIDGET

De Logilys
Révision datée du 15 mai 2019 à 13:23 par Stalbot (discussion | contributions) (→‎Informations retournées)
Aller à : navigation, rechercher
API - CONFIG - WIDGET

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="1" Name="OcaUID" Label="Occasion(s)" TypeID="6" TypeDesc="Liste de cases à cocher" LookupKey="OcaUID" LookupDesc="OcaDesc", Value="15">
  <LookupItems>
    <Oca OcaUID="558" OcaDesc="Abonnement L'Oratoire 2009" />
    <Oca OcaUID="498" OcaDesc="Bal masqué" />
    <Oca OcaUID="23" OcaDesc="Bourse" />
    ...
  </LookupItems>
</Param>
<Param ID="2" Name="MinDate" Label="Du" TypeID="3" TypeDesc="Date/Heure" SubTypeID="4" SubTypeDesc="Date" Prerequisite="OcaUID" />
<Param ID="3" Name="MaxDate" Label="au" TypeID="3" TypeDesc="Date/Heure" SubTypeID="4" SubTypeDesc="Date" Prerequisite="OcaUID" />
<Param ID="4" Name="WidgetName" Label="Nom du widget" TypeID="2" TypeDesc="Texte" />"
    }
  ]
}

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.
    • Value : Valeur du paramètre



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

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