DOCUMENTATION TECHNIQUE API TRANSPARENCE-SANTE
←
→
Transcription du contenu de la page
Si votre navigateur ne rend pas la page correctement, lisez s'il vous plaît le contenu de la page ci-dessous
Documentation technique API – S.I. « Transparence-Santé »
DOCUMENTATION TECHNIQUE API
TRANSPARENCE-SANTE
Ministère de la Santé et de la Prévention
S.I. « Transparence-Santé »
Référence : Transparence-Santé-DocumentationTechniqueAPI
Date : 5 Janvier 2023
Version : 2.3
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 1Documentation technique API – S.I. « Transparence-Santé »
HISTORIQUE
Date Version Rédacteurs Objet
12/02/2021 1.0 DGS Initialisation du document
12/03/2021 1.1 DGS Mise à jour de l’API déclaration et API récupération
des erreurs et alertes
10/08/2021 1.2 DGS Modification suite évolutions dans les contrôles
d’erreurs et d’alertes
18/08/2021 1.3 DGS Modification des motifs de lien d’intérêts
27/09/2021 1.4 DGS Modification de type du montant et du numeroLigne
03/12/2021 1.5 DGS Mise à jour des intitulés
13/12/2021 1.6 DGS Mise à jour des messages d’erreurs
17/01/2022 2 DGS Mise à jour du document
14/11/2022 2.1 DGS Evolution TS V1.7 Corps de réponse Erreurs et Alertes.
15/12/2022 2.2 DGS Mise à jour suite évolutions
05/01/2023 2.3 DGS Mise à jour des liens URLS
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 2Documentation technique API – S.I. « Transparence-Santé »
TABLE DES MATIÈRES
1. Objet du document ............................................................................................................. 5
2. Généralités .......................................................................................................................... 6
3. API Enrôlement ................................................................................................................... 6
A. Description ...................................................................................................................... 6
B. URL d’accès ...................................................................................................................... 6
C. Requête ........................................................................................................................... 6
D. Réponse ....................................................................................................................... 7
E. Codes d’erreur ................................................................................................................. 7
F. Exemple d’appel de l’API ................................................................................................. 7
4. API déclarations .................................................................................................................. 8
A. Description ...................................................................................................................... 8
B. URL d’accès ...................................................................................................................... 8
C. Requête ........................................................................................................................... 8
D. Réponse ..................................................................................................................... 13
E. Codes d’erreur ............................................................................................................... 13
F. Exemple d’appel de l’API ............................................................................................... 14
5. API Suivi des envois de liens d’intérêt .............................................................................. 16
A. Description .................................................................................................................... 16
B. URL d’accès .................................................................................................................... 16
C. Requête ......................................................................................................................... 16
D. Réponse ..................................................................................................................... 17
E. Codes d’erreur ............................................................................................................... 17
F. Exemple d’appel de l’API ............................................................................................... 17
6. API Récupération des erreurs et alertes ........................................................................... 18
A. Description .................................................................................................................... 18
B. URL d’accès .................................................................................................................... 18
C. Requête ......................................................................................................................... 18
D. Réponse ..................................................................................................................... 18
E. Codes d’erreur ............................................................................................................... 21
F. Exemple d’appel de l’API ............................................................................................... 21
7. Référentiels ....................................................................................................................... 21
A. Objet d’une convention................................................................................................. 21
B. Nature d’un avantage.................................................................................................... 22
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 3Documentation technique API – S.I. « Transparence-Santé »
C. Pays................................................................................................................................ 22
D. Catégories de bénéficiaire ......................................................................................... 28
E. Types d’identifiant du bénéficiaire ............................................................................... 28
F. Profession du bénéficiaire ............................................................................................. 29
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 4Documentation technique API – S.I. « Transparence-Santé »
1. Objet du document
Le présent document présente les différentes API exposées par l’application Transparence-
Santé et qui peuvent être utilisées par les entreprises pour faire leurs déclarations dans le
système.
Seront notamment abordés :
L’appel de chaque API avec les paramètres à envoyer,
Les codes erreurs et codes retours de l’API.
Note : pour l’ensemble du présent document, « [URL_WEB_API] » correspond à l’url
d’accès Web à l’API et dépend de chaque environnement.
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 5Documentation technique API – S.I. « Transparence-Santé »
2. Généralités
Pour l’ensemble des Web Services à l’exception du service d’enrôlement, la clé technique
préalablement activée doit être communiquée dans l’entête de la requête.
Pour les services employant la méthode GET, les autres paramètres sont à communiquer
directement dans l’URL.
Pour les services employant une autre méthode, les autres paramètres sont à communiquer
dans le corps de la requête.
Pour accéder au swagger de l’API : Cliquez ici
3. API Enrôlement
A. Description
L’API d’enrôlement permet à un utilisateur d’enrôler une application métier afin d'utiliser les
services web offerts par transparence santé pour la gestion de ses déclarations.
Pré requis :
L’utilisateur doit avoir la clé d’authentification qui lui a été fournie à la suite de l’activation
du web service pour son entreprise dans l’application Transparence-Santé.
Cette clé est valable uniquement 48H.
B. URL d’accès
https://[URL_WEB_API]/api-entreprise/enroler?id_entreprise=3
C. Requête
Entête Méthode https : POST
"cle_authentification": ""
Paramètres dans l’URL id_entreprise:3
Données transmises :
Champ Format Description
cle_authentification string Clé unique non encore activée générée dans
transparence santé – entreprise
id_entreprise Long Code de l’entreprise générée dans
transparence santé – entreprise
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 6Documentation technique API – S.I. « Transparence-Santé »
D. Réponse
Si le traitement est en succès :
- Code retour HTTP : 200
- Corps de la réponse :
{
"cleTechnique": "eoX9Kh5Ay1xu9eInbv"
}
Si le traitement est en échec :
- Code retour http : 400
- Corps de la réponse :
{
"code": "XXX",
"description": "XXX"
}
E. Codes d’erreur
Code Message
TS-API-ENR01 La clé n'existe pas ou a déjà été activée
TS-API-ENR02 Le code de l'entreprise doit exister en base et être actif
TS-API-ENR03 Ce couple clé / code entreprise n'existe pas
F. Exemple d’appel de l’API
curl -i -X POST "https://[URL_WEB_API]/api-entreprise/enroler?id_entreprise=1" -H "accept:
*/*" -H "cle_authentification: 1" -d ""
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 7Documentation technique API – S.I. « Transparence-Santé »
4. API déclarations
A. Description
L’API déclaration permet à une entreprise disposant d'une application métier de transmettre
ses déclarations.
B. URL d’accès
https://[URL_WEB_API]/api-entreprise/
C. Requête
Entête Méthode https : POST
" cle_technique ": ""
Paramètres dans l’URL id_entreprise:3
Corps [
{
"numeroLigne": 1,
"action": "C",
"declaration": "convention",
"identifiantUnique": "BDI111",
"conventionLiee": "",
"objetConventionNatureAvantageCode": "AEP",
"autre": "",
"montant": "1500",
"date": "2021-01-18",
"dateDebut": "2021-02-12",
"dateFin": "2021-02-12",
"informationConvention": "evt test API 18",
"beneficiaireCategorieCode": "ETU",
"beneficiaireTypeCode": "AUTRE",
"beneficiaireIdentifiant": "EtudiantALMA1",
"beneficiaireProfessionCode": "02",
"identite": "LE BRAS",
"prenom": "Clémence",
"structureExerciceRattachement": "",
"paysCode": "FR",
"codePostal": "44220",
"ville": "COUËRON",
"adresse": "9A rue de la lionniere",
"demandeRectification": ""
} ,
{
"numeroLigne": 1,
"action": "C",
"declaration": "convention",
"identifiantUnique": "BDI112",
"conventionLiee": "",
"objetConventionNatureAvantageCode": "AEP",
"autre": "",
"montant": "1500",
"date": "2021-01-18",
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 8Documentation technique API – S.I. « Transparence-Santé »
"dateDebut": "2021-02-12",
"dateFin": "2021-02-12",
"informationConvention": "evt test API 18",
"beneficiaireCategorieCode": "ETU",
"beneficiaireTypeCode": "AUTRE",
"beneficiaireIdentifiant": "EtudiantALMA2",
"beneficiaireProfessionCode": "02",
"identite": "LE BRAS",
"prenom": "Clémence",
"structureExerciceRattachement": "",
"paysCode": "FR",
"codePostal": "44220",
"ville": "COUËRON",
"adresse": "9A rue de la lionniere",
"demandeRectification": ""
}
]
Données transmises :
Champ Format Description
cle_technique (dans Alphanum Clé unique non encore activée générée dans
le header de la transparence santé – entreprise
requête)
id_entreprise Long Code de l’entreprise générée dans
transparence santé – entreprise
Liste des
déclarations
La liste des déclarations est un objet json qui contient les éléments suivants :
Champ Type Obligatoire / Description
Facultatif
numeroLigne string Obligatoire Numéro de la ligne dans la
liste des déclarations
action string Obligatoire Valeurs possibles : « C »
(création), « M »
(modification), ou « S »
(suppression)
declaration string Obligatoire Valeurs possibles :
« convention» ,
« remuneration » , ou
« avantage »
identifiantUnique string Obligatoire Identifiant unique de la
déclaration.
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 9Documentation technique API – S.I. « Transparence-Santé »
Format attendu : « [0-
9][A-Z] - Caractères "tiret"
et "underscore" autorisés
- maximum 128
caractères ».
conventionLiee string Obligatoire lorsque Identifiant de la
l’Action est convention liée.
« Création » Format attendu : « [0-
ou « Modification » 9][A-Z] - Caractères "tiret"
et si la déclaration et "underscore" autorisés
est une - maximum 128
rémunération liée à caractères ».
une convention.
Facultatif pour un
avantage.
objetConventionNatureAvantage string Obligatoire lorsque Code du motif de la
Code l’Action est « C » déclaration issu du
ou « M » et si la référentiel (cf § Objet
déclaration est une d’une convention et §
convention ou un Nature d’un avantage)
avantage.
autre string Obligatoire lorsque Précisions sur l’objet
l’action est « C » Convention / Nature
ou « M », si la avantage si sa valeur est
déclaration est une « Autre ».
convention ou un 256 caractères maximum
avantage et si la
valeur
précédemment
saisie est « Autre »
montant string Obligatoire pour les Montant en euros.
rémunérations et Nombre entier. Montant
avantages >= à 10€ pour les
rémunérations et les
avantages
date string Obligatoire Format yyyy-mm-dd.
dateDebut string Obligatoire lorsque Format yyyy-mm-dd.
l’Action est « C » ou
« M », si la
déclaration est une
convention
dateFin string Format yyyy-mm-dd.
La date de fin doit être >=
à la date de début.
informationConvention string Information sur la
convention.
256 caractères maximum
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 10Documentation technique API – S.I. « Transparence-Santé »
beneficiaireCategorieCode string Obligatoire Code de la catégorie du
bénéficiaire issu du
référentiel (cf §
Catégories de
bénéficiaire)
beneficiaireTypeCode string Obligatoire lorsque Code du type du
l’Action est « C » bénéficiaire issu du
ou « M » référentiel (cf §
Types d’identifiant du
bénéficiaire).
Valeurs possibles en
fonction de la catégorie
beneficiaireIdentifiant string Obligatoire lorsque Numéro d’identifiant du
l’Action est « C » ou bénéficiaire
« M » et si le
beneficiaireTypeCo
de est différent de
« AUTRE »
beneficiaireProfessionCode string Obligatoire lorsque Code de la profession du
l’Action est « C » bénéficiaire issu du
ou « M » et si le référentiel (cf § Profession
type de bénéficiaire du bénéficiaire)
n’est pas
RPPS/ADELI
identite string Obligatoire lorsque Identité/Nom/Dénominati
l’Action est « C » on publique du
ou « M » bénéficiaire
prenom string Obligatoire lorsque Prénom du bénéficiaire
l’Action est « C »
ou «M », si la
Catégorie de
bénéficiaire est «
PRS », « ETU » ou
« VET ».
structureExerciceRattachement string Obligatoire lorsque Structure d’exercice /
l’Action est « C » rattachement du
ou « M » et si la bénéficiaire
catégorie du
bénéficiaire est ETU
paysCode string Obligatoire lorsque Code du pays issu du
l’Action est « C » référentiel (cf § Pays)
ou « M » pour tous
les bénéficiaires
sauf les
influenceurs.
codePostal string Obligatoire lorsque Code postal du
l’Action est « C » bénéficiaire
ou « M » pour tous
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 11Documentation technique API – S.I. « Transparence-Santé »
les bénéficiaires
sauf les
influenceurs.
ville string Obligatoire lorsque Ville du bénéficiaire
l’Action est « C »
ou « M » pour tous
les bénéficiaires
sauf les
influenceurs.
adresse string Obligatoire en Adresse du bénéficiaire de
création et la déclaration
modification sauf
pour les
bénéficiaires de
type influenceur
demandeRectification string Obligatoire si Deux valeurs possibles :
l’Action est Oui / Non.
« modification » ou
« suppression »
d’une déclaration
au statut « Publié »
Attention :
Le champ « Montant » doit contenir une valeur entière. Si la valeur contient un point ou une
virgule, l’envoi sera bloqué.
Pour effectuer des actions différentes (création, modification, suppression) dans un même
envoi :
Vous ne pouvez pas créer d’une part une déclaration A et d’autre part modifier et/ou
supprimer cette même déclaration A.
Si dans un même envoi, vous indiquez des lignes avec des actions différentes, celles-ci
ne doivent pas concerner les mêmes déclarations. Ex : création de la déclaration A et
modification de la déclaration B (précédemment créée dans un autre envoi).
Il n’est pas possible à ce stade, dans un même envoi, de créer une convention ainsi qu’un
avantage ou une rémunération lié à cette même convention. Vous devez faire deux envois
distincts, en veillant à déclarer d’abord la convention.
Pour supprimer une déclaration, vous devez envoyer les champs suivants complétés :
numeroLigne
action
declaration
IdentifiantUnique
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 12Documentation technique API – S.I. « Transparence-Santé »
demandeRectification
Exemple :
[
{
"numeroLigne": 1,
"action": "S",
"declaration": "convention",
"identifiantUnique": "CONV_TEST_04012022_01",
"demandeRectification": "Non"
}
]
D. Réponse
Si le traitement est en succès :
- Code retour HTTP : 200
- Corps de la réponse : le numéro de traitement qui sera utilisé dans les API de suivi
et de récupération des alertes et erreurs
Exemple :
{
"numeroTraitement": 1
}
Si le traitement est en échec :
- Code retour http : 400
- Corps de la réponse :
{
"code": "XXX",
"description": "XXX"
}
E. Codes d’erreur
Code Message
TS-API-DEC01 La clé technique n'existe pas ou est désactivée.
TS-API-DEC02 Ce couple clé Technique / Identifiant Entreprise n'existe pas.
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 13Documentation technique API – S.I. « Transparence-Santé »
F. Exemple d’appel de l’API
curl -i -X POST -H "Content-Type: application/json" "https://[URL_WEB_API]/api-
entreprise/declarer?cle_technique=1&id_entreprise=1" --data @listeDecplarations.json -H
“cle_technique: [XXX]”
où listeDeclarations.json est un fichier au format json contenant par exemple le texte
suivant :
[
{
"numeroLigne": "1",
"action": "C",
"declaration": "convention",
"identifiantUnique": "API111",
"conventionLiee": "",
"objetConventionNatureAvantageCode": "CALEP",
"autre": "",
"montant": "100",
"date": "2021-01-18",
"dateDebut": "2021-02-12",
"dateFin": "2021-02-12",
"informationConvention": "evt test API 18",
"beneficiaireCategorieCode": "ETU",
"beneficiaireTypeCode": "AUTRE",
"beneficiaireIdentifiant": "EtudiantALMA1",
"beneficiaireProfessionCode": "02",
"identite": "DUPONT",
"prenom": "Chloé",
"structureExerciceRattachement": "CHU Montpellier",
"paysCode": "FR",
"codePostal": "44220",
"ville": "COUËRON",
"adresse": "9A rue de la lionniere",
"demandeRectification": ""
},
{
"numeroLigne": "2",
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 14Documentation technique API – S.I. « Transparence-Santé »
"action": "C",
"declaration": "remuneration",
"identifiantUnique": "API112",
"conventionLiee": " API111",
"objetConventionNatureAvantageCode": "",
"autre": "",
"montant": "100",
"date": "2021-01-18",
"dateDebut": "",
"dateFin": "",
"informationConvention": "",
"beneficiaireCategorieCode": "ETU",
"beneficiaireTypeCode": "AUTRE",
"beneficiaireIdentifiant": "EtudiantALMA1",
"beneficiaireProfessionCode": "02",
"identite": "DUPONT",
"prenom": "Chloé",
"structureExerciceRattachement": "CHU Montpellier",
"paysCode": "FR",
"codePostal": "44220",
"ville": "COUËRON",
"adresse": "9A rue de la lionniere",
"demandeRectification": ""
}
]
Note : Le fichier doit être encodé en UTF8.
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 15Documentation technique API – S.I. « Transparence-Santé »
5. API Suivi des envois de liens d’intérêt
A. Description
L’API de suivi des envois des déclarations permet à une entreprise disposant d'une application
métier de suivre l'intégration d'un envoi de déclarations précédemment fait via l’API
déclarations (cf § 4) pour vérifier l'état du traitement.
Il existe quatre statuts d’un envoi par API (statut = état courant du traitement) :
« en-attente » : traitement reçu mais pas encore exécuté,
« en-cours » : traitement en cours d’exécution,
« termine » : traitement exécuté – A ce stade les alertes et les erreurs sont
récupérables,
« en-erreur » : traitement reçu et exécuté mais pour lequel un problème technique est
survenu.
Evolution de l’outil :
Les erreurs techniques sont maintenant correctement attrapées en plus des
exceptions : par exemple, si une erreur de mémoire intervient, le traitement
passera automatiquement en erreur.
Amélioration de la gestion des exécuteurs pour la gestion d'un traitement (mise en
attente, exécution) : si la file d'attente est vide, l'exécuteur est à présent
correctement clôturé et la mémoire nettoyée.
B. URL d’accès
https://[URL_WEB_API]/api-entreprise/suivreEnvoi?id_entreprise=3&numero_traitement=1
C. Requête
Entête Méthode https : GET
"cle_technique ": ""
Paramètres dans l’URL id_entreprise:3
numero_traitement :1
Données transmises :
Champ Format Description
cle_technique (dans String Clé technique de l’entreprise pour
le header de la l’utilisation des API (clé générée par l’API
requête) d’enrôlement § 2)
id_entreprise Long Code de l’entreprise générée dans
transparence santé – entreprise
numero_traitement Long Numéro du traitement dont on souhaite
connaitre l’état (numéro généré par l’API
déclarations § 4)
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 16Documentation technique API – S.I. « Transparence-Santé »
D. Réponse
Si le traitement est en succès :
- Code retour HTTP : 200
- Corps de la réponse :
o Au format JSON : statut et suivi du traitement
Si le traitement est en échec :
- Code retour http : 400
- Corps de la réponse :
{
"code": "XXX",
"description": "XXX"
}
E. Codes d’erreur
Code Message
TS-API-SUI01 La clé n’existe pas ou a été désactivée
TS-API-SUI02 Ce code entreprise n’existe pas ou n’est pas actif
TS-API-SUI03 Ce couple clé / code entreprise n’existe pas
TS-API-SUI04 Ce couple clé / code entreprise / N° traitement n’existe pas
F. Exemple d’appel de l’API
curl -i https://[URL_WEB_API]/api-entreprise/suivreEnvoi?
id_entreprise=1&numero_traitement=1 -H “cle_technique: [XXX]”
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 17Documentation technique API – S.I. « Transparence-Santé »
6. API Récupération des erreurs et alertes
A. Description
L’API de récupération des erreurs et alertes permet à une entreprise disposant d'une
application métier de récupérer les alertes et erreurs liées à un envoi de déclarations
précédemment fait via l’API déclarations (cf § 4) pour effectuer les corrections.
B. URL d’accès
https://[URL_WEB_API]/api-
entreprise/recupererAlertesErreursEnvoi?id_entreprise=3&numero_traitement=1
C. Requête
Entête Méthode https : GET
"cle_technique ": ""
Paramètres dans l’URL id_entreprise:3
numero_traitement :1
Données transmises :
Champ Format Description
cle_technique (dans string Clé technique de l’entreprise pour
le header de la l’utilisation des API (clé générée par l’API
requête) d’enrôlement § 2)
id_entreprise Long Code de l’entreprise générée dans
transparence santé – entreprise
numero_traitement Long Numéro du traitement dont on souhaite
connaitre l’état (numéro généré par l’API
déclarations § 4)
D. Réponse
Si le traitement est en succès :
- Code retour HTTP : 200
- Corps de la réponse :
o Au format JSON : liste des alertes et des erreurs
- [
- {
- "id": XX,
- "traitementId": XX,
- "entrepriseId": XX,
- "identifiantLigne": XX,
- "identifiantUnique": XX,
- "codeAlerte": "XX",
- "descriptionAlerte": "X"
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 18Documentation technique API – S.I. « Transparence-Santé »
- },
- {
- "id": XX,
- "traitementId": XX,
- "entrepriseId": XX,
- "identifiantLigne": XX,
- "identifiantUnique": XX,
- "codeErreur": "XX",
- "descriptionErreur": "XX"
- }
- ]
La liste des alertes et erreurs, liée aux déclarations envoyées précédemment, est la suivante :
Code Message
ERREUR
ERR_01 Le champ {0} ne respecte pas le format attendu."
ERR_02 Le champ {0} ne respecte pas la longueur maximum."
ERR_03 Le champ {0} est obligatoire."
ERR_04 Le champ {0} ne respecte pas la liste des caractères autorisés pour ce champ."
ERR_05 Création impossible. L’identifiant unique du la
déclaration existe déjà en base pour l’entreprise : {0}."
ERR_06 Action impossible. La
déclaration {0} n’existe pas dans la base de données ou n'est plus publié."
ERR_07 Le champ Identifiant de la convention liée est obligatoire pour une rémunérati
on."
ERR_08 Rattachement à la convention liée impossible. L’identifiant de la convention lié
e n’existe pas dans la base ou est « DEPUBLIE » : {0}."
ERR_09 Le champ Objet convention / nature avantage est obligatoire pour une
convention ou un avantage.
ERR_10 Le champ Objet convention / nature avantage est incorrect. Ce type d'objet
convention n'est pas autorisé pour une convention: {0}.
ERR_11 Le champ Objet convention / nature avantage est incorrect. Ce type de nature
avantage n'est pas autorisé pour un avantage : {0}.
ERR_12 Le champ Autre est obligatoire pour une convention ou un avantage avec un
objet convention / nature avantage « Autre ».
ERR_13 Montant incorrect. Le montant déclaré doit être supérieur ou égal à 10€.
ERR_14 La date de la déclaration doit être inférieure ou égale à la date du jour
: {0}."
ERR_17 Le champ {0} est obligatoire pour une convention.
ERR_18 La date de début doit être inférieure à 5 ans.
ERR_19 La date de fin doit être égale ou supérieure à la date de début.
ERR_20 Le champ Type d’identifiant professionnel est obligatoire pour la catégorie : {0}
.
ERR_21 Le champ Type d’identifiant professionnel est incorrect. La valeur renseignée {
0} n’est pas autorisée pour la Catégorie de bénéficiaire renseignée
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 19Documentation technique API – S.I. « Transparence-Santé »
ERR_22 Le champ Numéro d’identifiant professionnel est obligatoire pour le type d’ide
ntifiant : {0}.
ERR_23 Le champ Profession est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_24 Le champ Prénom est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_25 Le champ Structure d'exercice / de rattachement est obligatoire pour la
Catégorie de bénéficiaire : {0}.
ERR_26 Le champ Pays est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_27 Le champ Pays est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_28 Le champ Ville est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_29 Le champ Adresse est obligatoire pour la Catégorie de bénéficiaire : {0}.
ERR_30 Le champ {0} est incorrect, ce numéro d’identifiant {0} n’est pas référencé dan
s l’Annuaire Santé.
ERR_31 Le champ Profession est incorrect. La profession {0} n’est pas référencée dans l
’Annuaire Santé pour le bénéficiaire {1}.
ERR_32 Le champ Identité / Nom est incorrect. L’identité / le nom {0}, n’est pas référen
cé dans l’Annuaire Santé pour le bénéficiaire {1}.
ERR_33 Le code postal renseigné ne correspond pas au département du professionnel
de santé enregistré dans l'Annuaire Santé. Valeur(s) attendue(s) : {2}.
ERR_34 Le champ Prénom est incorrect. Le Prénom {0} n’est pas référencé dans l’Annu
aire Santé pour le bénéficiaire {1}.
ERR_36 Pour un bénéficiaire dont l’identifiant professionnel est « RPPS / ADELI », le Pa
ys doit être France.
ERR_41 La valeur du champ {0} ne correspond pas à une valeur du référentiel {1}."
ERR_42 Action impossible. La déclaration {0} existe déjà dans la liste de déclarations.
ERR_43 Action impossible. Le numéro de ligne {0} existe déjà dans la liste de déclaratio
ns."
Code Message
ALERTE
WARN_01 La valeur renseignée pour le champ Identifiant de la convention liée ne sera
pas intégrée. Ce champ ne doit pas être renseignée pour une convention.
WARN_02 La valeur renseignée pour le champ {0} ne sera pas intégrée. Ce champ ne d
oit pas être renseignée pour une rémunération.
WARN_03 La valeur renseignée pour le champ {0} ne sera pas intégrée. Ce champ ne d
oit pas être renseigné pour un avantage.
WARN_07 Le champ {0} ne sera pas intégré, il ne doit pas être renseigné pour un influe
nceur.
WARN_08 Le champ Profession ne sera pas intégré, il ne doit pas être renseigné pour la
catégorie de bénéficiaire : {0}.
WARN_09 Le champ Prénom ne sera pas intégré, il ne doit pas être renseigné pour la c
atégorie de bénéficiaire : {0}.
WARN_10 Le champ Structure d’exercice ne sera pas intégré, il ne doit pas être renseig
né pour la catégorie de bénéficiaire : {0}.
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 20Documentation technique API – S.I. « Transparence-Santé »
NB :
- les valeurs {0} correspondent aux valeurs renseignées dans la déclaration,
- les valeurs {2] correspondent aux valeurs renseignées dans l’Annuaire Santé.
Si le traitement est en échec :
- Code retour http : 400
- Corps de la réponse :
{
"code": "XXX",
"description": "XXX"
}
E. Codes d’erreur
Code Message
TS-API-DEC01 La clé n’existe pas ou a été désactivée
TS-API-DEC02 Ce code entreprise n’existe pas ou n’est pas actif
F. Exemple d’appel de l’API
curl -i https://[URL_WEB_API]/api-entreprise/recupererAlertesErreursEnvoi?
&id_entreprise=1&numero_traitement=1 -H “cle_technique: [XXX]”
7. Référentiels
A. Objet d’une convention
Code Description
ADS Achat de documentation scientifique
AUTRE Autre
CALECES Contrat d'achat ou de location d'espaces dans le cadre d'évènements
scientifiques
CALEP Contrat d'achat ou de location d'espaces publicitaires
CCEAS Contrat de conseil ou d'expertise autre que scientifique (enquête, étude,
étude de marché)
CDLE Cession de droits / licence d'exploitation
CEVS Contrat d'évaluation scientifique
CI Contrat d'interview
CIC Contrat d'inscription aux congrès
CINM Contrat d'intervenant à une manifestation
CRBR Contrat de remise d'une bourse de recherche
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 21Documentation technique API – S.I. « Transparence-Santé »
CRP Contrat de remise de prix
CRS Contrat de recherche scientifique (expert, consultant)
DON Don / Mécénat
ED Edition
EPC Evaluation produit cosmétique
FOR Formation
PARR Parrainage
PART Partenariat
PM Prêt de matériel
VPC Vigilance produit cosmétique
B. Nature d’un avantage
Code Description
AUTRE Autre
BF Bourse de formation
BR Bourse de recherche
DEF Défraiement
DF Don ou prêt pour la formation
DMEO Don de matériel, d'échantillons, d'ouvrage
DP Don ou prêt pour la recherche
DSF Don ou subvention de fonctionnement
FI Frais d'inscription à un événement
FRO Frais de réunion / d'organisation
FT Frais de transport
HC Hospitalité - collation
HH Hospitalité - hébergement
HR Hospitalité - restauration
IND Indemnisation
PM Prêt de matériel
PR Prix de recherche
C. Pays
Code Description
AD ANDORRE
AE ÉMIRATS ARABES UNIS
AF AFGHANISTAN
AG ANTIGUA-ET-BARBUDA
AI ANGUILLA
AL ALBANIE
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 22Documentation technique API – S.I. « Transparence-Santé »
AM ARMÉNIE
AO ANGOLA
AQ ANTARCTIQUE
AR ARGENTINE
AS SAMOA AMÉRICAINES
AT AUTRICHE
AU AUSTRALIE
AW ARUBA
AX ÅLAND, ÎLES
AZ AZERBAÏDJAN
BA BOSNIE-HERZÉGOVINE
BB BARBADE
BD BANGLADESH
BE BELGIQUE
BF BURKINA FASO
BG BULGARIE
BH BAHREÏN
BI BURUNDI
BJ BÉNIN
BM BERMUDES
BO BOLIVIE, l'ÉTAT PLURINATIONAL DE
BQ BONAIRE, SAINT-EUSTACHE ET SABA
BR BRÉSIL
BS BAHAMAS
BT BHOUTAN
BV BOUVET, ÎLE
BW BOTSWANA
BY BÉLARUS
BZ BELIZE
CA CANADA
CC COCOS (KEELING), ÎLES
CD CONGO, LA RÉPUBLIQUE DÉMOCRATIQUE DU
CF CENTRAFRICAINE, RÉPUBLIQUE
CG CONGO
CH SUISSE
CI CÔTE D'IVOIRE
CK COOK, ÎLES
CL CHILI
CM CAMEROUN
CN CHINE
CO COLOMBIE
CR COSTA RICA
CU CUBA
CV CAP-VERT
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 23Documentation technique API – S.I. « Transparence-Santé »
CW CURAÇAO
CX CHRISTMAS, ÎLE
CY CHYPRE
CZ TCHÈQUE, RÉPUBLIQUE
DE ALLEMAGNE
DJ DJIBOUTI
DK DANEMARK
DM DOMINIQUE
DO DOMINICAINE, RÉPUBLIQUE
DZ ALGÉRIE
EC ÉQUATEUR
EE ESTONIE
EG ÉGYPTE
EH SAHARA OCCIDENTAL
ER ÉRYTHRÉE
ES ESPAGNE
ET ÉTHIOPIE
FI FINLANDE
FJ FIDJI
FK FALKLAND, ÎLES (MALVINAS)
FM MICRONÉSIE, ÉTATS FÉDÉRÉS DE
FO FÉROÉ, ÎLES
FR FRANCE
GA GABON
GB ROYAUME-UNI
GD GRENADE
GE GÉORGIE
GG GUERNESEY
GH GHANA
GL GROENLAND
GM GAMBIE
GN GUINÉE
GQ GUINÉE ÉQUATORIALE
GR GRÈCE
GS GÉORGIE DU SUD-ET-LES ÎLES SANDWICH DU SUD
GU GUAM
GW GUINÉE-BISSAU
GY GUYANA
HK HONG KONG
HM HEARD-ET-ÎLES MACDONALD, ÎLE
HN HONDURAS
HR CROATIE
HT HAÏTI
HU HONGRIE
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 24Documentation technique API – S.I. « Transparence-Santé »
ID INDONÉSIE
IE IRLANDE
IL ISRAËL
IM ÎLE DE MAN
IN INDE
IO OCÉAN INDIEN, TERRITOIRE BRITANNIQUE DE L'
IQ IRAQ
IR IRAN, RÉPUBLIQUE ISLAMIQUE D'
IS ISLANDE
IT ITALIE
JE JERSEY
JM JAMAÏQUE
JO JORDANIE
JP JAPON
KE KENYA
KG KIRGHIZISTAN
KH CAMBODGE
KI KIRIBATI
KM COMORES
KN SAINT-KITTS-ET-NEVIS
KP CORÉE, RÉPUBLIQUE POPULAIRE DÉMOCRATIQUE DE
KR CORÉE, RÉPUBLIQUE DE
KW KOWEÏT
KY CAÏMANS, ÎLES
KZ KAZAKHSTAN
LA LAO, RÉPUBLIQUE DÉMOCRATIQUE POPULAIRE
LB LIBAN
LC SAINTE-LUCIE
LI LIECHTENSTEIN
LK SRI LANKA
LR LIBÉRIA
LS LESOTHO
LT LITUANIE
LU LUXEMBOURG
LV LETTONIE
LY LIBYE
MA MAROC
MC MONACO
MD MOLDOVA, RÉPUBLIQUE DE
ME MONTÉNÉGRO
MG MADAGASCAR
MH MARSHALL, ÎLES
MK MACÉDOINE, L'EX-RÉPUBLIQUE YOUGOSLAVE DE
ML MALI
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 25Documentation technique API – S.I. « Transparence-Santé »
MN MONGOLIE
MO MACAO
MP MARIANNES DU NORD, ÎLES
MR MAURITANIE
MS MONTSERRAT
MT MALTE
MU MAURICE
MV MALDIVES
MX MEXIQUE
MY MALAISIE
MZ MOZAMBIQUE
NA NAMIBIE
NE NIGER
NF NORFOLK, ÎLE
NG NIGÉRIA
NI NICARAGUA
NL PAYS-BAS
NO NORVÈGE
NR NAURU
NU NIUÉ
NZ NOUVELLE-ZÉLANDE
OM OMAN
PA PANAMA
PE PÉROU
PG PAPOUASIE-NOUVELLE-GUINÉE
PH PHILIPPINES
PK PAKISTAN
PL POLOGNE
PN PITCAIRN
PR PORTO RICO
PS PALESTINE, ÉTAT DE
PW PALAOS
PY PARAGUAY
QA QATAR
RO ROUMANIE
RU RUSSIE, FÉDÉRATION DE
RW RWANDA
SA ARABIE SAOUDITE
SB SALOMON, ÎLES
SC SEYCHELLES
SD SOUDAN
SE SUÈDE
SH SAINTE-HÉLÈNE, ASCENSION ET TRISTAN DA CUNHA
SI SLOVÉNIE
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 26Documentation technique API – S.I. « Transparence-Santé »
SJ SVALBARD ET ÎLE JAN MAYEN
SK SLOVAQUIE
SL SIERRA LEONE
SM SAINT-MARIN
SN SÉNÉGAL
SO SOMALIE
SR SURINAME
SS SOUDAN DU SUD
ST SAO TOMÉ-ET-PRINCIPE
SV EL SALVADOR
SX SAINT-MARTIN (PARTIE NÉERLANDAISE)
SY SYRIENNE, RÉPUBLIQUE ARABE
SZ SWAZILAND
TC TURKS-ET-CAÏCOS, ÎLES
TD TCHAD
TG TOGO
TH THAÏLANDE
TJ TADJIKISTAN
TK TOKELAU
TL TIMOR-LESTE
TM TURKMÉNISTAN
TN TUNISIE
TO TONGA
TR TURQUIE
TT TRINITÉ-ET-TOBAGO
TW TAÏWAN, PROVINCE DE CHINE
TZ TANZANIE, RÉPUBLIQUE-UNIE DE
UA UKRAINE
UG OUGANDA
UM ÎLES MINEURES ÉLOIGNÉES DES ÉTATS-UNIS
US ÉTATS-UNIS
UY URUGUAY
UZ OUZBÉKISTAN
VA SAINT-SIÈGE (ÉTAT DE LA CITÉ DU VATICAN)
VC SAINT-VINCENT-ET-LES GRENADINES
VE VENEZUELA, RÉPUBLIQUE BOLIVARIENNE DU
VG ÎLES VIERGES BRITANNIQUES
VI ÎLES VIERGES DES ÉTATS-UNIS
VN VIET NAM
VU VANUATU
WS SAMOA
YE YÉMEN
ZA AFRIQUE DU SUD
ZM ZAMBIE
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 27Documentation technique API – S.I. « Transparence-Santé »
Note : les bénéficiaires des DOM/TOM sont à déclarer sous le pays “France”.
D. Catégories de bénéficiaire
Code Description
ADU Association d'étudiants
AGR Groupement professionnel agricole
APS Association de professionnels de santé
AUS Association d'usagers du système de santé
ETA Etablissement de santé
ETU Etudiant
FON Académie, fondation, société savante de conseils
INF Influenceur
LOG Editeur de logiciel
PMO Personne morale assurant la formation initiale ou continue des professionnels de
santé
PRE Presse et média
PRS Professionnel de santé
SAN Groupement sanitaire
VET Vétérinaire
VPM Vétérinaire Personne Morale
ADU Association d'étudiants
AGR Groupement professionnel agricole
APS Association de professionnels de santé
AUS Association d'usagers du système de santé
ETA Etablissement de santé
ETU Etudiant
FON Académie, fondation, société savante de conseils
INF Influenceur
LOG Editeur de logiciel
PMO Personne morale assurant la formation initiale ou continue des professionnels de
santé
PRE Presse et média
PRS Professionnel de santé
SAN Groupement sanitaire
VET Vétérinaire
VPM Vétérinaire Personne Morale
E. Types d’identifiant du bénéficiaire
Code Description Catégories de bénéficiaire
AUTRE AUTRE ADU, AGR, APS, AUS, ETA, ETU, FON,
INF, LOG, PMO, PRE, PRS, SAN, VET,
VPM
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 28Documentation technique API – S.I. « Transparence-Santé »
FINESS FINESS ADU, AGR, APS, AUS, ETA, FON, LOG,
PMO, PRE, SAN, VPM
ORDRE ORDRE VET
RPPS/ADELI RPPS/ADELI ETU, PRS
SIREN SIREN ADU, AGR, APS, AUS, ETA, FON, LOG,
PMO, PRE, SAN, VPM
F. Profession du bénéficiaire
Code Description
01 Préparateur en pharmacie et préparateur en pharmacie hospitalière
02 Aide-soignant
03 Auxiliaire de puériculture
04 Ambulancier
10 Médecin
21 Pharmacien
26 Audioprothésiste
28 Opticien-lunetier
31 Assistant dentaire
40 Chirurgien-dentiste
50 Sage-femme
60 Infirmier
70 Masseur-kinésithérapeute
80 Pédicure-podologue
82 Prothésiste et orthésiste pour l'appareillage des personnes handicapées
86 Technicien de laboratoire médical
91 Orthophoniste
92 Orthoptiste
94 Ergothérapeute
95 Diététicien
96 Psychomotricien
98 Manipulateur d'électroradiologie médicale
99 Physicien médical
VET Vétérinaire
Note : la valeur « Vétérinaire » dans le champ Profession est à utiliser uniquement pour la
catégorie de bénéficiaire « Etudiant ».
Ministère de la Santé et de la Prévention – S.I. « Transparence-Santé »
Page 29Vous pouvez aussi lire
