Contexte
EN TANT QU’ Agent
JE PEUX disposer d’une documentation d’API sur le module « dossiersFinanciersExternes »
AFIN DE pouvoir récupérer un document lié à une demande associée à un dossier financier externe
Routes
L’accès au module des dossiers Financiers Externes- mise à jour du statut d’une liquidation permet d’accéder à la route ci dessous :
| Action | Méthode | Path | Schéma du body de la requête | Schéma du body de la réponse |
|---|---|---|---|---|
| Mise à jour du statut d’une liquidation | POST | /api/tenants/{tenantId}/dossiers-financiers-externes/recuperer-documents-lies-a-une-liquidation | RecupererDocumentsType | fichier zip |
Types des objets
Requêtes
Récupération des documents
Le corps de la requête de récupération des documents devra respecter le schéma suivant RecupererDocumentsType :
| Nom | Type | Contenu | Obligatoire | Exemple |
|---|---|---|---|---|
| typeGestionFinanciere | string | Type de la Gestion Financière | X | Enumeration parmi : « grand-angle » « astre » « coriolis4 » « coriolis5 » « esedit-filien » « generique » |
| codeCollectivite | string | Code de la collectivité | X | 01 |
| codeBudget | string | Code du budget | X | 01 |
| referenceGestionFinanciere | string | Référence liquidation de la Gestion Financière | X | ReferenceLiquidation |
| documentsIds | Array<string> | Liste des « object id » des documents que l’on veut récupérer. La liste est entre crochets. Chaque « objectId » est entre guillemets. Les différents « objectIds » sont séparés par une virgule | X | [« document1 », « document2 »] |
Exemple :
{
"typeGestionFinanciere": "generique",
"codeCollectivite": "01",
"codeBudget": "01",
"referenceGestionFinanciere": "ReferenceLiquidation",
"documentsIds": ["document1", "document2"]
}Valeurs retournées
La requête retourne un binaire correspondant à un fichier zip.
Par défaut le fichier est nommé suivant l’heure à laquelle la requête a été traitée: Documents_YYYY_MM_DD_hh_mm_ss avec:
– YYYY: année sur 4 chiffres
– MM: mois sur 2 chiffres
– DD: jour sur 2 chiffres
– hh: heure sur 2 chiffres
– mm: minutes sur 2 chiffres
– ss: secondes sur 2 chiffres
Ce fichier contient:
– les documents demandés, identifiés par l’id cmis qui a été passé dans le corps de la requête. Ces documents peuvent être: la notification de décision, les pièces justificatives de la décision et celles liées au paiement.
– un fichier report.json qui liste pour chaque document:
- l’id cmis du document (idcmis)
- si l’export a réussi ou non (status: OK / KO)
- le nom originel du document (name)
- l’erreur de récupération du document s’il y lieu (error)