Fonctions communes:API - SELECT - LOGIN : Différence entre versions
(Page créée avec « {{Entete_TOC}}<br> {{BasPage_Fonctions_communes}} ») |
|||
| Ligne 1 : | Ligne 1 : | ||
{{Entete_TOC}}<br> | {{Entete_TOC}}<br> | ||
| + | == Ouverture de session == | ||
| + | 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> | ||
| + | DemAction : SELECT<br> | ||
| + | DemCat : LOGIN<br> | ||
| + | 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) | ||
| + | <br>Informations retournées : <pre> | ||
| + | { | ||
| + | "Usr":[ | ||
| + | { | ||
| + | "UsrHidenNo":"5", | ||
| + | "LngUID":"0", | ||
| + | "Message":"" | ||
| + | } | ||
| + | ], | ||
| + | "SecUsr":[ | ||
| + | { | ||
| + | "Security":"ASSNOUVALCLI", | ||
| + | "Access":"O" | ||
| + | }, | ||
| + | { | ||
| + | "Security":"CLIGES", | ||
| + | "Access":"A M D C" | ||
| + | }, | ||
| + | { | ||
| + | "Security":"ADRESSEGES", | ||
| + | "Access":"A M _ C" | ||
| + | } | ||
| + | ], | ||
| + | "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":"$" | ||
| + | }, | ||
| + | { | ||
| + | "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":"$" | ||
| + | } | ||
| + | ], | ||
| + | "Support":[ | ||
| + | { | ||
| + | "NoSerie":"0007008012", | ||
| + | "OrgCodeP":"G6T 1S7", | ||
| + | "OrgBur":"(819) 758-0560" | ||
| + | } | ||
| + | ], | ||
| + | "About":[ | ||
| + | { | ||
| + | "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" | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | '''Usr''' : Informations sur l'utilisateur et le login<br> | ||
| + | * 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é. | ||
| + | '''SecUsr''' : Sécurités | ||
| + | * Security : Code de la sécurité | ||
| + | * Access : Accès pour cette sécurité (AMDC ou Oui/Non) | ||
| + | '''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 | ||
| + | '''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... » | ||
| + | * 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 | ||
{{BasPage_Fonctions_communes}} | {{BasPage_Fonctions_communes}} | ||
Version du 25 octobre 2017 à 06:55
| API - SELECT - LOGIN |
Sommaire
Ouverture de session
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)
Informations retournées :
{
"Usr":[
{
"UsrHidenNo":"5",
"LngUID":"0",
"Message":""
}
],
"SecUsr":[
{
"Security":"ASSNOUVALCLI",
"Access":"O"
},
{
"Security":"CLIGES",
"Access":"A M D C"
},
{
"Security":"ADRESSEGES",
"Access":"A M _ C"
}
],
"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":"$"
},
{
"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":"$"
}
],
"Support":[
{
"NoSerie":"0007008012",
"OrgCodeP":"G6T 1S7",
"OrgBur":"(819) 758-0560"
}
],
"About":[
{
"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é.
SecUsr : Sécurités
- Security : Code de la sécurité
- Access : Accès pour cette sécurité (AMDC ou Oui/Non)
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
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... »
- 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