WS utiles

WS utiles
Sommaire
• 1 Web Services utiles
♦ 1.1 Envoi d'un courrier et de ses métadonnées dans Maarch
◊ 1.1.1 Fonctionnalité attendue
◊ 1.1.2 Paramètres en entrée
◊ 1.1.3 Retour
◊ 1.1.4 Exemple d'une requête SOAP
♦ 1.2 Envoi des métadonnées spécifiques au courrier dans Maarch
◊ 1.2.1 Fonctionnalité attendue
◊ 1.2.2 Paramètres en entrée
◊ 1.2.3 Retour
◊ 1.2.4 Exemple d'une requête SOAP
♦ 1.3 Envoi d'une pièce jointe dans Maarch
◊ 1.3.1 Fonctionnalité attendue
◊ 1.3.2 Paramètres en entrée
◊ 1.3.3 Retour
◊ 1.3.4 Exemple d'une requête SOAP
♦ 1.4 Demande de visualisation d'un courrier
◊ 1.4.1 Fonctionnalité attendue
◊ 1.4.2 Paramètres en entrée
◊ 1.4.3 Retour
◊ 1.4.4 Exemple d'une requête SOAP
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
encodedFile
data
collId
table
fileFormat
Type
Champ Maarch
String Stocké dans le docserver
Array *
String
String
String format
Valeur attendue
letterbox_coll
res_letterbox
PDF
status
String status
ATT
Commentaires
Chaîne de caractères contenant le courrier à ajouter encodée en base64
Un tableau complexe comprenant les métadonnées du courrier
Nom de la collection courrier
Table cible de la collection courrier
Format du fichier
Statut du courrier
Retour
Champ
Type
Champ Maarch Valeur attendue
Commentaires
Code retour.
returnCode Integer
resId
BigInt res_id
error
String
Exemple d'une requête SOAP
0 si OK
Si <> 0 alors erreur
Identifiant unique du courrier dans Maarch
Si status = KO alors error contient le libellé de l'erreur
<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>[email protected]</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 cible de l'extension de la collection courrier
table
String
mlb_coll_ext
Retour
Champ
Type
Champ Maarch Valeur attendue
Commentaires
Code retour.
returnCode Integer
resId
BigInt
error
String
0 si OK
res_id
Si <> 0 alors erreur
Identifiant unique du courrier dans Maarch
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
resId
collId
encodedFile
fileFormat
Type
Champ Maarch
Bigint res_id
String
String Stocké dans le docserver
String format
title
String title
Valeur attendue
letterbox_coll
PDF
Commentaires
Identifiant unique du courrier principal dans Maarch
Nom de la collection courrier
Chaîne de caractères contenant la pièce jointe à ajouter encodée en base64
Format du fichier
Titre de la pièce jointe
Retour
Champ
Type
Champ Maarch Valeur attendue
Commentaires
Code retour.
returnCode Integer
resId
error
BigInt
String
0 si OK
Si <> 0 alors erreur
Identifiant unique de la pièce jointe dans Maarch
Si status = KO alors error contient le libellé de l'erreur
res_id
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
gedId
tableName
adrTableName
calledByWS
Retour
Champ
Type
Champ Maarch
Valeur attendue
Commentaires
Bigint
res_letterbox.res_id
Numéro interne du courrier Maarch
String
res_letterbox
Nom de la table Maarch dédiée au courrier
String
adr_x
Nom de la table d'adresses Maarch
Boolean
true
Type
status
Char (2)
mime_type
ext
file_content
String
String
String
tmp_path
String
file_path
called_by_ws
error
String
Boolean
String
Champ Maarch
Valeur attendue
ok ou ko
Commentaires
Si Maarch retrouve le document demandé renvoie OK,
sinon KO
Type mime du fichier
Extension du fichier
Contenu du fichier encodé en base64
Chemin vers le répertoire temporaire du serveur Maarch
(non utile ici)
Chemin vers le fichier sur le seveur Maarch (non utile ici)
(Non utile ici)
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>