Aller à : navigation, rechercher

Maarch Courrier/1.5/fr/Tutorials/WS utiles

Web Services utiles

Envoi d'un courrier et de ses métadonnées dans Maarch

Fonctionnalité attendue

Verser un courrier et ses métadonnées dans Maarch depuis une application externe.
Maarch dispose d'un webservice permettant de verser des documents et leurs métadonnées de façon transactionnelle.
Nom du web service : storeResource.

Paramètres en entrée

Liste des paramètres à fournir par l'application tierce au web service de Maarch.


Champ Type Champ Maarch Valeur attendue Commentaires
encodedFile String Stocké dans le docserver Chaîne de caractères contenant le courrier à ajouter encodée en base64
data Array * Un tableau complexe comprenant les métadonnées du courrier
collId String letterbox_coll Nom de la collection courrier
table String res_letterbox Table cible de la collection courrier
fileFormat String format PDF Format du fichier
status String status ATT Statut du courrier


Retour

Champ Type Champ Maarch Valeur attendue Commentaires
returnCode Integer 0 si OK Code retour.

Si <> 0 alors erreur

resId BigInt res_id Identifiant unique du courrier dans Maarch
error String Si status = KO alors error contient le libellé de l'erreur

Exemple d'une requête SOAP

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:MaarchSoapServer">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:storeResource>
         <encodedFile>JVBE…
         </encodedFile>
         <data>
            <datas>
               <column>type_id</column>
               <value>1000</value>
               <type>integer</type>
            </datas>
            <datas>
               <column>custom_f1</column>
               <value>12345</value>
               <type>float</type>
            </datas>
            <datas>
               <column>custom_f2</column>
               <value>98765</value>
               <type>float</type>
            </datas>
            <datas>
               <column>custom_t2</column>
               <value>Normal</value>
               <type>string</type>
            </datas>
            <datas>
               <column>custom_t3</column>
               <value>Nicolas Martin</value>
               <type>string</type>
            </datas>
            <datas>
               <column>custom_t4</column>
               <value>Non</value>
               <type>string</type>
            </datas>
            <datas>
               <column>custom_t9</column>
               <value>11 boulevard du Sud-Est 92000 Nanterre</value>
               <type>string</type>
            </datas>
            <datas>
               <column>custom_t10</column>
               <value>info@maarch.org</value>
               <type>string</type>
            </datas>
            <datas>
               <column>custom_t15</column>
               <value>01.47.24.51.59</value>
               <type>string</type>
            </datas>
            <datas>
               <column>scan_batch</column>
               <value>SVE</value>
               <type>string</type>
            </datas>
            <datas>
               <column>doc_date</column>
               <value>01/08/2015</value>
               <type>date</type>
            </datas>
         </data>
         <collId>letterbox_coll</collId>
         <table>res_letterbox</table>
         <fileFormat>PDF</fileFormat>
         <status>ATT</status>
      </urn:storeResource>
   </soapenv:Body>
 </soapenv:Envelope>

Envoi des métadonnées spécifiques au courrier dans Maarch

Fonctionnalité attendue

Verser les métadonnées complémentaires et spécifiques au courrier dans Maarch depuis une application externe.
Maarch dispose d'un webservice permettant de verser ces métadonnées complémentaires.

Nom du web service : storeExtResource.

Paramètres en entrée

Liste des paramètres à fournir par l'application tierce au web service de Maarch.


Champ Type Champ Maarch Valeur attendue Commentaires
resId Bigint res_id Identifiant unique du courrier dans Maarch
data Array * Un tableau complexe comprenant les métadonnées spécifiques au courrier
table String mlb_coll_ext Table cible de l'extension de la collection courrier


Retour

Champ Type Champ Maarch Valeur attendue Commentaires
returnCode Integer 0 si OK Code retour.

Si <> 0 alors erreur

resId BigInt res_id Identifiant unique du courrier dans Maarch
error String Si status = KO alors error contient le libellé de l'erreur


Exemple d'une requête SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:MaarchSoapServer">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:storeExtResource>
         <resId>24</resId>
         <data>
            <datas>
               <column>category_id</column>
               <value>incoming</value>
               <type>string</type>
            </datas>
            <datas>
               <column>exp_contact_id</column>
               <value>14</value>
               <type>integer</type>
            </datas>
            <datas>
               <column>nature_id</column>
               <value>SVE</value>
               <type>string</type>
            </datas>
            <datas>
               <column>process_notes</column>
               <value>5</value>
               <type>string</type>
            </datas>
         </data>
         <table>mlb_coll_ext</table>
      </urn:storeExtResource>
   </soapenv:Body>
</soapenv:Envelope>

Envoi d'une pièce jointe dans Maarch

Fonctionnalité attendue

Verser une pièce jointe à un courrier principal dans Maarch depuis une application externe.
Maarch dispose d'un webservice permettant de verser des pièces jointes.

Nom du web service : storeAttachmentResource.

Paramètres en entrée

Liste des paramètres à fournir par l'application tierce au web service de Maarch.


Champ Type Champ Maarch Valeur attendue Commentaires
resId Bigint res_id Identifiant unique du courrier principal dans Maarch
collId String letterbox_coll Nom de la collection courrier
encodedFile String Stocké dans le docserver Chaîne de caractères contenant la pièce jointe à ajouter encodée en base64
fileFormat String format PDF Format du fichier
title String title Titre de la pièce jointe


Retour

Champ Type Champ Maarch Valeur attendue Commentaires
returnCode Integer 0 si OK Code retour.

Si <> 0 alors erreur

resId BigInt res_id Identifiant unique de la pièce jointe dans Maarch
error String Si status = KO alors error contient le libellé de l'erreur


Exemple d'une requête SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:MaarchSoapServer">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:storeAttachmentResource>
         <resId>109</resId>
         <collId>letterbox_coll</collId>
         <encodedContent>JVBERi0…
         </encodedContent>
         <fileFormat>PDF</fileFormat>
         <title>test import PJ</title>
      </urn:storeAttachmentResource>
   </soapenv:Body>
</soapenv:Envelope>

Demande de visualisation d'un courrier

Fonctionnalité attendue

Une fois les métadonnées du courrier injectées dans Maarch, ce dernier doit être visualisable depuis une application tierce.
Maarch dispose d'un webservice permettant de lui demander un document.
Nom du web service : viewResource.

Paramètres en entrée

Liste des paramètres à fournir par l'application tierce au web service de Maarch.


Champ Type Champ Maarch Valeur attendue Commentaires
gedId Bigint res_letterbox.res_id Numéro interne du courrier Maarch
tableName String res_letterbox Nom de la table Maarch dédiée au courrier
adrTableName String adr_x Nom de la table d'adresses Maarch
calledByWS Boolean true


Retour

Champ Type Champ Maarch Valeur attendue Commentaires
status Char (2) ok ou ko Si Maarch retrouve le document demandé renvoie OK, sinon KO
mime_type String Type mime du fichier
ext String Extension du fichier
file_content String Contenu du fichier encodé en base64
tmp_path String Chemin vers le répertoire temporaire du serveur Maarch (non utile ici)
file_path String Chemin vers le fichier sur le seveur Maarch (non utile ici)
called_by_ws Boolean (Non utile ici)
error String Si status = KO alors error contient le libellé de l'erreur


Exemple d'une requête SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:MaarchSoapServer">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:viewResource>
         <gedId>109</gedId>
         <tableName>res_letterbox</tableName>
         <adrTableName>adr_x</adrTableName>
         <calledByWS>true</calledByWS>
      </urn:viewResource>
   </soapenv:Body>
</soapenv:Envelope>