Introduction Glossaire Guide utilisateur Guide administrateur fonctionnel Guide administrateur technique Prérequis pour Maarch Courrier Installation Script de migration Exploitation Mise en oeuvre de docker Architecture technique Architecture du produit Architecture d'un projet type Description du modèle de données Description des webservices Contacts Resources

Resources

Création d'un courrier

Route

POST /rest/resources

Paramètres

Body

Valeur	Type	Obligatoire	Description
status	string	Oui	Statut du courrier
format	string	Oui	Format du fichier transmit
encodedFile	base64	Oui	Fichier encodé en base64
type_id	int	Oui	Type du courrier (type_id lié à la table "doctypes")
category_id	string	Oui	Catégorie du courrier (incoming, outgoing...)
chrono	boolean	Non	Si true, un numéro chrono sera généré (false par défaut)

A ces champs obligatoires peuvent s'ajouter les différentes colonnes des tables res_letterbox et mlb_coll_ext visibles ici.

Exemple

Enregistrement d'un courrier entrant d'une priorité normale à destination du service "Pôle jeunesse et sport (PJS)" ayant pour sujet "Un courrier à enregistrer" :

// JSON
{
    "status" : "COU",
    "format" : "PDF",
    "encodedFile": "JVBERi0xLjQgLi4u",
    "type_id" : 102,
    "category_id" : "incoming",
    "subject" : "Un courrier à enregistrer",
    "nature_id" : "simple_mail",
    "destination" : "PJS",
    "priority" : 2
}

Depuis Maarch Capture cela donnerait le paramétrage :

<process name="MaarchRestWSProcessFromScan">
    <loop xpath="/Batch/Documents/Document">
        <call name="/resources" method="POST">
            <argument type="entity" name="encodedFile" eval="base64_encode(file_get_contents($Element-&gt;path))"/>
            <argument type="entity" name="type_id">102</argument>
            <argument type="entity" name="destination">PJS</argument>
            <argument type="entity" name="priority">2</argument>
            <argument type="entity" name="category_id">incoming</argument>
            <argument type="entity" name="format" attribute="extension"/>
            <argument type="entity" name="status">INIT</argument>
            <return>
                <resId metadata="resId" />
            </return>
        </call>
    </loop>
</process>

Retour

Code Http	Type	Description	Exemple
200	array	Le courrier a bien été créé	['resId' => 123]
`400`	array	Un paramètre obligatoire est manquant	['errors' => 'Data is not set or empty']
`500`	array	Une erreur s'est produite	['errors' => '[ResController create] ...']

Documentation Maarch Courrier