FusionnerDumeAvecDonnesEntreprise
DESCRIPTION
The FusionnerDumeAvecDonnesEntreprise method (which translates as "Merge ESPD with company data") enables to meet two distinct needs:
- The buyer profile wishes to retrieve an Economic Operator ESPD template originating from a Buyer ESPD whose identification number or XML it has.
- The buyer profile wishes to retrieve an Economic Operator ESPD template originating from a Buyer ESPD whose identification number or XML it has, supplemented by the economic operator's public or private data.
Please note: In both cases, it is of course very important to communicate the Buyer ESPD identifier or XML prior to merging with the Economic Operator ESPD. The Type ID and ID OE ("ID type" and "Economic Operator ID") are optional when using this API.
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 |
Exemple de header :
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 parameters:
| Input parameter | M/O (Mandatory/ Optional) | Management rules |
|---|---|---|
| opération | M | Constant =FusionnerDumeAvecDonneesEntreprise |
| idDume | O | Functional ESPD ID - 6 random alphanumeric characters and In the output parameter, the Buyer ESPD ID must be provided or the Buyer ESPD's XML must be communicated. It is not possible to provide both the Buyer ESPD's ID and the XML and In the input parameter, the Economic Operator ESPD ID must be provided or the Economic Operator ESPD must be communicated. It is not possible to provide both the Economic Operator ESPD's ID and the XML |
| DUME A uuencode | O | UUENCODE XML in base64 |
| siretOE | M | Alphanumeric (1 to 18 characters) |
| typeDonnees | M | 1: published Economic Operator data 2: published and non published Economic Operator data If this parameter is not provided, it is deemed "1". |
| 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 positioned 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) |
Output parameters: Uuencoded in Base64 Economic Operator ESPD's XML and associated metadata.
{
"operation":"FusionnerDumeAvecDonneesEntreprise",
"idDemandeur":"12345678901011",
"rsDemandeur":"AIFE",
"plateforme":{
"typeIdPlateforme":"1",
"idPlateforme":"12345678901011",
"idTechniquePlateforme":"AAA001"
},
"siretOE":"38103128500491",
"typeDonnees":"1",
"dumeA": {
"idDume" : "1lm88fe6"
}
}
{
"operation":"FusionnerDumeAvecDonneesEntreprise",
"idDemandeur":"12315548545754",
"rsDemandeur":"AIFE",
"plateforme":{
"typeIdPlateforme":"1",
"idPlateforme":"12345678901011",
"idTechniquePlateforme":"AAA001"
},
"siretOE":"38103128500491",
"typeDonnees":"1",
"dumeA": {
"idDume" : "1lm88fe6"
}
}
{
"operation":"FusionnerDumeAvecDonneesEntreprise",
"idDemandeur":"12315548545754",
"rsDemandeur":"AIFE",
"plateforme":{
"typeIdPlateforme":"1",
"idPlateforme":"12345678901011",
"idTechniquePlateforme":"AAA001"
},
"siretOE":"38103128500491",
"typeDonnees":"1"
}
{
"operation":"FusionnerDumeAvecDonneesEntreprise",
"idDemandeur":"12315548545754",
"rsDemandeur":"AIFE",
"plateforme":{
"typeIdPlateforme":"1",
"idPlateforme":"12345678901011",
"idTechniquePlateforme":"AAA001"
},
}
{
"response": {
"messageList": [
{
"type": "INFO",
"code": "DUME-A_REMPLACE",
"message": "LE DUME 2 remplace le DUME 1lm88fe6 que vous avez sollicité pour fusion, conformément au souhait de l’acheteur "
},
{
"type": "INFO",
"code": "DLRO_DEPASSE",
"message": "Le DUME 2 a une DLRO dépassée. Veuillez contacter l’acheteur"
}
],
"dumeOE": {
"xmlDume": "xmluuencode",
}
}
}
