| API / API Web | |
|
Version : 5.0-00 Edition spéciale ES1 |
||
|
Package : fr.ACE.metier.bc4j.produit.common GestionProduitselectionnerProduit |
||
| Schémas d’entrée et de sortie : | IN | OUT |
Cette API permet de sélectionner des produits en fonction de critères de sélection et de tri, afin de les intégrer à l’objet défini en entrée (tarif élaboré, poste d’événement ou sélection d’enregistrements).
API imbriquées : aucune.
Contraintes et limites de fonctionnement (hors périmètre)
| RAS. |
Paramétrage (PPE)
| RECDES - |
Processus, contrôles et règles de gestion
| Etape | Description du Processus |
L’API construit une requête SQL
dynamiquement à partir des critères de sélection fournis en entrée de l’API.
Les critères de tri passés permettent d’ajouter une clause ORDER BY. L’API
nécessite également un objet en entrée qui défini la ViewObject cible dans
laquelle seront intégrés les produits sélectionnés :
|
|
|
Mode = vide ou 1 Si Poste est renseigné :
Si selectionEnregistrement est renseigné :
Si Poste et selectionEnregistrement sont renseignés, l’API teste l’existence du produit dans les postes et les enregistrements EVPG et crée un poste et un EVPG par produit. |
|
|
Mode = 2 (gestion des répartitions). Si les champs « Poste » et « selectionEnregistrement » sont renseignés, l’API teste l’existence du produit dans la table EVPG. L’API vérifie également que, pour ce produit, une répartition n’a pas déjà été faite. Le produit n’est créé que dans la table EVPG. Si poste ou selectionEnregistrement ne sont pas renseignés, l’API fonctionne en mode 1. |
|
| En sortie, l’API renvoie le nombre de produits qui ont été traités (intégrés dans la base), ainsi que le nombre de produits qui ont été sélectionnés (par la requête SQL). | |
| Précision |
Les produits déjà existants dans la base pour la ViewObject définie en entrée, ne sont pas traités (pas de doublon). Si une erreur se produit lors de l’exécution de ce service, les compteurs nombre de produits traités et sélectionnés sont remis à 0. |
Cas d’erreurs
| Cause | Effet |
| CLAU_ERR : la clause SQL n’est pas valide. Erreur lors de l’exécution de la requête. | |
| EVE_INEX : l’événement n’existe pas. Dans le cas de l’intégration des produits au niveau des postes. |