telechargerDumeAvecPJ
DESCRIPTION
Market's place wants to retrieve one or a number of Economic Operator ESPD to analyse them. This operation permits to retrieve certifications which are obtained by "API entreprise", and potential economic operator's attachement.
ENVIRONNEMENTS
| Production's URL | https://api.aife.economie.gouv.fr/dume/dumeOE |
| Qualification's | https://sandbox-api.aife.economie.gouv.fr/dume/dumeOE |
Paramètres
PARAMETER
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://api.aife.economie.gouv.fr/dume/dumeA -d "{}"
Braces frame the JSON.
Complete description of input and output parameter
Input parameter :
| Input parameter | Optional (O) / Mandatory (M) | Management rules |
|---|---|---|
| operation | M | Constant = telechargerDumeavecPJ |
| typeIdPlateforme | F | 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 |
| 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. |
| pjUnitaire | O | The values for "pjUnitaire" are : - "01 ": attestationSociale - "02": attestationFiscale - "03" : OPQIBI - "04" : CNETP - "05" : Autre Pjunitaire indicate wish to obtain one attachement in particular among other. If parameter insn't informed, it will be renseigned on "true" by default |
| listeAttestation | M | If this parameter is informed, it permits to identified different ESPD available certificates. These certificates will be in information message |
| idDume | M | Functional ESPD ID - 8 random alphanumerical characters given by the ESPD Service |
Output parameter : Economic operator ESPD's Id and metadata which are associated.
{
"operation":"telechargerDumeAvecPJ",
"plateforme": {
"typeIdPlateforme":"1",
"idPlateforme":"33592022900036",
"idTechniquePlateforme":"azerty"
},
"idDemandeur":"12345678901012",
"rsDemandeur":"Testeur",
"idConsultation": "12345632165412",
"piecesJointes": "true",
"tousStatus": "true",
"listeAttestation": "true",
"format":"zip"
}
"response": {
"messageList": [
{
"type": "INFO",
"code": "MSG_US29_002",
"message": "Les attestations disponibles pour le dume n° udfknydy de l' operateur economique 42165412345685 sont les suivantes: []"
},
{
"type": "INFO",
"code": "MSG_US29_002",
"message": "Les attestations disponibles pour le dume n° yj8zobdx de l' operateur economique 32165412345685 sont les suivantes: []"
}
],
"archive":
"ZIPUUENCODE" }
}
