| API / APIs Radiofréquence | |
| Version ACE : 1.3 | |
|
Package : Standard Nom de la gnc : gnc_ue_fermer |
Fonctionnalité : Poste de contrôle |
| Schémas d’entrée et de sortie : | voir en fin de document. |
Cette API permet de fermer une UE.
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RAS. |
Processus, contrôles et règles de gestion
| ETAPE | DESCRIPTION DU PROCESSUS |
| L’API vérifie tout d’abord le statut de l’UE, qui doit être inférieur ou égal à 5. Il faut également que l’UE ne soit pas vide. | |
| Lorsque l’UE est fermée, son statut passe à l’état « 6 ». | |
| Détail : |
Read the parcel data (LCOL) with the input parameters (typdep, sigdep, idobjcol = idue), as so to check the expedition unit status. If the parcel does not exist, the API returns an error code 0 and an error message “ELT_PASTRO”. If the parcel is already closed (lcol.statut > '5'), the API returns an error code 0 and the error message “L_UE_FERME”. Read the parcel data (LCOL) with the input parameters (typdep, sigdep, idue = idue), as so to check whether the expedition unit is empty. If the expedition unit is empty, the API returns an error code 0 and an error message “ELT_PASTRO”. Otherwise call the gnc_colis_modif_statut function, as so to change the status of the expedition unit to closed. (lcol.statut = ‘6’). |
Cas d’erreurs
| CODE | PARAMÈTRES | DESCRIPTION |
|---|---|---|
| 0/ELT_PASTRO | LCOL | The expedition unit does not exist. |
| 0/L_UE_FERME | The expedition unit is already closed. |
| NOM | DESCRIPTION | FORMAT | OBLIGATOIRE/FACULTATIF |
|---|---|---|---|
| typdep | Type dépôt | Char(3) | O |
| sigdep | Sigle dépôt | Char(12) | O |
| idue | N° UE en cours | Char(18) | O |
| NOM DU PARAMÈTRE | TYPE | FORMAT | TAILLE | REMARQUE |
| Aucun. |