Fonctions communes:API - BROWSE - DATA
API - BROWSE - DATA |
Récupérer les données d'une grille
Sert à afficher les données pour une grille en mentionnant la vue, le filtre et les boutons de filtre rapide utilisés.
DemAction : BROWSE
DemCat : DATA
DemOptions :
- GridCode : Code pour identifier la grille. Voir la liste des codes de grille
- NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
- LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
- ViewUID : ID de la vue que l'on souhaite afficher. Récupérer le ID grâce au SELECT / GRID_CONFIG. Doit être à 0 si les vues ne sont pas actives pour cette grille.
- FilterUID : ID du filtre sauvegardé à appliquer. Récupérer le ID grâce au SELECT / GRID_CONFIG. Doit être à 0 si les filtres ne sont pas actifs pour cette grille ou si aucun filtre n'est appliqué.
- PushButtons : Liste des noms de boutons de filtre rapide actif séparés par des virgules. Récupérer les noms grâce au SELECT / GRID_CONFIG.
- SearchValue : Filtre de la barre de recherche.
- SpecialWhere : Filtre forcé et non modifiable par l'utilisateur.
- RangeStart : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 1. [1]
- RangeEnd : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 25. [1]
- OrgUID : Numéro de l'organisme auquel l'utilisateur accède en ce moment. Retourné par le SELECT / LOGIN.
Informations retournées :
{ "Column":[ { "FieldName":"CliNo", "FieldDataType":"INT", "FieldVarcharSize":"0", "FieldDisplayFormat":"000 000", "FieldDisplayLabel":"No client", "FieldIsImageIndex":"0", "FieldIsCheckBox":"0", "FieldRequired":"0", "ColumnHidden":"0", "ColumnWebPC":"1", "ColumnWebTablet":"1", "ColumnWebSmartphone":"1", "ApplyCarFormat":"0", "CarNbDecimal":"", "CarSepDecimal":"", "CarSepMillier":"", "CarSymbole":"", "CarPlaceSymbole":"", "CarSeparateurDate":"", "CarDateFormat":"" } ], "Data":[ { "CliNo":"1", "CliCie":"0", "zClient":"No\u00EBl, Sapin", "CliAcronyme":"", "AdrStd":"41, rue des Sapins", "AdrVille":"P\u00F4le Nord", "AdrProvince":"Qu\u00E9bec", "AdrCodeP":"H0H 0H0" } ], "Footer":[ { "RecordCount":"2821" } ] }
Column : Liste des colonnes de la grille.
- FieldName : Nom du champ
- FieldDataType : Indique le type du champ
- FieldVarcharSize : Indique le nombre de caractères permis pour un champ texte. (0 = pas un champ texte, -1 = aucune limite/texte long)
- FieldDisplayFormat : Format d'affichage pour les nombres et les dates/heures
- FieldDisplayLabel : Entête de colonne
- FieldIsImageIndex : Pour les colonnes affichant une image, indique le ID de l'image.
- FieldIsCheckBox : Indique si la colonne doit être affichée sous forme de case à cocher.
- FieldRequired : Indique si la colonne doit toujours être retournée même si elle n'apparaît pas dans la vue.
- ColumnHidden : À 0, la colonne ne doit pas être affichée dans la grille
- ColumnWebPC : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un moniteur d'ordinateur.
- ColumnWebTablet : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'une tablette.
- ColumnWebSmartphone : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un téléphone intelligent.
- ApplyCarFormat : Si 1, il faut ignorer FieldDisplayFormat et utiliser les options de formatage de la caractéristique.
- CarNbDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au nombre de décimales.
- CarSepDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de décimales.
- CarSepMillier : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de milliers.
- CarSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au symbole monétaire.
- CarPlaceSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, indique si le symbole monétaire doit être placé avant ou après le nombre. (0 = Après, 1 = Avant)
- CarSeparateurDate : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au séparateur de date.
- CarDateFormat : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au format d'affichage de la date.
- CommTypeMaitre : 1 = Téléphone, 2 = Courriel, 3 = Site web
Data : Données
- Le nom des paires correspond au nom des champs reçus dans Column...
Footer : Informations au bas de la grille
- RecordCount : Nombre de lignes dans la grille.
Notes
Nom du document : Fonctions communes:API - BROWSE - DATA