recupererDE
DESCRIPTION
Lorsqu’un profil d’acheteur souhaite récupérer les données essentielles contenues dans la base de données DUME, il doit avoir recours à l’opération recupererDE de l’API Données essentielles. Cette opération permet au profil d’acheteur de publier les données essentielles sans avoir à les stocker dans sa base de données. Dans le cas où les données essentielles sont contenues dans la base de données Service DUME, elles sont retournées au format PDF, XML ou HTML, en complément du format JSON.
Cette API récupère l’ensemble des données essentielles issues des critères de recherche passés en paramètre d’entrée.
ENVIRONNEMENTS
| URL de Production | https://api.aife.economie.gouv.fr/dume/donneesEssentielles |
| URL de Qualification | https://sandbox-api.aife.economie.gouv.fr/dume/donneesEsssentielles |
PARAMÈTRES
Paramètres du Header
| Donnée | Format | Facultatif / obligatoire |
|---|---|---|
| Certificat | Varchar | Obligatoire |
| Content-Type | Varchar | Obligatoire |
Exemple de header :
curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/donneesEssentielles -d "{}"
Les accolades encadrent le JSON.
Description complète des paramètres d'entrée et de sortie de l'API
JSON IN :
| Paramètre d'entrée | Obligatoire (O) / Facultatif (F) | Règle de gestion |
|---|---|---|
| Opération | O | Donnée fixe : recupererDE |
| Date de début publication | F | / Format : AAAA-MM-JJ / Au moins l’un des deux paramètres dateDebutPublication et dateFinPublication doivent être renseignés. Lorsque la référence fonctionnelle DE est renseignée, les paramètres dateDebutPublication et dateFinPublication deviennent entièrement facultatifs. |
| Date de fin publication | F | / Format : AAAA-MM-JJ / Au moins l’un des deux paramètres dateDebutPublication et dateFinPublication doivent être renseignés. Lorsque la référence fonctionnelle DE est renseignée, les paramètres dateDebutPublication et dateFinPublication deviennent entièrement facultatifs. |
| Plateforme | ||
| Type ID plateforme demandeuse | F | Les valeurs pour « type d’ID plateforme demandeuse / Type ID OE» sont - « 1 » (Tiers avec SIRET) - « 2 » (Structure Européenne hors France) – TVA intracommunautaire - « 3 » (Structure hors UE) – Code pays + 16 premiers caractères raison sociale - « 4 » (RIDET) - « 5 » (Numéro Tahiti) |
| ID Plateforme demandeuse | O | / Le format de l’ID / ID OE de la plateforme est contrôlé : - Si « type identifiant » est « 1 » : 14 caractères - Si « type identifiant » est « 2 » : 18 caractères maximum (soit 1 à 18 caractères) - Si « type identifiant » est « 3 » : 3 à 18 caractères - Si « type identifiant » est « 4 » : 9 ou 10 caractères - Si « type identifiant » est « 5 » : « 9 » caractères - Si « type identifiant » n’est pas renseigné, il est réputé s’agir d’un SIRET : 14 caractères / L’ID technique de la plateforme et l’ID de la plateforme doivent exister en base de données et être positionnés sur la même ligne de cette base de données |
| Id technique plateforme | O | / Alphanumérique (6 caractères) - ID disponible sur l'espace "raccordement" de Chorus Pro / L’ID technique de la plateforme et l’ID de la plateforme doivent exister en base de données et être positionnés sur la même ligne de cette base de données |
| Acheteur | ||
| Id Acheteur | F | / SIRET Acheteur : Alphanumérique (14 caractères) |
| Consultation | ||
| Id consultation | F | ID de la consultation, issu de la plateforme qui fait la demande d'enregistrement du DUME |
| refFonctionnelleConsultation | F | Même référence que dans le DUME |
| Lot | F | / Alphanumérique / Si la consultation n’est pas allotie, il n’est pas nécessaire de renseigner de lot. Pour une même consultation et un même lot, il est possible d’avoir n données essentielles (s’il y a n contrats) |
| Référence fonctionnelle DE | ||
| ID Référence Unique marché | F | Alphanumérique (255 caractères) |
| ID Référence fonctionnelle DE | F | / Alphanumérique (255 caractères) correspond à l’ID unique produit par SN DUME lors de l’enregistrement initial / Sur l’opération recupererDE, si l’ID référence fonctionnelle est renseigné en entrée, la DE correspondante est renvoyée quel que soit son statut de publication. Sans ID en entrée, seules les données au statut de publication True sont renvoyées. / Au moins l’un des deux paramètres dateDebutPublication et dateFinPublication doivent être renseignés. Lorsque la référence fonctionnelle DE est renseignée, les paramètres dateDebutPublication et dateFinPublication deviennent entièrement facultatifs. |
| Autres champs de recherche | ||
| Raison sociale acheteur | F | Alphanumérique 255 caractères |
| Nature de marché | F | Référentiel |
| Type de procédure | F | Référentiel |
| Code CPV | F | 8 caractères numériques |
| Type de DE | F | Référentiel |
| Raison sociale du titulaire du marché | F | Alphanumérique 255 caractères |
| Type ID titulaire | F | Les valeurs pour « type d’ID plateforme demandeuse / Type ID OE» sont - « 1 » (Tiers avec SIRET) - « 2 » (Structure Européenne hors France) – TVA intracommunautaire - « 3 » (Structure hors UE) – Code pays + 16 premiers caractères raison sociale - « 4 » (RIDET) - « 5 » (Numéro Tahiti) |
| Id titulaire | F | Le format de l’ID / ID OE de la plateforme est contrôlé : - Si « type identifiant » est « 1 » : 14 caractères - Si « type identifiant » est « 2 » : 18 caractères maximum (soit 1 à 18 caractères) - Si « type identifiant » est « 3 » : 3 à 18 caractères - Si « type identifiant » est « 4 » : 9 ou 10 caractères - Si « type identifiant » est « 5 » : « 9 » caractères - Si « type identifiant » n’est pas renseigné, il est réputé s’agir d’un SIRET : 14 caractères |
| Format | ||
| Format | F | / Les valeurs pour « format de DUME / format de donnée essentielle » sont : - « 1 » : métadonnées + PDF - « 2 » : métadonnées + XML - « 3 » : métadonnées + HTML - « 4 » : métadonnées + XML + PDF - « 0 » : métadonnées Sinon, message ": "Le champ format ne correspond pas aux valeurs prédéfinies [0, 1, 2, 3,4]" / Considéré à « 0 » si non renseigné |
{
"operation": "recupererDE",
"rsDemandeur": "EntrepriseX",
"idDemandeur": "38103128500491",
"plateforme":
{
"typeIdPlateforme": "1",
"idPlateforme": "33592022900036",
"idTechniquePlateforme": "azerty"
},
"idConsultation": "11223344556677",
"refFonctionnelleConsultation": "reference consultation X",
"lot" : "1",
"dateDebutPublication": "2018-07-12",
"dateFinPublication": "2018-12-12",
"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",
"typeDE":"MP",
"format" : "1",
"id": "2018123456789100",
"acheteur":
{
"id": "13001977100018",
"nom": "Acheteur"
},
"nature": "Marche",
"codeCPV": "12345678",
"procedure": "Appel d'offres ouvert",
"titulaires":
[
{
"typeIdentifiant": "TVA",
"id": "FR21483209000",
"denominationSociale": "Entreprise1"
},
{
"typeIdentifiant": "RIDET",
"id": "1234567000",
"denominationSociale": "Entreprise2"
}
]
}
{
"operation": "recupererDE",
"rsDemandeur": "Entreprise X",
"idDemandeur": "38103128500491",
"plateforme":
{
"typeIdPlateforme": "1",
"idPlateforme": "33592022900036",
"idTechniquePlateforme": "azerty"
},
"idConsultation": "11223344556677",
"refFonctionnelleConsultation": "reference consultation X",
"lot" : "1",
"dateDebutPublication": "2017-07-13",
"dateFinPublication": "2020-07-13",
"refFonctionnelleDE": "A REMPLIR APRES LA CREATION DE",
"typeDE":"CC",
"format" : "1",
"id": "2018123456789100",
"autoriteConcedante":
{
"id": "13001977100018",
"nom": "AcheteurX"
},
"nature": "Concession de travaux",
"procedure": "Procedure negociee ouverte",
"concessionnaires":
[
{
"typeIdentifiant": "SIRET",
"id": "79858993300018",
"denominationSociale": "Entreprise1"
}
]
}
