Listerreférentiel
DESCRIPTION
This function enables the buyer profile to know the list of the referentials present in the ESPD Service. This function is therefore to favor when only some data need modifying, for example contract identification data.
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 | ||
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 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 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 | 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. |
rsDemandeur | M | Name of the entity which makes the request on the place (Corporate name) |
{
"operation": "listerReferentiels",
"rsDemandeur": "AIFE",
"idDemandeur": "12345698765445",
"plateforme": { "typeIdPlateforme": "1" , "idPlateforme":"33592022900036", "idTechniquePlateforme":"azerty"}
}
{
"response": {
"messageList": [
{
"type": "INFO",
"code": "INFO_REF_MSG",
"message": "Liste des référentiel"
}
],
"listeReferentiels": [
{
"nom": "REF_TYPE_PROCEDURE",
"commentaire": "REFERENTIEL TYPE PROCEDURE"
},
{
"nom": "REF_TYPE_MARKET",
"commentaire": "REFERENTIEL TYPE MARKET"
},
{
"nom": "REF_TYPE_QUALITY",
"commentaire": "REFERENTIEL TYPE QUALITY"
},
{
"nom": "REF_TYPE_ID",
"commentaire": "REFERENTIEL TYPE ID"
},
{
"nom": "REF_NATURE_MARKET",
"commentaire": "REFERENTIEL NATURE MARKET"
}
]
}
}