| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Interrogation_Objet_Stock Nom de la gnc : gnc_rf_interrogation |
Fonctionnalité :Général |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de fournir les informations associées à un objet de stock.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Retour = Interrogation_Objet_Stock (numero_module, idobj1, lcodmag, adremp, natstk, statut, lirstat, libpalette, codpro, qteunt, cnttyp, cntcod, codemb, idobjpere) |
Messages en entrée
| INTERRO~idobj1~ |
Messages en sortie
| Retour~lcodmag~adremp~natstk~statut~lirstat~libpalette~codpro~qteunt~cnttyp~cntcod~ codemb~idobjpere |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | Le traitement de l’API s’est correctement déroulé. |
| 14 | Le numéro d’objet de stock n’existe pas dans le dépôt courant. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| 1 | Identification de l’objet de stock dans le dépôt courant de l’utilisateur. |
| Détail : |
Read the depot (TIE table) for the operator. Read the stock object data (LOBJSTK table) with the idobj input parameter. If the stock object is not found, the API returns the error code 14. Read the short label (LETA table) of the stock object status (lobjstk.statut). Read the stock object data (lobjstk) with (idobjpere = idobj input parameter) in order to check whether the stock object is a parent object for another stock object. If no such stock object is found. The API copies ‘homogene’ in the ParamOut6 output parameter. Otherwise. The API copies ‘heterogene’ in the ParamOut6 output parameter. |
Erreurs possibles
| CAUSE | EFFET |
| L’objet de stock n’existe pas dans le dépôt de l’agent. | Affichage d’un message (code retour 14). |
| L’agent connecté n’a pas de dépôt par défaut. | Affichage d’un message (code retour 14). |
Exemple(s) d’utilisation
| RetourInterrogation= Interrogation_Objet_Stock(numero_module, “121245679897653454”, lcodmag , adremp, natstk, statut, lirstat, libpalette, codpro, qteunt, cnttyp, cntcod, codemb, idobjpere) |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | OBL O/N | REMARQUE |
| idobj | CHAR | 18 | O | Numéro de SSCC d’un objet de stock, colis préparé, conteneur |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | REMARQUE |
| ParamOut1 | CHAR | 3 | Code magasin (LOBJSTK.lcodmag) | |
| ParamOut2 | CHAR | 10 | Code emplacement (lobjstk.adremp) | |
| ParamOut3 | CHAR | 2 | Nature de stock (lobjstk.natstk) | |
| ParamOut4 | CHAR | 1 | Statut de l’objet (lobjstk.statut) | |
| ParamOut5 | CHAR | 10 | Libellé réduit du statut (LETA.lirleta) | |
| ParamOut6 | CHAR | 10 |
libpalette : « homogene » dans le cas d’un objet de stock. « heterogene » dans le cas où l’objet de stock est un conteneur contenant plusieurs objets. |
|
| ParamOut7 | CHAR | 16 | Code produit de l’objet de stock (lobjstk.codpro) | |
| ParamOut8 | Long | Nombre d’unités dans l’objet de stock (lobjstk.qteunt) | ||
| ParamOut9 | CHAR | 2 | Type de contenant (lobjstk.cnttyp1) | |
| ParamOut10 | CHAR | 2 | Code contenant (lobjstk.cntcod1) | |
| ParamOut11 | CHAR | 16 | Code emballage (lobjstk.codemb) | |
| ParamOut12 | CHAR | 18 | N° d’objet de l’objet-père (n° support) (lobjstk.idobjpere). |