recupererDE
DESCRIPTION
When a buyer profile wants to retrieve the essential data contained in the DUME database, it must use the recover operationDE of the Essential Data API.
This operation allows the buyer profile to publish essential data without having to store it in database. In case the essential data is contained in the DUME Service database, they are returned in PDF, XML or HTML format, in addition to the JSON format.
This API retrieves all the essential data from the search criteria passed as an input parameter.
ENVIRONMENTS
Production URL | https://chorus-pro.gouv.fr:5443/service/dumes/donneesEssentielles |
Qualification URL | https://chorus-pro.gouv.fr:5443/service-qualif/dumes/donneesEssentielles |
PARAMETERS
Header parameters
Donnée | Format | Facultatif / obligatoire |
---|---|---|
Certificat | Varchar | Obligatoire |
Content-Type | Varchar | Obligatoire |
Header example :
curl -v -X POST --insecure --cert xxxxx.pem https://chorus-pro.gouv.fr:5443/service/dume/dumeA -d "{}"
Braces frame the JSON.
Complete description of the input and output parameters of the API
JSON IN :
Input parameter | Optional (O) / Mandatory (M) | Management rule |
---|---|---|
Operation | M | constant = recupererDE |
Publication start date | O | AAAA-MM-JJ format |
Publication end date | O | AAAA-MM-JJ format |
Type ID plateforme demandeuse | 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) |
ID Plateforme demandeuse | 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 |
Id technique plateforme | 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 |
Id Acheteur | O | Buyer SIRET: Alphanumeric (14 characters) |
Id consultation | O | Call for tenders ID, released by the platform which makes the request to record the ESPD - 14 alphanumerical characters |
refFonctionnelleConsultation | O | Same reference as in the ESPD |
Lot | O | 3 numerical characters |
ID Référence Unique marché | O | Alphanumerical (255 characters) |
ID Référence fonctionnelle DE | O | Alphanumerical (255 characters) |
Rs demandeur | O | Name of the entity which makes the request on the place (Corporate name) - 100 characters maximum |
Nature de marché (market nature) | O | Heading Code status: « 01 » - Contract (initial contract) « 02 » - Partnership contract « 03 » - Framework agreement « 04 » - Subsequent contract « 05 » - Reserved market « 06 » - other |
Type de procédure (procedure market) | O | Heading Code status: « 01 » - adapted procedure « 02 » - Open call for tenders « 03 » - Restricted call for tenders « 04 » - competitive procedure with negotiation « 05 » - negotiated procedure with a prior call for competition « 06 »- contract negotiated with no publication or prior call for competition « 07 » - competitive dialogue « 08 »- Competition « 09 » - Other |
Code CPV | O | 9 numerical characters |
Type de DE (ED type) | O | reference document |
Raison sociale du titulaire du marché | O | Holder's name Alphanumerical (255 characters) |
Type ID titulaire (type holder id) | O | The values 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) |
Id titulaire (holder id) | O | - 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 The type holder ID and the platform's ID must exist in database and be postioned on the same line as this database |
Format | O | 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. |
{
"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"
}
]
}