Fonctions communes:API - SELECT - LOGIN : Différence entre versions
(→Informations envoyées) |
|||
(12 révisions intermédiaires par le même utilisateur non affichées) | |||
Ligne 1 : | Ligne 1 : | ||
{{Entete_TOC}}<br> | {{Entete_TOC}}<br> | ||
− | == | + | == Informations envoyées == |
L'ouverture de session est obligatoire. Aucune requête ne sera fonctionnelle tant qu'une session n'aura pas été ouverte dans votre logiciel. | L'ouverture de session est obligatoire. Aucune requête ne sera fonctionnelle tant qu'une session n'aura pas été ouverte dans votre logiciel. | ||
<br><br> | <br><br> | ||
Ligne 9 : | Ligne 9 : | ||
* NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON. | * 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) | * LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | ||
− | + | * UsrToken : Code de sécurité du courriel. | |
+ | |||
+ | ==Informations retournées == | ||
+ | <pre> | ||
{ | { | ||
"Usr":[ | "Usr":[ | ||
Ligne 15 : | Ligne 18 : | ||
"UsrHidenNo":"5", | "UsrHidenNo":"5", | ||
"LngUID":"0", | "LngUID":"0", | ||
− | "Message":"" | + | "Message":"", |
+ | "OrgUID":"1", | ||
+ | "Elevated":"1", | ||
+ | "UsrElevateMode":"2" | ||
} | } | ||
], | ], | ||
Ligne 30 : | Ligne 36 : | ||
"Security":"ADRESSEGES", | "Security":"ADRESSEGES", | ||
"Access":"A M _ C" | "Access":"A M _ C" | ||
+ | } | ||
+ | ], | ||
+ | "Module":[ | ||
+ | { | ||
+ | "Module":"ENG", | ||
+ | "Active":"1" | ||
+ | }, | ||
+ | { | ||
+ | "Module":"BENEF", | ||
+ | "Active":"0" | ||
} | } | ||
], | ], | ||
Ligne 45 : | Ligne 61 : | ||
"DateTimeFormat":"jj.mm.aaaa hh:nn", | "DateTimeFormat":"jj.mm.aaaa hh:nn", | ||
"ShortTimeFormat":"hh:nn", | "ShortTimeFormat":"hh:nn", | ||
− | "CurrencyString":"$" | + | "CurrencyString":"$", |
+ | "PaysDefaut":"Canada" | ||
}, | }, | ||
{ | { | ||
Ligne 59 : | Ligne 76 : | ||
"DateTimeFormat":"yyyy/mm/dd hh:nn", | "DateTimeFormat":"yyyy/mm/dd hh:nn", | ||
"ShortTimeFormat":"hh:nn", | "ShortTimeFormat":"hh:nn", | ||
− | "CurrencyString":"$" | + | "CurrencyString":"$", |
+ | "PaysDefaut":"Canada" | ||
} | } | ||
], | ], | ||
Ligne 71 : | Ligne 89 : | ||
"About":[ | "About":[ | ||
{ | { | ||
+ | "Application":"ProDon", | ||
"NoSerie":"0007008012", | "NoSerie":"0007008012", | ||
"Version":"5.0.5", | "Version":"5.0.5", | ||
Ligne 90 : | Ligne 109 : | ||
* LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | * LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | ||
* Message : Message d'erreur indiquant pourquoi le login a échoué. | * Message : Message d'erreur indiquant pourquoi le login a échoué. | ||
+ | * OrgUID : Organisme sous lequel l'utilisateur est connecté. | ||
+ | * Elevated : Retourne 1 si l'utilisateur s'est élevé au rang de SUPERVISEUR ou si l'utilisateur est connecté avec le compte SUPERVISEUR. | ||
+ | * UsrElevateMode : | ||
+ | 0 = L'utilisateur ne peut pas s'élever | ||
+ | 1 = L'utilisateur est automatiquement élevé au rang de SUPERVISEUR | ||
+ | 2 = [[Fonctions_communes:API_-_ELEVATE_-_USR|ELEVATE / USR]] devra être utilisé pour élever l'utilisateur au rang de SUPERVISEUR. | ||
+ | 3 = [[Fonctions_communes:API_-_ELEVATE_-_USR|ELEVATE / USR]] devra être utilisé pour élever l'utilisateur au rang de SUPERVISEUR. (Mot de passe SUPERVISEUR requis) | ||
'''SecUsr''' : Sécurités | '''SecUsr''' : Sécurités | ||
* Security : Code de la sécurité | * Security : Code de la sécurité | ||
* Access : Accès pour cette sécurité (AMDC ou Oui/Non) | * Access : Accès pour cette sécurité (AMDC ou Oui/Non) | ||
+ | '''Module''' : Liste des modules | ||
+ | * Module : Code du module | ||
+ | * Active : 0 = Inactif, 1 = Actif | ||
'''DisplayFormat''' : Configurations pour les formats d'affichage | '''DisplayFormat''' : Configurations pour les formats d'affichage | ||
* LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | * LngUID : Langue d'affichage (0 = Français, 1 = Anglais) | ||
Ligne 126 : | Ligne 155 : | ||
* ShortTimeFormat : Format d'affichage pour les heures | * ShortTimeFormat : Format d'affichage pour les heures | ||
* CurrencyString : Devise monétaire | * CurrencyString : Devise monétaire | ||
+ | * PaysDefaut : Nom du pays par défaut dans le logiciel. | ||
'''Support''' : Informations nécessaire pour l'affichage de la page de demande de soutien | '''Support''' : Informations nécessaire pour l'affichage de la page de demande de soutien | ||
* NoSerie : Numéro de série de la clé logicielle | * NoSerie : Numéro de série de la clé logicielle | ||
Ligne 131 : | Ligne 161 : | ||
* OrgBur : Téléphone au bureau de l'organisme #1 | * OrgBur : Téléphone au bureau de l'organisme #1 | ||
'''About''' : Informations nécessaire pour l'affichage de la page « À propos de... » | '''About''' : Informations nécessaire pour l'affichage de la page « À propos de... » | ||
+ | * Application : Nom de l'application | ||
* NoSerie : Numéro de série de la clé logicielle | * NoSerie : Numéro de série de la clé logicielle | ||
* Version : Version de l'application | * Version : Version de l'application |
Version actuelle datée du 1 mars 2019 à 16:30
API - SELECT - LOGIN |
Informations envoyées
L'ouverture de session est obligatoire. Aucune requête ne sera fonctionnelle tant qu'une session n'aura pas été ouverte dans votre logiciel.
DemAction : SELECT
DemCat : LOGIN
DemOptions :
- UsrEmail : Courriel servant à s'identifier. Doit correspondre au courriel inscrit dans la fiche de l'utilisateur dans votre logiciel.
- 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)
- UsrToken : Code de sécurité du courriel.
Informations retournées
{ "Usr":[ { "UsrHidenNo":"5", "LngUID":"0", "Message":"", "OrgUID":"1", "Elevated":"1", "UsrElevateMode":"2" } ], "SecUsr":[ { "Security":"ASSNOUVALCLI", "Access":"O" }, { "Security":"CLIGES", "Access":"A M D C" }, { "Security":"ADRESSEGES", "Access":"A M _ C" } ], "Module":[ { "Module":"ENG", "Active":"1" }, { "Module":"BENEF", "Active":"0" } ], "DisplayFormat":[ { "LngUID":"0", "LngCode":"FR", "CurrencyFormat":"0", "NegCurrencyFormat":"14", "DecimalSeparator":",", "ThousandSeparator":"\u00A0", "DateSeparator":".", "ShortDateFormat":"jj.mm.aaaa", "LongDateFormat":"jjjj j mmmm aaaa", "DateTimeFormat":"jj.mm.aaaa hh:nn", "ShortTimeFormat":"hh:nn", "CurrencyString":"$", "PaysDefaut":"Canada" }, { "LngUID":"1", "LngCode":"EN", "CurrencyFormat":"0", "NegCurrencyFormat":"0", "DecimalSeparator":",", "ThousandSeparator":" ", "DateSeparator":"/", "ShortDateFormat":"yyyy/mm/dd", "LongDateFormat":"dddd, mmmm d yyyy", "DateTimeFormat":"yyyy/mm/dd hh:nn", "ShortTimeFormat":"hh:nn", "CurrencyString":"$", "PaysDefaut":"Canada" } ], "Support":[ { "NoSerie":"0007008012", "OrgCodeP":"G6T 1S7", "OrgBur":"(819) 758-0560" } ], "About":[ { "Application":"ProDon", "NoSerie":"0007008012", "Version":"5.0.5", "TypeVersion":"Multi-utilisateur", "VersionSQL":"Developer Edition (64-bit) 11.0.2100.60 RTM", "NbLic":"10" } ], "Org":[ { "OrgUID":"1", "OrgCode":"ORG1", "OrgNom":"Fondation Démo" } }
Usr : Informations sur l'utilisateur et le login
- UsrHidenNo : Numéro de l'utilisateur correspondant au courriel utilisé pour le login. Si ce champ est vide, c'est que le login a échoué.
- LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
- Message : Message d'erreur indiquant pourquoi le login a échoué.
- OrgUID : Organisme sous lequel l'utilisateur est connecté.
- Elevated : Retourne 1 si l'utilisateur s'est élevé au rang de SUPERVISEUR ou si l'utilisateur est connecté avec le compte SUPERVISEUR.
- UsrElevateMode :
0 = L'utilisateur ne peut pas s'élever 1 = L'utilisateur est automatiquement élevé au rang de SUPERVISEUR 2 = ELEVATE / USR devra être utilisé pour élever l'utilisateur au rang de SUPERVISEUR. 3 = ELEVATE / USR devra être utilisé pour élever l'utilisateur au rang de SUPERVISEUR. (Mot de passe SUPERVISEUR requis)
SecUsr : Sécurités
- Security : Code de la sécurité
- Access : Accès pour cette sécurité (AMDC ou Oui/Non)
Module : Liste des modules
- Module : Code du module
- Active : 0 = Inactif, 1 = Actif
DisplayFormat : Configurations pour les formats d'affichage
- LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
- LngCode : Code de la langue d'affichage
- CurrencyFormat : Format d'affichage pour les valeurs monétaires positives
0 = $1 1 = 1$ 2 = $ 1 3 = 1 $
- NegCurrencyFormat : Format d'affichage pour les valeurs monétaires négatives
0 = ($1) 1 = -$1 2 = $-1 3 = $1- 4 = (1$) 5 = -1$ 6 = 1-$ 7 = 1$- 8 = -1 $ 9 = -$ 1 10 = 1 $- 11 = $ 1- 12 = $ -1 13 = 1- $ 14 = ($ 1) 15 = (1 $)
- DecimalSeparator : Séparateur de décimales pour les valeurs monétaires
- ThousandSeparator : Séparateur de milliers pour les entiers supérieurs à 999
- DateSeparator : Séparateur de date
- ShortDateFormat : Format d'affichage pour les dates courtes sans heure, sans nom de jour ni de mois.
- LongDateFormat : Format d'affichage pour les dates longues sans heure mais ayant un nom de jour ou de mois.
- DateTimeFormat : Format d'affichage pour les dates ayant une heure
- ShortTimeFormat : Format d'affichage pour les heures
- CurrencyString : Devise monétaire
- PaysDefaut : Nom du pays par défaut dans le logiciel.
Support : Informations nécessaire pour l'affichage de la page de demande de soutien
- NoSerie : Numéro de série de la clé logicielle
- OrgCodeP : Code postal de l'organisme #1
- OrgBur : Téléphone au bureau de l'organisme #1
About : Informations nécessaire pour l'affichage de la page « À propos de... »
- Application : Nom de l'application
- NoSerie : Numéro de série de la clé logicielle
- Version : Version de l'application
- TypeVersion : Type de license
- VersionSQL : Numéro de la version de MS SQL Server
- NbLic : Nombre d'utilisateur simultanés
Org : Liste des organismes
- OrgUID : ID de l'organisme
- OrgCode : Code de l'organisme
- OrgNom : Nom de l'organisme
Nom du document : Fonctions communes:API - SELECT - LOGIN