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

De Logilys
Aller à : navigation, rechercher
(Page créée avec « == Afficher la liste des widgets == Retourne la liste des paramètres pour un widget.<br><br>DemAction : CONFIG<br>DemCat : WIDGET<br>DemOptions : * NomSession : Même no... »)
 
Ligne 31 : Ligne 31 :
 
** Label : Libellé du paramètre.
 
** Label : Libellé du paramètre.
 
** TypeID : Numéro du type de paramètre.
 
** TypeID : Numéro du type de paramètre.
## Numérique
+
# Numérique
## Texte
+
# Texte
## Date/Heure
+
# Date/Heure
## Oui/Non
+
# Oui/Non
## Liste déroulante
+
# Liste déroulante
## Liste de cases à cocher
+
# Liste de cases à cocher
## Texte long
+
# Texte long
 
** TypeDesc : Description textuel du type de paramètre.
 
** TypeDesc : Description textuel du type de paramètre.
 
** SubTypeID : Numéro du sous-type de paramètre.
 
** SubTypeID : Numéro du sous-type de paramètre.
## Quantité
+
# Quantité
## Monétaire
+
# Monétaire
## Pourcentage
+
# Pourcentage
## Date
+
# Date
## Date et heure
+
# Date et heure
## Heure
+
# Heure
## Case à cocher
+
# Case à cocher
## Liste déroulante
+
# Liste déroulante
 
** SubTypeDesc : Description textuel du sous-type de paramètre.
 
** 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.
 
** 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.

Version du 24 janvier 2018 à 09:58

Afficher la liste des widgets

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


Informations retournées :

{  
  "Widget":[  
    {  
      "Params":"
<Param Name="OcaUID" Label="Occasion(s)" TypeID="6" TypeDesc="Liste de cases à cocher" LookupKey="OcaUID" LookupDesc="OcaDesc">
  <LookupItems>
    <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" />"
    }
  ]
}

Widget :

  • Params : XML contenant la liste des paramètres. Voici les informations sur le XML.
    • 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
    • TypeDesc : Description textuel du type de paramètre.
    • SubTypeID : Numéro du sous-type de paramètre.
  1. Quantité
  2. Monétaire
  3. Pourcentage
  4. Date
  5. Date et heure
  6. Heure
  7. Case à cocher
  8. Liste déroulante
    • 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.




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