Fonctions communes:API - CONFIG - WIDGET : Différence entre versions
(→Informations envoyées) |
(→Informations envoyées) |
||
Ligne 5 : | Ligne 5 : | ||
* 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 : 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é. | * 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="" /> | ||
<br> | <br> | ||
Version du 10 mai 2019 à 09:30
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 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.
- 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.
Nom du document : Fonctions communes:API - CONFIG - WIDGET