Copyright © 2020. Aurea Software, Inc. ("Aurea")
| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Autorise_Agent_Depot Nom de la gnc : gnc_rf_agent_depot |
Fonctionnalité :Général |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de contrôler les habilitations de l’agent connecté pour un dépôt donné, et de mettre à jour les informations du dépôt si l'agent y est autorisé.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Function Autorise_Agent_Depot(p_numero_module As String,p_sigdep As String,p_mode As String,p_nomdep As String,p_habil As String) As Integer |
Messages en entrée
| AGE_DEPOT ~ p_sigdep~ p_mode~ |
Messages en sortie
| AGE_DEPOT ~ p_nomdep~ p_habil~ |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | Le mode d’habilitation demandé existe pour l’opérateur. |
| 100 | Dépôt inconnu. |
| 101 | Aucune habilitation trouvée. |
| 102 | Erreur de mise à jour du dépôt par défaut de l’opérateur. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Identification du dépôt et de ses caractéristiques. |
| 2 | Recherche du niveau d’habilitation de l’opérateur connecté pour ce dépôt |
| 3 | Si le mode d’habilitation à contrôler est la modification, le dépôt par défaut de l’opérateur est automatiquement mis à jour. |
| Détail : |
Read the Depot information (TIE table) with the input parameter (sigdep). If the depot does not exist, the API function returns an error code 100. Call the function gnc_agent_depot, as so to verify whether the connected operator has authorizations to modify the information for the depot passed as a parameter (sigdep). If the connected operator has no authorizations to modify the data for the depot passed as a parameter. Call the function gnc_agent_depot, as so to verify whether the connected operator has authorizations to visualize the information for the depot passed as a parameter (sigdep). If the connected operator has no authorizations to modify and display the information for the depot passed as a parameter the API returns an error code 101. If the checked data action is 1(1 = Modification) If the operator is not authorized to modify the information for the depot, the API function fills the output parameters and returns an error code 101. Read the Depot data for the connected operator (tie.sigtie = gen.uti_cod). If the depot does not exist, the API function returns an error code 102. Modify the default depot for the connected operator with the depot received as a parameter. If the modification is not successful the API returns an error code 102. If the modification is successful the API fills the output parameters and returns 1. Else The API fills the output parameters and returns 1. |
Erreurs possibles
| CAUSE | EFFET |
| Problème de lecture du dépôt passé en entrée | Code retour 100, message « Dépôt incorrect » |
| Il n’y a pas d’habilitation pour l’opérateur connecté. | Code retour 101, message « Pas d'habilitation dans le dépôt » |
| La mise à jour du dépôt par défaut de l’opérateur à échoué. | Code retour 102, message « Erreur connexion dans le dépôt » |
Exemple(s) d’utilisation
| Retour_Autorise_Agent_Depot = Autorise_Agent_Depot (numero_module, sigdep, "1", nomdep, habil) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| Sigdep | CHAR | 12 | O | Sigle du dépôt | |
| Mode | CHAR | 1 | N |
Mode d’habilitation à contrôler pour l’opérateur connecté. 1 : En modification 2 : En visualisation |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | REMARQUE |
| ParamOut1 (P_nomdep) | CHAR | 18 | Nom du dépôt(TIE.nomtie) | |
| ParamOut2 (P_habil) | CHAR | 1 |
Niveau d’habilitation de l’opérateur : 0 : Pas d’habilitation 1 : Habilitation en visualisation 2 : Habilitation en modification |