Documentation API

Documentation de l'API Gestion des Entretiens et Travaux

Cette API permet de gérer les entretiens et travaux en offrant des fonctionnalités de création, consultation, mise à jour et suppression des enregistrements.

Base URL

/api/maintenance

Ressources

L'API est structurée autour des ressources suivantes :

• /maintenance : Gestion des entretiens et travaux.

---

Endpoints

1. Récupérer tous les entretiens/travaux

GET /maintenance

Réponse

[
  {
    "id": 1,
    "nom": "Révision chaudière",
    "date": "2025-03-20",
    "duree": 3,
    "cout": 200,
    "piece": "Chaudière",
    "remplacementPrev": "2027-03-20"
  }
]

2. Récupérer un entretien/travail spécifique

GET /maintenance/{id}

Paramètres

• id (integer, obligatoire) : Identifiant de l'entretien/travail.

Réponse

{
  "id": 1,
  "nom": "Révision chaudière",
  "date": "2025-03-20",
  "duree": 3,
  "cout": 200,
  "piece": "Chaudière",
  "remplacementPrev": "2027-03-20"
}

3. Créer un nouvel entretien/travail

POST /maintenance

Corps de requête

{
  "nom": "Révision chaudière",
  "date": "2025-03-20",
  "duree": 3,
  "cout": 200,
  "piece": "Chaudière",
  "remplacementPrev": "2027-03-20"
}

Réponse

{
  "result": "success",
  "id": 2
}

4. Modifier un entretien/travail existant

PUT /maintenance/{id}

Paramètres

• id (integer, obligatoire) : Identifiant de l'entretien/travail.

Corps de requête

{
  "nom": "Révision chaudière",
  "date": "2025-04-01",
  "duree": 4,
  "cout": 220,
  "piece": "Chaudière",
  "remplacementPrev": "2027-04-01"
}

Réponse

{
  "result": "success"
}

5. Supprimer un entretien/travail

DELETE /maintenance/{id}

Paramètres

• id (integer, obligatoire) : Identifiant de l'entretien/travail.

Réponse

{
  "result": "success"
}

---

Gestion des erreurs

L'API renvoie des codes d'erreur en cas de problème :

• 400 Bad Request : Requête invalide.
• 404 Not Found : Ressource non trouvée.
• 500 Internal Server Error : Erreur interne du serveur.

Exemple d'erreur

{
  "error": "Entretien non trouvé"
}