Restful API

Cette API permet la manipulation des informations au sujet des médicaments vétérinaire en France. La plupart des classes et des fonctions sont partagées sur le site web GitHub. Retrouvez le code source sur ces pages Spring API et Jakarta EE API.

Obtenir des informations sur un Médicament en particulier

Pour obtenir les informations, nous effectuons une requête HTTP GET selon un id donné.

HTTP GET: /api/medicament/{id}

La réponse produite est de format JSON comme le montre l'exemple ci-dessous:

Supprimer un Médicament

Pour retirer un Médicament de la base de données, une requête HTTP DELETE peut-être envoyée suivant un id donné.

HTTP DELETE: /api/medicament/{id}

La réponse est vide et le statut de l'en-tête est Ok (200).

Mettre à jour les données d'un Médicament

Pour actualiser les informations du Médicament, nous pouvons effectuer une requête HTTP PUT incluant un contenu multi-part.

HTTP PUT: /api/medicament/update

La réponse renvoie les informations modifiées du Médicament.

Obtenir l'image associée à un Medicament

Pour obtenir la réponse image nous pouvons envoyer une requête HTTP GET avec l'id du Médicament.

HTTP GET: /api/medicament/{id}/image

L'en-tête de la réponse contient l'extension de l'image.

Obtenir une image en particulier de l'objet Rcp

Pour télécharger l'image nous envoyons une requête HTTP GET avec l'id du Medicament et le numéro de l'image de l'objet Rcp.

HTTP GET: /api/medicament/{id}/rcp/image/{number}

L'en-tête de la réponse contient l'extension de l'image.

Obtenir les noms et l'ids de tous les Médicaments

Les données peuvent être obtenues en envoyant une requête HTTP GET.

HTTP GET: /api/medicaments/nom-id

La réponse est au format JSON. L'exemple ci-dessous montre un extrait:

Rechercher la liste des noms des Médicaments

La liste des noms s'obtient en envoyant une requête HTTP POST.

HTTP POST: /api/medicaments/search

La requête doit contenir un body en JSON incluant les valeurs des paramètres de recherche. Retrouvez plus d'informations au sujet des paramètres dans la classe Java MedicamentSearch.

Un exemple de body en format JSON:

La réponse en JSON:

Obtenir les entrées utilisées dans le formulaire de recherche

Pour obtenir les données, nous effectuons une requête HTTP GET.

HTTP GET: /api/search-form

Ci-dessous est un extrait de la réponse en JSON:

Obtenir toutes les entrées afin de compléter ou de modifier les données d'un Médicament

Pour obtenir les données une requête HTTP GET est envoyée.

HTTP GET: /api/update-form

La réponse ci-dessous est une réponse partielle: