RecupererLibellesDUME
DESCRIPTION
This function enables the buyer profile to retrieve the ESPD form labels. The labels are sworn by the DAJ ("Legal affairs directorate"). They are available in two languages (French and English).
This API enables to make sure that all buyer profiles use the same labels for the same fields and, furthermore, enables to automatically impact the potential label changes in one's buyer profile.
ENVIRONMENTS
| Production URL | https://api.aife.economie.gouv.fr/dume/referentiels/ |
| Qualification URL | https://sandbox-api.aife.economie.gouv.fr/dume/referentiels |
PARAMETERS
Header parameters
| Data | Format | Optional / mandatory |
|---|---|---|
| Certificate | Varchar | Mandatory |
| Content - Type | Varchar | Mandatory |
Header example:
curl -v -X POST --insecure --cert xxxxx.pem https://api.aife.economie.gouv.fr/dume/referentiels -d "{}"
The braces frame the JSON.
Complete description of the API's input and output parameters
| Input parameter | Mandatory (M) / Optional (O) | Management rule |
|---|---|---|
| platform | ||
| Operation | M | Constant |
| 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/The ID format of the platform is controlled: - 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 2/ 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 positioned on the same line as this database |
| idDemandeur | M | SIRET or functional identifier of the place entity which makes the request |
| rsDemandeur | M | Name of the entity which makes the request on the place (Corporate name) |
| UUID | O | 1/ The system makes a fields coherence check: UUID, Code and Context. 2/ In the case where there is no known tooltip for this UUID, the answer returns "null" 3/ In the case where there is no known management rule for this UUID, the answer returns "null" |
| Code | O | |
| Context | O | 1/ The system makes a fields coherence check: UUID, Code and Context. 2/ The potential values for the context are the following: - A - OE 3/ The potential values for the context are the following: - A - OE 3/ In the case where, for a same UUID, the criterions database has two labels (one for buyers and one for economic operators). If the marketplace doesn't specify the context, then two tables are returned by this same UUIDcode |
| Language | M | The possible values for the "langue" ("language") parameter are the following (coming from the ISO 639-1 code) - « en » (English) - « fr » (French) If the "langue" parameter is not valuated in the input parameters, it is deemed "fr" |
{
"operation": "recupererLibelles",
"rsDemandeur": "AIFE",
"idDemandeur": "12345698765445",
"plateforme": { "typeIdPlateforme": "1" , "idPlateforme":"33592022900036", "idTechniquePlateforme":"azerty"},
"uuid" : "6ee55a59-6adb-4c3a-b89f-e62a7ad7be7f",
"contexte" : "A",
"langue": "fr"
}
{
"response": {
"listeLibelles": [
{
"Uuid": "6ee55a59-6adb-4c3a-b89f-e62a7ad7be7f",
"Code": "CRITERION.SELECTION.SUITABILITY.PROFESSIONAL_REGISTER_ENROLMENT",
"Langue": "FR",
"Contexte": "A",
"Libellé": "Inscription sur un registre professionnel pertinent",
"Infobulle": "Pour la France, il s'agit du registre du commerce et des société et du répertoire des métiers. Pour les autres pays européens, se référer à l'annexe XI de l'a Directive 2014/24/UE",
"Regle de gestion": ""
}
]
}
}
