< Descriptif des entités

< API Partenaires

API Partenaire : Traitement de masse de vote de dossiers

Contexte

EN TANT QU’ Agent

JE PEUX disposer d’une documentation d’API sur le module « Traitement de masse »

AFIN DE pouvoir enregistrer une décision sur une liste de dossier

MGDIS met à disposition une API partenaire afin d’enregistrer la décision sur une liste de dossiers.

Module « Traitement de masse »

Route

L’accès au module Traitement de masse permet d’accéder aux routes ci dessous :

Lancement du traitement de masse de création de décision

URL

/pda-semi-public-api/api/tenants/{tenantId}/traitement-masse/creation-de-decision

Verbe

POST: Lancement du traitement de masse

Headers

Content-Type

application/json

Authorization

Basic login:mdp

Corps de la requête

CreateDecisionType

Code retour

Code de réponse	Description	Schéma de la réponse
201	Le traitement est lancé	CreateDecisionResponseType
400	Requête incorrecte
401	Non autorisé
403	L'utilisateur courant n'a pas les droits d'accéder à la ressource
500	Une erreur est survenue au niveau du serveur

Récupération du rapport d'un traitement de masse de création de décision

URL

/pda-semi-public-api/api/tenants/{tenantId}/traitement-masse/creation-de-decision/rapport/{referenceRapport}?{{offset}}&{{limit}}

Verbe

GET

Paramètres d'URL

Nom	Description	Obligatoire	Valeur par défaut
offset	Le nombre d'items du rapport à ignorer	non	0
limit	Le nombre d'items du rapport à récupérer	non	50

Par exemple avec offset=20 et limit=100 on va récupérer les 100 items après les 20 premiers.

Headers

Authorization

Basic login:mdp

Code retour

Code de réponse	Description	Schéma de la réponse
200	Rapport récupéré avec succès	ReportType
401	Non autorisé
403	L'utilisateur courant n'a pas les droits d'accéder à la ressource
404	Le rapport n'a pas été trouvé
500	Une erreur est survenue au niveau du serveur

Types des objets

CreateDecisionType

Le corps de la requête pour lancer un traitement de masse de création de décision devra respecter le schéma suivant CreationDecisionType :

Nom	Type	Contenu	Obligatoire	Exemple
referenceDossiers	Array<string>	La liste des références technique des dossiers à traiter	oui	["6Mh3gvHOv", "Fk7-6jWU_"]
avisDecision	string	La référence du type de décision (doit correspondre à la référence d'un type de décision paramétré sur Aiden)	oui	"FAVORABLE"
dateDecision	string	La date de la décision au format date ISO 8601 (AAAA-MM-JJ)	oui	"2024-02-14"

Exemple :

				
					{
    "referenceDossiers": ["6Mh3gvHOv", "Fk7-6jWU_"],
    "avisDecision": "FAVORABLE",
    "dateDecision": "2024-02-14"
  }

CreateDecisionResponseType

Lorsque la requête de création de décision est lancée avec succès, le corps de la réponse respecte le schéma suivant CreationDecisionType :

Nom	Type	Contenu	Exemple
reference	string	La référence du rapport du traitement en cours	"Q1v15rxmRv"

Exemple :

				
					{
    "reference": "Q1v15rxmRv"
  }

ReportType

Lorsque la requête de récupération d’un rapport du traitement de création de décision est lancée avec succès, le corps de la réponse respecte le schéma suivant ReportType :

Nom	Type	Contenu
report	ReportDetailType	Les détails du rapport
items	Array<ReportItemType>	La liste paginée des items du rapport
meta	MetaType	Les informations sur la pagination et sur la progression

Exemple :

				
					{
  "report":{
    "reference":"5RScECgSkUHUaKHXv7G5O",
    "referenceAdministrative":"TTM00000205",
    "status":"SUCCEEDED",
    "tenant":"test",
    "completion":100
  },
  "items":[
    {
      "entityReference":"dossier1",
      "status":"SUCCEEDED",
      "result":{
        "message":"Dossier 00000001-1 traité"
      }
    },
    {
      "entityReference":"dossier2",
      "status":"FAILED",
      "result":{
        "message":"No dossiers of financement exists with this reference : dossier2"
      }
    }
  ],
  "meta":{
    "errors":1,
    "processed":2,
    "total":2,
    "limit":50,
    "offset":0
  }
}

ReportDetailType

La structure ReportDetailType est détaillée ci-dessous :

Nom	Type	Contenu	Exemple
reference	string	La référence technique du rapport	"5RScECgSkUHUaKHXv7G5O"
referenceAdministrative	string	La référence administrative du rapport	"TTM00000205"
status	string	Le statut du rapport (SUCCEEDED, FAILED ou IN_PROGRESS)	"IN_PROGRESS"
tenant	string	Le tenant de l'environnement	"test"
completion	number	Le pourcentage d'avancement du traitement (de 0 à 100 quand le traitement terminé)	67

ReportItemType

Un item de rapport pour le traitement d’un dossier.

Nom	Type	Contenu	Exemple
entityReference	string	La référence technique du dossier traité	"5RScECgSkU"
status	string	Le statut du traitement du dossier (SUCCEEDED, FAILED)	"SUCCEEDED"
result	object	Le resultat contenant le message d'erreur ou de succès	{ "message": "Dossier 00000001-1 traité" }

MetaType

Les métadonnées sur la pagination et le rapport sont les suivantes :

Nom	Type	Contenu	Exemple
errors	number	Le nombre total de dossiers où le traitement a échoué	2
processed	number	Le nombre total de dossiers qui ont été traités.	10
total	number	Le nombre total de dossiers traités et à traiter	20
offset	number	Le nombre d'item ignoré avant les items retournés dans la requête	20
limit	number	Le nombre max d'items à retourner	100