recupererIdDE (retrieve ED Id)
DESCRIPTION
When a buyer profile wishes to retrieve the identifier(s) of the essential data associated with a lot and a consultation, it must resort to recupererIdDE operation of the Essential Data API.
The marketplace is informed if the data has been modified or not by a message.
ENVIRONMENTS
| Production URL | https://chorus-pro.gouv.fr:5443/service/dumes/donneesEssentielles |
| Qualification URL | https://chorus-pro.gouv.fr:5443/service/dumes/donneesEssentielles |
PARAMETERS
Header parameter
| 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 = recupererIdDE |
| rsDemandeur | M | Name of the entity which makes the request on the place (Corporate name) - 100 characters maximum |
| 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 |
| idConsultation | 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 |
| Numéro Lot (lot number) | O | 3 numerical characters |
| Acheteur (buyer) | O | Buyer SIRET: Alphanumeric (14 characters) |
| 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 |
| dateDebutPublication | O | YYYY-MM-DDTHH :MM :SS format |
| dateFinPublication | O | YYYY-MM-DDTHH :MM :SS format |
| ID Référence Unique marché | O | Alphanumerical (255 characters) |
JSON OUT :
| Output parameter | Optional (O) / Mandatory (M) | Management rule |
|---|---|---|
| ID Référence Unique marché | O | Alphanumerical (255 characters) |
| Référence fonctionnelle DE | M | Alphanumerical |
| Témoin publiable | M | True/False |
{
"operation": "recupererIdDE",
"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",
"id":"2018123456789100",
"acheteur":
{
"id": "13001977100018"
}
}
{
"operation": "recupererIdDE",
"rsDemandeur": "EntrepriseX",
"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",
"id": "2018123456789100",
"autoriteConcedante":
{
"id": "13001977100018"
}
}
