Fonctions communes:API - RESULT - WIDGET

API - RESULT - WIDGET

Version imprimable

---

Récupérer les donné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.
• 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.
• 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 :

{  
  "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é (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.

---

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

Version imprimable