API Partenaires GRU Publik : Récupération des tiers et des demandes associés à un compte OiDC

Contexte

EN TANT QU’ intégrateur Entr’ouvert

JE PEUX récupérer les tiers et les demandes associés à un compte OiDC

AFIN DE restituer cette information aux usagers Publik.

L’accès à ces API est sécurisé avec la création d’un compte de service personnalisé (une demande est à soumettre auprès de votre chef de projet MGDIS).

Route

Types des objets

Réponse

Récupérer des demandes d’un tiers d’un compte

La réponse d’une route de lecture respectera le schéma suivant, avec la propriété « data » qui est positionnée avant la propriété « err » :

Exemple :

{
    "data": {
    "tiers": [
      {
        "id": "gHbRCJMeW",
        "text": "ASSOCIATION DE TEST",
        "referenceAdministrative": "00000012",
        "raisonSociale": "ASSOCIATION DE TEST",
        "SIRET": "78748657656543",
        "RNA": "W881984090",
        "adresse": "32 RUE DE LA FONTAINE 44000 NANTES FRANCE",
        "mail": "martinm02@yopmail.com",
        "telephone": "00 00 00 00 00",
        "site": "http://www.asso-test.com",
        "status": {
          "id": "SUPPORTED",
          "text": "Valide"
        },
        "famille": {
          "id": "75",
          "text": "Association"
        },
        "demandes": [
          {
            "id": "6Mh3gvHOv",
            "text": "Dépot d'aide à l'analyse produit - ASSOCIATION DE TEST",
            "datetime": "2022-07-01T13:16:43.762Z",
            "form_number": "00000004",
            "url": "http://mgdis-ftc-dev6.mgdis.ovh/aides/#/saintandre/connecte/dashboard/6Mh3gvHOv/recapitulatif",
            "form_status_is_endpoint": false,
            "draft": false,
            "action_usager": false,
            "compte_demandeur": true,
            "tiers_beneficiaire": false,
            "status": {
              "id": "SUPPORTED",
              "text": "Prise en charge"
            },
            "teleservice": {
              "id": "F_DEMOTEST",
              "text": "Aide à l'analyse produit"
            }
          },
          {
            "id": "3TGErwL9F",
            "text": "Dépot d'aide à l'analyse produit 2 - ASSOCIATION DE TEST",
            "datetime": "2022-07-01T13:16:43.762Z",
            "form_number": "00000005",
            "url": "http://mgdis-ftc-dev6.mgdis.ovh/aides/#/saintandre/connecte/dashboard/3TGErwL9F/recapitulatif",
            "form_status_is_endpoint": false,
            "draft": false,
            "action_usager": false,
            "compte_demandeur": true,
            "tiers_beneficiaire": false,
            "status": {
              "id": "SUPPORTED",
              "text": "Prise en charge"
            },
            "teleservice": {
              "id": "F_DEMOTEST",
              "text": "Aide à l'analyse produit"
            }
          }
        ]
      },
      {
        "id": "I9fMm7fV5",
        "text": "Madame Marie MARTIN",
        "referenceAdministrative": "00000011",
        "adresse": "18, rue Emile Zola 44000 NANTES FRANCE",
        "mail": "martinm02@yopmail.com",
        "telephone": "00 00 00 00 00",
        "status": {
          "id": "SUPPORTED",
          "text": "Valide"
        },
        "famille": {
          "id": "01",
          "text": "Particulier"
        },
        "demandes": [
          {
            "id": "B1FTQ_nc9",
            "text": "Bourse au mérite - Marie MARTIN",
            "datetime": "2022-07-01T13:16:43.762Z",
            "form_number": "00000006",
            "url": "http://mgdis-ftc-dev6.mgdis.ovh/aides/#/saintandre/connecte/dashboard/B1FTQ_nc9/recapitulatif",
            "form_status_is_endpoint": false,
            "draft": false,
            "action_usager": false,
            "compte_demandeur": true,
            "tiers_beneficiaire": false,
            "status": {
              "id": "SUPPORTED",
              "text": "Prise en charge"
            },
            "teleservice": {
              "id": "BRMIE",
              "text": "Bourse au mérite"
            }
          }
        ]
      },
      {
        "id": "hal7Er7Gr",
        "text": "ENTREPRISE DE TEST",
        "referenceAdministrative": "00001693",
        "raisonSociale": "ENTREPRISE DE TEST",
        "SIRET": "87198798700009",
        "adresse": "45 RUE ALSACE LORRAINE 44000 NANTES FRANCE",
        "mail": "martinm02@yopmail.com",
        "telephone": "00 00 00 00 00",
        "site": "http://www.entreprise-test.com",
        "status": {
          "id": "TRANSMITTED",
          "text": "Transmis"
        },
        "famille": {
          "id": "02",
          "text": "Entreprise"
        },
        "demandes": [
          {
            "id": "rkMLTtlK5",
            "text": "Dépot d'aide à l'analyse produit - ENTREPRISE DE TEST",
            "datetime": "2023-01-02T15:46:43.652Z",
            "form_number": "00000076",
            "url": "http://mgdis-ftc-dev6.mgdis.ovh/aides/#/saintandre/connecte/dashboard/rkMLTtlK5/recapitulatif",
            "form_status_is_endpoint": false,
            "draft": false,
            "action_usager": false,
            "compte_demandeur": true,
            "tiers_beneficiaire": false,
            "status": {
              "id": "TRANSMITTED",
              "text": "Transmis"
            },
            "teleservice": {
              "id": "F_DEMOTEST",
              "text": "Aide à l'analyse produit"
            }
          }
        ]
      }
    ]
  }
"err": 0,
}

Précisions sur la réponse dans la propriété « err_desc »

Il y a 3 cas où l’erreur ne pourra pas être transmise dans cette propriété « Err_desc » car elles sont gérées dans un module générique avant l’appel de l’API GRU. Ces erreurs sont renvoyées directement, sans avoir la réponse « data » ou « err » et « err_desc » :

• L’erreur 500 : le service ne répond pas
• L’erreur 404 quand le tenant de l’url n’est pas correct, on aura directement la réponse technique à la racine de la réponse, sans avoir err : 0 et err_desc

         {« code »: « ERR_NOT_FOUND », »message »: « No tenant with this id \ »a\ » found. »}

• Et l’erreur 401 contenant Unauthorized avec une mauvaise authentification
• le compte existe mais n’a pas le bon rôle ou n’est pas dans le bon groupe : erreur 403 « 
  

  Unauthorized

Par contre, les autres erreurs notamment « métiers » seront bien restituées dans « err_desc ».

Exemple :

Si l’identifiant d’un compte usager OIdC n’est pas renseigné alors le message remonté dans la propriété err_desc est :

• L’identifiant du compte est obligatoire. La récupération des demandes par tiers du compte est impossible.

La route d’API renvoie un tableau vide dans les cas suivants si le compte n’existe pas.