recupererDumeFormate
DESCRIPTION
La place de marché souhaite récupérer un Dume sous un format spécifique : XML, HTML ou PDF. Elle doit réaliser autant d’appel que de formats souhaités.
ENVIRONNEMENTS
| URL de Production | https://api.aife.economie.gouv.fr/dume/dumeA |
| URL de Qualification | https://sandbox-api.aife.economie.gouv.fr/dume/dumeA |
PARAMÈTRES
Paramètres du Header
| Donnée | Format | Facultatif / obligatoire |
|---|---|---|
| Certificat | Varchar | Obligatoire |
| Content-Type | Varchar | Obligatoire |
Exemple de header :
curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/dumeA -d "{}"
Les accolades encadrent le JSON.
Description complète des paramètres d'entrée et de sortie de l'API
| Paramètre d’entrée | Facultatif (F) / Obligatoire (O) | Règle de gestion |
|---|---|---|
| operation | O | constante =recupererDumeFormate |
| idDume | F (l'appel doit valoriser soit un XML soit un ID DUME) | ID DUME - 8 caractères alphanumériques aléatoires |
| Dume | F (l'appel doit valoriser soit un XML soit un ID DUME) | DUME A UUencode |
| format | O | Les valeurs pour « format de DUME » sont : - « 1 » : DUME PDF - « 2 » : DUME XML - « 3 » : DUME HTML - « 4 » : ZIP (PDF + XML) - « 0 » : PAS DE DUME Un seul « format de DUME » peut être renseigné. Une Place sollicitant plusieurs formats devra réaliser plusieurs appels. Seul le format concerné est retourné |
| plateforme | ||
| typeIdPlateforme | F | Les valeurs pour « type d’ID plateforme demandeuse » sont - « 1 » (Tiers avec SIRET) - « 2 » (Structure Européenne hors France) – TVA intracommunautaire - « 3 » (Structure hors UE) – Code pays + 16 premiers caractères raison sociale - « 4 » (RIDET) - « 5 » (Numéro Tahiti) |
| idPlateforme | O | 1/ Id fonctionnel du profil d'acheteur ayant sollicité le raccordement 2/ Le format de l’ID de la plateforme est contrôlé : - Si « type identifiant » est « 1 » : 14 caractères - Si « type identifiant » est « 2 » : 18 caractères maximum (soit 1 à 18 caractères) - Si « type identifiant » est « 3 » : 3 à 18 caractères - Si « type identifiant » est « 4 » : 9 ou 10 caractères - Si « type identifiant » est « 5 » : « 9 » caractères - Si « type identifiant » n’est pas renseigné, il est réputé s’agir d’un SIRET : 14 caractères 3/ L’ID technique de la plateforme et l’ID de la plateforme doivent exister en base de données et être positionnés sur la même ligne de cette base de données |
| idTechniquePlateforme | O | 1/ ID disponible sur l'espace "raccordement" de Chorus Pro. L'id technique correspond au code application partenaire contenu dans la fiche de raccordement 2/ L’ID technique de la plateforme et l’ID de la plateforme doivent exister en base de données et être positionnés sur la même ligne de cette base de données |
| idDemandeur | O | L'idDemandeur correspond au SIRET ou l'identifiant fonctionnel de l'entité qui fait la demande sur la place de marché. |
| rsDemandeur | O | Nom de l'entité qui fait la demande sur la place (Raison sociale) |
{
"operation": "recupererDumeFormate",
"rsDemandeur": "AIFE",
"idDemandeur": "12345698765445",
"plateforme": { "typeIdPlateforme": "1" , "idPlateforme":"33592022900036", "idTechniquePlateforme":"azerty"},
"dume": {"idDume":"amdhc8an"},
"format": "3"
}
{
"response": {
"dumeA": "DUMEHTMLuuencode",
"idStatutDume": "01",
"identifiantA": "12345678901236",
"lots": [],
"accessible": true
}
}
