Copyright © 2020. Aurea Software, Inc. ("Aurea")
| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Lect_Comment Nom de la gnc : gnc_rf_lec_commen |
Fonctionnalité :Préparation |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet d’obtenir les commentaires de livraison et de préparation associés aux en-têtes et aux lignes des ordres de livraison (OL).
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Lect_Comment (numero_module, typdep, sigdep, codid, typtxt_com, codniv, numlig, numblo, fl_com, ligcom1, ligcom2, ligcom3, ligcom4, ligcom5, ligcom6, ligcom7, ligcom8) |
Messages en entrée
| LEC_COMMEN~typdep~sigdep~codid~typtxt_com~codniv~numlig~numblo~ |
Messages en sortie
| Retour~fl_com~ligcom1~ligcom2~ligcom3~ligcom4~ligcom5~ligcom6~ligcom7~ligcom8~ |
Valeurs restituées par l’API
| 1 : le traitement de l’API s’est déroulé avec succès. |
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Identification du commentaire et des informations associées. |
| Détail : |
Create the text data (TXT) structure and compose the text code (codtxt) with the input parameters (typdep, sigdep, typtxt, id). Call the function gnc_commentaire_logis with the input parameters (codniv, numblo), the composed text code (codtxt), the created txt structure and the local flag ‘flcom’ used to obtain the information about the existence of the comments, as so to obtain the corresponding comments. If the local flag ‘flcom’ is equal to 98, the output parameter (ParamOut1) is filled with ‘O’. The output parameters are filled from the obtained TXT structure. |
Exemple(s) d’utilisation
| Retour_Lect_Comment = Lect_Comment (numero_module, p_typdep, p_sigdep, p_codid, p_typtxt, p_codniv, p_numlig, w_numblo, w_fl_com, w_lig1, w_lig2, w_lig3, w_lig4, w_lig5, w_lig6, w_lig7, w_lig8 ) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| typdep | CHAR | 3 | O | Type du dépôt | |
| sigdep | CHAR | 12 | O | Sigle du dépôt | |
| id | CHAR | 10 | Identifiant OL | ||
| typtxt | CHAR | 2 | O | Type de commentaire (« LI » pour livraison, « PR » pour préparation) | |
| codniv | CHAR | 3 | O | Niveau : « OLE » pour les entêtes d’OL – « OLL » pour les lignes d’OL | |
| numlig | CHAR | 3 | O | Numéro de ligne d’OL | |
| numblo | CHAR | 3 | O | Numéro de bloc commentaire (numéro de page) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | REMARQUE |
| ParamOut1 | CHAR | 1 | Indicateur indiquant si le commentaire demandé existe ("O" s'il existe, sinon non renseigné). | |
| ParamOut2 | CHAR | 78 | Ligne 1 de la page de commentaire (TXT.texte1) | |
| ParamOut3 | CHAR | 78 | Ligne 2 de la page de commentaire (txt.texte2) | |
| ParamOut4 | CHAR | 78 | Ligne 3 de la page de commentaire (txt.texte3) | |
| ParamOut5 | CHAR | 78 | Ligne 4 de la page de commentaire (txt.texte4) | |
| ParamOut6 | CHAR | 78 | Ligne 5 de la page de commentaire (txt.texte5) | |
| ParamOut7 | CHAR | 78 | Ligne 6 de la page de commentaire (txt.texte6) | |
| ParamOut8 | CHAR | 78 | Ligne 7 de la page de commentaire (txt.texte7) | |
| ParamOut9 | CHAR | 78 | Ligne 8 de la page de commentaire (txt.texte8) |