Copyright © 2020. Aurea Software, Inc. ("Aurea")
| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Infos_Colis Nom de la gnc : gnc_rf_infos_lcol |
Fonctionnalité :Préparation |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de fournir les informations associées à un colis.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
Prototype de la fonction Basic
| Retour = Infos_Colis (numero_module, typdep, sigdep, idobjcol, flgue, statut, typliv, sigliv, col_gerb_sous, col_gerb_sur) |
Messages en entrée
| INFO_LCOL~typdep~sigdep~idobjcol~ |
Messages en sortie
| Retour~flgue~statut~typliv~sigliv~col_gerb_sous~col_gerb_sur~IDTRN~ |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | Le colis a été identifié. |
| 0 | Le colis est inexistant. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Identification du colis. |
| 2 |
Grâce au paramètre LOGGER, et en cas de gerbage, l’API alimente l’identifiant du colis suivant (champ « idobj_dessus ») et l’identifiant du colis précédent « idobj_dessous ». Si le paramètre n’est pas positionné, ces champs ne sont pas alimentés (vides). |
| Détail : |
Read the logistic stock parcel data (LCOL) with the input parameters (typdep, sigdep, idobjcol). If the parcel does not exist, the API returns an error code 0 Else If the parameter LCONSO is not active AND the parameter LOGGER is active AND the fields N1 and N2 of the parameter LOGGER are different from 0 The identifiers of the next and the previous parcel identifiers in case of stacking are copied in ParamOut5 and ParamOut6 parameters from the corresponding parameterized lcol fields (the numbers of these parameterized fields are given by LOGGER.N1 and LOGGER.N2 parameter fields). Else An empty string is copied in ParamOut5 and ParamOut6 parameters. |
Erreurs possibles
| CAUSE | EFFET |
| Le colis n’existe pas. | Code retour 0. |
Exemple(s) d’utilisation
| Retour_Infos_Colis = Infos_colis (numero_module, "DEP", p_sigdep, w_idobj_conso, w_flgue_cible, w_statut_col_cible, w_typliv_cible, w_sigliv_cible, w_col_gerb_sur, w_col_gerb_sous) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| typdep | CHAR | 3 | O | Type du dépôt | |
| digdep | CHAR | 12 | O | Sigle du dépôt | |
| idobjcol | CHAR | 18 | O | Identifiant du colis |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | REMARQUE |
| ParamOut1 | CHAR | 1 |
Indicateur de l’unité d’expédition (LCOL.flgue) : 1 = oui, 0 = non. |
|
| ParamOut2 | CHAR | 1 | Statut du colis (lcol.statut) | |
| ParamOut3 | CHAR | 3 | Type du tiers livré (lcol.typliv) | |
| ParamOut4 | CHAR | 12 | Sigle du tiers livré (lcol.sigliv) | |
| ParamOut5 | CHAR | 18 | Identifiant colis suivant (idobj_dessus) en cas de gerbage, zone complémentaire du colis indiquée par la zone N1 du paramètre LOGGER. | |
| ParamOut6 | CHAR | 18 | Identifiant colis précédent (idobj_dessous) en cas de gerbage, zone complémentaire du colis indiquée par a zone N2 du paramètre LOGGER. | |
| ParamOut7 | LONG | Identifiant de la tournée du colis (lcol.idtrn). |