| API / APIs Radiofréquence | |
| Version ACE : 5.0-00 | |
|
Package : Standard Sous-programme Basic : Chargement Nom de la gnc : gnc_rf_controle_chargement |
Fonctionnalité :Expédition |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de contrôler que le colis choisi appartient à la tournée et peut être chargé. Si c'est le cas, le colis est alors chargé.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Prototype de la fonction Basic
| Retour = Chargement (numero_module, idtrn, idobj) |
Messages en entrée
| CHARGEMENT~idtrn~idobj~ |
Messages en sortie
| Aucun. |
Valeurs restituées par l’API
| VALEUR | REMARQUE |
| 1 | Le colis a été chargé |
| 10 | Le colis n’existe pas |
| 11 | Le colis n’est pas en attente de chargement |
| 12 | Le colis n’appartient pas à la tournée |
| 13 | Le colis est inclus dans une unité d’expédition |
| 14 | L’objet de stock associé au colis n’existe pas |
| 15 | L’objet de stock associé au colis n’est pas disponible |
| 16 | Problème de chargement et de modification du statut du colis |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
|
Read the depot for the operator. If the Parcel/Expedition Unit does not exists the API returns the error code 10. If the object is not waiting for a loading (LCOL.statut != 6) the API returns the error code 11. If the object does not belong to the tour the API returns the error code 12. If the object is in an Expedition Unit (lcol.idue != ‘’) the API returns the error code 13. If the object does not exist the API returns the error code 14. If the object is not available the API returns the error code 15. If the status of the object can not be modified on 7 (waiting for an expedition) the API returns the error code 16. Load the object passed as a parameter |
Erreurs possibles
| CAUSE | EFFET |
| Le colis n’existe pas |
Code retour 10 Message «Colis/UE inexistant» |
| Le colis n’est pas en attente de chargement |
Code retour 11 Message «L'objet n'est pas en attente chargement» |
| Le colis n’appartient pas à la tournée |
Code retour 12 Message «L'objet n'appartient pas à la tournée» |
| Le colis est inclus dans une unité d’expédition |
Code retour 13 Message «L'objet est sur une UE» |
| L’objet de stock associé au colis n’existe pas |
Code retour 14 Message «L'objet de stock est inexistant» |
| L’objet de stock associé au colis n’est pas disponible |
Code retour 15 Message «L'objet n'est pas disponible» |
| Problème de chargement et de modification du statut du colis |
Code retour 16 Message «Problème de mise à jour de l'objet» |
Exemple(s) d’utilisation
| Retour_Chargement = Chargement (numero_module, idtrn, idobj) |