Catalogue des Webservices

+33 (0)8 11 90 21 31
www.ifce.fr
CATALOGUE DES
WEB-SERVICES
Année 2017
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
1
SOMMAIRE
1. Présentation.....................................................................................3
2. Module « Informations cheval »..........................................................4
3. Module « Pedigree »..........................................................................6
4. Module « Recherche d’un cheval ».....................................................18
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
2
1.
Présentation
Voici le catalogue des modules de web-services opérationnels de l’IFCE.
La plupart des web-services fonctionnent selon le principe suivant :
-
On appelle un web-service en sélectionnant un type d’identifiant qui peut être :
o
N°SIRE
o
N°SIRE + clé
o
N°SIRE codé
o
Transpondeur
o
N°UELN
-
Si le web-service est appelé avec un identifiant officiel ( N°SIRE, N°SIRE + clé,
transpondeur ou N°UELN), le web-service vous donnera en retour l’ensemble de
ces identifiants officiels pour le cheval. Si le web-service est appelé avec le N°SIRE
codé, le web-service ne vous retournera que le N°SIRE codé pour le cheval.
-
On saisit la valeur correspondant au type d’identifiant choisi
-
Certains paramètres d’entrée sont obligatoires (notés O), et les autres restent
facultatifs
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
3
2. Module « Informations cheval »
Ce module de web-service permet d’obtenir l’ensemble des informations basiques sur un
cheval.
2.1.
Appel en clair
2.1.1.
Les paramètres d’entrée
Champ
--Contexte utilisateur--
O/F
Login
O
Code langue
O
Détail
-- Cheval par identifiant -Type d’identifiant
O
Valeur identifiant
O
2.1.2.
N°SIRE, N°SIRE + clé, n° transpondeur, UELN
Informations de sortie
Champ
-- Erreur --
Détail
Code erreur + libellé erreur
Voir précisions en 2.3
-- Infos cheval -UELN
N° SIRE
Clé
Clé du n°SIRE
N° transpondeur
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance estimée
Date castration
AAAA-MM-JJ
Taille
cm
Mort
Oui/non
Date de mort
AAAA-MM-JJ
2.2.
Appel en codé
2.2.1.
Les paramètres d’entrée
Champ
--Contexte utilisateur--
O/F
Login
O
Code langue
O
Détail
-- Cheval par identifiant --
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
4
Type d’identifiant
O
Valeur identifiant
O
2.2.2.
N°SIRE codé
Informations de sortie
Champ
-- Erreur --
Détail
Code erreur + libellé erreur
Voir précisions en 2.3
-- Infos cheval -N°SIRE codé
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance estimée
Date castration
AAAA-MM-JJ
Taille
cm
Mort
Oui/non
Date de mort
AAAA-MM-JJ
2.3.
Remarques et contrôles liés au web-service
Un champ non renseigné dans notre base de données n’est pas transmis en sortie du
web-service.
Voici les contrôles réalisés lors de l’appel du web-service :
Type de contrôle
Champs obligatoires renseignés
Contrôle de la validité des identifiants
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
5
3. Web-service « Pedigree »
Ce module de web-service permet d’obtenir l’ensemble des informations basiques sur un
cheval et ses ascendants, en remontant jusqu’à la 3 ème génération, soient 15 chevaux pour
un pedigree complet.
3.1.
Appel en clair
3.1.1.
Les paramètres d’entrée
Champ
--Contexte utilisateur--
O/F
Login
O
Code langue
O
Détail
-- Cheval par identifiant -Type d’identifiant
O
Valeur identifiant
O
3.1.2.
N°SIRE, N°SIRE + clé, transpodeur, UELN
Informations de sortie
Champ
-- Erreur--
Détail
Code erreur + libellé erreur
-- Infos pedigree cheval -UELN
N° SIRE
Clé
Clé du n°SIRE
N° transpondeur
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
-- -- Infos père 1G – attribut de Infos pedigree cheval
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
6
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos père 2G – attribut de Infos père 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G – attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G – attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
7
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos mère 2G – attribut de Infos père 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G – attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G – attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
8
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- Infos mère 1G – attribut de Infos pedigree cheval
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos père 2G –attribut de Infos mère 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G –attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
9
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G –attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos mère 2G –attribut de Infos mère 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G –attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
10
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G –attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
Appel en codé
3.1.3.
Les paramètres d’entrée
Champ
--Contexte utilisateur--
O/F
Login
O
Code langue
O
Détail
-- Cheval par identifiant -Type d’identifiant
O
Valeur identifiant
O
3.1.4.
N°SIRE codé
Informations de sortie
Champ
-- Erreur--
Détail
Code erreur + libellé erreur
-- Infos pedigree cheval -N° SIRE codé
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
11
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- Infos père 1G – attribut de Infos pedigree cheval
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos père 2G – attribut de Infos père 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G – attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
12
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G – attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos mère 2G – attribut de Infos père 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G – attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
13
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G – attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- Infos mère 1G – attribut de Infos pedigree cheval
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos père 2G –attribut de Infos mère 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
14
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G –attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G –attribut de Infos père 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- Infos mère 2G –attribut de Infos mère 1G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
15
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos père 3G –attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
-- -- -- -- Infos mère 3G –attribut de Infos mère 2G
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays de naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date de naissance
Date de naissance ou 1er janvier de l’année de naissance
estimée
Date castration
Taille
cm
Mort
Oui/non
Date de mort
N°SIRE codé
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
16
3.2.
Remarques et contrôles liés au web-service
Un champ ou un attribut non renseigné dans notre base de données n’est pas transmis en
sortie du web-service.
Voici les contrôles réalisés lors de l’appel du web-service :
Type de contrôle
Champs obligatoires renseignés
Contrôle de la validité des identifiants
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
17
4. Module « Recherche d’un cheval »
Ce module de web-service permet de rechercher un cheval ou une liste de chevaux à
partir de critères autres que des identifiants.
4.1.
Les paramètres d’entrée
Champ
-- ContexteUtilisateur --
O/F
Login
O
Code langue
O
Détail
-- Cheval -Nom
O
Au moins 3 caractères
Race
Sexe
Année de naissance mini
Année de naissance maxi
Nom du père
Au moins 3 caractères
Nom de la mère
Au moins 3 caractères
4.2.
Informations de sortie
Champ
-- Résultat --
Détail
Résultat
Codes erreurs + libellé erreur
-- Cheval -N° SIRE codé
Nom donné à la naissance
Nom actuel
Code pays de naissance
Libellé pays naissance
Code race
Libellé race
Pourcentage sang arabe
Code sexe
Libellé sexe
Code robe
Libellé robe
Date naissance
Date castration
Taille
Cheval mort
Oui/non
Date de mort
-- -- Généalogie – attribut de Cheval
Nom père
Race père
Pays naissance père
Code pays, voir table de référence pays
Nom mère
Race mère
Pays naissance mère
Code pays, voir table de référence pays
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
18
Nom père de mère
Race père de mère
Pays naissance père de mère
4.3.
Code pays, voir table de référence pays
Remarques et contrôles liés au web-service
Règles d’appel du web service :

Le nom (du cheval, de son père et de sa mère) : les 3 premières lettres sont
obligatoires et le caractère ‘%’ peut être utilisé pour remplacer des caractères non
connus. Ce caractère n’est autorisé qu’à partir de la quatrième position : les 3
premiers caractères sont différents de %.

Si le nombre de chevaux correspondant à la requête est trop grand (20 chevaux),
le web-service retourne un message d’erreur.
Catalogue des web-services proposé par l’IFCE– 2017
Service Secrétariat, Qualité, Extraction SIRE
19