RecupererDumeFormate
DESCRIPTION
The RécupérerDumeFormate ("Retrieve ESPD format") method enables to retrieve an ESPD in PDF, HTML or XML formats as well as the associated metadata, on the basis of the identifier or this ESPD's XML.
ENVIRONMENTS
| Production URL | https://api.aife.economie.gouv.fr/dume/dumeOE |
| Qualification URL | https://sandbox-api.aife.economie.gouv.fr/dume/dumeOE |
PARAMETERS
Header Parameters
| Data | Format | Optional / mandatory |
|---|---|---|
| Certificate | Varchar | Mandatory |
| Content - Type | Varchar | Mandatory |
Header example
curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/dumeOE -d "{}"
The braces frame the JSON
Complete description of the API’s input and output parameters
Input and output parameters
| Input parameter | M/O (Mandatory / Optional) | Management rules |
|---|---|---|
| operation | M | Constant =recupererDumeFormate |
| idDume | O | Functional ESPD ID - 8 random alphanumerical characters given by the ESPD Service |
| format | M | The values for "ESPD format" are: - « 1 » : DUME PDF ("PDF ESPD") - « 2 » : DUME XML (XML ESPD - « 3 » : DUME HTML (HTML ESPD) - « 0 » : PAS DE DUME (NO ESPD) Only one "ESPD format" can be provided. A Place requesting multiple formats will have to make multiple calls. Only the concerned format is returned. |
| platform | ||
| typeIdPlateforme | O | The values for « type d’ID plateforme demandeuse » (which means "requesting platform ID type") are: - « 1 » (Third party with SIRET number) - « 2 » (European structure outside of France) – intracommunity VAT - « 3 » (Structure outside of the EU) – Country code + first 16 corporate name characters - « 4 » (RIDET) - « 5 » (Tahiti Number) |
| idPlateforme | M | 1/ Functional Id of the buyer profile which requested the connection 2/ The ID format of the platform is controled: - If « identification type » is « 1 » : 14 characters - If « identification type » is « 2 » : 18 characters maximum (1 to 18 characters) - If « identification type » is « 3 » : 3 to 18 characters - If « identification type » is « 4 » : 9 ou 10 characters - If « identification type » is « 5 » : « 9 » characters - If « identification type » is not provided, it is deemed to be a SIRET: 14 characters 3/ The platform's technical ID and the platform's ID must exist in database and be postioned on the same line as this database |
| idTechniquePlateforme | M | 1/ ID available on the Chorus Pro "connection" space. The technical ID corresponds to the partner application code contained in the connection form. 2/ The platform's technical ID and the platform's ID must exist in database and be postioned on the same line as this database |
| idDemandeur | M | The idDemandeur (which means "requester ID") corresponds to the SIRET number or functional identifier of the public entity that makes the request on the marketplace. - 1 to 18 characters |
| rsDemandeur | M | Name of the entity which makes the request on the place (Corporate name) - 100 characters |
Output parameters: ESPD in the requested format, and associated metadata
{
"dume":{"idDume":"xxxxxxx"},
"operation": "recupererDumeFormate",
"format": "2",
"plateforme": { "idPlateforme": "33592022900036", "idTechniquePlateforme":"azerty" },
"idDemandeur": "12345678901239",
"rsDemandeur": "aife"
}
"response": {
"dumeOE": "DUMEOEuuencode",
"typeIdOE": "1",
"idStatutDume": "01",
"idTypeProcedure": "01",
"idTypeMarche": "01",
"idNatureMarche": "01",
"idConsultation": "4578524851447",
"libelleConsultation": "libconsult",
"refFonctionnelleConsultation": "consultation_DumeA_ii12dfs9",
"DLRO": 1524507943511,
"Lots": [
{
"lotId": 80,
"libelle": "super lot"
}
],
"idFonctionnelOE": "32165412345685",
"typeReponse": "1",
"siretNP1": 37
}
}
