Note technique sur les modalités d’échanges A2A





télécharger 271.3 Kb.
titreNote technique sur les modalités d’échanges A2A
page1/3
date de publication11.10.2019
taille271.3 Kb.
typeNote
m.20-bal.com > loi > Note
  1   2   3




GUICHET ONEGATE

Note technique sur les modalités d’échanges A2A

Décembre 2013



1.Introduction


Ce document décrit les modalités techniques de récupération via webservices des feedbacks (comptes rendus de traitement des fichiers par l’application OneGate) et des messages applicatifs OneGate (notamment, les comptes rendus de traitement « métier ») liés ou non à une remise de fichier.


2.Sommaire





1. Introduction 1

2. Sommaire 2

3. Description et utilisation des différents WebServices 3

3.1. Consultation des comptes rendus liés aux fichiers remis 3

3.1.1. Synoptique des opérations 4

3.1.2. Description du webservice « FeedbackList » 5

3.1.3. Description du webservice « FeedbackUrls » 9

3.2. Consultation des messages contenus dans la messagerie OneGate 14

3.2.1. Synoptique des opérations 15

3.2.2. Description du webservice « MessageList » 16

3.2.3. Description du service MessageUrls 21

3.3. Authentification de l’application émettrice sur l’infrastructure Banque De France 28

3.4. Intégration WSDL 29

3.5. Horaires d’ouverture 30

3.6. Contacts 31

3.6.1. Support ONEGATE 31

3.6.2. La Maîtrise d’Ouvrage – Coordination Métier ONEGATE 31

3.Description et utilisation des différents WebServices

3.1. Consultation des comptes rendus liés aux fichiers remis


Les comptes rendus traités dans ce paragraphe sont les comptes rendus de traitement des fichiers remis dans l’application OneGate.

Lorsque le traitement d’un fichier dans OneGate est au Statut « Succès », un feedback (compte rendu de traitement ou compte rendu de validation) est généré et mentionne que le traitement est en succès.

Lorsque le traitement d’un fichier dans OneGate est au statut « Echec » ou « Partiellement validé », un feedback (compte rendu de traitement ou compte rendu de validation) est généré et mentionne la liste des anomalies bloquantes (dans le cas d’un échec) ou la liste des warnings (dans le cas d’un fichier partiellement validé).

3.1.1.Synoptique des opérations


Pour récupérer les feedbacks (comptes rendus de traitement), les 3 opérations suivantes doivent être réalisées chronologiquement :

    • Le remettant demande la liste des comptes rendus disponibles (« FeedbackListRequest »)

    • Le remettant demande un compte rendu spécifique (« FeedbackUrlsRequest »)

    • Le remettant soumet une requête HTTPS pour chaque URL liée à un compte rendu et le serveur renverra le contenu de la pièce jointe associée.


Ces opérations sont matérialisées dans le schéma ci-dessous :


3.1.2.Description du webservice « FeedbackList »


Ce webservice permet de récupérer les identifiants des comptes rendus disponibles en fonction de certains critères (lus ou non, sur une période de temps).

A noter, un message passe au statut « Lu » si le service FeedbackUrls est appelé sur ce message.

3.1.2.1.Message d’entrée du service






FeedbackListRequest




Description

Contient les attributs pour demander la liste des identifiants des comptes rendus

XML format

ComplexType

Children

NotRead

Read





NotRead




Description

Utilisé pour demander les identifiants des nouveaux comptes rendus

XML format

ComplexType

Validation

Empty element




Read




Description

Utilisé pour demander les identifiants des comptes rendus déjà demandés sur une période donnée

XML format

ComplexType

Children

TimeFrame






TimeFrame




Description

Utilisé pour spécifier la période durant laquelle le compte rendu a été récupéré de l’application pour la première fois.

XML format

ComplexType

Children

FromTime

ToTime





FromTime




Description

Timestamp identifiant le début de la période.

XML format

xs:dateTime

Validation

Required



ToTime




Description

Timestamp identifiant la fin de la période

XML format

xs:dateTime

Validation

Required


Exemple de message « FeedbackListRequest »
http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.onegate.eu/2010-01-01">

  

  

     

        

           

               2014-01-01T09:00:00

               2014-01-10T09:00:00

           


        


     


  





3.1.2.2.Message de sortie du service






FeedbackListResponse




Description

Contient la liste des identifiants des comptes rendus disponibles.

XML format

ComplexType

Children

NoFeedback

Feedback





NoFeedback




Description

Pas de comptes rendus trouvé pour les critères spécifiés

  • Non lus : Pas de nouveaux comptes rendus

  • Lus : Pas de comptes rendus récupérés sur la période spécifiée

XML format

ComplexType

Validation

Empty element





Feedback




Description

Contient l’information sur le compte rendu disponible en téléchargement.

XML format

ComplexType

Minimum occurence: 1

Maximum occurence: Pas de maximum

Children

FeedbackId

TicketId



FeedbackId




Description

Identifiant du compte rendu

XML format

xs:nonNegativeInteger.

minExclusive: 0 (*)

Validation

Required

(*) Max value: 2^63 - 1 = 9223372036854775807






TicketId




Description

Identifiant OneGate du fichier remis auquel est rattaché le compte rendu.

XML format

xs:string

whiteSpace=collapse

Validation

Required






Exemple de message « FeedbackListResponse »









145530

CSV-1024







155514

236108









3.1.2.3.Message d’erreur



En cas d’erreur fonctionnelle ou technique à l’appel au service une « SOAP fault » est transmise à l’appelant.
Exemple

http://schemas.xmlsoap.org/soap/envelope/">

  

     

         soapenv:Server

         [ISS.0088.9256] Fault returned by invoked service

         https://xxxx.xxxx.xx/ws>

        

            http://www.onegate.eu/2010-01-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

              

                  SOAP-ENV:Server

              


              

                  C0001

              


               Validation error

           


        


     


  




3.1.3.Description du webservice « FeedbackUrls »


Ce webservice “FeedbackUrlsRequest” est utilisé pour récupérer un compte rendu de traitement spécifique à partir de son Identifiant.

3.1.3.1.Message d’entrée du service






FeedbackUrlsRequest




Description

Contient les informations liées au compte rendu que l’on souhaite récupérer.

XML format

ComplexType

Children

FeedbackId






FeedbackId




Description

Identifiant du compte rendu que l’on souhaite récupérer.

XML format

xs:nonNegativeInteger

minExclusive: 0 (*)

Validation

Requise

(*) Max value: 2^63 - 1 = 9223372036854775807

Exemple de message « FeedbackUrlsRequest »









155512






3.1.3.2.Message de sortie du service






FeedbackUrlsResponse




Description

Contient le compte rendu demandé

XML format

ComplexType

Children

Message







Message




Description

Le message est le compte rendu qui contient à minima le corps du message et, de façon optionnelle, une pièce jointe.

XML format

ComplexType

Children

Body

Attachment




Body




Description

Corps du message en format texte

Exemple: « Feedback de chargement pour le fichier XXX.xml avec numéro de ticket [79219] »

XML format

xs:string

Validation

Requise










URL




Description

Pièces jointes liées au message

  • @contentType indique le type du compte rendu

  • @URL indique l’URL où le compte rendu peut être récupéré en utilisant une requête HTTPS GET

XML format

ComplexType

Attributes

Name

Type

Value

contentType

xs:string

“text/xml” or “application/zip”

URL

xs:string







Validation

Empty element, Optional
Exemple de message « FeedbackUrlsResponse »









voici mon feedback

https://inonegate-strong-dev.intra-dev01.bdf-dev01.local/onegate/a2a/feedback/attachment/154822









Exemple de retour d’un appel à l’URL via https





BDF



onegate-support@banque-france.fr

FR







Le fichier est sans signature.

Le fichier est incorrect : Le format du fichier n'est pas conforme aux spécifications.





3.1.3.3.Message d’erreur



En cas d’erreur fonctionnelle ou technique lors de l’appel au service une « SOAP fault » est transmise à l’appelant.
Exemple

http://schemas.xmlsoap.org/soap/envelope/">

  

     

         soapenv:Server

         [ISS.0088.9256] Fault returned by invoked service

         https://xxxx.xxxx.xx/ws>

        

            http://www.onegate.eu/2010-01-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

              

                  SOAP-ENV:Server

              


              

                  C0001

              


               Validation error

           


        


     


  




  1   2   3

similaire:

Note technique sur les modalités d’échanges A2A iconNote technique sur les modalités d’échanges A2A
«Soap Fault» est retournée en cas de dépassement de ce timeout. Néanmoins, si la remise est correctement traitée, l’émetteur recevra...

Note technique sur les modalités d’échanges A2A iconProgramme : N. Corroyer contexte
«ralentissement» du développement des foyers. Après le 04/07, les populations de puceron lanigère sont en diminution dans toutes...

Note technique sur les modalités d’échanges A2A iconCette note technique permettra d’apprécier la qualité du projet et...

Note technique sur les modalités d’échanges A2A iconNote technique

Note technique sur les modalités d’échanges A2A iconNote technique Rappel du contexte

Note technique sur les modalités d’échanges A2A iconNote technique dsmf n°2014-01 relative à la collecte
...

Note technique sur les modalités d’échanges A2A iconNote technique securite des piscines
«Les maîtres d'ouvrage des piscines construites ou installées à partir du le` janvier 2004 doivent les avoir pourvues, avant la première...

Note technique sur les modalités d’échanges A2A iconIntitulé du Cati : Bioinformatique, Biodiversité, Représentation...
...

Note technique sur les modalités d’échanges A2A icon7. 2Note technique sur les accréditations 22

Note technique sur les modalités d’échanges A2A iconNote sur les délais de prescription





Tous droits réservés. Copyright © 2016
contacts
m.20-bal.com