Documentation de l'API de Disponibilités

Endpoint Principal

Paramètres

L'endpoint requiert un seul paramètre obligatoire :

• name: Le nom du praticien. La valeur doit être encodée pour l'URL.

Exemple de Requête

GET /api/rdv?name=Aur%C3%A9lie%20Bardot

Structure de la Réponse

La réponse est au format JSON et suit le standard Schema.org pour garantir une compréhension maximale par les machines.

En cas de succès (Code 200 OK)

La réponse contient un objet SearchResultsPage avec une ItemList d'événements (Event) représentant les créneaux.

{
  "@context": "https://schema.org",
  "@type": "SearchResultsPage",
  "mainEntity": {
    "@type": "ItemList",
    "name": "Disponibilités pour Aurélia Bardot",
    "itemListElement": [
      {
        "@type": "ListItem",
        "item": {
          "@type": "Event",
          "name": "Consultation Diététique",
          "description": "Consultation avec Aurélia Bardot...",
          "startDate": "2024-10-27T09:00:00+02:00",
          "endDate": "2024-10-27T10:00:00+02:00",
          "duration": "PT60M",
          "location": { ... },
          "offers": { ... },
          "organizer": { ... },
          "eventStatus": "https://schema.org/EventScheduled",
          "availability": "https://schema.org/InStock"
        }
      }
    ],
    "numberOfItems": 15
  },
  "description": "Liste des prochains créneaux de consultation disponibles."
}
            

En cas d'erreur

• Code 400 Bad Request : Le paramètre name est manquant.
• Code 404 Not Found : Aucun praticien trouvé pour le nom donné, ou pas de disponibilité.

Exemple de réponse 404 :

{
  "@context": "https://schema.org",
  "@type": "SearchResultsPage",
  "mainEntity": {
    "@type": "ItemList",
    "name": "Disponibilités pour Praticien Inconnu",
    "itemListElement": [],
    "numberOfItems": 0
  },
  "description": "Aucun créneau de disponibilité n'a été trouvé pour le praticien demandé."
}
            

Conseils d'Utilisation pour les IA