SFD_WS_APCE_V1.0.doc. Spécification Fonctionnelle du Web Service Appartenance PCE

Transcription

1 Spécification Fonctionnelle du Web Service Appartenance PCE 1

2 HISTORIQUE DES MISES A JOUR Auteur Version Objet ou pages modifiées Date CAT-AMANIA V1.0 Création 25/01/2016 APPROBATIONS Nom Direction Fonction Date Signature Documents de références Nom version 2

3 Table des matières HISTORIQUE DES MISES A JOUR... 2 CAT-AMANIA... 2 V Création /01/ APPROBATIONS... 2 Documents de références... 2 I. Introduction... 4 I.A. Objet du document... 4 II. Méthodes disponibles... 4 II.A. demanderapce... 4 II.A.1. Description... 4 II.A.2. Généralités... 4 II.A.3. Données en entrées... 5 II.A.4. Données en sortie... 6 II.A.5. Validation Type... 7 II.A.6. Validation Metier... 7 II.A.6.i. ValiderFournisseurExistant... 7 II.A.6.ii. ValiderCAD... 7 II.A.6.iii. ValiderBody... 7 II.A.7. Traitement

4 I. Introduction I.A. Objet du document Ce document présente les services proposés par le composant web service dit d " Appartenance PCE ". La présentation contiendra: Le nom des méthodes Les données en entrées et en sortie de chacune Les diverses vérifications effectuées par le web service Les traitements II. Méthodes disponibles II.A. demanderapce II.A.1. Description Cette méthode permet au fournisseur d'avoir une vision des X dernières dates DET/RATT d un PCE questionné, filtrés uniquement sur des dates de DET/RATT dans le périmètre du CAD demandeur. II.A.2. Généralités L'utilisation par le fournisseur du web service d appartenance PCE ne donne pas lieu à un enregistrement dans le SI de Regaz. 4

5 II.A.3. Données en entrées WSDL Nom Type Val Oblig Oblig Verif Type Val Commentaire Erreur Identification X DEM_COH01 NuméroCAD String <= 8 X Num <= 8 DEM_COH01, ERR_CAD_FORMAT_ERREUR; ERR_CAD_NOT_FOUND_EXCEPTION; ERR_NATURE_CONTRAT; NuméroFounisseur String X Num <= 8 DEM_COH01; ERR_FOURNISSEUR_FORMAT_ERREUR; ERR_FOURNISSEUR_NOT_FOUND_EXCEPTION; NuméroPCE String <= 8 Num <= 8 N'est pas renseigné dans cette méthode Fournisseur X DEM_COH01 RechercheAPCEType GroupeAppartenance String X Varchar2 <= 30 DEM_COH01 Identifiant String X Varchar2 <= 50 DEM_COH01 Telephone String Varchar2 <= 14 Tel: numeropce String Num <= 8 ERR_INTEGRITE_DEMANDE ERR_DEMANDE_MANQUE_INFORMATION ERR_FOURNISSEUR_JAMAIS_TITULAIRE_POUR_LE_PCE X JAVA 5

6 II.A.4. Données en sortie xn => signifie qu'il peut y avoir plusieurs occurences de la même structure de données. body WSDL Nom Type Val Commentaires CodesRetour String Pour les valeurs possibles des codes retours voir le document de référence CodeAlerte String Pour les valeurs possibles des codes alerte voir le document de référence DemandesAPCE xn Con_chrono long Num <= 8 (ex ) Pts_chrono_point long Num <= 8 (ex ) Dpt_date_debut String String au format dd/mm/yyyy (ex 25/01/2016) Dpt_date_fin String String au format dd/mm/yyyy (ex 25/01/2016) 6

7 II.A.5. Validation Type Le WS vérifie que la partie fournisseur existe bien puis vérifie que les parties Identifiant et groupe d'appartenance ne sont pas nulles. Le WS vérifie que la partie Identification existe bien puis vérifie: (1) Que le numéro de CAD n'est pas nul et qu'il est numérique et de longueur 8 maximum. (2) Que le numéro fournisseur n'est pas nul et qu'il est numérique et de longueur 8 maximum. II.A.6. Validation Metier II.A.6.i. ValiderFournisseurExistant Si le fournisseur n'est pas retrouvé dans le SI alors l'erreur ERR_FOURNISSEUR_NOT_FOUND_EXCPETION est lancée, s'il survient un problème quelconque l'erreur ERR_DATA_ACCESS est lancée. II.A.6.ii. ValiderCAD Si le CAD n'est pas trouvé dans le SI alors l'erreur ERR_CAD_NOT_FOUND_EXCEPTION est lancée. Si la nature du contrat lié au numéro de CAD est différent d'un contrat d'acheminement alors l'erreur ERR_NATURE_CONTRAT est lancée. S'il survient un problème quelconque l'erreur ERR_DATA_ACCESS est lancée II.A.6.iii. ValiderBody Vérification du champ obligatoire NumeroPCE - Si champ vide : ERR_DEMANDE_MANQUE_INFORMATION - Si champ invalide : ERR_INTEGRITE_DEMANDE II.A.7. Traitement Récupération des demandes APCE associées aux PCE renseigné. Tri des demandes pour ne renvoyer que celles correspondantes au CAD. Si le fournisseur demandeur n'a jamais détenu le PCE interrogé, alors l erreur ERR_FOURNISSEUR_JAMAIS_TITULAIRE_POUR_LE_PCE est lancée. 7