Introduction Guide de l'utilisateur Guide administrateur fonctionnel Guide administrateur technique Installation Prérequis pour Maarch Parapheur Exploitation Architecture technique Description du modèle de données Description des webservices Utilisateurs Documents

Main Documents

Envoi d'un document dans le parapheur

Route

POST /rest/documents

Paramètres

Body
Valeur Type Obligatoire Description
title string Oui Titre du document
reference string Non Référence du document
description string Non Description du document
mode string Oui Mode du document ('NOTE' ou 'SIGN')
encodedDocument base64 Oui Fichier PDF compressé au format zip encodé en base64
processingUser string Oui Login de l'utilisateur qui traitera le document dans le parapheur ("users.login")
sender string Oui Prénom Nom de l'expéditeur
deadline date Non Date limite de traitement du document
attachments array Non Pièces jointes liées au document. Exemple : '[{"title":"test", "encodedDocument": "REUGFMLLlpxjeoikjcxoe668v"}]'
metadata array Non Données additionelles affichées dans l'interface. Exemple : '{"Entité émettrice" : "DGA", "Destinataire" : "M. Macron", "Priorité" : "Urgent"}'

Le tableau attachments peut contenir 1 à N pièces jointes. Chaque pièce jointe représente une case de ce tableau.

Exemple
// JSON
{
    "title" : "Réponse pétition",
    "reference" : "2019/REF/1",
    "description" : "Pétition sur l'écologie",
    "mode" : "SIGN",
    "encodedDocument": "JVBERi0xLjQgLi4u",
    "processingUser" : "PN256789",
    "sender" : "Nicolas Hulot",
    "deadline" : "2019-02-25",
    "attachments" : [
        {
            "title" : "Attestation des fonds marins",
            "encodedDocument" : "deJOIJKiSDYUIfolpcdm",
            "reference": "MAARCH/2019A/21"
        },
        {
            "title" : "Falsification des données de pêche",
            "encodedDocument" : "REUGFMLLlpxjeoikjcxoe668v"
        }
    ],
    "metadata" : {
        "Entité émettrice" : "DGA",
        "Destinataire" : "M. Macron",
        "Priorité" : "Urgent"
    }
}

Retour

Code Http Type Description Exemple
200 array Le document a bien été créé ['id' => 123]
400 array Un paramètre obligatoire est manquant ['errors' => '...']
500 array Une erreur s'est produite ['errors' => '...']

Récupération du status d'un document

Route

GET /rest/documents/{id}/status

Le paramètre id de la route représente l'identifiant (int) du document

Retour

Code Http Type Description
200 array Informations du document
400 array Message d'erreur
403 array Document hors périmètre
Données
Valeur Type Description
id int Identifiant technique
reference string Référence du status
label string Libellé du status
mode string Mode du document ('NOTE' ou 'SIGN')
Exemple
// JSON
{
    "status": {
        "id": 2,
        "reference": "VAL",
        "label": "Validé",
        "mode": "NOTE"
    }
}

Récupération du document signé/annoté

Route

GET /rest/documents/{id}/processedDocument

Le paramètre id de la route représente l'identifiant (int) du document

Retour

Code Http Type Description
200 array Informations du document
400 array Message d'erreur
403 array Document hors périmètre
404 array Message d'erreur
Données
Valeur Type Description
encodedDocument base64 Document encodé en base64

Si le document n'a pas été annoté ou signé, 'encodedDocument' vaudra null.

Exemple
// JSON
{
    "encodedDocument": "JVBERi0x...",

}

Récupération des informations d'un document

Route

GET /rest/documents/{id}

Le paramètre id de la route représente l'identifiant (int) du document

Retour

Code Http Type Description
200 array Informations du document
400 array Message d'erreur
Données
Valeur Type Description
id int Identifiant technique du document
title string Titre du document
reference string Référence externe du document
description string Description du document
status json Informations sur le statut du document
sender string Prénom Nom de l'expéditeur
creationDate date Date de création du document
modificationDate date Date de dernière modification du document
actionsAllowed array Actions possibles sur le document
processingUser string Login de l'utilisateur devant annoter/signer le document ("users.login")
processingUserDisplay string Prénom Nom de l'utilisateur devant traiter le document ("users.firstname users.lastname")
encodedDocument base64 Document encodé en base64
deadline date Date limite de traitement du document
attachments array Identifiants des pièces jointes liées au document
metadata json Données additionelles du document. Exemple : '{"Entité émettrice" : "DGA", "Destinataire" : "M. Macron", "Priorité" : "Urgent"}'
Exemple
// JSON
{
    "document": {
        "id": 1,
        "title": "Réponse pétition",
        "reference": "2019/REF/1",
        "description": "Pétition sur l'écologie"
        "status": {
            "id": 2,
            "reference": "VAL",
            "label": "Validé",
            "mode": "NOTE"
        }

        "sender": "Nicolas Hulot",
        "creationDate": "2019-01-05 17:12:10.049202",
        "modificationDate": "2019-01-06 17:12:10.049202",
        "actionsAllowed": [1, 3, 6],
        "processingUser": "PNAZERT",
        "processingUserDisplay": "Jenny JANE",
        "creatorId" : "PNPOPIO",
        "creatorDisplayName" : "Charly CHARLES",
        "encodedDocument": "JVBERi0x...",
        "deadline": "2019-03-05",
        "attachments": [2, 4],
        "metadata" : {
            "Entité émettrice" : "DGA",
            "Destinataire" : "M. Macron",
            "Priorité" : "Urgent"
        }
    }
}

Récupération de l'historique d'un document

Route

GET /rest/documents/{id}/history

Le paramètre id de la route représente l'identifiant (int) du document

Retour

Code Http Type Description
200 array Informations du document
400 array Message d'erreur
403 array Document hors périmètre
Données
Valeur Type Description
code string Code du message: OK ou KO
userLogin string Identifiant de l'utilisateur ayant fait l'action
date date Date de l'action
type string Type d'action effectuée
message string Message de l'action
data array Informations complémentaires concernant l'action
Exemple
// JSON
{
    "history": [
        {
            "code": "OK",
            "userLogin": "PN23546",
            "date": "01-05-2019 17:12",
            "type": "CREATION",
            "message": "Document added : Réponse pétition",
            "data": []
        },
        {
            "code": "OK",
            "userLogin": "PN23546",
            "date": "01-05-2019 17:32",
            "type": "VIEW",
            "message": "Document viewed : Réponse pétition",
            "data": []
        }
    ]
}

results matching ""

    No results matching ""