Skip to main content

Création d’un dossier financier avec l’API

Pour créer un dossier financier avec l’API, il faut réaliser une requête API avec les éléments suivants :

  • Utiliser la méthode POST
  • L’url de l’environnement concerné (le chemin doit se positionner sur donnees_dossier_fi)
  • Le header de la requête doit posséder le champ Static-Token correctement valorisé (le token
    doit posséder les droits d’écritures)
  • Le corps de la requête doit être en format JSON et contenir les champs suivants
    • donnees_dossier_fi_Email_collaborateur
    • donnees_dossier_fi_Email_signataire -> responsable du bureau
    • donnees_dossier_fi_Libelle_bureau
    • donnees_dossier_fi_Libelle_trame  -> DOSSIER->type  -> toujours OGEC (dans un premier temps)
    • donnees_dossier_fi_Donnees_Json_Compressed -> voir Modèle détaillé


Après la soumission de la requête, une réponse sera renvoyée par le serveur et les champs
exploitables sont les suivants :

  • l’erreur (avec son numéro et son commentaire) si jamais des champs sont manquant dans le
    corps de la requête ou des catégorie de donnée manquant dans le champ
    « donnees_dossier_fi_Donnees_Json_Compressed »
  • les données de retour de la requête, utile si jamais aucune erreur empêchant la création du
    dossier n’a été détectées et se trouvant à l’intérieur :
    • l’id du donnees_dossier_fi créé (pour revoir les détails de la requête)
    • le code du dossier financer créé (pour accéder au dossier financier)
    • les logs des tests sur le modèle JSON fourni (si des éléments sont inconnus dans la BDD et
      dans quel section les trouver)